From c333f062ddcba9b35330647bf6cbd0a07f2d786e Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Thu, 11 May 2017 14:55:55 +0200 Subject: New upstream version 1.8.0 --- docs/api/html/nm-settings.html | 725 ++++++++++++++++++++++++++--------------- 1 file changed, 467 insertions(+), 258 deletions(-) (limited to 'docs/api/html/nm-settings.html') diff --git a/docs/api/html/nm-settings.html b/docs/api/html/nm-settings.html index 9501aa71..38c28d64 100644 --- a/docs/api/html/nm-settings.html +++ b/docs/api/html/nm-settings.html @@ -5,8 +5,8 @@ nm-settings: NetworkManager Reference Manual - - + + @@ -16,7 +16,7 @@ Home Up -Prev +Prev Next
@@ -93,9 +93,171 @@
-
-

Table 25. 802-1x setting

-
+
+

connection setting

+

General Connection Profile Settings.

+
++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
+autoconnectbooleanTRUEWhether 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 intervention to activate the connection.
+autoconnect-priorityint320The 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.
+autoconnect-retriesint32-1The number of times a connection should be tried when autoctivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden).
+autoconnect-slavesNMSettingConnectionAutoconnectSlaves (int32) 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. 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 determine the real value. If it is default as well, this fallbacks to 0.
+gateway-ping-timeoutuint320If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.
+idstring A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".
+interface-namestring 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). For software devices this specifies the name of the created device. For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.
+lldpint32-1Whether LLDP is enabled for the connection.
+masterstring Interface name of the master device or UUID of the master connection.
+meteredNMMetered (int32) Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.
+namestringconnectionThe setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".
+permissionsarray of string[]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 this connection. Otherwise a user is allowed to access this connection if and only if they are in this list. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.
+read-onlybooleanFALSEFALSE 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.
+secondariesarray of string[]List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported.
+slave-typestring Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.
+stable-idstring Token to generate stable IDs for the connection. 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. Specifing a stable-id allows multiple connections to generate the same addresses. Another use is to generate IDs at runtime via dynamic substitutions. 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. 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.
+timestampuint640The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).
+typestring 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 non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).
+uuidstring 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 network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").
+zonestring The trust level of a the connection. Free form case-insensitive string (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, the change takes effect immediately.
+
+
+
+

802-1x setting

+

AIEEE 802.1x Authentication Settings.

+
@@ -125,6 +287,13 @@ + + + + + + @@ -132,6 +301,20 @@ + + + + + + + + + + + + @@ -146,6 +329,20 @@ + + + + + + + + + + + + @@ -209,6 +406,13 @@ + + + + + + @@ -258,6 +462,20 @@ + + + + + + + + + + + + @@ -272,6 +490,20 @@ + + + + + + + + + + + + @@ -282,7 +514,7 @@ phase2-private-key - + - +
+auth-timeoutint320A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.
ca-cert byte array  
+ca-cert-passwordstring The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
+ca-cert-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "ca-cert-password" property. (see the section called “Secret flag types:” for flag values)
ca-path string  
+client-cert-passwordstring The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
+client-cert-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "client-cert-password" property. (see the section called “Secret flag types:” for flag values)
domain-suffix-match string  
+phase1-auth-flagsuint320Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The invidual TLS versions can be explicitly disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x settings. See the wpa_supplicant documentation for more details.
phase1-fast-provisioning string  
+phase2-ca-cert-passwordstring The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
+phase2-ca-cert-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "phase2-ca-cert-password" property. (see the section called “Secret flag types:” for flag values)
phase2-ca-path string  
+phase2-client-cert-passwordstring The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.
+phase2-client-cert-password-flagsNMSettingSecretFlags (uint32) Flags indicating how to handle the "phase2-client-cert-password" property. (see the section called “Secret flag types:” for flag values)
phase2-domain-suffix-match string   byte array  Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.
@@ -324,7 +556,7 @@ private-key byte array  Contains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.Contains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.
@@ -357,9 +589,11 @@
-
-

Table 26. adsl setting

-
+
+
+

adsl setting

+

ADSL Settings.

+
@@ -432,9 +666,11 @@
-
-

Table 27. bluetooth setting

-
+
+
+

bluetooth setting

+

Bluetooth Settings.

+
@@ -472,9 +708,11 @@
-
-

Table 28. bond setting

-
+
+
+

bond setting

+

Bonding Settings.

+
@@ -512,9 +750,11 @@
-
-

Table 29. bridge setting

-
+
+
+

bridge setting

+

Bridging Settings.

+
@@ -601,9 +841,11 @@
-
-

Table 30. bridge-port setting

-
+
+
+

bridge-port setting

+

Bridge Port Settings.

+
@@ -648,9 +890,11 @@
-
-

Table 31. cdma setting

-
+
+
+

cdma setting

+

CDMA-based Mobile Broadband Settings.

+
@@ -666,6 +910,13 @@ + + + + + + @@ -702,168 +953,11 @@
+mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
name string cdma
-
-

Table 32. connection setting

-
------ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
Key NameValue TypeDefault ValueValue Description
-autoconnectbooleanTRUEWhether 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 intervention to activate the connection.
-autoconnect-priorityint320The 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.
-autoconnect-retriesint32-1The number of times a connection should be tried when autoctivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden).
-autoconnect-slavesNMSettingConnectionAutoconnectSlaves (int32) 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. 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 determine the real value. If it is default as well, this fallbacks to 0.
-gateway-ping-timeoutuint320If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.
-idstring A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".
-interface-namestring 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). For software devices this specifies the name of the created device. For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.
-lldpint32-1Whether LLDP is enabled for the connection.
-masterstring Interface name of the master device or UUID of the master connection.
-meteredNMMetered (int32) Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.
-namestringconnectionThe setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".
-permissionsarray of string[]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 this connection. Otherwise a user is allowed to access this connection if and only if they are in this list. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.
-read-onlybooleanFALSEFALSE 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.
-secondariesarray of string[]List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported.
-slave-typestring Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.
-stable-idstring Token to generate stable IDs for the connection. 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. Specifing a stable-id allows multiple connections to generate the same addresses. Another use is to generate IDs at runtime via dynamic substitutions. 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. 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.
-timestampuint640The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).
-typestring 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 non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).
-uuidstring 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 network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").
-zonestring The trust level of a the connection. Free form case-insensitive string (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, the change takes effect immediately.
-
-
-

Table 33. dcb setting

-
+
+
+

dcb setting

+

Data Center Bridging Settings.

+
@@ -992,9 +1086,37 @@
-
-

Table 34. generic setting

-
+
+
+

dummy setting

+

Dummy Link Settings.

+
++++++ + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
+namestringdummyThe setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".
+
+
+
+

generic setting

+

Generic Link Settings.

+
@@ -1016,9 +1138,11 @@
-
-

Table 35. gsm setting

-
+
+
+

gsm setting

+

GSM-based Mobile Broadband Settings.

+
@@ -1055,6 +1179,13 @@ + + + + + + @@ -1126,9 +1257,11 @@
+mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.
name string gsm
-
-

Table 36. infiniband setting

-
+
+
+

infiniband setting

+

Infiniband Settings.

+
@@ -1187,9 +1320,11 @@
-
-

Table 37. ipv4 setting

-
+
+
+

ipv4 setting

+

IPv4 Settings.

+
@@ -1360,9 +1495,11 @@
-
-

Table 38. ipv6 setting

-
+
+
+

ipv6 setting

+

IPv6 Settings.

+
@@ -1540,9 +1677,11 @@
-
-

Table 39. ip-tunnel setting

-
+
+
+

ip-tunnel setting

+

IP Tunneling Settings.

+
@@ -1650,9 +1789,11 @@
-
-

Table 40. macsec setting

-
+
+
+

macsec setting

+

MACSec Settings.

+
@@ -1732,9 +1873,11 @@
-
-

Table 41. macvlan setting

-
+
+
+

macvlan setting

+

MAC VLAN Settings.

+
@@ -1786,9 +1929,11 @@
-
-

Table 42. 802-11-olpc-mesh setting

-
+
+
+

802-11-olpc-mesh setting

+

OLPC Wireless Mesh Settings.

+
@@ -1833,9 +1978,11 @@
-
-

Table 43. ppp setting

-
+
+
+

ppp setting

+

Point-to-Point Protocol Settings.

+
@@ -1985,9 +2132,11 @@
-
-

Table 44. pppoe setting

-
+
+
+

pppoe setting

+

PPP-over-Ethernet Settings.

+
@@ -2039,9 +2188,11 @@
-
-

Table 45. proxy setting

-
+
+
+

proxy setting

+

WWW Proxy Settings.

+
@@ -2093,9 +2244,11 @@
-
-

Table 46. serial setting

-
+
+
+

serial setting

+

Serial Link Settings.

+
@@ -2154,9 +2307,11 @@
-
-

Table 47. team setting

-
+
+
+

team setting

+

Teaming Settings.

+
@@ -2194,9 +2349,11 @@
-
-

Table 48. team-port setting

-
+
+
+

team-port setting

+

Team Port Settings.

+
@@ -2227,9 +2384,11 @@
-
-

Table 49. tun setting

-
+
+
+

tun setting

+

Tunnel Settings.

+
@@ -2295,9 +2454,46 @@
-
-

Table 50. vlan setting

-
+
+
+

user setting

+

General User Profile Settings.

+
++++++ + + + + + + + + + + + + + + + + + + + + +
Key NameValue TypeDefault ValueValue Description
+datadict of string to string{}A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.
+namestringuserThe setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".
+
+
+
+

vlan setting

+

VLAN Settings.

+
@@ -2363,9 +2559,11 @@
-
-

Table 51. vpn setting

-
+
+
+

vpn setting

+

VPN Settings.

+
@@ -2431,9 +2629,11 @@
-
-

Table 52. vxlan setting

-
+
+
+

vxlan setting

+

VXLAN Settings.

+
@@ -2569,9 +2769,11 @@
-
-

Table 53. wimax setting

-
+
+
+

wimax setting

+

WiMax Settings.

+
@@ -2609,9 +2811,11 @@
-
-

Table 54. 802-3-ethernet setting

-
+
+
+

802-3-ethernet setting

+

Wired Ethernet Settings.

+
@@ -2740,9 +2944,11 @@
-
-

Table 55. 802-11-wireless setting

-
+
+
+

802-11-wireless setting

+

Wi-Fi Settings.

+
@@ -2892,9 +3098,11 @@
-
-

Table 56. 802-11-wireless-security setting

-
+
+
+

802-11-wireless-security setting

+

Wi-Fi Security Settings.

+
@@ -3037,7 +3245,8 @@
-
+
+

Secret flag types:

Each secret property in a setting has an associated flags property -- cgit 1.3.0-6-gf8a5