From 04bc9e1cd3544445d883ad29ea108c1645c8e7b7 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Mon, 4 Jun 2018 00:07:45 +0200 Subject: New upstream version 1.11.4 --- docs/libnm/html/NMSettingConnection.html | 352 +++++++++++++++++++++---------- 1 file changed, 240 insertions(+), 112 deletions(-) (limited to 'docs/libnm/html/NMSettingConnection.html') diff --git a/docs/libnm/html/NMSettingConnection.html b/docs/libnm/html/NMSettingConnection.html index 36f687c3..1e17821f 100644 --- a/docs/libnm/html/NMSettingConnection.html +++ b/docs/libnm/html/NMSettingConnection.html @@ -8,7 +8,7 @@ - + @@ -86,7 +86,7 @@ -gboolean +gboolean nm_setting_connection_get_autoconnect () @@ -94,7 +94,7 @@ -gint +gint nm_setting_connection_get_autoconnect_priority () @@ -102,7 +102,7 @@ -gint +gint nm_setting_connection_get_autoconnect_retries () @@ -110,7 +110,7 @@ -guint64 +guint64 nm_setting_connection_get_timestamp () @@ -118,7 +118,7 @@ -gboolean +gboolean nm_setting_connection_get_read_only () @@ -126,7 +126,7 @@ -guint32 +guint32 nm_setting_connection_get_num_permissions () @@ -134,7 +134,7 @@ -gboolean +gboolean nm_setting_connection_get_permission () @@ -149,7 +149,7 @@ -gboolean +gboolean nm_setting_connection_permissions_user_allowed () @@ -157,7 +157,7 @@ -gboolean +gboolean nm_setting_connection_add_permission () @@ -173,7 +173,7 @@ -gboolean +gboolean nm_setting_connection_remove_permission_by_value () @@ -188,7 +188,7 @@ -gboolean +gboolean nm_setting_connection_is_slave_type () @@ -211,7 +211,7 @@ -guint32 +guint32 nm_setting_connection_get_num_secondaries () @@ -226,7 +226,7 @@ -gboolean +gboolean nm_setting_connection_add_secondary () @@ -242,7 +242,7 @@ -gboolean +gboolean nm_setting_connection_remove_secondary_by_value () @@ -250,7 +250,7 @@ -guint32 +guint32 nm_setting_connection_get_gateway_ping_timeout () @@ -274,12 +274,20 @@ -gint +gint nm_setting_connection_get_auth_retries () + + +NMSettingConnectionMdns + + +nm_setting_connection_get_mdns () + + @@ -293,22 +301,22 @@ -gint +gint auth-retries Read / Write / Construct -gboolean +gboolean autoconnect Read / Write / Construct -gint +gint autoconnect-priority Read / Write / Construct -gint +gint autoconnect-retries Read / Write / Construct @@ -318,85 +326,90 @@ Read / Write / Construct -guint +guint gateway-ping-timeout Read / Write / Construct -gchar * +gchar * id Read / Write -gchar * +gchar * interface-name Read / Write -gint +gint lldp Read / Write / Construct -gchar * +gchar * master Read / Write +gint +mdns +Read / Write + + NMMetered metered Read / Write -GStrv +GStrv permissions Read / Write -gboolean +gboolean read-only Read / Write / Construct -GStrv +GStrv secondaries Read / Write -gchar * +gchar * slave-type Read / Write -gchar * +gchar * stable-id Read / Write -guint64 +guint64 timestamp Read / Write / Construct -gchar * +gchar * type Read / Write -gchar * +gchar * uuid Read / Write -gchar * +gchar * zone Read / Write / Construct @@ -508,6 +521,10 @@ NM_SETTING_CONNECTION_AUTH_RETRIES +#define +NM_SETTING_CONNECTION_MDNS + + enum NMSettingConnectionAutoconnectSlaves @@ -516,6 +533,10 @@ NMSettingConnectionLldp +enum +NMSettingConnectionMdns + +   NMSettingConnection @@ -526,8 +547,9 @@

Object Hierarchy

    GEnum
     ├── NMSettingConnectionAutoconnectSlaves
-    ╰── NMSettingConnectionLldp
-    GObject
+    ├── NMSettingConnectionLldp
+    ╰── NMSettingConnectionMdns
+    GObject
     ╰── NMSetting
         ╰── NMSettingConnection
 
@@ -687,7 +709,7 @@ nm_setting_connection_get_connection_type

nm_setting_connection_get_autoconnect ()

-
gboolean
+
gboolean
 nm_setting_connection_get_autoconnect (NMSettingConnection *setting);

Returns the “autoconnect” property of the connection.

@@ -713,7 +735,7 @@ nm_setting_connection_get_autoconnect (

nm_setting_connection_get_autoconnect_priority ()

-
gint
+
gint
 nm_setting_connection_get_autoconnect_priority
                                (NMSettingConnection *setting);

Returns the “autoconnect-priority” property of the connection. @@ -741,7 +763,7 @@ The higher number, the higher priority.


nm_setting_connection_get_autoconnect_retries ()

-
gint
+
gint
 nm_setting_connection_get_autoconnect_retries
                                (NMSettingConnection *setting);

Returns the “autoconnect-retries” property of the connection. @@ -770,7 +792,7 @@ Zero means infinite, -1 means the global default value.


nm_setting_connection_get_timestamp ()

-
guint64
+
guint64
 nm_setting_connection_get_timestamp (NMSettingConnection *setting);

Returns the “timestamp” property of the connection.

@@ -796,7 +818,7 @@ nm_setting_connection_get_timestamp (

nm_setting_connection_get_read_only ()

-
gboolean
+
gboolean
 nm_setting_connection_get_read_only (NMSettingConnection *setting);

Returns the “read-only” property of the connection.

@@ -816,13 +838,13 @@ nm_setting_connection_get_read_only (

Returns

-

TRUE if the connection is read-only, FALSE if it is not

+

TRUE if the connection is read-only, FALSE if it is not


nm_setting_connection_get_num_permissions ()

-
guint32
+
guint32
 nm_setting_connection_get_num_permissions
                                (NMSettingConnection *setting);

Returns the number of entries in the “permissions” @@ -850,9 +872,9 @@ property of this setting.


nm_setting_connection_get_permission ()

-
gboolean
+
gboolean
 nm_setting_connection_get_permission (NMSettingConnection *setting,
-                                      guint32 idx,
+                                      guint32 idx,
                                       const char **out_ptype,
                                       const char **out_pitem,
                                       const char **out_detail);
@@ -891,7 +913,7 @@ of this setting.

out_detail

-

on return, the permission detail (at this time, always NULL)

+

on return, the permission detail (at this time, always NULL)

  @@ -899,7 +921,7 @@ of this setting.

Returns

-

TRUE if a permission was returned, FALSE if idx +

TRUE if a permission was returned, FALSE if idx was invalid

@@ -932,7 +954,7 @@ nm_setting_connection_get_zone (

nm_setting_connection_permissions_user_allowed ()

-
gboolean
+
gboolean
 nm_setting_connection_permissions_user_allowed
                                (NMSettingConnection *setting,
                                 const char *uname);
@@ -961,14 +983,14 @@ nm_setting_connection_permissions_user_allowed

Returns

-

TRUE if the requested user is allowed to view this connection, -FALSE if the given user is not allowed to view this connection

+

TRUE if the requested user is allowed to view this connection, +FALSE if the given user is not allowed to view this connection


nm_setting_connection_add_permission ()

-
gboolean
+
gboolean
 nm_setting_connection_add_permission (NMSettingConnection *setting,
                                       const char *ptype,
                                       const char *pitem,
@@ -1004,7 +1026,7 @@ the "user" permission type is supported, and pitem
 
 

detail

-

unused at this time; must be NULL.

+

unused at this time; must be NULL.

[allow-none] @@ -1012,8 +1034,8 @@ the "user" permission type is supported, and pitem

Returns

-

TRUE if the permission was unique and was successfully added to the -list, FALSE if ptype +

TRUE if the permission was unique and was successfully added to the +list, FALSE if ptype or pitem was invalid or it the permission was already present in the list

@@ -1025,7 +1047,7 @@ present in the list

void
 nm_setting_connection_remove_permission
                                (NMSettingConnection *setting,
-                                guint32 idx);
+ guint32 idx);

Removes the permission at index idx from the connection.

@@ -1054,7 +1076,7 @@ nm_setting_connection_remove_permission

nm_setting_connection_remove_permission_by_value ()

-
gboolean
+
gboolean
 nm_setting_connection_remove_permission_by_value
                                (NMSettingConnection *setting,
                                 const char *ptype,
@@ -1091,7 +1113,7 @@ be a username. See 

detail

-

unused at this time; must be NULL.

+

unused at this time; must be NULL.

[allow-none] @@ -1099,7 +1121,7 @@ be a username. See

Returns

-

TRUE if the permission was found and removed; FALSE if it was not.

+

TRUE if the permission was found and removed; FALSE if it was not.


@@ -1132,7 +1154,7 @@ connection.


nm_setting_connection_is_slave_type ()

-
gboolean
+
gboolean
 nm_setting_connection_is_slave_type (NMSettingConnection *setting,
                                      const char *type);
@@ -1161,7 +1183,7 @@ against setting

Returns

-

TRUE if connection is of the given slave type +

TRUE if connection is of the given slave type

@@ -1223,7 +1245,7 @@ with the connection.


nm_setting_connection_get_num_secondaries ()

-
guint32
+
guint32
 nm_setting_connection_get_num_secondaries
                                (NMSettingConnection *setting);
@@ -1251,7 +1273,7 @@ nm_setting_connection_get_num_secondaries

nm_setting_connection_get_secondary ()

const char *
 nm_setting_connection_get_secondary (NMSettingConnection *setting,
-                                     guint32 idx);
+ guint32 idx);

Parameters

@@ -1283,7 +1305,7 @@ nm_setting_connection_get_secondary (

nm_setting_connection_add_secondary ()

-
gboolean
+
gboolean
 nm_setting_connection_add_secondary (NMSettingConnection *setting,
                                      const char *sec_uuid);

Adds a new secondary connetion UUID to the setting.

@@ -1311,7 +1333,7 @@ nm_setting_connection_add_secondary (

Returns

-

TRUE if the secondary connection UUID was added; FALSE if the UUID +

TRUE if the secondary connection UUID was added; FALSE if the UUID was already present

@@ -1321,7 +1343,7 @@ was already present

void
 nm_setting_connection_remove_secondary
                                (NMSettingConnection *setting,
-                                guint32 idx);
+ guint32 idx);

Removes the secondary coonnection UUID at index idx .

@@ -1350,7 +1372,7 @@ nm_setting_connection_remove_secondary

nm_setting_connection_remove_secondary_by_value ()

-
gboolean
+
gboolean
 nm_setting_connection_remove_secondary_by_value
                                (NMSettingConnection *setting,
                                 const char *sec_uuid);
@@ -1380,13 +1402,13 @@ nm_setting_connection_remove_secondary_by_value

Returns

-

TRUE if the secondary connection UUID was found and removed; FALSE if it was not.

+

TRUE if the secondary connection UUID was found and removed; FALSE if it was not.


nm_setting_connection_get_gateway_ping_timeout ()

-
guint32
+
guint32
 nm_setting_connection_get_gateway_ping_timeout
                                (NMSettingConnection *setting);
@@ -1467,7 +1489,7 @@ enabled for the connection.


nm_setting_connection_get_auth_retries ()

-
gint
+
gint
 nm_setting_connection_get_auth_retries
                                (NMSettingConnection *setting);

Returns the value contained in the “auth-retries” property.

@@ -1493,6 +1515,32 @@ infinity and -1 means a global default value.

Since: 1.10

+
+
+

nm_setting_connection_get_mdns ()

+
NMSettingConnectionMdns
+nm_setting_connection_get_mdns (NMSettingConnection *setting);
+
+

Parameters

+
+++++ + + + + + +

setting

the NMSettingConnection

 
+
+
+

Returns

+

the “mdns” property of the setting.

+
+

Since: 1.12

+

Types and Values

@@ -1641,6 +1689,12 @@ infinity and -1 means a global default value.


+

NM_SETTING_CONNECTION_MDNS

+
#define NM_SETTING_CONNECTION_MDNS           "mdns"
+
+
+
+

enum NMSettingConnectionAutoconnectSlaves

NMSettingConnectionAutoconnectSlaves values indicate whether slave connections should be activated when master is activated.

@@ -1720,6 +1774,52 @@ should be activated when master is activated.


+

enum NMSettingConnectionMdns

+

NMSettingConnectionMdns values indicate whether mDNS should be enabled.

+
+

Members

+
+++++ + + + + + + + + + + + + + + + + + + + + + + +

NM_SETTING_CONNECTION_MDNS_DEFAULT

+

default value

+
 

NM_SETTING_CONNECTION_MDNS_NO

+

disable mDNS

+
 

NM_SETTING_CONNECTION_MDNS_RESOLVE

+

support only resolving, do not register hostname

+
 

NM_SETTING_CONNECTION_MDNS_YES

+

enable mDNS

+
 
+
+

Since: 1.12

+
+
+

NMSettingConnection

typedef struct _NMSettingConnection NMSettingConnection;

General Connection Profile Settings

@@ -1729,7 +1829,7 @@ should be activated when master is activated.

Property Details

The “auth-retries” property

-
  “auth-retries”             gint
+
  “auth-retries”             gint

The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection.

@@ -1742,18 +1842,21 @@ retries for 3 times before failing the connection.


The “autoconnect” property

-
  “autoconnect”              gboolean
+
  “autoconnect”              gboolean

Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. -TRUE to automatically activate the connection, FALSE to require manual +TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection.

+

Note that autoconnect is not implemented for VPN profiles. See +“secondaries” as an alternative to automatically +connect VPN profiles.

Flags: Read / Write / Construct

Default value: TRUE


The “autoconnect-priority” property

-
  “autoconnect-priority”     gint
+
  “autoconnect-priority”     gint

The autoconnect priority. If the connection is set to autoconnect, connections with higher priority will be preferred. Defaults to 0. The higher number means higher priority.

@@ -1764,7 +1867,7 @@ The higher number means higher priority.


The “autoconnect-retries” property

-
  “autoconnect-retries”      gint
+
  “autoconnect-retries”      gint

The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before @@ -1780,7 +1883,9 @@ to autoconnect again.

  “autoconnect-slaves”       NMSettingConnectionAutoconnectSlaves

Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect -for master connections. +for master connections. The properties “autoconnect”, +“autoconnect-priority” and “autoconnect-retries” +are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to @@ -1792,7 +1897,7 @@ determine the real value. If it is default as well, this fallbacks to 0.


The “gateway-ping-timeout” property

-
  “gateway-ping-timeout”     guint
+
  “gateway-ping-timeout”     guint

If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.

Flags: Read / Write / Construct

@@ -1802,7 +1907,7 @@ timeout is reached, or an IP gateway replies to a ping.


The “id” property

-
  “id”                       gchar *
+
  “id”                       gchar *

A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".

Flags: Read / Write

@@ -1811,7 +1916,7 @@ or "T-Mobile 3G".


The “interface-name” property

-
  “interface-name”           gchar *
+
  “interface-name”           gchar *

The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings).

@@ -1827,7 +1932,7 @@ connection may be applied to the wrong interface.


The “lldp” property

-
  “lldp”                     gint
+
  “lldp”                     gint

Whether LLDP is enabled for the connection.

Flags: Read / Write / Construct

Default value: -1

@@ -1836,13 +1941,29 @@ connection may be applied to the wrong interface.


The “master” property

-
  “master”                   gchar *
+
  “master”                   gchar *

Interface name of the master device or UUID of the master connection.

Flags: Read / Write

Default value: NULL


+

The “mdns” property

+
  “mdns”                     gint
+

Whether mDNS is enabled for the connection.

+

The permitted values are: yes: register hostname and resolving +for the connection, no: disable mDNS for the interface, resolve: +do not register hostname but allow resolving of mDNS host names. +When updating this property on a currently activated connection, +the change takes effect immediately.

+

This feature requires a plugin which supports mDNS. One such +plugin is dns-systemd-resolved.

+

Flags: Read / Write

+

Default value: -1

+

Since: 1.12

+
+
+

The “metered” property

  “metered”                  NMMetered

Whether the connection is metered.

@@ -1855,9 +1976,9 @@ the change takes effect immediately.


The “permissions” property

-
  “permissions”              GStrv
+
  “permissions”              GStrv

An array of strings defining what access a given user has to this -connection. If this is NULL or empty, all users are allowed to access +connection. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry @@ -1872,9 +1993,9 @@ use. All of [type], [id], and [reserved] must be valid UTF-8.


The “read-only” property

-
  “read-only”                gboolean
-

FALSE if the connection can be modified using the provided settings -service's D-Bus interface with the right privileges, or TRUE if the +

  “read-only”                gboolean
+

FALSE if the connection can be modified using the provided settings +service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.

Flags: Read / Write / Construct

Default value: FALSE

@@ -1882,7 +2003,7 @@ connection is read-only and cannot be modified.


The “secondaries” property

-
  “secondaries”              GStrv
+
  “secondaries”              GStrv

List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported.

@@ -1891,9 +2012,9 @@ supported.


The “slave-type” property

-
  “slave-type”               gchar *
+
  “slave-type”               gchar *

Setting name of the device type of this slave's master connection (eg, -NM_SETTING_BOND_SETTING_NAME), or NULL if this connection is not a +NM_SETTING_BOND_SETTING_NAME), or NULL if this connection is not a slave.

Flags: Read / Write

Default value: NULL

@@ -1901,29 +2022,36 @@ slave.


The “stable-id” property

-
  “stable-id”                gchar *
-

Token to generate stable IDs for the connection.

+
  “stable-id”                gchar *
+

This represents the identity of the connection used for various purposes. +It allows to configure multiple profiles to share the identity. Also, +the stable-id can contain placeholders that are substituted dynamically and +deterministically depending on the context.

The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable -and wifi.cloned-mac-address=stable. Note that also the interface name -of the activating connection and a per-host secret key is included -into the address generation so that the same stable-id on different -hosts/devices yields different addresses.

-

If the value is unset, an ID unique for the connection is used. -Specifying a stable-id allows multiple connections to generate the -same addresses. Another use is to generate IDs at runtime via -dynamic substitutions.

+and wifi.cloned-mac-address=stable. It is also used as DHCP client +identifier with ipv4.dhcp-client-id=stable.

+

Note that depending on the context where it is used, other parameters are +also seeded into the generation algorithm. For example, a per-host key +is commonly also included, so that different systems end up generating +different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's +name is included, so that different interfaces yield different addresses.

The '$' character is treated special to perform dynamic substitutions -at runtime. Currently supported are "${CONNECTION}", "${BOOT}", "${RANDOM}". -These effectively create unique IDs per-connection, per-boot, or every time. +at runtime. Currently supported are "${CONNECTION}", "${DEVICE}", +"${BOOT}", "${RANDOM}". +These effectively create unique IDs per-connection, per-device, per-boot, +or every time. Note that "${DEVICE}" corresponds the the interface name of the +device. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". -For example, set it to "${CONNECTION}/${BOOT}" to create a unique id for -this connection that changes with every reboot.

-

Note that two connections only use the same effective id if -their stable-id is also identical before performing dynamic substitutions.

+For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for +this connection that changes with every reboot and differs depending on the +interface where the profile activates.

+

If the value is unset, a global connection default is consulted. If the +value is still unset, the default is similar to "${CONNECTION}" and uses +a unique, fixed ID for the connection.

Flags: Read / Write

Default value: NULL

Since: 1.4

@@ -1931,7 +2059,7 @@ their stable-id is also identical before performing dynamic substitutions.


The “timestamp” property

-
  “timestamp”                guint64
+
  “timestamp”                guint64

The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated.

NetworkManager updates the connection timestamp periodically when the @@ -1944,7 +2072,7 @@ property will not be preserved).


The “type” property

-
  “type”                     gchar *
+
  “type”                     gchar *

Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for @@ -1956,7 +2084,7 @@ the setting name of that setting type (ie, "vpn" or "bridge", etc).


The “uuid” property

-
  “uuid”                     gchar *
+
  “uuid”                     gchar *

A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same @@ -1967,16 +2095,16 @@ provider, or nm_utils_uuid_generate() or -nm_utils_uuid_generate_from_string().

+nm_utils_uuid_generate_from_string().

Flags: Read / Write

Default value: NULL


The “zone” property

-
  “zone”                     gchar *
+
  “zone”                     gchar *

The trust level of a the connection. Free form case-insensitive string -(for example "Home", "Work", "Public"). NULL or unspecified zone means +(for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.

When updating this property on a currently activated connection, @@ -1987,6 +2115,6 @@ the change takes effect immediately.

+
Generated by GTK-Doc V1.28
\ No newline at end of file -- cgit 1.3.0-6-gf8a5