diff options
Diffstat (limited to 'man/nm-settings.5')
| -rw-r--r-- | man/nm-settings.5 | 1631 |
1 files changed, 871 insertions, 760 deletions
diff --git a/man/nm-settings.5 b/man/nm-settings.5 index 6f6aaf8e..0a90098a 100644 --- a/man/nm-settings.5 +++ b/man/nm-settings.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> -.\" Date: 03 July 2014 +.\" Date: 19 December 2014 .\" Manual: Configuration -.\" Source: NetworkManager 0.9.10.0 +.\" Source: NetworkManager 1.0.0 .\" Language: English .\" -.TH "NM\-SETTINGS" "5" "" "NetworkManager 0\&.9\&.10\&.0" "Configuration" +.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.0\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -111,112 +111,121 @@ l l l l l l l l l l l l. T{ -name +altsubject\-matches T}:T{ -string +array of string T}:T{ -802\-1x +[] T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +List of strings to be matched against the altSubjectName of the certificate presented by the authentication server\&. If the list is empty, no verification of the server certificate\*(Aqs altSubjectName is performed\&. T} T{ -eap +anonymous\-identity T}:T{ -array of string +string T}:T{ \ \& T}:T{ -The allowed EAP method to be used when authenticating to the network with 802\&.1x\&. Valid methods are: \*(Aqleap\*(Aq, \*(Aqmd5\*(Aq, \*(Aqtls\*(Aq, \*(Aqpeap\*(Aq, \*(Aqttls\*(Aq, \*(Aqpwd\*(Aq, and \*(Aqfast\*(Aq\&. Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations\&. +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{ -identity +ca\-cert T}:T{ -string +byte array T}:T{ \ \& T}:T{ -Identity string for EAP authentication methods\&. Often the user\*(Aqs user or login name\&. +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{ -anonymous\-identity +ca\-path T}:T{ string T}:T{ \ \& 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\&. +UTF\-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca\-cert" property\&. T} T{ -pac\-file +client\-cert T}:T{ -string +byte array T}:T{ \ \& T}:T{ -UTF\-8 encoded file path containing PAC for EAP\-FAST\&. +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{ -ca\-cert +eap T}:T{ -byte array +array of string T}:T{ [] T}:T{ -Contains the CA certificate if used by the EAP method specified in the \*(Aqeap\*(Aq property\&. Certificate data is specified using a \*(Aqscheme\*(Aq; 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 \*(Aqfile://\*(Aq and ending with a terminating NULL 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\&. +The allowed EAP method to be used when authenticating to the network with 802\&.1x\&. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast"\&. Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations\&. T} T{ -ca\-path +identity T}:T{ string T}:T{ \ \& T}:T{ -UTF\-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the \*(Aqca\-cert\*(Aq property\&. +Identity string for EAP authentication methods\&. Often the user\*(Aqs user or login name\&. T} T{ -subject\-match +name +T}:T{ +string +T}:T{ +802\-1x +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{ +pac\-file T}:T{ string T}:T{ \ \& T}:T{ -Substring to be matched against the subject of the certificate presented by the authentication server\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. +UTF\-8 encoded file path containing PAC for EAP\-FAST\&. T} T{ -altsubject\-matches +password T}:T{ -array of string +string T}:T{ \ \& T}:T{ -List of strings to be matched against the altSubjectName of the certificate presented by the authentication server\&. If the list is empty, no verification of the server certificate\*(Aqs altSubjectName is performed\&. +UTF\-8 encoded password used for EAP authentication methods\&. If both the "password" property and the "password\-raw" property are specified, "password" is preferred\&. T} T{ -client\-cert +password\-flags T}:T{ -byte array +NMSettingSecretFlags (uint32) T}:T{ -[] +\ \& T}:T{ -Contains the client certificate if used by the EAP method specified in the \*(Aqeap\*(Aq property\&. Certificate data is specified using a \*(Aqscheme\*(Aq; 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 \*(Aqfile://\*(Aq and ending with a terminating NULL byte\&. +Flags indicating how to handle the "password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ -phase1\-peapver +password\-raw T}:T{ -string +byte array T}:T{ \ \& T}:T{ -Forces which PEAP version is used when PEAP is set as the EAP method in \*(Aqeap\*(Aq property\&. When unset, the version reported by the server will be used\&. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version\&. To do so, this property may be set to \*(Aq0\*(Aq or \*(Aq1\*(Aq to force that specific PEAP version\&. +Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF\-8 to be used\&. If both the "password" property and the "password\-raw" property are specified, "password" is preferred\&. T} T{ -phase1\-peaplabel +password\-raw\-flags T}:T{ -string +NMSettingSecretFlags (uint32) T}:T{ \ \& T}:T{ -Forces use of the new PEAP label during key derivation\&. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1\&. Set to \*(Aq1\*(Aq to force use of the new PEAP label\&. See the wpa_supplicant documentation for more details\&. +Flags indicating how to handle the "password\-raw" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ phase1\-fast\-provisioning @@ -225,178 +234,169 @@ string T}:T{ \ \& T}:T{ -Enables or disables in\-line provisioning of EAP\-FAST credentials when FAST is specified as the EAP method in the #NMSetting8021x:eap property\&. Allowed values are \*(Aq0\*(Aq (disabled), \*(Aq1\*(Aq (allow unauthenticated provisioning), \*(Aq2\*(Aq (allow authenticated provisioning), and \*(Aq3\*(Aq (allow both authenticated and unauthenticated provisioning)\&. See the wpa_supplicant documentation for more details\&. +Enables or disables in\-line provisioning of EAP\-FAST credentials when FAST is specified as the EAP method in the "eap" property\&. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning)\&. See the wpa_supplicant documentation for more details\&. T} T{ -phase2\-auth +phase1\-peaplabel T}:T{ string T}:T{ \ \& T}:T{ -Specifies the allowed \*(Aqphase 2\*(Aq inner non\-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the \*(Aqeap\*(Aq property\&. Recognized non\-EAP phase2 methods are \*(Aqpap\*(Aq, \*(Aqchap\*(Aq, \*(Aqmschap\*(Aq, \*(Aqmschapv2\*(Aq, \*(Aqgtc\*(Aq, \*(Aqotp\*(Aq, \*(Aqmd5\*(Aq, and \*(Aqtls\*(Aq\&. Each \*(Aqphase 2\*(Aq inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details\&. +Forces use of the new PEAP label during key derivation\&. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1\&. Set to "1" to force use of the new PEAP label\&. See the wpa_supplicant documentation for more details\&. T} T{ -phase2\-autheap +phase1\-peapver T}:T{ string T}:T{ \ \& T}:T{ -Specifies the allowed \*(Aqphase 2\*(Aq inner EAP\-based authentication methods when an EAP method that uses an inner TLS tunnel is specified in the \*(Aqeap\*(Aq property\&. Recognized EAP\-based \*(Aqphase 2\*(Aq methods are \*(Aqmd5\*(Aq, \*(Aqmschapv2\*(Aq, \*(Aqotp\*(Aq, \*(Aqgtc\*(Aq, and \*(Aqtls\*(Aq\&. Each \*(Aqphase 2\*(Aq inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details\&. +Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property\&. When unset, the version reported by the server will be used\&. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version\&. To do so, this property may be set to "0" or "1" to force that specific PEAP version\&. T} T{ -phase2\-ca\-cert +phase2\-altsubject\-matches T}:T{ -byte array +array of string T}:T{ [] T}:T{ -Contains the \*(Aqphase 2\*(Aq CA certificate if used by the EAP method specified in the \*(Aqphase2\-auth\*(Aq or \*(Aqphase2\-autheap\*(Aq properties\&. Certificate data is specified using a \*(Aqscheme\*(Aq; two are currentlysupported: 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 \*(Aqfile://\*(Aq and ending with a terminating NULL 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\&. +List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication\&. If the list is empty, no verification of the server certificate\*(Aqs altSubjectName is performed\&. T} T{ -phase2\-ca\-path +phase2\-auth T}:T{ string T}:T{ \ \& T}:T{ -UTF\-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the \*(Aqphase2\-ca\-cert\*(Aq property\&. +Specifies the allowed "phase 2" inner non\-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property\&. Recognized non\-EAP "phase 2" methods are "pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls"\&. Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details\&. T} T{ -phase2\-subject\-match +phase2\-autheap T}:T{ string T}:T{ \ \& T}:T{ -Substring to be matched against the subject of the certificate presented by the authentication server during the inner \*(Aqphase2\*(Aq authentication\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. +Specifies the allowed "phase 2" inner EAP\-based authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property\&. Recognized EAP\-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls"\&. Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details\&. T} T{ -phase2\-altsubject\-matches +phase2\-ca\-cert T}:T{ -array of string +byte array T}:T{ \ \& T}:T{ -List of strings to be matched against List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner \*(Aqphase 2\*(Aq authentication\&. If the list is empty, no verification of the server certificate\*(Aqs altSubjectName is performed\&. +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\-client\-cert +phase2\-ca\-path T}:T{ -byte array +string T}:T{ -[] +\ \& T}:T{ -Contains the \*(Aqphase 2\*(Aq client certificate if used by the EAP method specified in the \*(Aqphase2\-auth\*(Aq or \*(Aqphase2\-autheap\*(Aq properties\&. Certificate data is specified using a \*(Aqscheme\*(Aq; 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 \*(Aqfile://\*(Aq and ending with a terminating NULL byte\&. +UTF\-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2\-ca\-cert" property\&. T} T{ -password +phase2\-client\-cert T}:T{ -string +byte array T}:T{ \ \& T}:T{ -UTF\-8 encoded password used for EAP authentication methods\&. +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{ -password\-flags +phase2\-private\-key T}:T{ -uint32 +byte array T}:T{ -0 +\ \& T}:T{ -Flags indicating how to handle the 802\&.1x password\&. (see the section called \(lqSecret flag types:\(rq for flag values) +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\&. T} T{ -password\-raw +phase2\-private\-key\-password T}:T{ -byte array +string T}:T{ -[] +\ \& T}:T{ -Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF\-8 to be used\&. If both \*(Aqpassword\*(Aq and \*(Aqpassword\-raw\*(Aq are given, \*(Aqpassword\*(Aq is preferred\&. +The password used to decrypt the "phase 2" private key specified in the "phase2\-private\-key" property when the private key either uses the path scheme, or is a PKCS#12 format key\&. T} T{ -password\-raw\-flags +phase2\-private\-key\-password\-flags T}:T{ -uint32 +NMSettingSecretFlags (uint32) T}:T{ -0 +\ \& T}:T{ -Flags indicating how to handle the 802\&.1x password byte array\&. (see the section called \(lqSecret flag types:\(rq for flag values) +Flags indicating how to handle the "phase2\-private\-key\-password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ -private\-key +phase2\-subject\-match T}:T{ -byte array +string T}:T{ -[] +\ \& T}:T{ -Contains the private key when the \*(Aqeap\*(Aq property is set to \*(Aqtls\*(Aq\&. Key data is specified using a \*(Aqscheme\*(Aq; 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 \*(Aqfile://\*(Aq and ending with a terminating NULL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the \*(Aqprivate\-key\-password\*(Aq 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 \*(Aqfile://\*(Aq and and ending with a terminating NULL byte, and as with the blob scheme the \*(Aqprivate\-key\-password\*(Aq property must be set to the password used to decode the PKCS#12 private key and certificate\&. +Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. T} T{ -private\-key\-password +pin T}:T{ string T}:T{ \ \& T}:T{ -The password used to decrypt the private key specified in the \*(Aqprivate\-key\*(Aq property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key\&. +PIN used for EAP authentication methods\&. T} T{ -private\-key\-password\-flags +pin\-flags T}:T{ -uint32 +NMSettingSecretFlags (uint32) T}:T{ -0 +\ \& T}:T{ -Flags indicating how to handle the 802\&.1x private key password\&. (see the section called \(lqSecret flag types:\(rq for flag values) +Flags indicating how to handle the "pin" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ -phase2\-private\-key +private\-key T}:T{ byte array T}:T{ -[] +\ \& T}:T{ -Contains the \*(Aqphase 2\*(Aq inner private key when the \*(Aqphase2\-auth\*(Aq or \*(Aqphase2\-autheap\*(Aq property is set to \*(Aqtls\*(Aq\&. Key data is specified using a \*(Aqscheme\*(Aq; 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 \*(Aqfile://\*(Aq and ending with a terminating NULL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the \*(Aqphase2\-private\-key\-password\*(Aq 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 \*(Aqfile://\*(Aq and and ending with a terminating NULL byte, and as with the blob scheme the \*(Aqphase2\-private\-key\-password\*(Aq property must be set to the password used to decode the PKCS#12 private key and certificate\&. +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\&. T} T{ -phase2\-private\-key\-password +private\-key\-password T}:T{ string T}:T{ \ \& T}:T{ -The password used to decrypt the \*(Aqphase 2\*(Aq private key specified in the \*(Aqprivate\-key\*(Aq property when the phase2 private key either uses the path scheme, or if the phase2 private key is a PKCS#12 format key\&. +The password used to decrypt the private key specified in the "private\-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key\&. T} T{ -phase2\-private\-key\-password\-flags +private\-key\-password\-flags T}:T{ -uint32 +NMSettingSecretFlags (uint32) T}:T{ -0 +\ \& T}:T{ -Flags indicating how to handle the 802\&.1x phase2 private key password\&. (see the section called \(lqSecret flag types:\(rq for flag values) +Flags indicating how to handle the "private\-key\-password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ -pin +subject\-match T}:T{ string T}:T{ \ \& T}:T{ -PIN used for EAP authentication methods\&. -T} -T{ -pin\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating how to handle the 802\&.1x PIN\&. (see the section called \(lqSecret flag types:\(rq for flag values) +Substring to be matched against the subject of the certificate presented by the authentication server\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. T} T{ system\-ca\-certs @@ -405,7 +405,7 @@ boolean T}:T{ FALSE T}:T{ -When TRUE, overrides \*(Aqca\-path\*(Aq and \*(Aqphase2\-ca\-path\*(Aq properties using the system CA directory specified at configure time with the \-\-system\-ca\-path switch\&. The certificates in this directory are added to the verification chain in addition to any certificates specified by the \*(Aqca\-cert\*(Aq and \*(Aqphase2\-ca\-cert\*(Aq properties\&. +When TRUE, overrides the "ca\-path" and "phase2\-ca\-path" properties using the system CA directory specified at configure time with the \-\-system\-ca\-path switch\&. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca\-cert" and "phase2\-ca\-cert" properties\&. T} .TE .sp 1 @@ -437,22 +437,22 @@ l l l l l l l l l l l l. T{ -name +encapsulation T}:T{ string T}:T{ -adsl +\ \& T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +Encapsulation of ADSL connection\&. Can be "vcmux" or "llc"\&. T} T{ -username +name T}:T{ string T}:T{ -\ \& +adsl T}:T{ -Username used to authenticate with the pppoa service\&. +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{ password @@ -461,16 +461,16 @@ string T}:T{ \ \& T}:T{ -Password used to authenticate with the pppoa service\&. +Password used to authenticate with the ADSL service\&. T} T{ password\-flags T}:T{ -uint32 +NMSettingSecretFlags (uint32) T}:T{ -0 +\ \& T}:T{ -Flags indicating how to handle the ADSL password\&. (see the section called \(lqSecret flag types:\(rq for flag values) +Flags indicating how to handle the "password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ protocol @@ -479,34 +479,34 @@ string T}:T{ \ \& T}:T{ -ADSL connection protocol\&. +ADSL connection protocol\&. Can be "pppoa", "pppoe" or "ipoatm"\&. T} T{ -encapsulation +username T}:T{ string T}:T{ \ \& T}:T{ -Encapsulation of ADSL connection +Username used to authenticate with the ADSL service\&. T} T{ -vpi +vci T}:T{ uint32 T}:T{ 0 T}:T{ -VPI of ADSL connection +VCI of ADSL connection T} T{ -vci +vpi T}:T{ uint32 T}:T{ 0 T}:T{ -VCI of ADSL connection +VPI of ADSL connection T} .TE .sp 1 @@ -533,22 +533,22 @@ l l l l l l l l l l l l. T{ -name +bdaddr T}:T{ -string +byte array T}:T{ -bluetooth +\ \& T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +The Bluetooth address of the device\&. T} T{ -bdaddr +name T}:T{ -byte array +string T}:T{ -[] +bluetooth T}:T{ -The Bluetooth address of the device +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{ type @@ -557,7 +557,7 @@ string T}:T{ \ \& T}:T{ -Either \*(Aqdun\*(Aq for Dial\-Up Networking connections or \*(Aqpanu\*(Aq for Personal Area Networking connections\&. +Either "dun" for Dial\-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile\&. T} .TE .sp 1 @@ -584,31 +584,31 @@ l l l l l l l l l l l l. T{ -name +interface\-name T}:T{ string T}:T{ -bond +\ \& T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +Deprecated in favor of connection\&.interface\-name, but can be used for backward\-compatibility with older daemons, to set the bond\*(Aqs interface name\&. T} T{ -interface\-name +name T}:T{ string T}:T{ -\ \& +bond T}:T{ -The name of the virtual in\-kernel bonding network interface +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{ options T}:T{ -dict of (string::string) +dict of string to string T}:T{ \ \& T}:T{ -Dictionary of key/value pairs of bonding options\&. Both keys and values must be strings\&. Option names must contain only alphanumeric characters (ie, [a\-zA\-Z0\-9])\&. +Dictionary of key/value pairs of bonding options\&. Both keys and values must be strings\&. Option names must contain only alphanumeric characters (ie, [a\-zA\-Z0\-9])\&. T} .TE .sp 1 @@ -641,85 +641,85 @@ l l l l l l l l l l l l. T{ -name +ageing\-time T}:T{ -string +uint32 T}:T{ -bridge +300 T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +The Ethernet MAC address aging time, in seconds\&. T} T{ -interface\-name +forward\-delay T}:T{ -string +uint32 T}:T{ -\ \& +15 T}:T{ -The name of the virtual in\-kernel bridging network interface +The Spanning Tree Protocol (STP) forwarding delay, in seconds\&. T} T{ -mac\-address +hello\-time T}:T{ -byte array +uint32 T}:T{ -[] +2 T}:T{ -The MAC address of the bridge +The Spanning Tree Protocol (STP) hello time, in seconds\&. T} T{ -stp +interface\-name T}:T{ -boolean +string T}:T{ -TRUE +\ \& T}:T{ -Controls whether Spanning Tree Protocol (STP) is enabled for this bridge\&. +Deprecated in favor of connection\&.interface\-name, but can be used for backward\-compatibility with older daemons, to set the bridge\*(Aqs interface name\&. T} T{ -priority +mac\-address T}:T{ -uint32 +byte array T}:T{ -32768 +\ \& T}:T{ -Sets the Spanning Tree Protocol (STP) priority for this bridge\&. Lower values are \*(Aqbetter\*(Aq; the lowest priority bridge will be elected the root bridge\&. +If specified, the MAC address of bridge\&. When creating a new bridge, this MAC address will be set\&. When matching an existing (outside NetworkManager created) bridge, this MAC address must match\&. T} T{ -forward\-delay +max\-age T}:T{ uint32 T}:T{ -15 +20 T}:T{ -The Spanning Tree Protocol (STP) forwarding delay, in seconds\&. +The Spanning Tree Protocol (STP) maximum message age, in seconds\&. T} T{ -hello\-time +name T}:T{ -uint32 +string T}:T{ -2 +bridge T}:T{ -The Spanning Tree Protocol (STP) hello time, in seconds\&. +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{ -max\-age +priority T}:T{ uint32 T}:T{ -20 +32768 T}:T{ -The Spanning Tree Protocol (STP) maximum message age, in seconds\&. +Sets the Spanning Tree Protocol (STP) priority for this bridge\&. Lower values are "better"; the lowest priority bridge will be elected the root bridge\&. T} T{ -ageing\-time +stp T}:T{ -uint32 +boolean T}:T{ -300 +TRUE T}:T{ -The Ethernet MAC address aging time, in seconds\&. +Controls whether Spanning Tree Protocol (STP) is enabled for this bridge\&. T} .TE .sp 1 @@ -747,22 +747,22 @@ l l l l l l l l l l l l. T{ -name +hairpin\-mode T}:T{ -string +boolean T}:T{ -bridge\-port +FALSE T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +Enables or disabled "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on\&. T} T{ -priority +name T}:T{ -uint32 +string T}:T{ -32 +bridge\-port T}:T{ -The Spanning Tree Protocol (STP) priority of this bridge port +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{ path\-cost @@ -774,13 +774,13 @@ T}:T{ The Spanning Tree Protocol (STP) port cost for destinations via this port\&. T} T{ -hairpin\-mode +priority T}:T{ -boolean +uint32 T}:T{ -FALSE +32 T}:T{ -Enables or disabled \*(Aqhairpin mode\*(Aq for the port, which allows frames to be sent back out through the port the frame was received on\&. +The Spanning Tree Protocol (STP) priority of this bridge port\&. T} .TE .sp 1 @@ -815,7 +815,7 @@ string T}:T{ cdma T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +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{ number @@ -824,34 +824,34 @@ string T}:T{ \ \& T}:T{ -Number to dial when establishing a PPP data session with the CDMA\-based mobile broadband network\&. If not specified, the default number (#777) is used when required\&. +The number to dial to establish the connection to the CDMA\-based mobile broadband network, if any\&. If not specified, the default number (#777) is used when required\&. T} T{ -username +password T}:T{ string T}:T{ \ \& T}:T{ -Username used to authenticate with the network, if required\&. Note that many providers do not require a username or accept any username\&. +The password used to authenticate with the network, if required\&. Many providers do not require a password, or accept any password\&. But if a password is required, it is specified here\&. T} T{ -password +password\-flags T}:T{ -string +NMSettingSecretFlags (uint32) T}:T{ \ \& T}:T{ -Password used to authenticate with the network, if required\&. Note that many providers do not require a password or accept any password\&. +Flags indicating how to handle the "password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ -password\-flags +username T}:T{ -uint32 +string T}:T{ -0 +\ \& T}:T{ -Flags indicating how to handle the CDMA password\&. (see the section called \(lqSecret flag types:\(rq for flag values) +The username used to authenticate with the network, if required\&. Many providers do not require a username, or accept any username\&. But if a username is required, it is specified here\&. T} .TE .sp 1 @@ -887,78 +887,79 @@ 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{ -name +autoconnect T}:T{ -string +boolean T}:T{ -connection +TRUE T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +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{ -id +autoconnect\-priority T}:T{ -string +int32 T}:T{ -\ \& +0 T}:T{ -User\-readable connection identifier/name\&. Must be one or more characters and may change over the lifetime of the connection if the user decides to rename it\&. +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{ -uuid +gateway\-ping\-timeout T}:T{ -string +uint32 T}:T{ -\ \& +0 T}:T{ -Universally unique connection identifier\&. Must be in the format \*(Aq2815492f\-7e56\-435e\-b2e9\-246bd7cdc664\*(Aq (ie, contains only hexadecimal characters and \*(Aq\-\*(Aq)\&. The UUID 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 user changes the connection\*(Aqs \*(Aqid\*(Aq, but should be recreated when the Wi\-Fi SSID, mobile broadband network provider, or the connection type changes\&. +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{ -interface\-name +id T}:T{ string T}:T{ \ \& T}:T{ -Interface name 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 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\&. +A human readable unique identifier for the connection, like "Work Wi\-Fi" or "T\-Mobile 3G"\&. T} T{ -type +interface\-name 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, \*(Aq802\-3\-ethernet\*(Aq or \*(Aq802\-11\-wireless\*(Aq or \*(Aqbluetooth\*(Aq, etc), and for non\-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, \*(Aqvpn\*(Aq or \*(Aqbridge\*(Aq, etc)\&. +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{ -permissions +master T}:T{ -array of string +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 array\&. Each entry is of the form "[type]:[id]:[reserved]", for example: "user:dcbw:blah" At this time only the \*(Aquser\*(Aq [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 \*(Aq:\*(Aq character\&. Any [reserved] information (if present) must be ignored and is reserved for future use\&. All of [type], [id], and [reserved] must be valid UTF\-8\&. +Interface name of the master device or UUID of the master connection\&. T} T{ -autoconnect +name T}:T{ -boolean +string T}:T{ -TRUE +connection T}:T{ -If TRUE, NetworkManager will activate this connection when its network resources are available\&. If FALSE, the connection must be manually activated by the user or some other mechanism\&. +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{ -timestamp +permissions T}:T{ -uint64 +array of string T}:T{ -0 +[] T}:T{ -Timestamp (in seconds since the Unix Epoch) that the connection was last successfully 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)\&. +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 @@ -967,52 +968,61 @@ boolean T}:T{ FALSE T}:T{ -If TRUE, the connection is read\-only and cannot be changed by the user or any other mechanism\&. This is normally set for system connections whose plugin cannot yet write updated connections back out\&. +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{ -zone +secondaries T}:T{ -string +array of 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\&. +List of connection UUIDs that should be activated when the base connection itself is activated\&. Currently only VPN connections are supported\&. T} T{ -master +slave\-type T}:T{ string T}:T{ \ \& T}:T{ -Interface name of the master device or UUID of the master connection +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{ -slave\-type +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{ -Setting name describing the type of slave this connection is (ie, \*(Aqbond\*(Aq) or NULL if this connection is not a slave\&. +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{ -secondaries +uuid T}:T{ -array of string +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\&. +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{ -gateway\-ping\-timeout +zone T}:T{ -uint32 +string 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\&. +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\&. T} .TE .sp 1 @@ -1052,22 +1062,22 @@ l l l l l l l l l l l l. T{ -name +app\-fcoe\-flags T}:T{ -string +NMSettingDcbFlags (uint32) T}:T{ -dcb +\ \& T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +Specifies the NMSettingDcbFlags for the DCB FCoE application\&. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4)\&. T} T{ -app\-fcoe\-flags +app\-fcoe\-mode T}:T{ -uint32 +string T}:T{ -0 +"fabric" T}:T{ -Specifies the flags for the DCB FCoE application\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. (see the section called \(lqSecret flag types:\(rq for flag values) +The FCoE controller mode; either "fabric" (default) or "vn2vn"\&. T} T{ app\-fcoe\-priority @@ -1076,88 +1086,79 @@ int32 T}:T{ \-1 T}:T{ -The highest User Priority (0 \- 7) which FCoE frames should use, or \-1 for default priority\&. Only used when the \*(Aqapp\-fcoe\-flags\*(Aq property includes the \*(Aqenabled\*(Aq flag\&. -T} -T{ -app\-fcoe\-mode -T}:T{ -string -T}:T{ -"fabric" -T}:T{ -The FCoe controller mode; either \*(Aqfabric\*(Aq (default) or \*(Aqvn2vn\*(Aq\&. +The highest User Priority (0 \- 7) which FCoE frames should use, or \-1 for default priority\&. Only used when the "app\-fcoe\-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag\&. T} T{ -app\-iscsi\-flags +app\-fip\-flags T}:T{ -uint32 +NMSettingDcbFlags (uint32) T}:T{ -0 +\ \& T}:T{ -Specifies the flags for the DCB iSCSI application\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. (see the section called \(lqSecret flag types:\(rq for flag values) +Specifies the NMSettingDcbFlags for the DCB FIP application\&. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4)\&. T} T{ -app\-iscsi\-priority +app\-fip\-priority T}:T{ int32 T}:T{ \-1 T}:T{ -The highest User Priority (0 \- 7) which iSCSI frames should use, or \-1 for default priority\&. Only used when the \*(Aqapp\-iscsi\-flags\*(Aq property includes the \*(Aqenabled\*(Aq flag\&. +The highest User Priority (0 \- 7) which FIP frames should use, or \-1 for default priority\&. Only used when the "app\-fip\-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag\&. T} T{ -app\-fip\-flags +app\-iscsi\-flags T}:T{ -uint32 +NMSettingDcbFlags (uint32) T}:T{ -0 +\ \& T}:T{ -Specifies the flags for the DCB FIP application\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. (see the section called \(lqSecret flag types:\(rq for flag values) +Specifies the NMSettingDcbFlags for the DCB iSCSI application\&. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4)\&. T} T{ -app\-fip\-priority +app\-iscsi\-priority T}:T{ int32 T}:T{ \-1 T}:T{ -The highest User Priority (0 \- 7) which FIP frames should use, or \-1 for default priority\&. Only used when the \*(Aqapp\-fip\-flags\*(Aq property includes the \*(Aqenabled\*(Aq flag\&. +The highest User Priority (0 \- 7) which iSCSI frames should use, or \-1 for default priority\&. Only used when the "app\-iscsi\-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag\&. T} T{ -priority\-flow\-control\-flags +name T}:T{ -uint32 +string T}:T{ -0 +dcb T}:T{ -Specifies the flags for DCB Priority Flow Control\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. (see the section called \(lqSecret flag types:\(rq for flag values) +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{ -priority\-flow\-control +priority\-bandwidth T}:T{ array of uint32 T}:T{ \ \& T}:T{ -An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates whether or not the corresponding priority should transmit priority pause\&. Allowed values are 0 (do not transmit pause) and 1 (transmit pause)\&. +An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the percentage of bandwidth of the priority\*(Aqs assigned group that the priority may use\&. The sum of all percentages for priorities which belong to the same group must total 100 percent\&. T} T{ -priority\-group\-flags +priority\-flow\-control T}:T{ -uint32 +array of uint32 T}:T{ -0 +\ \& T}:T{ -Specifies the flags for DCB Priority Groups\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. (see the section called \(lqSecret flag types:\(rq for flag values) +An array of 8 boolean values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates whether or not the corresponding priority should transmit priority pause\&. T} T{ -priority\-group\-id +priority\-flow\-control\-flags T}:T{ -array of uint32 +NMSettingDcbFlags (uint32) T}:T{ \ \& T}:T{ -An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the Priority Group ID\&. Allowed Priority Group ID values are 0 \- 7 or 15 for the unrestricted group\&. +Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC)\&. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4)\&. T} T{ priority\-group\-bandwidth @@ -1169,13 +1170,22 @@ T}:T{ An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 \- 7) and the value indicates the percentage of link bandwidth allocated to that group\&. Allowed values are 0 \- 100, and the sum of all values must total 100 percent\&. T} T{ -priority\-bandwidth +priority\-group\-flags +T}:T{ +NMSettingDcbFlags (uint32) +T}:T{ +\ \& +T}:T{ +Specifies the NMSettingDcbFlags for DCB Priority Groups\&. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4)\&. +T} +T{ +priority\-group\-id T}:T{ array of uint32 T}:T{ \ \& T}:T{ -An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the percentage of bandwidth of the priority\*(Aqs assigned group that the priority may use\&. The sum of all percentages for priorities which belong to the same group must total 100 percent\&. +An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the Priority Group ID\&. Allowed Priority Group ID values are 0 \- 7 or 15 for the unrestricted group\&. T} T{ priority\-strict\-bandwidth @@ -1184,7 +1194,7 @@ array of uint32 T}:T{ \ \& T}:T{ -An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group\&. Allowed values are 0 (the priority may not utilize all bandwidth) or 1 (the priority may utilize all bandwidth)\&. +An array of 8 boolean values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group\&. T} T{ priority\-traffic\-class @@ -1202,7 +1212,38 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&10.\ \&gsm setting +.B Table\ \&10.\ \&generic 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. +T{ +name +T}:T{ +string +T}:T{ +generic +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 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&11.\ \&gsm setting .TS allbox tab(:); lB lB lB lB. @@ -1216,8 +1257,6 @@ 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 @@ -1229,76 +1268,67 @@ l l l l l l l l l l l l. T{ -name +apn T}:T{ string T}:T{ -gsm +\ \& T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM\-based network\&. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider\-specific walled\-garden, so it is important to use the correct APN for the user\*(Aqs mobile broadband plan\&. The APN may only be composed of the characters a\-z, 0\-9, \&., and \- per GSM 03\&.60 Section 14\&.9\&. T} T{ -number +home\-only T}:T{ -string +boolean T}:T{ -\ \& +FALSE T}:T{ -Number to dial when establishing a PPP data session with the GSM\-based mobile broadband network\&. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which allows NetworkManager to select the appropriate settings automatically\&. +When TRUE, only connections to the home network will be allowed\&. Connections to roaming networks will not be made\&. T} T{ -username +name T}:T{ string T}:T{ -\ \& +gsm T}:T{ -Username used to authenticate with the network, if required\&. Note that many providers do not require a username or accept any username\&. +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{ -password +network\-id T}:T{ string T}:T{ \ \& T}:T{ -Password used to authenticate with the network, if required\&. Note that many providers do not require a password or accept any password\&. +The Network ID (GSM LAI format, ie MCC\-MNC) to force specific network registration\&. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network\&. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible\&. T} T{ -password\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating how to handle the GSM password\&. (see the section called \(lqSecret flag types:\(rq for flag values) -T} -T{ -apn +number T}:T{ string T}:T{ \ \& T}:T{ -The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM\-based network\&. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider\-specific walled\-garden, so it is important to use the correct APN for the user\*(Aqs mobile broadband plan\&. The APN may only be composed of the characters a\-z, 0\-9, \&., and \- per GSM 03\&.60 Section 14\&.9\&. +Number to dial when establishing a PPP data session with the GSM\-based mobile broadband network\&. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which allows NetworkManager to select the appropriate settings automatically\&. T} T{ -network\-id +password T}:T{ string T}:T{ \ \& T}:T{ -The Network ID (GSM LAI format, ie MCC\-MNC) to force specific network registration\&. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network\&. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible\&. +The password used to authenticate with the network, if required\&. Many providers do not require a password, or accept any password\&. But if a password is required, it is specified here\&. T} T{ -network\-type +password\-flags T}:T{ -int32 +NMSettingSecretFlags (uint32) T}:T{ -\-1 +\ \& T}:T{ -Network preference to force the device to only use specific network technologies\&. The permitted values are: \-1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, 3: prefer 2G, 4: prefer 4G/LTE, 5: 4G/LTE only\&. Notes: This property is deprecated and NetworkManager from 0\&.9\&.10 onwards doesn\*(Aqt use this property when talking to ModemManager\&.Also, not all devices allow network preference control\&. +Flags indicating how to handle the "password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ pin @@ -1312,29 +1342,20 @@ T} T{ pin\-flags T}:T{ -uint32 -T}:T{ -0 +NMSettingSecretFlags (uint32) T}:T{ -Flags indicating how to handle the GSM SIM PIN\&. (see the section called \(lqSecret flag types:\(rq for flag values) -T} -T{ -allowed\-bands -T}:T{ -uint32 -T}:T{ -1 +\ \& T}:T{ -Bitfield of allowed frequency bands\&.Notes: This property is deprecated and NetworkManager from 0\&.9\&.10 onwards doesn\*(Aqt use this property when talking to ModemManager\&.Also, not all devices allow frequency band control\&. +Flags indicating how to handle the "pin" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ -home\-only +username T}:T{ -boolean +string T}:T{ -FALSE +\ \& T}:T{ -When TRUE, only connections to the home network will be allowed\&. Connections to roaming networks will not be made\&. +The username used to authenticate with the network, if required\&. Many providers do not require a username, or accept any username\&. But if a username is required, it is specified here\&. T} .TE .sp 1 @@ -1343,7 +1364,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&11.\ \&infiniband setting +.B Table\ \&12.\ \&infiniband setting .TS allbox tab(:); lB lB lB lB. @@ -1364,22 +1385,13 @@ l l l l l l l l l l l l. T{ -name -T}:T{ -string -T}:T{ -infiniband -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ mac\-address T}:T{ byte array T}:T{ -[] +\ \& T}:T{ -If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches\&. This property does not change the MAC address of the device (i\&.e\&. MAC spoofing)\&. +If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches\&. This property does not change the MAC address of the device (i\&.e\&. MAC spoofing)\&. T} T{ mtu @@ -1391,13 +1403,13 @@ T}:T{ If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. T} T{ -transport\-mode +name T}:T{ string T}:T{ -\ \& +infiniband T}:T{ -The IPoIB transport mode\&. Either \*(Aqdatagram\*(Aq or \*(Aqconnected\*(Aq\&. +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{ p\-key @@ -1406,7 +1418,7 @@ int32 T}:T{ \-1 T}:T{ -The InfiniBand P_Key\&. Either \-1 for the default, or a 16\-bit unsigned integer\&. +The InfiniBand P_Key to use for this device\&. A value of \-1 means to use the default P_Key (aka "the P_Key at index 0")\&. Otherwise it is a 16\-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key\&. T} T{ parent @@ -1415,7 +1427,16 @@ string T}:T{ \ \& T}:T{ -The interface name of the parent device, or NULL +The interface name of the parent device of this device\&. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac\-address"\&. +T} +T{ +transport\-mode +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The IP\-over\-InfiniBand transport mode\&. Either "datagram" or "connected"\&. T} .TE .sp 1 @@ -1424,7 +1445,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&12.\ \&ipv4 setting +.B Table\ \&13.\ \&ipv4 setting .TS allbox tab(:); lB lB lB lB. @@ -1451,78 +1472,81 @@ 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{ -name +address\-data T}:T{ -string +array of vardict T}:T{ -ipv4 +\ \& T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +Array of IPv4 addresses\&. Each address dictionary contains at least \*(Aqaddress\*(Aq and \*(Aqprefix\*(Aq entries, containing the IP address as a string, and the prefix length as a uint32\&. Additional attributes may also exist on some addresses\&. T} T{ -method +addresses T}:T{ -string +array of array of uint32 T}:T{ \ \& T}:T{ -IPv4 configuration method\&. If \*(Aqauto\*(Aq is specified then the appropriate automatic method (DHCP, PPP, etc) is used for the interface and most other properties can be left unset\&. If \*(Aqlink\-local\*(Aq is specified, then a link\-local address in the 169\&.254/16 range will be assigned to the interface\&. If \*(Aqmanual\*(Aq is specified, static IP addressing is used and at least one IP address must be given in the \*(Aqaddresses\*(Aq property\&. If \*(Aqshared\*(Aq is specified (indicating that this connection will provide network access to other computers) then the interface is assigned an address in the 10\&.42\&.x\&.1/24 range and a DHCP and forwarding DNS server are started, and the interface is NAT\-ed to the current default network connection\&. \*(Aqdisabled\*(Aq means IPv4 will not be used on this connection\&. This property must be set\&. +Deprecated in favor of the \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq properties, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq\&. Array of IPv4 address structures\&. Each IPv4 address structure is composed of 3 32\-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 \- 32), and last the IPv4 gateway (network byte order)\&. The gateway may be left as 0 if no gateway exists for that subnet\&. T} T{ -dns +dhcp\-client\-id T}:T{ -array of uint32 +string T}:T{ \ \& T}:T{ -List of DNS servers (network byte order)\&. For the \*(Aqauto\*(Aq method, these DNS servers are appended to those (if any) returned by automatic configuration\&. DNS servers cannot be used with the \*(Aqshared\*(Aq, \*(Aqlink\-local\*(Aq, or \*(Aqdisabled\*(Aq methods as there is no upstream network\&. In all other methods, these DNS servers are used as the only DNS servers for this connection\&. +A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options\&. T} T{ -dns\-search +dhcp\-hostname T}:T{ -array of string +string T}:T{ \ \& T}:T{ -List of DNS search domains\&. For the \*(Aqauto\*(Aq method, these search domains are appended to those returned by automatic configuration\&. Search domains cannot be used with the \*(Aqshared\*(Aq, \*(Aqlink\-local\*(Aq, or \*(Aqdisabled\*(Aq methods as there is no upstream network\&. In all other methods, these search domains are used as the only search domains for this connection\&. +If the "dhcp\-send\-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease\&. T} T{ -addresses +dhcp\-send\-hostname T}:T{ -array of array of uint32 +boolean T}:T{ -\ \& +TRUE T}:T{ -Array of IPv4 address structures\&. Each IPv4 address structure is composed of 3 32\-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 \- 32), and last the IPv4 gateway (network byte order)\&. The gateway may be left as 0 if no gateway exists for that subnet\&. For the \*(Aqauto\*(Aq method, given IP addresses are appended to those returned by automatic configuration\&. Addresses cannot be used with the \*(Aqshared\*(Aq, \*(Aqlink\-local\*(Aq, or \*(Aqdisabled\*(Aq methods as addressing is either automatic or disabled with these methods\&. +If TRUE, a hostname is sent to the DHCP server when acquiring a lease\&. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer\&. If the "dhcp\-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent\&. T} T{ -address\-labels +dns T}:T{ -array of string +array of uint32 T}:T{ -\ \& +[] T}:T{ -Internal use only +Array of IP addresses of DNS servers (as network\-byte\-order integers) T} T{ -routes +dns\-search T}:T{ -array of array of uint32 +array of string T}:T{ -\ \& +[] T}:T{ -Array of IPv4 route structures\&. Each IPv4 route structure is composed of 4 32\-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 \- 32), the third being the next\-hop (network byte order) if any, and the fourth being the route metric\&. For the \*(Aqauto\*(Aq method, given IP routes are appended to those returned by automatic configuration\&. Routes cannot be used with the \*(Aqshared\*(Aq, \*(Aqlink\-local\*(Aq, or \*(Aqdisabled\*(Aq, methods as there is no upstream network\&. +Array of DNS search domains\&. T} T{ -ignore\-auto\-routes +gateway T}:T{ -boolean +string T}:T{ -FALSE +\ \& T}:T{ -When the method is set to \*(Aqauto\*(Aq and this property to TRUE, automatically configured routes are ignored and only routes specified in the \*(Aqroutes\*(Aq property, if any, are used\&. +The gateway associated with this configuration\&. This is only meaningful if "addresses" is also set\&. T} T{ ignore\-auto\-dns @@ -1531,34 +1555,43 @@ boolean T}:T{ FALSE T}:T{ -When the method is set to \*(Aqauto\*(Aq and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the \*(Aqdns\*(Aq and \*(Aqdns\-search\*(Aq properties, if any, are used\&. +When "method" is set to "auto" and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the "dns" and "dns\-search" properties, if any, are used\&. T} T{ -dhcp\-client\-id +ignore\-auto\-routes T}:T{ -string +boolean T}:T{ -\ \& +FALSE T}:T{ -A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options\&. +When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used\&. T} T{ -dhcp\-send\-hostname +may\-fail T}:T{ boolean T}:T{ TRUE T}:T{ -If TRUE, a hostname is sent to the DHCP server when acquiring a lease\&. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer\&. If the \*(Aqdhcp\-hostname\*(Aq property is empty and this property is TRUE, the current persistent hostname of the computer is sent\&. +If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out\&. Note that at least one IP configuration must succeed or overall network configuration will still fail\&. For example, in IPv6\-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully\&. T} T{ -dhcp\-hostname +method T}:T{ string T}:T{ \ \& T}:T{ -If the \*(Aqdhcp\-send\-hostname\*(Aq property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease\&. +IP configuration method\&. NMSettingIP4Config and NMSettingIP6Config both support "auto", "manual", and "link\-local"\&. See the subclass\-specific documentation for other values\&. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration\&. The "ignore\-auto\-routes" and "ignore\-auto\-dns" properties modify this behavior\&. For methods that imply no upstream network, such as "shared" or "link\-local", these properties must be empty\&. +T} +T{ +name +T}:T{ +string +T}:T{ +ipv4 +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{ never\-default @@ -1567,16 +1600,34 @@ boolean T}:T{ FALSE T}:T{ -If TRUE, this connection will never be the default IPv4 connection, meaning it will never be assigned the default route by NetworkManager\&. +If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager\&. T} T{ -may\-fail +route\-data T}:T{ -boolean +array of vardict T}:T{ -TRUE +\ \& +T}:T{ +Array of IPv4 routes\&. Each route dictionary contains at least \*(Aqdest\*(Aq and \*(Aqprefix\*(Aq entries, containing the destination IP address as a string, and the prefix length as a uint32\&. Most routes will also have a \*(Aqgateway\*(Aq entry, containing the gateway IP address as a string\&. If the route has a \*(Aqmetric\*(Aq entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device)\&. Additional attributes may also exist on some routes\&. +T} +T{ +route\-metric +T}:T{ +int64 +T}:T{ +\-1 +T}:T{ +The default metric for routes that don\*(Aqt explicitly specify a metric\&. The default value \-1 means that the metric is choosen automatically based on the device type\&. The metric applies to dynamic routes, manual (static) routes that don\*(Aqt have an explicit metric setting, address prefix routes, and the default route\&. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default)\&. Hence, setting this property to zero effectively mean setting it to 1024\&. For IPv4, zero is a regular value for the metric\&. +T} +T{ +routes T}:T{ -If TRUE, allow overall network configuration to proceed even if IPv4 configuration times out\&. Note that at least one IP configuration must succeed or overall network configuration will still fail\&. For example, in IPv6\-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully\&. +array of array of uint32 +T}:T{ +\ \& +T}:T{ +Deprecated in favor of the \*(Aqroute\-data\*(Aq property, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqroute\-data\*(Aq\&. Array of IPv4 route structures\&. Each IPv4 route structure is composed of 4 32\-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 \- 32), the third being the next\-hop (network byte order) if any, and the fourth being the route metric\&. If the metric is 0, NM will choose an appropriate default metric for the device\&. (There is no way to explicitly specify an actual metric of 0 with this property\&.) T} .TE .sp 1 @@ -1585,7 +1636,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&13.\ \&ipv6 setting +.B Table\ \&14.\ \&ipv6 setting .TS allbox tab(:); lB lB lB lB. @@ -1610,24 +1661,29 @@ 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{ -name +address\-data T}:T{ -string +array of vardict T}:T{ -ipv6 +\ \& T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +Array of IPv6 addresses\&. Each address dictionary contains at least \*(Aqaddress\*(Aq and \*(Aqprefix\*(Aq entries, containing the IP address as a string, and the prefix length as a uint32\&. Additional attributes may also exist on some addresses\&. T} T{ -method +addresses T}:T{ -string +array of legacy IPv6 address struct (a(ayuay)) T}:T{ \ \& T}:T{ -IPv6 configuration method\&. If \*(Aqauto\*(Aq is specified then the appropriate automatic method (PPP, router advertisement, etc) is used for the device and most other properties can be left unset\&. To force the use of DHCP only, specify \*(Aqdhcp\*(Aq; this method is only valid for Ethernet\-based hardware\&. If \*(Aqlink\-local\*(Aq is specified, then an IPv6 link\-local address will be assigned to the interface\&. If \*(Aqmanual\*(Aq is specified, static IP addressing is used and at least one IP address must be given in the \*(Aqaddresses\*(Aq property\&. If \*(Aqignore\*(Aq is specified, IPv6 configuration is not done\&. This property must be set\&. Note: the \*(Aqshared\*(Aq method is not yet supported\&. +Deprecated in favor of the \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq properties, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq\&. Array of IPv6 address structures\&. Each IPv6 address structure is composed of an IPv6 address, a prefix length (1 \- 128), and an IPv6 gateway address\&. The gateway may be zeroed out if no gateway exists for that subnet\&. T} T{ dhcp\-hostname @@ -1636,43 +1692,52 @@ string T}:T{ \ \& T}:T{ -The specified name will be sent to the DHCP server when acquiring a lease\&. +If the "dhcp\-send\-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease\&. +T} +T{ +dhcp\-send\-hostname +T}:T{ +boolean +T}:T{ +TRUE +T}:T{ +If TRUE, a hostname is sent to the DHCP server when acquiring a lease\&. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer\&. If the "dhcp\-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent\&. T} T{ dns T}:T{ array of byte array T}:T{ -\ \& +[] T}:T{ -Array of DNS servers, where each member of the array is a byte array containing the IPv6 address of the DNS server (in network byte order)\&. For the \*(Aqauto\*(Aq method, these DNS servers are appended to those (if any) returned by automatic configuration\&. DNS servers cannot be used with the \*(Aqshared\*(Aq or \*(Aqlink\-local\*(Aq methods as there is no usptream network\&. In all other methods, these DNS servers are used as the only DNS servers for this connection\&. +Array of IP addresses of DNS servers (in network byte order) T} T{ dns\-search T}:T{ array of string T}:T{ -\ \& +[] T}:T{ -List of DNS search domains\&. For the \*(Aqauto\*(Aq method, these search domains are appended to those returned by automatic configuration\&. Search domains cannot be used with the \*(Aqshared\*(Aq or \*(Aqlink\-local\*(Aq methods as there is no upstream network\&. In all other methods, these search domains are used as the only search domains for this connection\&. +Array of DNS search domains\&. T} T{ -addresses +gateway T}:T{ -array of (byte array, uint32, byte array) +string T}:T{ \ \& T}:T{ -Array of IPv6 address structures\&. Each IPv6 address structure is composed of 3 members, the first being a byte array containing the IPv6 address (network byte order), the second a 32\-bit integer containing the IPv6 address prefix, and the third a byte array containing the IPv6 address (network byte order) of the gateway associated with this address, if any\&. If no gateway is given, the third element should be given as all zeros\&. For the \*(Aqauto\*(Aq method, given IP addresses are appended to those returned by automatic configuration\&. Addresses cannot be used with the \*(Aqshared\*(Aq or \*(Aqlink\-local\*(Aq methods as the interface is automatically assigned an address with these methods\&. +The gateway associated with this configuration\&. This is only meaningful if "addresses" is also set\&. T} T{ -routes +ignore\-auto\-dns T}:T{ -array of (byte array, uint32, byte array, uint32) +boolean T}:T{ -\ \& +FALSE T}:T{ -Array of IPv6 route structures\&. Each IPv6 route structure is composed of 4 members; the first being the destination IPv6 network or address (network byte order) as a byte array, the second the destination network or address IPv6 prefix, the third being the next\-hop IPv6 address (network byte order) if any, and the fourth being the route metric\&. For the \*(Aqauto\*(Aq method, given IP routes are appended to those returned by automatic configuration\&. Routes cannot be used with the \*(Aqshared\*(Aq or \*(Aqlink\-local\*(Aq methods because there is no upstream network\&. +When "method" is set to "auto" and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the "dns" and "dns\-search" properties, if any, are used\&. T} T{ ignore\-auto\-routes @@ -1681,16 +1746,43 @@ boolean T}:T{ FALSE T}:T{ -When the method is set to \*(Aqauto\*(Aq or \*(Aqdhcp\*(Aq and this property is set to TRUE, automatically configured routes are ignored and only routes specified in the \*(Aqroutes\*(Aq property, if any, are used\&. +When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used\&. T} T{ -ignore\-auto\-dns +ip6\-privacy +T}:T{ +NMSettingIP6ConfigPrivacy (int32) +T}:T{ +\ \& +T}:T{ +Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941\&. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI\-64\&. This enhances privacy, but could cause problems in some applications, on the other hand\&. The permitted values are: 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses)\&. +T} +T{ +may\-fail T}:T{ boolean T}:T{ -FALSE +TRUE +T}:T{ +If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out\&. Note that at least one IP configuration must succeed or overall network configuration will still fail\&. For example, in IPv6\-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully\&. +T} +T{ +method +T}:T{ +string +T}:T{ +\ \& +T}:T{ +IP configuration method\&. NMSettingIP4Config and NMSettingIP6Config both support "auto", "manual", and "link\-local"\&. See the subclass\-specific documentation for other values\&. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration\&. The "ignore\-auto\-routes" and "ignore\-auto\-dns" properties modify this behavior\&. For methods that imply no upstream network, such as "shared" or "link\-local", these properties must be empty\&. +T} +T{ +name +T}:T{ +string +T}:T{ +ipv6 T}:T{ -When the method is set to \*(Aqauto\*(Aq or \*(Aqdhcp\*(Aq and this property is set to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the \*(Aqdns\*(Aq and \*(Aqdns\-search\*(Aq properties, if any, are used\&. +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{ never\-default @@ -1699,25 +1791,34 @@ boolean T}:T{ FALSE T}:T{ -If TRUE, this connection will never be the default IPv6 connection, meaning it will never be assigned the default IPv6 route by NetworkManager\&. +If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager\&. T} T{ -may\-fail +route\-data T}:T{ -boolean +array of vardict T}:T{ -TRUE +\ \& T}:T{ -If TRUE, allow overall network configuration to proceed even if IPv6 configuration times out\&. Note that at least one IP configuration must succeed or overall network configuration will still fail\&. For example, in IPv4\-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv6 configuration fails but IPv4 configuration completes successfully\&. +Array of IPv6 routes\&. Each route dictionary contains at least \*(Aqdest\*(Aq and \*(Aqprefix\*(Aq entries, containing the destination IP address as a string, and the prefix length as a uint32\&. Most routes will also have a \*(Aqnext\-hop\*(Aq entry, containing the next hop IP address as a string\&. If the route has a \*(Aqmetric\*(Aq entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device)\&. Additional attributes may also exist on some routes\&. T} T{ -ip6\-privacy +route\-metric T}:T{ -int32 +int64 T}:T{ \-1 T}:T{ -Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941\&. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI\-64\&. This enhances privacy, but could cause problems in some applications, on the other hand\&. The permitted values are: 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses)\&. +The default metric for routes that don\*(Aqt explicitly specify a metric\&. The default value \-1 means that the metric is choosen automatically based on the device type\&. The metric applies to dynamic routes, manual (static) routes that don\*(Aqt have an explicit metric setting, address prefix routes, and the default route\&. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default)\&. Hence, setting this property to zero effectively mean setting it to 1024\&. For IPv4, zero is a regular value for the metric\&. +T} +T{ +routes +T}:T{ +array of legacy IPv6 route struct (a(ayuayu)) +T}:T{ +\ \& +T}:T{ +Deprecated in favor of the \*(Aqroute\-data\*(Aq property, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqroute\-data\*(Aq\&. Array of IPv6 route structures\&. Each IPv6 route structure is composed of an IPv6 address, a prefix length (1 \- 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric\&. If the metric is 0, NM will choose an appropriate default metric for the device\&. T} .TE .sp 1 @@ -1726,7 +1827,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&14.\ \&802-11-olpc-mesh setting +.B Table\ \&15.\ \&802-11-olpc-mesh setting .TS allbox tab(:); lB lB lB lB. @@ -1745,40 +1846,40 @@ l l l l l l l l l l l l. T{ -name +channel T}:T{ -string +uint32 T}:T{ -802\-11\-olpc\-mesh +0 T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +Channel on which the mesh network to join is located\&. T} T{ -ssid +dhcp\-anycast\-address T}:T{ byte array T}:T{ -[] +\ \& T}:T{ -SSID of the mesh network to join\&. +Anycast DHCP MAC address used when requesting an IP address via DHCP\&. The specific anycast address used determines which DHCP server class answers the request\&. T} T{ -channel +name T}:T{ -uint32 +string T}:T{ -0 +802\-11\-olpc\-mesh T}:T{ -Channel on which the mesh network to join is located\&. +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{ -dhcp\-anycast\-address +ssid T}:T{ byte array T}:T{ -[] +\ \& T}:T{ -Anycast DHCP MAC address used when requesting an IP address via DHCP\&. The specific anycast address used determines which DHCP server class answers the the request\&. +SSID of the mesh network to join\&. T} .TE .sp 1 @@ -1787,7 +1888,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&15.\ \&ppp setting +.B Table\ \&16.\ \&ppp setting .TS allbox tab(:); lB lB lB lB. @@ -1821,175 +1922,175 @@ l l l l l l l l l l l l. T{ -name +baud T}:T{ -string +uint32 T}:T{ -ppp +0 T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +If non\-zero, instruct pppd to set the serial port to the specified baudrate\&. This value should normally be left as 0 to automatically choose the speed\&. T} T{ -noauth +crtscts T}:T{ boolean T}:T{ -TRUE +FALSE T}:T{ -If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client\&. If FALSE, require authentication from the remote side\&. In almost all cases, this should be TRUE\&. +If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals\&. This value should normally be set to FALSE\&. T} T{ -refuse\-eap +lcp\-echo\-failure T}:T{ -boolean +uint32 T}:T{ -FALSE +0 T}:T{ -If TRUE, the EAP authentication method will not be used\&. +If non\-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo\-requests go unanswered by the peer\&. The "lcp\-echo\-interval" property must also be set to a non\-zero value if this property is used\&. T} T{ -refuse\-pap +lcp\-echo\-interval T}:T{ -boolean +uint32 T}:T{ -FALSE +0 T}:T{ -If TRUE, the PAP authentication method will not be used\&. +If non\-zero, instruct pppd to send an LCP echo\-request frame to the peer every n seconds (where n is the specified value)\&. Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this\&. T} T{ -refuse\-chap +mppe\-stateful T}:T{ boolean T}:T{ FALSE T}:T{ -If TRUE, the CHAP authentication method will not be used\&. +If TRUE, stateful MPPE is used\&. See pppd documentation for more information on stateful MPPE\&. T} T{ -refuse\-mschap +mru T}:T{ -boolean +uint32 T}:T{ -FALSE +0 T}:T{ -If TRUE, the MSCHAP authentication method will not be used\&. +If non\-zero, instruct pppd to request that the peer send packets no larger than the specified size\&. If non\-zero, the MRU should be between 128 and 16384\&. T} T{ -refuse\-mschapv2 +mtu T}:T{ -boolean +uint32 T}:T{ -FALSE +0 T}:T{ -If TRUE, the MSCHAPv2 authentication method will not be used\&. +If non\-zero, instruct pppd to send packets no larger than the specified size\&. T} T{ -nobsdcomp +name T}:T{ -boolean +string T}:T{ -FALSE +ppp T}:T{ -If TRUE, BSD compression will not be requested\&. +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{ -nodeflate +no\-vj\-comp T}:T{ boolean T}:T{ FALSE T}:T{ -If TRUE, \*(Aqdeflate\*(Aq compression will not be requested\&. +If TRUE, Van Jacobsen TCP header compression will not be requested\&. T} T{ -no\-vj\-comp +noauth T}:T{ boolean T}:T{ -FALSE +TRUE T}:T{ -If TRUE, Van Jacobsen TCP header compression will not be requested\&. +If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client\&. If FALSE, require authentication from the remote side\&. In almost all cases, this should be TRUE\&. T} T{ -require\-mppe +nobsdcomp T}:T{ boolean T}:T{ FALSE T}:T{ -If TRUE, MPPE (Microsoft Point\-to\-Point Encrpytion) will be required for the PPP session\&. If either 64\-bit or 128\-bit MPPE is not available the session will fail\&. Note that MPPE is not used on mobile broadband connections\&. +If TRUE, BSD compression will not be requested\&. T} T{ -require\-mppe\-128 +nodeflate T}:T{ boolean T}:T{ FALSE T}:T{ -If TRUE, 128\-bit MPPE (Microsoft Point\-to\-Point Encrpytion) will be required for the PPP session, and the \*(Aqrequire\-mppe\*(Aq property must also be set to TRUE\&. If 128\-bit MPPE is not available the session will fail\&. +If TRUE, "deflate" compression will not be requested\&. T} T{ -mppe\-stateful +refuse\-chap T}:T{ boolean T}:T{ FALSE T}:T{ -If TRUE, stateful MPPE is used\&. See pppd documentation for more information on stateful MPPE\&. +If TRUE, the CHAP authentication method will not be used\&. T} T{ -crtscts +refuse\-eap T}:T{ boolean T}:T{ FALSE T}:T{ -If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals\&. This value should normally be set to FALSE\&. +If TRUE, the EAP authentication method will not be used\&. T} T{ -baud +refuse\-mschap T}:T{ -uint32 +boolean T}:T{ -0 +FALSE T}:T{ -If non\-zero, instruct pppd to set the serial port to the specified baudrate\&. This value should normally be left as 0 to automatically choose the speed\&. +If TRUE, the MSCHAP authentication method will not be used\&. T} T{ -mru +refuse\-mschapv2 T}:T{ -uint32 +boolean T}:T{ -0 +FALSE T}:T{ -If non\-zero, instruct pppd to request that the peer send packets no larger than the specified size\&. If non\-zero, the MRU should be between 128 and 16384\&. +If TRUE, the MSCHAPv2 authentication method will not be used\&. T} T{ -mtu +refuse\-pap T}:T{ -uint32 +boolean T}:T{ -0 +FALSE T}:T{ -If non\-zero, instruct pppd to send packets no larger than the specified size\&. +If TRUE, the PAP authentication method will not be used\&. T} T{ -lcp\-echo\-failure +require\-mppe T}:T{ -uint32 +boolean T}:T{ -0 +FALSE T}:T{ -If non\-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo\-requests go unanswered by the peer\&. The \*(Aqlcp\-echo\-interval\*(Aq property must also be set to a non\-zero value if this property is used\&. +If TRUE, MPPE (Microsoft Point\-to\-Point Encrpytion) will be required for the PPP session\&. If either 64\-bit or 128\-bit MPPE is not available the session will fail\&. Note that MPPE is not used on mobile broadband connections\&. T} T{ -lcp\-echo\-interval +require\-mppe\-128 T}:T{ -uint32 +boolean T}:T{ -0 +FALSE T}:T{ -If non\-zero, instruct pppd to send an LCP echo\-request frame to the peer every n seconds (where n is the specified value)\&. Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this\&. +If TRUE, 128\-bit MPPE (Microsoft Point\-to\-Point Encrpytion) will be required for the PPP session, and the "require\-mppe" property must also be set to TRUE\&. If 128\-bit MPPE is not available the session will fail\&. T} .TE .sp 1 @@ -1998,7 +2099,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&16.\ \&pppoe setting +.B Table\ \&17.\ \&pppoe setting .TS allbox tab(:); lB lB lB lB. @@ -2024,43 +2125,43 @@ string T}:T{ pppoe T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +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{ -service +password T}:T{ string T}:T{ \ \& T}:T{ -If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service\&. For most providers, this should be left blank\&. It is only required if there are multiple access concentrators or a specific service is known to be required\&. +Password used to authenticate with the PPPoE service\&. T} T{ -username +password\-flags T}:T{ -string +NMSettingSecretFlags (uint32) T}:T{ \ \& T}:T{ -Username used to authenticate with the PPPoE service\&. +Flags indicating how to handle the "password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ -password +service T}:T{ string T}:T{ \ \& T}:T{ -Password used to authenticate with the PPPoE service\&. +If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service\&. For most providers, this should be left blank\&. It is only required if there are multiple access concentrators or a specific service is known to be required\&. T} T{ -password\-flags +username T}:T{ -uint32 +string T}:T{ -0 +\ \& T}:T{ -Flags indicating how to handle the PPPoE password\&. (see the section called \(lqSecret flag types:\(rq for flag values) +Username used to authenticate with the PPPoE service\&. T} .TE .sp 1 @@ -2069,7 +2170,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&17.\ \&serial setting +.B Table\ \&18.\ \&serial setting .TS allbox tab(:); lB lB lB lB. @@ -2090,15 +2191,6 @@ l l l l l l l l l l l l. T{ -name -T}:T{ -string -T}:T{ -serial -T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. -T} -T{ baud T}:T{ uint32 @@ -2114,25 +2206,25 @@ uint32 T}:T{ 8 T}:T{ -Byte\-width of the serial communication\&. The 8 in \*(Aq8n1\*(Aq for example\&. +Byte\-width of the serial communication\&. The 8 in "8n1" for example\&. T} T{ -parity +name T}:T{ -gchar +string T}:T{ -110 +serial T}:T{ -Parity setting of the serial port\&. Either \*(AqE\*(Aq for even parity, \*(Aqo\*(Aq for odd parity, or \*(Aqn\*(Aq for no parity\&. +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{ -stopbits +parity T}:T{ -uint32 +byte T}:T{ -1 +\ \& T}:T{ -Number of stop bits for communication on the serial port\&. Either 1 or 2\&. The 1 in \*(Aq8n1\*(Aq for example\&. +The connection parity: 69 (ASCII \*(AqE\*(Aq) for even parity, 111 (ASCII \*(Aqo\*(Aq) for odd, 110 (ASCII \*(Aqn\*(Aq) for none\&. T} T{ send\-delay @@ -2143,6 +2235,15 @@ T}:T{ T}:T{ Time to delay between each byte sent to the modem, in microseconds\&. T} +T{ +stopbits +T}:T{ +uint32 +T}:T{ +1 +T}:T{ +Number of stop bits for communication on the serial port\&. Either 1 or 2\&. The 1 in "8n1" for example\&. +T} .TE .sp 1 .sp @@ -2150,7 +2251,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&18.\ \&team setting +.B Table\ \&19.\ \&team setting .TS allbox tab(:); lB lB lB lB. @@ -2168,13 +2269,13 @@ l l l l l l l l l l l l. T{ -name +config T}:T{ string T}:T{ -team +\ \& T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +The JSON configuration for the team network interface\&. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd\&. If not specified, the default configuration is used\&. See man teamd\&.conf for the format details\&. T} T{ interface\-name @@ -2183,16 +2284,16 @@ string T}:T{ \ \& T}:T{ -The name of the virtual in\-kernel team network interface +Deprecated in favor of connection\&.interface\-name, but can be used for backward\-compatibility with older daemons, to set the team\*(Aqs interface name\&. T} T{ -config +name T}:T{ string T}:T{ -\ \& +team T}:T{ -JSON configuration for the team network interface\&. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd\&. If not specified, the default configuration is used\&. See man teamd\&.conf for the format details\&. +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 @@ -2201,7 +2302,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&19.\ \&team-port setting +.B Table\ \&20.\ \&team-port setting .TS allbox tab(:); lB lB lB lB. @@ -2218,22 +2319,22 @@ T} l l l l l l l l. T{ -name +config T}:T{ string T}:T{ -team\-port +\ \& T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +The JSON configuration for the team port\&. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd\&. If not specified, the default configuration is used\&. See man teamd\&.conf for the format details\&. T} T{ -config +name T}:T{ string T}:T{ -\ \& +team\-port T}:T{ -JSON configuration for the team port\&. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd\&. If not specified, the dafault configuration is used\&. See man teamd\&.conf for the format details\&. +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 @@ -2242,7 +2343,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&20.\ \&vlan setting +.B Table\ \&21.\ \&vlan setting .TS allbox tab(:); lB lB lB lB. @@ -2264,67 +2365,67 @@ l l l l l l l l l l l l. T{ -name +egress\-priority\-map T}:T{ -string +array of string T}:T{ -vlan +[] T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +For outgoing packets, a list of mappings from Linux SKB priorities to 802\&.1p priorities\&. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3"\&. T} T{ -interface\-name +flags T}:T{ -string +NMVlanFlags (uint32) T}:T{ \ \& T}:T{ -If given, specifies the kernel name of the VLAN interface\&. If not given, a default name will be constructed from the interface described by the parent interface and the \*(Aqid\*(Aq property, ex \*(Aqeth2\&.1\*(Aq\&. The parent interface may be given by the \*(Aqparent\*(Aq property or by the \*(Aqmac\-address\*(Aq property of a \*(Aqwired\*(Aq setting\&. +One or more flags which control the behavior and features of the VLAN interface\&. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device\*(Aqs operating state)\&. T} T{ -parent +id T}:T{ -string +uint32 T}:T{ -\ \& +0 T}:T{ -If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created\&. If this property is not specified, the connection must contain a \*(Aqwired\*(Aq setting with a \*(Aqmac\-address\*(Aq property\&. +The VLAN identifier that the interface created by this connection should be assigned\&. T} T{ -id +ingress\-priority\-map T}:T{ -uint32 +array of string T}:T{ -0 +[] T}:T{ -The VLAN indentifier the interface created by this connection should be assigned\&. +For incoming packets, a list of mappings from 802\&.1p priorities to Linux SKB priorities\&. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3"\&. T} T{ -flags +interface\-name T}:T{ -uint32 +string T}:T{ -0 +\ \& T}:T{ -One or more flags which control the behavior and features of the VLAN interface\&. Flags include reordering of output packet headers (0x01), use of the GVRP protocol (0x02), and loose binding of the interface to its master device\*(Aqs operating state (0x04)\&. +Deprecated in favor of connection\&.interface\-name, but can be used for backward\-compatibility with older daemons, to set the vlan\*(Aqs interface name\&. T} T{ -ingress\-priority\-map +name T}:T{ -array of string +string T}:T{ -\ \& +vlan T}:T{ -For incoming packets, a list of mappings from 802\&.1p priorities to Linux SKB priorities\&. The mapping is given in the format \*(Aqfrom:to\*(Aq where both \*(Aqfrom\*(Aq and \*(Aqto\*(Aq are unsigned integers, ie \*(Aq7:3\*(Aq\&. +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{ -egress\-priority\-map +parent T}:T{ -array of string +string T}:T{ \ \& T}:T{ -For outgoing packets, a list of mappings from Linux SKB priorities to 802\&.1p priorities\&. The mapping is given in the format \*(Aqfrom:to\*(Aq where both \*(Aqfrom\*(Aq and \*(Aqto\*(Aq are unsigned integers, ie \*(Aq7:3\*(Aq\&. +If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created\&. If this property is not specified, the connection must contain an "802\-3\-ethernet" setting with a "mac\-address" property\&. T} .TE .sp 1 @@ -2333,7 +2434,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&21.\ \&vpn setting +.B Table\ \&22.\ \&vpn setting .TS allbox tab(:); lB lB lB lB. @@ -2351,51 +2452,61 @@ 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{ +data +T}:T{ +dict of string to string +T}:T{ +\ \& +T}:T{ +Dictionary of key/value pairs of VPN plugin specific data\&. Both keys and values must be strings\&. +T} +T{ name T}:T{ string T}:T{ vpn T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +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{ -service\-type +persistent T}:T{ -string +boolean T}:T{ -\ \& +FALSE T}:T{ -D\-Bus service name of the VPN plugin that this setting uses to connect to its network\&. i\&.e\&. org\&.freedesktop\&.NetworkManager\&.vpnc for the vpnc plugin\&. +If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected\&. T} T{ -user\-name +secrets T}:T{ -string +dict of string to string T}:T{ \ \& T}:T{ -If the VPN connection requires a user name for authentication, that name should be provided here\&. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty\&. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection\&. +Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys\&. Both keys and values must be strings\&. T} T{ -data +service\-type T}:T{ -dict of (string::string) +string T}:T{ \ \& T}:T{ -Dictionary of key/value pairs of VPN plugin specific data\&. Both keys and values must be strings\&. +D\-Bus service name of the VPN plugin that this setting uses to connect to its network\&. i\&.e\&. org\&.freedesktop\&.NetworkManager\&.vpnc for the vpnc plugin\&. T} T{ -secrets +user\-name T}:T{ -dict of (string::string) +string T}:T{ \ \& T}:T{ -Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys\&. Both keys and values must be strings\&. +If the VPN connection requires a user name for authentication, that name should be provided here\&. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty\&. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection\&. T} .TE .sp 1 @@ -2404,7 +2515,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&22.\ \&wimax setting +.B Table\ \&23.\ \&wimax setting .TS allbox tab(:); lB lB lB lB. @@ -2422,13 +2533,22 @@ l l l l l l l l l l l l. T{ +mac\-address +T}:T{ +byte array +T}:T{ +\ \& +T}:T{ +If specified, this connection will only apply to the WiMAX device whose MAC address matches\&. This property does not change the MAC address of the device (known as MAC spoofing)\&. +T} +T{ name T}:T{ string T}:T{ wimax T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +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{ network\-name @@ -2439,15 +2559,6 @@ T}:T{ T}:T{ Network Service Provider (NSP) name of the WiMAX network this connection should use\&. T} -T{ -mac\-address -T}:T{ -byte array -T}:T{ -[] -T}:T{ -If specified, this connection will only apply to the WiMAX device whose MAC address matches\&. This property does not change the MAC address of the device (known as MAC spoofing)\&. -T} .TE .sp 1 .sp @@ -2455,7 +2566,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&23.\ \&802-3-ethernet setting +.B Table\ \&24.\ \&802-3-ethernet setting .TS allbox tab(:); lB lB lB lB. @@ -2482,31 +2593,22 @@ l l l l l l l l l l l l. T{ -name +auto\-negotiate T}:T{ -string +boolean T}:T{ -802\-3\-ethernet +TRUE T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +If TRUE, allow auto\-negotiation of port speed and duplex mode\&. If FALSE, do not allow auto\-negotiation, in which case the "speed" and "duplex" properties should be set\&. T} T{ -port +cloned\-mac\-address T}:T{ -string +byte array T}:T{ \ \& T}:T{ -Specific port type to use if multiple the device supports multiple attachment methods\&. One of \*(Aqtp\*(Aq (Twisted Pair), \*(Aqaui\*(Aq (Attachment Unit Interface), \*(Aqbnc\*(Aq (Thin Ethernet) or \*(Aqmii\*(Aq (Media Independent Interface\&. If the device supports only one port type, this setting is ignored\&. -T} -T{ -speed -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, request that the device use only the specified speed\&. In Mbit/s, ie 100 == 100Mbit/s\&. +If specified, request that the device use this MAC address instead of its permanent MAC address\&. This is known as MAC cloning or spoofing\&. T} T{ duplex @@ -2515,41 +2617,23 @@ string T}:T{ \ \& T}:T{ -If specified, request that the device only use the specified duplex mode\&. Either \*(Aqhalf\*(Aq or \*(Aqfull\*(Aq\&. -T} -T{ -auto\-negotiate -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -If TRUE, allow auto\-negotiation of port speed and duplex mode\&. If FALSE, do not allow auto\-negotiation,in which case the \*(Aqspeed\*(Aq and \*(Aqduplex\*(Aq properties should be set\&. +If specified, request that the device only use the specified duplex mode\&. Either "half" or "full"\&. T} T{ mac\-address T}:T{ byte array T}:T{ -[] -T}:T{ -If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches\&. This property does not change the MAC address of the device (i\&.e\&. MAC spoofing)\&. -T} -T{ -cloned\-mac\-address -T}:T{ -byte array -T}:T{ -[] +\ \& T}:T{ -If specified, request that the device use this MAC address instead of its permanent MAC address\&. This is known as MAC cloning or spoofing\&. +If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches\&. This property does not change the MAC address of the device (i\&.e\&. MAC spoofing)\&. T} T{ mac\-address\-blacklist T}:T{ array of string T}:T{ -\ \& +[] T}:T{ If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list\&. Each MAC address is in the standard hex\-digits\-and\-colons notation (00:11:22:33:44:55)\&. T} @@ -2563,13 +2647,22 @@ T}:T{ If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. T} T{ -s390\-subchannels +name T}:T{ -array of string +string +T}:T{ +802\-3\-ethernet +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{ +port +T}:T{ +string T}:T{ \ \& T}:T{ -Identifies specific subchannels that this network device uses for communcation with z/VM or s390 host\&. Like the \*(Aqmac\-address\*(Aq property for non\-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels\&. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (\&.) character\&. +Specific port type to use if multiple the device supports multiple attachment methods\&. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface\&. If the device supports only one port type, this setting is ignored\&. T} T{ s390\-nettype @@ -2578,16 +2671,34 @@ string T}:T{ \ \& T}:T{ -s390 network device type; one of \*(Aqqeth\*(Aq, \*(Aqlcs\*(Aq, or \*(Aqctc\*(Aq, representing the different types of virtual network devices available on s390 systems\&. +s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems\&. T} T{ s390\-options T}:T{ -dict of (string::string) +dict of string to string T}:T{ \ \& T}:T{ -Dictionary of key/value pairs of s390\-specific device options\&. Both keys and values must be strings\&. Allowed keys include \*(Aqportno\*(Aq, \*(Aqlayer2\*(Aq, \*(Aqportname\*(Aq, \*(Aqprotocol\*(Aq, among others\&. +Dictionary of key/value pairs of s390\-specific device options\&. Both keys and values must be strings\&. Allowed keys include "portno", "layer2", "portname", "protocol", among others\&. Key names must contain only alphanumeric characters (ie, [a\-zA\-Z0\-9])\&. +T} +T{ +s390\-subchannels +T}:T{ +array of string +T}:T{ +[] +T}:T{ +Identifies specific subchannels that this network device uses for communication with z/VM or s390 host\&. Like the "mac\-address" property for non\-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels\&. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (\&.) character\&. +T} +T{ +speed +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +If non\-zero, request that the device use only the specified speed\&. In Mbit/s, ie 100 == 100Mbit/s\&. T} .TE .sp 1 @@ -2596,7 +2707,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&24.\ \&802-11-wireless setting +.B Table\ \&25.\ \&802-11-wireless setting .TS allbox tab(:); lB lB lB lB. @@ -2626,139 +2737,139 @@ l l l l l l l l l l l l. T{ -name +band T}:T{ string T}:T{ -802\-11\-wireless +\ \& T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +802\&.11 frequency band of the network\&. One of "a" for 5GHz 802\&.11a or "bg" for 2\&.4GHz 802\&.11\&. This will lock associations to the Wi\-Fi network to the specific band, i\&.e\&. if "a" is specified, the device will not associate with the same network in the 2\&.4GHz band even if the network\*(Aqs settings are compatible\&. This setting depends on specific driver capability and may not work with all drivers\&. T} T{ -ssid +bssid T}:T{ byte array T}:T{ -[] +\ \& T}:T{ -SSID of the Wi\-Fi network\&. Must be specified\&. +If specified, directs the device to only associate with the given access point\&. This capability is highly driver dependent and not supported by all devices\&. Note: this property does not control the BSSID used when creating an Ad\-Hoc network and is unlikely to in the future\&. T} T{ -mode +channel T}:T{ -string +uint32 T}:T{ -\ \& +0 T}:T{ -Wi\-Fi network mode; one of \*(Aqinfrastructure\*(Aq, \*(Aqadhoc\*(Aq or \*(Aqap\*(Aq\&. If blank, infrastructure is assumed\&. +Wireless channel to use for the Wi\-Fi connection\&. The device will only join (or create for Ad\-Hoc networks) a Wi\-Fi network on the specified channel\&. Because channel numbers overlap between bands, this property also requires the "band" property to be set\&. T} T{ -band +cloned\-mac\-address T}:T{ -string +byte array T}:T{ \ \& T}:T{ -802\&.11 frequency band of the network\&. One of \*(Aqa\*(Aq for 5GHz 802\&.11a or \*(Aqbg\*(Aq for 2\&.4GHz 802\&.11\&. This will lock associations to the Wi\-Fi network to the specific band, i\&.e\&. if \*(Aqa\*(Aq is specified, the device will not associate with the same network in the 2\&.4GHz band even if the network\*(Aqs settings are compatible\&. This setting depends on specific driver capability and may not work with all drivers\&. +If specified, request that the Wi\-Fi device use this MAC address instead of its permanent MAC address\&. This is known as MAC cloning or spoofing\&. T} T{ -channel +hidden T}:T{ -uint32 +boolean T}:T{ -0 +FALSE T}:T{ -Wireless channel to use for the Wi\-Fi connection\&. The device will only join (or create for Ad\-Hoc networks) a Wi\-Fi network on the specified channel\&. Because channel numbers overlap between bands, this property also requires the \*(Aqband\*(Aq property to be set\&. +If TRUE, indicates this network is a non\-broadcasting network that hides its SSID\&. In this case various workarounds may take place, such as probe\-scanning the SSID for more reliable network discovery\&. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution\&. T} T{ -bssid +mac\-address T}:T{ byte array T}:T{ -[] +\ \& T}:T{ -If specified, directs the device to only associate with the given access point\&. This capability is highly driver dependent and not supported by all devices\&. Note: this property does not control the BSSID used when creating an Ad\-Hoc network and is unlikely to in the future\&. +If specified, this connection will only apply to the Wi\-Fi device whose permanent MAC address matches\&. This property does not change the MAC address of the device (i\&.e\&. MAC spoofing)\&. T} T{ -rate +mac\-address\-blacklist T}:T{ -uint32 +array of string T}:T{ -0 +[] T}:T{ -If non\-zero, directs the device to only use the specified bitrate for communication with the access point\&. Units are in Kb/s, ie 5500 = 5\&.5 Mbit/s\&. This property is highly driver dependent and not all devices support setting a static bitrate\&. +A list of permanent MAC addresses of Wi\-Fi devices to which this connection should never apply\&. Each MAC address should be given in the standard hex\-digits\-and\-colons notation (eg "00:11:22:33:44:55")\&. T} T{ -tx\-power +mode T}:T{ -uint32 +string T}:T{ -0 +\ \& T}:T{ -If non\-zero, directs the device to use the specified transmit power\&. Units are dBm\&. This property is highly driver dependent and not all devices support setting a static transmit power\&. +Wi\-Fi network mode; one of "infrastructure", "adhoc" or "ap"\&. If blank, infrastructure is assumed\&. T} T{ -mac\-address +mtu T}:T{ -byte array +uint32 T}:T{ -[] +0 T}:T{ -If specified, this connection will only apply to the Wi\-Fi device whose permanent MAC address matches\&. This property does not change the MAC address of the device (i\&.e\&. MAC spoofing)\&. +If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. T} T{ -cloned\-mac\-address +name T}:T{ -byte array +string T}:T{ -[] +802\-11\-wireless T}:T{ -If specified, request that the Wi\-Fi device use this MAC address instead of its permanent MAC address\&. This is known as MAC cloning or spoofing\&. +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{ -mac\-address\-blacklist +rate T}:T{ -array of string +uint32 T}:T{ -\ \& +0 T}:T{ -A list of permanent MAC addresses of Wi\-Fi devices to which this connection should never apply\&. Each MAC address should be given in the standard hex\-digits\-and\-colons notation (eg \*(Aq00:11:22:33:44:55\*(Aq)\&. +If non\-zero, directs the device to only use the specified bitrate for communication with the access point\&. Units are in Kb/s, ie 5500 = 5\&.5 Mbit/s\&. This property is highly driver dependent and not all devices support setting a static bitrate\&. T} T{ -mtu +security T}:T{ -uint32 +None T}:T{ -0 +\ \& T}:T{ -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. +This property is deprecated, but can be set to the value \*(Aq802\-11\-wireless\-security\*(Aq when a wireless security setting is also present in the connection dictionary, for compatibility with very old NetworkManager daemons\&. T} T{ seen\-bssids T}:T{ array of string T}:T{ -\ \& +[] T}:T{ -A list of BSSIDs (each BSSID formatted as a MAC address like 00:11:22:33:44:55\*(Aq) that have been detected as part of the Wi\-Fi network\&. NetworkManager internally tracks previously seen BSSIDs\&. The property is only meant for reading and reflects the BSSID list of NetworkManager\&. The changes you make to this property will not be preserved\&. +A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi\-Fi network\&. NetworkManager internally tracks previously seen BSSIDs\&. The property is only meant for reading and reflects the BSSID list of NetworkManager\&. The changes you make to this property will not be preserved\&. T} T{ -security +ssid T}:T{ -string +byte array T}:T{ \ \& T}:T{ -If the wireless connection has any security restrictions, like 802\&.1x, WEP, or WPA, set this property to \*(Aq802\-11\-wireless\-security\*(Aq and ensure the connection contains a valid 802\-11\-wireless\-security setting\&. +SSID of the Wi\-Fi network\&. Must be specified\&. T} T{ -hidden +tx\-power T}:T{ -boolean +uint32 T}:T{ -FALSE +0 T}:T{ -If TRUE, indicates this network is a non\-broadcasting network that hides its SSID\&. In this case various workarounds may take place, such as probe\-scanning the SSID for more reliable network discovery\&. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution\&. +If non\-zero, directs the device to use the specified transmit power\&. Units are dBm\&. This property is highly driver dependent and not all devices support setting a static transmit power\&. T} .TE .sp 1 @@ -2767,7 +2878,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&25.\ \&802-11-wireless-security setting +.B Table\ \&26.\ \&802-11-wireless-security setting .TS allbox tab(:); lB lB lB lB. @@ -2800,166 +2911,166 @@ l l l l l l l l l l l l. T{ -name +auth\-alg T}:T{ string T}:T{ -802\-11\-wireless\-security +\ \& T}:T{ -The setting\*(Aqs name; these names are defined by the specification and cannot be changed after the object has been created\&. Each setting class has a name, and all objects of that class share the same name\&. +When WEP is used (ie, key\-mgmt = "none" or "ieee8021x") indicate the 802\&.11 authentication algorithm required by the AP here\&. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP\&. When using Cisco LEAP (ie, key\-mgmt = "ieee8021x" and auth\-alg = "leap") the "leap\-username" and "leap\-password" properties must be specified\&. T} T{ -key\-mgmt +group T}:T{ -string +array of string T}:T{ -\ \& +[] T}:T{ -Key management used for the connection\&. One of \*(Aqnone\*(Aq (WEP), \*(Aqieee8021x\*(Aq (Dynamic WEP), \*(Aqwpa\-none\*(Aq (WPA\-PSK Ad\-Hoc), \*(Aqwpa\-psk\*(Aq (infrastructure WPA\-PSK), or \*(Aqwpa\-eap\*(Aq (WPA\-Enterprise)\&. This property must be set for any Wi\-Fi connection that uses security\&. +A list of group/broadcast encryption algorithms which prevents connections to Wi\-Fi networks that do not utilize one of the algorithms in the list\&. For maximum compatibility leave this property empty\&. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp"\&. T} T{ -wep\-tx\-keyidx +key\-mgmt T}:T{ -uint32 +string T}:T{ -0 +\ \& T}:T{ -When static WEP is used (ie, key\-mgmt = \*(Aqnone\*(Aq) and a non\-default WEP key index is used by the AP, put that WEP key index here\&. Valid values are 0 (default key) through 3\&. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 \- 4\&. +Key management used for the connection\&. One of "none" (WEP), "ieee8021x" (Dynamic WEP), "wpa\-none" (Ad\-Hoc WPA\-PSK), "wpa\-psk" (infrastructure WPA\-PSK), or "wpa\-eap" (WPA\-Enterprise)\&. This property must be set for any Wi\-Fi connection that uses security\&. T} T{ -auth\-alg +leap\-password T}:T{ string T}:T{ \ \& T}:T{ -When WEP is used (ie, key\-mgmt = \*(Aqnone\*(Aq or \*(Aqieee8021x\*(Aq) indicate the 802\&.11 authentication algorithm required by the AP here\&. One of \*(Aqopen\*(Aq for Open System, \*(Aqshared\*(Aq for Shared Key, or \*(Aqleap\*(Aq for Cisco LEAP\&. When using Cisco LEAP (ie, key\-mgmt = \*(Aqieee8021x\*(Aq and auth\-alg = \*(Aqleap\*(Aq) the \*(Aqleap\-username\*(Aq and \*(Aqleap\-password\*(Aq properties must be specified\&. +The login password for legacy LEAP connections (ie, key\-mgmt = "ieee8021x" and auth\-alg = "leap")\&. T} T{ -proto +leap\-password\-flags T}:T{ -array of string +NMSettingSecretFlags (uint32) T}:T{ \ \& T}:T{ -List of strings specifying the allowed WPA protocol versions to use\&. Each element may be one \*(Aqwpa\*(Aq (allow WPA) or \*(Aqrsn\*(Aq (allow WPA2/RSN)\&. If not specified, both WPA and RSN connections are allowed\&. +Flags indicating how to handle the "leap\-password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ -pairwise +leap\-username T}:T{ -array of string +string T}:T{ \ \& T}:T{ -A list of pairwise encryption algorithms which prevents connections to Wi\-Fi networks that do not utilize one of the algorithms in the list\&. For maximum compatibility leave this property empty\&. Each list element may be one of \*(Aqtkip\*(Aq or \*(Aqccmp\*(Aq\&. +The login username for legacy LEAP connections (ie, key\-mgmt = "ieee8021x" and auth\-alg = "leap")\&. T} T{ -group +name T}:T{ -array of string +string T}:T{ -\ \& +802\-11\-wireless\-security T}:T{ -A list of group/broadcast encryption algorithms which prevents connections to Wi\-Fi networks that do not utilize one of the algorithms in the list\&. For maximum compatibility leave this property empty\&. Each list element may be one of \*(Aqwep40\*(Aq, \*(Aqwep104\*(Aq, \*(Aqtkip\*(Aq, or \*(Aqccmp\*(Aq\&. +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{ -leap\-username +pairwise T}:T{ -string +array of string T}:T{ -\ \& +[] T}:T{ -The login username for legacy LEAP connections (ie, key\-mgmt = \*(Aqieee8021x\*(Aq and auth\-alg = \*(Aqleap\*(Aq)\&. +A list of pairwise encryption algorithms which prevents connections to Wi\-Fi networks that do not utilize one of the algorithms in the list\&. For maximum compatibility leave this property empty\&. Each list element may be one of "tkip" or "ccmp"\&. T} T{ -wep\-key0 +proto T}:T{ -string +array of string T}:T{ -\ \& +[] T}:T{ -Index 0 WEP key\&. This is the WEP key used in most networks\&. See the \*(Aqwep\-key\-type\*(Aq property for a description of how this key is interpreted\&. +List of strings specifying the allowed WPA protocol versions to use\&. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN)\&. If not specified, both WPA and RSN connections are allowed\&. T} T{ -wep\-key1 +psk T}:T{ string T}:T{ \ \& T}:T{ -Index 1 WEP key\&. This WEP index is not used by most networks\&. See the \*(Aqwep\-key\-type\*(Aq property for a description of how this key is interpreted\&. +Pre\-Shared\-Key for WPA networks\&. If the key is 64\-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key\&. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802\&.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA\-PSK used when connecting to the Wi\-Fi network\&. T} T{ -wep\-key2 +psk\-flags T}:T{ -string +NMSettingSecretFlags (uint32) T}:T{ \ \& T}:T{ -Index 2 WEP key\&. This WEP index is not used by most networks\&. See the \*(Aqwep\-key\-type\*(Aq property for a description of how this key is interpreted\&. +Flags indicating how to handle the "psk" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ -wep\-key3 +wep\-key\-flags T}:T{ -string +NMSettingSecretFlags (uint32) T}:T{ \ \& T}:T{ -Index 3 WEP key\&. This WEP index is not used by most networks\&. See the \*(Aqwep\-key\-type\*(Aq property for a description of how this key is interpreted\&. +Flags indicating how to handle the "wep\-key0", "wep\-key1", "wep\-key2", and "wep\-key3" properties\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ -wep\-key\-flags +wep\-key\-type T}:T{ -uint32 +NMWepKeyType (uint32) T}:T{ -0 +\ \& T}:T{ -Flags indicating how to handle the WEP keys\&. (see the section called \(lqSecret flag types:\(rq for flag values) +Controls the interpretation of WEP keys\&. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10\- or 26\-character hexadecimal string, or a 5\- or 13\-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de\-facto MD5 method to derive the actual WEP key\&. T} T{ -wep\-key\-type +wep\-key0 T}:T{ -uint32 +string T}:T{ -0 +\ \& T}:T{ -Controls the interpretation of WEP keys\&. Allowed values are 1 (interpret WEP keys as hexadecimal or ASCII keys) or 2 (interpret WEP keys as WEP Passphrases)\&. If set to 1 and the keys are hexadecimal, they must be either 10 or 26 characters in length\&. If set to 1 and the keys are ASCII keys, they must be either 5 or 13 characters in length\&. If set to 2, the passphrase is hashed using the de\-facto MD5 method to derive the actual WEP key\&. +Index 0 WEP key\&. This is the WEP key used in most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. T} T{ -psk +wep\-key1 T}:T{ string T}:T{ \ \& T}:T{ -Pre\-Shared\-Key for WPA networks\&. If the key is 64\-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key\&. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802\&.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA\-PSK used when connecting to the Wi\-Fi network\&. +Index 1 WEP key\&. This WEP index is not used by most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. T} T{ -psk\-flags +wep\-key2 T}:T{ -uint32 +string T}:T{ -0 +\ \& T}:T{ -Flags indicating how to handle the WPA PSK key\&. (see the section called \(lqSecret flag types:\(rq for flag values) +Index 2 WEP key\&. This WEP index is not used by most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. T} T{ -leap\-password +wep\-key3 T}:T{ string T}:T{ \ \& T}:T{ -The login password for legacy LEAP connections (ie, key\-mgmt = \*(Aqieee8021x\*(Aq and auth\-alg = \*(Aqleap\*(Aq)\&. +Index 3 WEP key\&. This WEP index is not used by most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. T} T{ -leap\-password\-flags +wep\-tx\-keyidx T}:T{ uint32 T}:T{ 0 T}:T{ -Flags indicating how to handle the LEAP password\&. (see the section called \(lqSecret flag types:\(rq for flag values) +When static WEP is used (ie, key\-mgmt = "none") and a non\-default WEP key index is used by the AP, put that WEP key index here\&. Valid values are 0 (default key) through 3\&. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 \- 4\&. T} .TE .sp 1 @@ -3024,6 +3135,6 @@ NetworkManager developers or distro plugin\-specific location .SH "SEE ALSO" .PP -https://live\&.gnome\&.org/NetworkManagerConfiguration +https://wiki\&.gnome\&.org/Projects/NetworkManager/ConfigurationSpecification .PP NetworkManager(8), nmcli(1), nmcli\-examples(5), NetworkManager\&.conf(5) |