diff options
Diffstat (limited to 'man/nm-settings.5')
| -rw-r--r-- | man/nm-settings.5 | 914 |
1 files changed, 502 insertions, 412 deletions
diff --git a/man/nm-settings.5 b/man/nm-settings.5 index 0d91c79d..543179c1 100644 --- a/man/nm-settings.5 +++ b/man/nm-settings.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings .\" Author: .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 02/15/2017 +.\" Date: 05/10/2017 .\" Manual: Configuration -.\" Source: NetworkManager 1.6.2 +.\" Source: NetworkManager 1.8.0 .\" Language: English .\" -.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.6\&.2" "Configuration" +.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.8\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -58,12 +58,9 @@ that allows direct configuration of the settings and properties according to a c connection editor has also a built\-in \fIdescribe\fR command that can display description of particular settings and properties of this page\&. -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&1.\ \&802\-1x setting +.SS "connection setting" +.PP +General Connection Profile Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -96,6 +93,234 @@ l l l l l l l l l l l l l l l l +l l l l. +T{ +autoconnect +T}:T{ +boolean +T}:T{ +TRUE +T}:T{ +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 intervention to activate the connection\&. +T} +T{ +autoconnect\-priority +T}:T{ +int32 +T}:T{ +0 +T}:T{ +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\&. +T} +T{ +autoconnect\-retries +T}:T{ +int32 +T}:T{ +\-1 +T}:T{ +The 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)\&. +T} +T{ +autoconnect\-slaves +T}:T{ +NMSettingConnectionAutoconnectSlaves (int32) +T}:T{ +\ \& +T}:T{ +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\&. +T} +T{ +gateway\-ping\-timeout +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping\&. +T} +T{ +id +T}:T{ +string +T}:T{ +\ \& +T}:T{ +A human readable unique identifier for the connection, like "Work Wi\-Fi" or "T\-Mobile 3G"\&. +T} +T{ +interface\-name +T}:T{ +string +T}:T{ +\ \& +T}:T{ +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\&. +T} +T{ +lldp +T}:T{ +int32 +T}:T{ +\-1 +T}:T{ +Whether LLDP is enabled for the connection\&. +T} +T{ +master +T}:T{ +string +T}:T{ +\ \& +T}:T{ +Interface name of the master device or UUID of the master connection\&. +T} +T{ +metered +T}:T{ +NMMetered (int32) +T}:T{ +\ \& +T}:T{ +Whether the connection is metered\&. When updating this property on a currently activated connection, the change takes effect immediately\&. +T} +T{ +name +T}:T{ +string +T}:T{ +connection +T}:T{ +The setting\*(Aqs 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"\&. +T} +T{ +permissions +T}:T{ +array of string +T}:T{ +[] +T}:T{ +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\&. +T} +T{ +read\-only +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +FALSE if the connection can be modified using the provided settings service\*(Aqs D\-Bus interface with the right privileges, or TRUE if the connection is read\-only and cannot be modified\&. +T} +T{ +secondaries +T}:T{ +array of string +T}:T{ +[] +T}:T{ +List of connection UUIDs that should be activated when the base connection itself is activated\&. Currently only VPN connections are supported\&. +T} +T{ +slave\-type +T}:T{ +string +T}:T{ +\ \& +T}:T{ +Setting name of the device type of this slave\*(Aqs master connection (eg, "bond"), or NULL if this connection is not a slave\&. +T} +T{ +stable\-id +T}:T{ +string +T}:T{ +\ \& +T}:T{ +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 \*(Aq$\*(Aq 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 \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq 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\&. +T} +T{ +timestamp +T}:T{ +uint64 +T}:T{ +0 +T}:T{ +The 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)\&. +T} +T{ +type +T}:T{ +string +T}:T{ +\ \& +T}:T{ +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)\&. +T} +T{ +uuid +T}:T{ +string +T}:T{ +\ \& +T}:T{ +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 "\-")\&. +T} +T{ +zone +T}:T{ +string +T}:T{ +\ \& +T}:T{ +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\&. +T} +.TE +.sp 1 +.SS "802\-1x setting" +.PP +AIEEE 802\&.1x Authentication Settings\&. +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l l l l l l l l l l l l l @@ -131,6 +356,15 @@ T}:T{ Anonymous identity string for EAP authentication methods\&. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP\-TTLS\&. T} T{ +auth\-timeout +T}:T{ +int32 +T}:T{ +0 +T}:T{ +A timeout for the authentication\&. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds\&. +T} +T{ ca\-cert T}:T{ byte array @@ -140,6 +374,24 @@ T}:T{ Contains the CA certificate if used by the EAP method specified in the "eap" property\&. Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. T} T{ +ca\-cert\-password +T}:T{ +string +T}:T{ +\ \& +T}:T{ +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\&. +T} +T{ +ca\-cert\-password\-flags +T}:T{ +NMSettingSecretFlags (uint32) +T}:T{ +\ \& +T}:T{ +Flags indicating how to handle the "ca\-cert\-password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) +T} +T{ ca\-path T}:T{ string @@ -158,6 +410,24 @@ T}:T{ Contains the client certificate if used by the EAP method specified in the "eap" property\&. Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. T} T{ +client\-cert\-password +T}:T{ +string +T}:T{ +\ \& +T}:T{ +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\&. +T} +T{ +client\-cert\-password\-flags +T}:T{ +NMSettingSecretFlags (uint32) +T}:T{ +\ \& +T}:T{ +Flags indicating how to handle the "client\-cert\-password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) +T} +T{ domain\-suffix\-match T}:T{ string @@ -239,6 +509,15 @@ T}:T{ Flags indicating how to handle the "password\-raw" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ +phase1\-auth\-flags +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Specifies 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\&. +T} +T{ phase1\-fast\-provisioning T}:T{ string @@ -302,6 +581,24 @@ T}:T{ Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2\-auth" or "phase2\-autheap" properties\&. Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. T} T{ +phase2\-ca\-cert\-password +T}:T{ +string +T}:T{ +\ \& +T}:T{ +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\&. +T} +T{ +phase2\-ca\-cert\-password\-flags +T}:T{ +NMSettingSecretFlags (uint32) +T}:T{ +\ \& +T}:T{ +Flags indicating how to handle the "phase2\-ca\-cert\-password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) +T} +T{ phase2\-ca\-path T}:T{ string @@ -320,6 +617,24 @@ T}:T{ Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2\-auth" or "phase2\-autheap" properties\&. Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. T} T{ +phase2\-client\-cert\-password +T}:T{ +string +T}:T{ +\ \& +T}:T{ +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\&. +T} +T{ +phase2\-client\-cert\-password\-flags +T}:T{ +NMSettingSecretFlags (uint32) +T}:T{ +\ \& +T}:T{ +Flags indicating how to handle the "phase2\-client\-cert\-password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) +T} +T{ phase2\-domain\-suffix\-match T}:T{ string @@ -335,7 +650,7 @@ byte array T}:T{ \ \& T}:T{ -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\*(Aqs 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\*(Aqs 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\&. T} T{ phase2\-private\-key\-password @@ -389,7 +704,7 @@ byte array T}:T{ \ \& T}:T{ -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\*(Aqs 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\*(Aqs 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\&. T} T{ private\-key\-password @@ -429,12 +744,9 @@ When TRUE, overrides the "ca\-path" and "phase2\-ca\-path" properties using the T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&2.\ \&adsl setting +.SS "adsl setting" +.PP +ADSL Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -530,12 +842,9 @@ VPI of ADSL connection T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&3.\ \&bluetooth setting +.SS "bluetooth setting" +.PP +Bluetooth Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -581,12 +890,9 @@ Either "dun" for Dial\-Up Networking connections or "panu" for Personal Area Net T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&4.\ \&bond setting +.SS "bond setting" +.PP +Bonding Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -632,12 +938,9 @@ Dictionary of key/value pairs of bonding options\&. Both keys and values must b T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&5.\ \&bridge setting +.SS "bridge setting" +.PP +Bridging Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -753,12 +1056,9 @@ Controls whether Spanning Tree Protocol (STP) is enabled for this bridge\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&6.\ \&bridge\-port setting +.SS "bridge\-port setting" +.PP +Bridge Port Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -814,12 +1114,9 @@ The Spanning Tree Protocol (STP) priority of this bridge port\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&7.\ \&cdma setting +.SS "cdma setting" +.PP +CDMA\-based Mobile Broadband Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -837,8 +1134,18 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ +mtu +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. +T} +T{ name T}:T{ string @@ -885,233 +1192,9 @@ The username used to authenticate with the network, if required\&. Many provide T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&8.\ \&connection setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -autoconnect -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -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 intervention to activate the connection\&. -T} -T{ -autoconnect\-priority -T}:T{ -int32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -autoconnect\-retries -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -The 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)\&. -T} -T{ -autoconnect\-slaves -T}:T{ -NMSettingConnectionAutoconnectSlaves (int32) -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -gateway\-ping\-timeout -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping\&. -T} -T{ -id -T}:T{ -string -T}:T{ -\ \& -T}:T{ -A human readable unique identifier for the connection, like "Work Wi\-Fi" or "T\-Mobile 3G"\&. -T} -T{ -interface\-name -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -lldp -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Whether LLDP is enabled for the connection\&. -T} -T{ -master -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Interface name of the master device or UUID of the master connection\&. -T} -T{ -metered -T}:T{ -NMMetered (int32) -T}:T{ -\ \& -T}:T{ -Whether the connection is metered\&. When updating this property on a currently activated connection, the change takes effect immediately\&. -T} -T{ -name -T}:T{ -string -T}:T{ -connection -T}:T{ -The setting\*(Aqs 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"\&. -T} -T{ -permissions -T}:T{ -array of string -T}:T{ -[] -T}:T{ -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\&. -T} -T{ -read\-only -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -FALSE if the connection can be modified using the provided settings service\*(Aqs D\-Bus interface with the right privileges, or TRUE if the connection is read\-only and cannot be modified\&. -T} -T{ -secondaries -T}:T{ -array of string -T}:T{ -[] -T}:T{ -List of connection UUIDs that should be activated when the base connection itself is activated\&. Currently only VPN connections are supported\&. -T} -T{ -slave\-type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Setting name of the device type of this slave\*(Aqs master connection (eg, "bond"), or NULL if this connection is not a slave\&. -T} -T{ -stable\-id -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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 \*(Aq$\*(Aq 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 \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq 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\&. -T} -T{ -timestamp -T}:T{ -uint64 -T}:T{ -0 -T}:T{ -The 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)\&. -T} -T{ -type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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)\&. -T} -T{ -uuid -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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 "\-")\&. -T} -T{ -zone -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&9.\ \&dcb setting +.SS "dcb setting" +.PP +Data Center Bridging Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -1287,12 +1370,37 @@ An array of 8 uint values, where the array index corresponds to the User Priorit T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&10.\ \&generic setting +.SS "dummy setting" +.PP +Dummy Link Settings\&. +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l. +T{ +name +T}:T{ +string +T}:T{ +dummy +T}:T{ +The setting\*(Aqs 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"\&. +T} +.TE +.sp 1 +.SS "generic setting" +.PP +Generic Link Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -1318,12 +1426,9 @@ The setting\*(Aqs name, which uniquely identifies the setting within the connect T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&11.\ \&gsm setting +.SS "gsm setting" +.PP +GSM\-based Mobile Broadband Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -1349,6 +1454,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ apn @@ -1378,6 +1484,15 @@ T}:T{ When TRUE, only connections to the home network will be allowed\&. Connections to roaming networks will not be made\&. T} T{ +mtu +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. +T} +T{ name T}:T{ string @@ -1469,12 +1584,9 @@ The username used to authenticate with the network, if required\&. Many provide T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&12.\ \&infiniband setting +.SS "infiniband setting" +.PP +Infiniband Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -1550,12 +1662,9 @@ The IP\-over\-InfiniBand transport mode\&. Either "datagram" or "connected"\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&13.\ \&ipv4 setting +.SS "ipv4 setting" +.PP +IPv4 Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -1791,12 +1900,9 @@ Deprecated in favor of the \*(Aqroute\-data\*(Aq property, but this can be used T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&14.\ \&ipv6 setting +.SS "ipv6 setting" +.PP +IPv6 Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2042,12 +2148,9 @@ Configure the token for draft\-chown\-6man\-tokenised\-ipv6\-identifiers\-02 IPv T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&15.\ \&ip\-tunnel setting +.SS "ip\-tunnel setting" +.PP +IP Tunneling Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2193,12 +2296,9 @@ The TTL to assign to tunneled packets\&. 0 is a special value meaning that packe T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&16.\ \&macsec setting +.SS "macsec setting" +.PP +MACSec Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2304,12 +2404,9 @@ Specifies the validation mode for incoming frames\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&17.\ \&macvlan setting +.SS "macvlan setting" +.PP +MAC VLAN Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2375,12 +2472,9 @@ Whether the interface should be a MACVTAP\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&18.\ \&802\-11\-olpc\-mesh setting +.SS "802\-11\-olpc\-mesh setting" +.PP +OLPC Wireless Mesh Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2436,12 +2530,9 @@ SSID of the mesh network to join\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&19.\ \&ppp setting +.SS "ppp setting" +.PP +Point\-to\-Point Protocol Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2647,12 +2738,9 @@ If TRUE, 128\-bit MPPE (Microsoft Point\-to\-Point Encrpytion) will be required T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&20.\ \&pppoe setting +.SS "pppoe setting" +.PP +PPP\-over\-Ethernet Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2718,12 +2806,9 @@ Username used to authenticate with the PPPoE service\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&21.\ \&proxy setting +.SS "proxy setting" +.PP +WWW Proxy Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2789,12 +2874,9 @@ PAC URL for obtaining PAC file\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&22.\ \&serial setting +.SS "serial setting" +.PP +Serial Link Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2870,12 +2952,9 @@ Number of stop bits for communication on the serial port\&. Either 1 or 2\&. Th T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&23.\ \&team setting +.SS "team setting" +.PP +Teaming Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2921,12 +3000,9 @@ The setting\*(Aqs name, which uniquely identifies the setting within the connect T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&24.\ \&team\-port setting +.SS "team\-port setting" +.PP +Team Port Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2962,12 +3038,9 @@ The setting\*(Aqs name, which uniquely identifies the setting within the connect T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&25.\ \&tun setting +.SS "tun setting" +.PP +Tunnel Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -3053,12 +3126,47 @@ If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&26.\ \&vlan setting +.SS "user setting" +.PP +General User Profile Settings\&. +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l +l l l l. +T{ +data +T}:T{ +dict of string to string +T}:T{ +{} +T}:T{ +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\&. +T} +T{ +name +T}:T{ +string +T}:T{ +user +T}:T{ +The setting\*(Aqs 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"\&. +T} +.TE +.sp 1 +.SS "vlan setting" +.PP +VLAN Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -3144,12 +3252,9 @@ If given, specifies the parent interface name or parent connection UUID from whi T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&27.\ \&vpn setting +.SS "vpn setting" +.PP +VPN Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -3235,12 +3340,9 @@ If the VPN connection requires a user name for authentication, that name should T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&28.\ \&vxlan setting +.SS "vxlan setting" +.PP +VXLAN Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -3426,12 +3528,9 @@ Specifies the time\-to\-live value to use in outgoing packets\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&29.\ \&wimax setting +.SS "wimax setting" +.PP +WiMax Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -3477,12 +3576,9 @@ Network Service Provider (NSP) name of the WiMAX network this connection should T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&30.\ \&802\-3\-ethernet setting +.SS "802\-3\-ethernet setting" +.PP +Wired Ethernet Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -3658,12 +3754,9 @@ If specified, the password used with magic\-packet\-based Wake\-on\-LAN, represe T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&31.\ \&802\-11\-wireless setting +.SS "802\-11\-wireless setting" +.PP +Wi\-Fi Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -3869,12 +3962,9 @@ If non\-zero, directs the device to use the specified transmit power\&. Units ar T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&32.\ \&802\-11\-wireless\-security setting +.SS "802\-11\-wireless\-security setting" +.PP +Wi\-Fi Security Settings\&. .TS allbox tab(:); lB lB lB lB. |