NM-SETTINGS(5) Configuration NM-SETTINGS(5)
NAME
nm-settings - Description of settings and properties of NetworkManager connection profiles
DESCRIPTION
NetworkManager is based on a concept of connection profiles, sometimes referred to as connections only. These connection profiles contain a
network configuration. When NetworkManager activates a connection profile on a network device the configuration will be applied and an
active network connection will be established. Users are free to create as many connection profiles as they see fit. Thus they are flexible
in having various network configurations for different networking needs. The connection profiles are handled by NetworkManager via settings
service and are exported on D-Bus (/org/freedesktop/NetworkManager/Settings/<num> objects). The conceptual objects can be described as
follows:
Connection (profile)
A specific, encapsulated, independent group of settings describing all the configuration required to connect to a specific network. It
is referred to by a unique identifier called the UUID. A connection is tied to a one specific device type, but not necessarily a
specific hardware device. It is composed of one or more Settings objects.
Setting
A group of related key/value pairs describing a specific piece of a Connection (profile). Settings keys and allowed values are
described in the tables below. Keys are also reffered to as properties. Developers can find the setting objects and their properties in
the libnm-util sources. Look for the class_init functions near the bottom of each setting source file.
The settings and properties shown in tables below list all available connection configuration options. However, note that not all settings
are applicable to all connection types. NetworkManager provides a command-line tool nmcli that allows direct configuration of the settings
and properties according to a connection profile type. nmcli connection editor has also a built-in describe command that can display
description of particular settings and properties of this page.
Table 1. 802-1x setting
+----------------------------------+-----------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+----------------------------------+-----------------+---------------+-------------------------------+
|name | string | 802-1x | The setting's 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. |
+----------------------------------+-----------------+---------------+-------------------------------+
|eap | array of string | | 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. |
+----------------------------------+-----------------+---------------+-------------------------------+
|identity | string | | Identity string for EAP |
| | | | authentication methods. |
| | | | Often the user's user or |
| | | | login name. |
+----------------------------------+-----------------+---------------+-------------------------------+
|anonymous-identity | string | | Anonymous identity string for |
| | | | EAP authentication methods. |
| | | | Used as the unencrypted |
| | | | identity with EAP types that |
| | | | support different tunneled |
| | | | identity like EAP-TTLS. |
+----------------------------------+-----------------+---------------+-------------------------------+
|pac-file | string | | UTF-8 encoded file path |
| | | | containing PAC for EAP-FAST. |
+----------------------------------+-----------------+---------------+-------------------------------+
|ca-cert | byte array | [] | 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's 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 |
| | | | 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. |
+----------------------------------+-----------------+---------------+-------------------------------+
|ca-path | string | | 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. |
+----------------------------------+-----------------+---------------+-------------------------------+
|subject-match | string | | Substring to be matched |
| | | | against the subject of the |
| | | | certificate presented by the |
| | | | authentication server. When |
| | | | unset, no verification of the |
| | | | authentication server |
| | | | certificate's subject is |
| | | | performed. |
+----------------------------------+-----------------+---------------+-------------------------------+
|altsubject-matches | array of string | | 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's altSubjectName |
| | | | is performed. |
+----------------------------------+-----------------+---------------+-------------------------------+
|client-cert | byte array | [] | 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's 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 |
| | | | NULL byte. |
+----------------------------------+-----------------+---------------+-------------------------------+
|phase1-peapver | string | | Forces which PEAP version is |
| | | | used when PEAP is set as the |
| | | | EAP method in '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. |
+----------------------------------+-----------------+---------------+-------------------------------+
|phase1-peaplabel | string | | 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. |
+----------------------------------+-----------------+---------------+-------------------------------+
|phase1-fast-provisioning | string | | 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 |
| | | | '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. |
+----------------------------------+-----------------+---------------+-------------------------------+
|phase2-auth | string | | 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 phase2 |
| | | | 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. |
+----------------------------------+-----------------+---------------+-------------------------------+
|phase2-autheap | string | | 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. |
+----------------------------------+-----------------+---------------+-------------------------------+
|phase2-ca-cert | byte array | [] | 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 |
| | | | 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's 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 |
| | | | 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. |
+----------------------------------+-----------------+---------------+-------------------------------+
|phase2-ca-path | string | | 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. |
+----------------------------------+-----------------+---------------+-------------------------------+
|phase2-subject-match | string | | Substring to be matched |
| | | | against the subject of the |
| | | | certificate presented by the |
| | | | authentication server during |
| | | | the inner 'phase2' |
| | | | authentication. When unset, |
| | | | no verification of the |
| | | | authentication server |
| | | | certificate's subject is |
| | | | performed. |
+----------------------------------+-----------------+---------------+-------------------------------+
|phase2-altsubject-matches | array of string | | 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 'phase 2' |
| | | | authentication. If the list |
| | | | is empty, no verification of |
| | | | the server certificate's |
| | | | altSubjectName is performed. |
+----------------------------------+-----------------+---------------+-------------------------------+
|phase2-client-cert | byte array | [] | 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's 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 |
| | | | NULL byte. |
+----------------------------------+-----------------+---------------+-------------------------------+
|password | string | | UTF-8 encoded password used |
| | | | for EAP authentication |
| | | | methods. |
+----------------------------------+-----------------+---------------+-------------------------------+
|password-flags | uint32 | 0 | Flags indicating how to |
| | | | handle the 802.1x password. |
| | | | (see the section called |
| | | | "Secret flag types:" for flag |
| | | | values) |
+----------------------------------+-----------------+---------------+-------------------------------+
|password-raw | byte array | [] | 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 'password' and |
| | | | 'password-raw' are given, |
| | | | 'password' is preferred. |
+----------------------------------+-----------------+---------------+-------------------------------+
|password-raw-flags | uint32 | 0 | Flags indicating how to |
| | | | handle the 802.1x password |
| | | | byte array. (see the section |
| | | | called "Secret flag types:" |
| | | | for flag values) |
+----------------------------------+-----------------+---------------+-------------------------------+
|private-key | byte array | [] | Contains the private key when |
| | | | the 'eap' property is set to |
| | | | 'tls'. Key data is specified |
| | | | using a 'scheme'; two are |
| | | | currently supported: blob and |
| | | | path. When using the blob |
| | | | scheme and private keys, this |
| | | | property should be set to the |
| | | | key's encrypted PEM encoded |
| | | | data. When using private keys |
| | | | with the path scheme, this |
| | | | property should be set to the |
| | | | full UTF-8 encoded path of |
| | | | the key, prefixed with the |
| | | | string 'file://' and ending |
| | | | with a terminating 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 |
| | | | '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 |
| | | | NULL 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. |
+----------------------------------+-----------------+---------------+-------------------------------+
|private-key-password | string | | 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. |
+----------------------------------+-----------------+---------------+-------------------------------+
|private-key-password-flags | uint32 | 0 | Flags indicating how to |
| | | | handle the 802.1x private key |
| | | | password. (see the section |
| | | | called "Secret flag types:" |
| | | | for flag values) |
+----------------------------------+-----------------+---------------+-------------------------------+
|phase2-private-key | byte array | [] | Contains the 'phase 2' inner |
| | | | private key when the |
| | | | 'phase2-auth' or |
| | | | 'phase2-autheap' property is |
| | | | set to 'tls'. Key data is |
| | | | specified using a 'scheme'; |
| | | | two are currently supported: |
| | | | blob and path. When using the |
| | | | blob scheme and private keys, |
| | | | this property should be set |
| | | | to the key's encrypted PEM |
| | | | encoded data. When using |
| | | | private keys with the path |
| | | | scheme, this property should |
| | | | be set to the full UTF-8 |
| | | | encoded path of the key, |
| | | | prefixed with the string |
| | | | 'file://' and ending with a |
| | | | terminating 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 |
| | | | '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 |
| | | | NULL 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. |
+----------------------------------+-----------------+---------------+-------------------------------+
|phase2-private-key-password | string | | The password used to decrypt |
| | | | the 'phase 2' private key |
| | | | specified in the |
| | | | 'private-key' property when |
| | | | the phase2 private key either |
| | | | uses the path scheme, or if |
| | | | the phase2 private key is a |
| | | | PKCS#12 format key. |
+----------------------------------+-----------------+---------------+-------------------------------+
|phase2-private-key-password-flags | uint32 | 0 | Flags indicating how to |
| | | | handle the 802.1x phase2 |
| | | | private key password. (see |
| | | | the section called "Secret |
| | | | flag types:" for flag values) |
+----------------------------------+-----------------+---------------+-------------------------------+
|pin | string | | PIN used for EAP |
| | | | authentication methods. |
+----------------------------------+-----------------+---------------+-------------------------------+
|pin-flags | uint32 | 0 | Flags indicating how to |
| | | | handle the 802.1x PIN. (see |
| | | | the section called "Secret |
| | | | flag types:" for flag values) |
+----------------------------------+-----------------+---------------+-------------------------------+
|system-ca-certs | boolean | FALSE | When TRUE, overrides |
| | | | '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. |
+----------------------------------+-----------------+---------------+-------------------------------+
Table 2. adsl setting
+---------------+------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+---------------+------------+---------------+-------------------------------+
|name | string | adsl | The setting's 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. |
+---------------+------------+---------------+-------------------------------+
|username | string | | Username used to authenticate |
| | | | with the pppoa service. |
+---------------+------------+---------------+-------------------------------+
|password | string | | Password used to authenticate |
| | | | with the pppoa service. |
+---------------+------------+---------------+-------------------------------+
|password-flags | uint32 | 0 | Flags indicating how to |
| | | | handle the ADSL password. |
| | | | (see the section called |
| | | | "Secret flag types:" for flag |
| | | | values) |
+---------------+------------+---------------+-------------------------------+
|protocol | string | | ADSL connection protocol. |
+---------------+------------+---------------+-------------------------------+
|encapsulation | string | | Encapsulation of ADSL |
| | | | connection |
+---------------+------------+---------------+-------------------------------+
|vpi | uint32 | 0 | VPI of ADSL connection |
+---------------+------------+---------------+-------------------------------+
|vci | uint32 | 0 | VCI of ADSL connection |
+---------------+------------+---------------+-------------------------------+
Table 3. bluetooth setting
+---------+------------+---------------+------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+---------+------------+---------------+------------------------------+
|name | string | bluetooth | The setting's 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. |
+---------+------------+---------------+------------------------------+
|bdaddr | byte array | [] | The Bluetooth address of the |
| | | | device |
+---------+------------+---------------+------------------------------+
|type | string | | Either 'dun' for Dial-Up |
| | | | Networking connections or |
| | | | 'panu' for Personal Area |
| | | | Networking connections. |
+---------+------------+---------------+------------------------------+
Table 4. bond setting
+---------------+--------------------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+---------------+--------------------------+---------------+-------------------------------+
|name | string | bond | The setting's 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. |
+---------------+--------------------------+---------------+-------------------------------+
|interface-name | string | | The name of the virtual |
| | | | in-kernel bonding network |
| | | | interface |
+---------------+--------------------------+---------------+-------------------------------+
|options | dict of (string::string) | | 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]). |
+---------------+--------------------------+---------------+-------------------------------+
Table 5. bridge setting
+---------------+------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+---------------+------------+---------------+-------------------------------+
|name | string | bridge | The setting's 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. |
+---------------+------------+---------------+-------------------------------+
|interface-name | string | | The name of the virtual |
| | | | in-kernel bridging network |
| | | | interface |
+---------------+------------+---------------+-------------------------------+
|stp | boolean | TRUE | Controls whether Spanning |
| | | | Tree Protocol (STP) is |
| | | | enabled for this bridge. |
+---------------+------------+---------------+-------------------------------+
|priority | uint32 | 32768 | Sets the Spanning Tree |
| | | | Protocol (STP) priority for |
| | | | this bridge. Lower values |
| | | | are 'better'; the lowest |
| | | | priority bridge will be |
| | | | elected the root bridge. |
+---------------+------------+---------------+-------------------------------+
|forward-delay | uint32 | 15 | The Spanning Tree Protocol |
| | | | (STP) forwarding delay, in |
| | | | seconds. |
+---------------+------------+---------------+-------------------------------+
|hello-time | uint32 | 2 | The Spanning Tree Protocol |
| | | | (STP) hello time, in seconds. |
+---------------+------------+---------------+-------------------------------+
|max-age | uint32 | 20 | The Spanning Tree Protocol |
| | | | (STP) maximum message age, in |
| | | | seconds. |
+---------------+------------+---------------+-------------------------------+
|ageing-time | uint32 | 300 | The ethernet MAC address |
| | | | aging time, in seconds. |
+---------------+------------+---------------+-------------------------------+
Table 6. bridge-port setting
+-------------+------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+-------------+------------+---------------+-------------------------------+
|name | string | bridge-port | The setting's 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. |
+-------------+------------+---------------+-------------------------------+
|priority | uint32 | 32 | The Spanning Tree Protocol |
| | | | (STP) priority of this bridge |
| | | | port |
+-------------+------------+---------------+-------------------------------+
|path-cost | uint32 | 100 | The Spanning Tree Protocol |
| | | | (STP) port cost for |
| | | | destinations via this port. |
+-------------+------------+---------------+-------------------------------+
|hairpin-mode | boolean | FALSE | Enables or disabled 'hairpin |
| | | | mode' for the port, which |
| | | | allows frames to be sent back |
| | | | out through the port the |
| | | | frame was received on. |
+-------------+------------+---------------+-------------------------------+
Table 7. cdma setting
+---------------+------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+---------------+------------+---------------+-------------------------------+
|name | string | cdma | The setting's 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. |
+---------------+------------+---------------+-------------------------------+
|number | string | | 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. |
+---------------+------------+---------------+-------------------------------+
|username | string | | Username used to authenticate |
| | | | with the network, if |
| | | | required. Note that many |
| | | | providers do not require a |
| | | | username or accept any |
| | | | username. |
+---------------+------------+---------------+-------------------------------+
|password | string | | Password used to authenticate |
| | | | with the network, if |
| | | | required. Note that many |
| | | | providers do not require a |
| | | | password or accept any |
| | | | password. |
+---------------+------------+---------------+-------------------------------+
|password-flags | uint32 | 0 | Flags indicating how to |
| | | | handle the CDMA password. |
| | | | (see the section called |
| | | | "Secret flag types:" for flag |
| | | | values) |
+---------------+------------+---------------+-------------------------------+
Table 8. connection setting
+---------------------+-----------------+---------------+----------------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+---------------------+-----------------+---------------+----------------------------------------+
|name | string | connection | The setting's 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. |
+---------------------+-----------------+---------------+----------------------------------------+
|id | string | | 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. |
+---------------------+-----------------+---------------+----------------------------------------+
|uuid | string | | Universally unique connection |
| | | | identifier. Must be in the |
| | | | format |
| | | | '2815492f-7e56-435e-b2e9-246bd7cdc664' |
| | | | (ie, contains only |
| | | | hexadecimal characters and |
| | | | '-'). 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's 'id', but should |
| | | | be recreated when the WiFi |
| | | | SSID, mobile broadband |
| | | | network provider, or the |
| | | | connection type changes. |
+---------------------+-----------------+---------------+----------------------------------------+
|interface-name | string | | 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. |
+---------------------+-----------------+---------------+----------------------------------------+
|type | string | | 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). |
+---------------------+-----------------+---------------+----------------------------------------+
|permissions | array of string | | An array of strings defining what |
| | | | access a given user has to this |
| | | | connection. If this is NULL or empty, |
| | | | all users are allowed to access this |
| | | | connection. Otherwise a user is |
| | | | allowed to access this connection if |
| | | | and only if they are in this array. |
| | | | 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 (if |
| | | | present) must be ignored and is |
| | | | reserved for future use. All of |
| | | | [type], [id], and [reserved] must be |
| | | | valid UTF-8. |
+---------------------+-----------------+---------------+----------------------------------------+
|autoconnect | boolean | TRUE | 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. |
+---------------------+-----------------+---------------+----------------------------------------+
|timestamp | uint64 | 0 | 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). |
+---------------------+-----------------+---------------+----------------------------------------+
|read-only | boolean | FALSE | 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. |
+---------------------+-----------------+---------------+----------------------------------------+
|zone | string | | 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. |
+---------------------+-----------------+---------------+----------------------------------------+
|master | string | | Interface name of the master device or |
| | | | UUID of the master connection |
+---------------------+-----------------+---------------+----------------------------------------+
|slave-type | string | | Setting name describing the type of |
| | | | slave this connection is (ie, 'bond') |
| | | | or NULL if this connection is not a |
| | | | slave. |
+---------------------+-----------------+---------------+----------------------------------------+
|secondaries | array of string | | List of connection UUIDs that should |
| | | | be activated when the base connection |
| | | | itself is activated. |
+---------------------+-----------------+---------------+----------------------------------------+
|gateway-ping-timeout | uint32 | 0 | If greater than zero, delay success of |
| | | | IP addressing until either the timeout |
| | | | is reached, or an IP gateway replies |
| | | | to a ping. |
+---------------------+-----------------+---------------+----------------------------------------+
Table 9. dcb setting
+----------------------------+-----------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+----------------------------+-----------------+---------------+-------------------------------+
|name | string | dcb | The setting's 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. |
+----------------------------+-----------------+---------------+-------------------------------+
|app-fcoe-flags | uint32 | 0 | 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 "Secret flag |
| | | | types:" for flag values) |
+----------------------------+-----------------+---------------+-------------------------------+
|app-fcoe-priority | int32 | -1 | 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 'enabled' flag. |
+----------------------------+-----------------+---------------+-------------------------------+
|app-fcoe-mode | string | "fabric" | The FCoe controller mode; |
| | | | either 'fabric' (default) or |
| | | | 'vn2vn'. |
+----------------------------+-----------------+---------------+-------------------------------+
|app-iscsi-flags | uint32 | 0 | 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 "Secret flag |
| | | | types:" for flag values) |
+----------------------------+-----------------+---------------+-------------------------------+
|app-iscsi-priority | int32 | -1 | 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 'enabled' flag. |
+----------------------------+-----------------+---------------+-------------------------------+
|app-fip-flags | uint32 | 0 | 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 "Secret flag |
| | | | types:" for flag values) |
+----------------------------+-----------------+---------------+-------------------------------+
|app-fip-priority | int32 | -1 | 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 'enabled' flag. |
+----------------------------+-----------------+---------------+-------------------------------+
|priority-flow-control-flags | uint32 | 0 | 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 "Secret flag |
| | | | types:" for flag values) |
+----------------------------+-----------------+---------------+-------------------------------+
|priority-flow-control | array of uint32 | | 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). |
+----------------------------+-----------------+---------------+-------------------------------+
|priority-group-flags | uint32 | 0 | Specifies the flags for DCB |
| | | | Priority Groups. Flags may be |
| | | | any combination of 0x1 |
| | | | (enable), 0x2 (advertise), |
| | | | and 0x4 (willing). (see the |
| | | | section called "Secret flag |
| | | | types:" for flag values) |
+----------------------------+-----------------+---------------+-------------------------------+
|priority-group-id | array of uint32 | | 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. |
+----------------------------+-----------------+---------------+-------------------------------+
|priority-group-bandwidth | array of uint32 | | 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. |
+----------------------------+-----------------+---------------+-------------------------------+
|priority-bandwidth | array of uint32 | | 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's assigned group |
| | | | that the priority may use. |
| | | | The sum of all percentages |
| | | | for priorities which belong |
| | | | to the same group must total |
| | | | 100 percent. |
+----------------------------+-----------------+---------------+-------------------------------+
|priority-strict-bandwidth | array of uint32 | | 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). |
+----------------------------+-----------------+---------------+-------------------------------+
|priority-traffic-class | array of uint32 | | An array of 8 uint values, |
| | | | where the array index |
| | | | corresponds to the User |
| | | | Priority (0 - 7) and the |
| | | | value indicates the traffic |
| | | | class (0 - 7) to which the |
| | | | priority is mapped. |
+----------------------------+-----------------+---------------+-------------------------------+
Table 10. gsm setting
+---------------+------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+---------------+------------+---------------+-------------------------------+
|name | string | gsm | The setting's 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. |
+---------------+------------+---------------+-------------------------------+
|number | string | | 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. |
+---------------+------------+---------------+-------------------------------+
|username | string | | Username used to authenticate |
| | | | with the network, if |
| | | | required. Note that many |
| | | | providers do not require a |
| | | | username or accept any |
| | | | username. |
+---------------+------------+---------------+-------------------------------+
|password | string | | Password used to authenticate |
| | | | with the network, if |
| | | | required. Note that many |
| | | | providers do not require a |
| | | | password or accept any |
| | | | password. |
+---------------+------------+---------------+-------------------------------+
|password-flags | uint32 | 0 | Flags indicating how to |
| | | | handle the GSM password. (see |
| | | | the section called "Secret |
| | | | flag types:" for flag values) |
+---------------+------------+---------------+-------------------------------+
|apn | string | | 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's mobile |
| | | | broadband plan. The APN may |
| | | | only be composed of the |
| | | | characters a-z, 0-9, ., and - |
| | | | per GSM 03.60 Section 14.9. |
+---------------+------------+---------------+-------------------------------+
|network-id | string | | 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. |
+---------------+------------+---------------+-------------------------------+
|network-type | int32 | -1 | 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't |
| | | | use this property when |
| | | | talking to ModemManager.Also, |
| | | | not all devices allow network |
| | | | preference control. |
+---------------+------------+---------------+-------------------------------+
|pin | string | | If the SIM is locked with a |
| | | | PIN it must be unlocked |
| | | | before any other operations |
| | | | are requested. Specify the |
| | | | PIN here to allow operation |
| | | | of the device. |
+---------------+------------+---------------+-------------------------------+
|pin-flags | uint32 | 0 | Flags indicating how to |
| | | | handle the GSM SIM PIN. (see |
| | | | the section called "Secret |
| | | | flag types:" for flag values) |
+---------------+------------+---------------+-------------------------------+
|allowed-bands | uint32 | 1 | Bitfield of allowed frequency |
| | | | bands.Notes: This property is |
| | | | deprecated and NetworkManager |
| | | | from 0.9.10 onwards doesn't |
| | | | use this property when |
| | | | talking to ModemManager.Also, |
| | | | not all devices allow |
| | | | frequency band control. |
+---------------+------------+---------------+-------------------------------+
|home-only | boolean | FALSE | When TRUE, only connections |
| | | | to the home network will be |
| | | | allowed. Connections to |
| | | | roaming networks will not be |
| | | | made. |
+---------------+------------+---------------+-------------------------------+
Table 11. infiniband setting
+---------------+------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+---------------+------------+---------------+-------------------------------+
|name | string | infiniband | The setting's 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. |
+---------------+------------+---------------+-------------------------------+
|mac-address | byte array | [] | 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). |
+---------------+------------+---------------+-------------------------------+
|mtu | uint32 | 0 | If non-zero, only transmit |
| | | | packets of the specified size |
| | | | or smaller, breaking larger |
| | | | packets up into multiple |
| | | | frames. |
+---------------+------------+---------------+-------------------------------+
|transport-mode | string | | The IPoIB transport mode. |
| | | | Either 'datagram' or |
| | | | 'connected'. |
+---------------+------------+---------------+-------------------------------+
|p-key | int32 | -1 | The InfiniBand P_Key. Either |
| | | | -1 for the default, or a |
| | | | 16-bit unsigned integer. |
+---------------+------------+---------------+-------------------------------+
|parent | string | | The interface name of the |
| | | | parent device, or NULL |
+---------------+------------+---------------+-------------------------------+
Table 12. ipv4 setting
+-------------------+--------------------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+-------------------+--------------------------+---------------+-------------------------------+
|name | string | ipv4 | The setting's 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. |
+-------------------+--------------------------+---------------+-------------------------------+
|method | string | | IPv4 configuration method. |
| | | | If 'auto' is specified then |
| | | | the appropriate automatic |
| | | | method (DHCP, PPP, etc) is |
| | | | used for the interface and |
| | | | most other properties can be |
| | | | left unset. If 'link-local' |
| | | | is specified, then a |
| | | | link-local address in the |
| | | | 169.254/16 range will be |
| | | | assigned to the interface. |
| | | | If 'manual' is specified, |
| | | | static IP addressing is used |
| | | | and at least one IP address |
| | | | must be given in the |
| | | | 'addresses' property. If |
| | | | 'shared' 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. |
| | | | 'disabled' means IPv4 will |
| | | | not be used on this |
| | | | connection. This property |
| | | | must be set. |
+-------------------+--------------------------+---------------+-------------------------------+
|dns | array of uint32 | | List of DNS servers (network |
| | | | byte order). For the 'auto' |
| | | | method, these DNS servers are |
| | | | appended to those (if any) |
| | | | returned by automatic |
| | | | configuration. DNS servers |
| | | | cannot be used with the |
| | | | 'shared', 'link-local', or |
| | | | 'disabled' methods as there |
| | | | is no upstream network. In |
| | | | all other methods, these DNS |
| | | | servers are used as the only |
| | | | DNS servers for this |
| | | | connection. |
+-------------------+--------------------------+---------------+-------------------------------+
|dns-search | array of string | | List of DNS search domains. |
| | | | For the 'auto' method, these |
| | | | search domains are appended |
| | | | to those returned by |
| | | | automatic configuration. |
| | | | Search domains cannot be used |
| | | | with the 'shared', |
| | | | 'link-local', or 'disabled' |
| | | | methods as there is no |
| | | | upstream network. In all |
| | | | other methods, these search |
| | | | domains are used as the only |
| | | | search domains for this |
| | | | connection. |
+-------------------+--------------------------+---------------+-------------------------------+
|addresses | array of array of uint32 | | 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 'auto' |
| | | | method, given IP addresses |
| | | | are appended to those |
| | | | returned by automatic |
| | | | configuration. Addresses |
| | | | cannot be used with the |
| | | | 'shared', 'link-local', or |
| | | | 'disabled' methods as |
| | | | addressing is either |
| | | | automatic or disabled with |
| | | | these methods. |
+-------------------+--------------------------+---------------+-------------------------------+
|address-labels | array of string | | Internal use only |
+-------------------+--------------------------+---------------+-------------------------------+
|routes | array of array of uint32 | | 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 'auto' |
| | | | method, given IP routes are |
| | | | appended to those returned by |
| | | | automatic configuration. |
| | | | Routes cannot be used with |
| | | | the 'shared', 'link-local', |
| | | | or 'disabled', methods as |
| | | | there is no upstream network. |
+-------------------+--------------------------+---------------+-------------------------------+
|ignore-auto-routes | boolean | FALSE | When the 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. |
+-------------------+--------------------------+---------------+-------------------------------+
|ignore-auto-dns | boolean | FALSE | When the 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. |
+-------------------+--------------------------+---------------+-------------------------------+
|dhcp-client-id | string | | 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. |
+-------------------+--------------------------+---------------+-------------------------------+
|dhcp-send-hostname | boolean | TRUE | 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 |
| | | | empty and this property is |
| | | | TRUE, the current persistent |
| | | | hostname of the computer is |
| | | | sent. |
+-------------------+--------------------------+---------------+-------------------------------+
|dhcp-hostname | string | | If the 'dhcp-send-hostname' |
| | | | property is TRUE, then the |
| | | | specified name will be sent |
| | | | to the DHCP server when |
| | | | acquiring a lease. |
+-------------------+--------------------------+---------------+-------------------------------+
|never-default | boolean | FALSE | If TRUE, this connection will |
| | | | never be the default IPv4 |
| | | | connection, meaning it will |
| | | | never be assigned the default |
| | | | route by NetworkManager. |
+-------------------+--------------------------+---------------+-------------------------------+
|may-fail | boolean | TRUE | 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. |
+-------------------+--------------------------+---------------+-------------------------------+
Table 13. ipv6 setting
+-------------------+-------------------------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+-------------------+-------------------------------+---------------+-------------------------------+
|name | string | ipv6 | The setting's 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. |
+-------------------+-------------------------------+---------------+-------------------------------+
|method | string | | IPv6 configuration method. |
| | | | If 'auto' 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 'dhcp'; this |
| | | | method is only valid for |
| | | | ethernet-based hardware. If |
| | | | 'link-local' is specified, |
| | | | then an IPv6 link-local |
| | | | address will be assigned to |
| | | | the interface. If 'manual' |
| | | | is specified, static IP |
| | | | addressing is used and at |
| | | | least one IP address must be |
| | | | given in the 'addresses' |
| | | | property. If 'ignore' is |
| | | | specified, IPv6 configuration |
| | | | is not done. This property |
| | | | must be set. Note: the |
| | | | 'shared' method is not yet |
| | | | supported. |
+-------------------+-------------------------------+---------------+-------------------------------+
|dhcp-hostname | string | | The specified name will be |
| | | | sent to the DHCP server when |
| | | | acquiring a lease. |
+-------------------+-------------------------------+---------------+-------------------------------+
|dns | array of byte array | | 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 'auto' |
| | | | method, these DNS servers are |
| | | | appended to those (if any) |
| | | | returned by automatic |
| | | | configuration. DNS servers |
| | | | cannot be used with the |
| | | | 'shared' or 'link-local' |
| | | | methods as there is no |
| | | | usptream network. In all |
| | | | other methods, these DNS |
| | | | servers are used as the only |
| | | | DNS servers for this |
| | | | connection. |
+-------------------+-------------------------------+---------------+-------------------------------+
|dns-search | array of string | | List of DNS search domains. |
| | | | For the 'auto' method, these |
| | | | search domains are appended |
| | | | to those returned by |
| | | | automatic configuration. |
| | | | Search domains cannot be used |
| | | | with the 'shared' or |
| | | | 'link-local' methods as there |
| | | | is no upstream network. In |
| | | | all other methods, these |
| | | | search domains are used as |
| | | | the only search domains for |
| | | | this connection. |
+-------------------+-------------------------------+---------------+-------------------------------+
|addresses | array of (byte array, uint32, | | Array of IPv6 address |
| | byte array) | | 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 'auto' method, given |
| | | | IP addresses are appended to |
| | | | those returned by automatic |
| | | | configuration. Addresses |
| | | | cannot be used with the |
| | | | 'shared' or 'link-local' |
| | | | methods as the interface is |
| | | | automatically assigned an |
| | | | address with these methods. |
+-------------------+-------------------------------+---------------+-------------------------------+
|routes | array of (byte array, uint32, | | Array of IPv6 route |
| | byte array, uint32) | | 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 |
| | | | 'auto' method, given IP |
| | | | routes are appended to those |
| | | | returned by automatic |
| | | | configuration. Routes cannot |
| | | | be used with the 'shared' or |
| | | | 'link-local' methods because |
| | | | there is no upstream network. |
+-------------------+-------------------------------+---------------+-------------------------------+
|ignore-auto-routes | boolean | FALSE | When the method is set to |
| | | | 'auto' or 'dhcp' and this |
| | | | property is set to TRUE, |
| | | | automatically configured |
| | | | routes are ignored and only |
| | | | routes specified in the |
| | | | 'routes' property, if any, |
| | | | are used. |
+-------------------+-------------------------------+---------------+-------------------------------+
|ignore-auto-dns | boolean | FALSE | When the method is set to |
| | | | 'auto' or 'dhcp' and this |
| | | | property is set 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. |
+-------------------+-------------------------------+---------------+-------------------------------+
|never-default | boolean | FALSE | If TRUE, this connection will |
| | | | never be the default IPv6 |
| | | | connection, meaning it will |
| | | | never be assigned the default |
| | | | IPv6 route by NetworkManager. |
+-------------------+-------------------------------+---------------+-------------------------------+
|may-fail | boolean | TRUE | 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. |
+-------------------+-------------------------------+---------------+-------------------------------+
|ip6-privacy | int32 | -1 | 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). |
+-------------------+-------------------------------+---------------+-------------------------------+
Table 14. 802-11-olpc-mesh setting
+---------------------+------------+------------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+---------------------+------------+------------------+-------------------------------+
|name | string | 802-11-olpc-mesh | The setting's 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. |
+---------------------+------------+------------------+-------------------------------+
|ssid | byte array | [] | SSID of the mesh network to |
| | | | join. |
+---------------------+------------+------------------+-------------------------------+
|channel | uint32 | 0 | Channel on which the mesh |
| | | | network to join is located. |
+---------------------+------------+------------------+-------------------------------+
|dhcp-anycast-address | byte array | [] | 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. |
+---------------------+------------+------------------+-------------------------------+
Table 15. ppp setting
+------------------+------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+------------------+------------+---------------+-------------------------------+
|name | string | ppp | The setting's 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. |
+------------------+------------+---------------+-------------------------------+
|noauth | boolean | TRUE | 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. |
+------------------+------------+---------------+-------------------------------+
|refuse-eap | boolean | FALSE | If TRUE, the EAP |
| | | | authentication method will |
| | | | not be used. |
+------------------+------------+---------------+-------------------------------+
|refuse-pap | boolean | FALSE | If TRUE, the PAP |
| | | | authentication method will |
| | | | not be used. |
+------------------+------------+---------------+-------------------------------+
|refuse-chap | boolean | FALSE | If TRUE, the CHAP |
| | | | authentication method will |
| | | | not be used. |
+------------------+------------+---------------+-------------------------------+
|refuse-mschap | boolean | FALSE | If TRUE, the MSCHAP |
| | | | authentication method will |
| | | | not be used. |
+------------------+------------+---------------+-------------------------------+
|refuse-mschapv2 | boolean | FALSE | If TRUE, the MSCHAPv2 |
| | | | authentication method will |
| | | | not be used. |
+------------------+------------+---------------+-------------------------------+
|nobsdcomp | boolean | FALSE | If TRUE, BSD compression will |
| | | | not be requested. |
+------------------+------------+---------------+-------------------------------+
|nodeflate | boolean | FALSE | If TRUE, 'deflate' |
| | | | compression will not be |
| | | | requested. |
+------------------+------------+---------------+-------------------------------+
|no-vj-comp | boolean | FALSE | If TRUE, Van Jacobsen TCP |
| | | | header compression will not |
| | | | be requested. |
+------------------+------------+---------------+-------------------------------+
|require-mppe | boolean | FALSE | 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. |
+------------------+------------+---------------+-------------------------------+
|require-mppe-128 | boolean | FALSE | 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. |
+------------------+------------+---------------+-------------------------------+
|mppe-stateful | boolean | FALSE | If TRUE, stateful MPPE is |
| | | | used. See pppd documentation |
| | | | for more information on |
| | | | stateful MPPE. |
+------------------+------------+---------------+-------------------------------+
|crtscts | boolean | FALSE | 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. |
+------------------+------------+---------------+-------------------------------+
|baud | uint32 | 0 | 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. |
+------------------+------------+---------------+-------------------------------+
|mru | uint32 | 0 | 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. |
+------------------+------------+---------------+-------------------------------+
|mtu | uint32 | 0 | If non-zero, instruct pppd to |
| | | | send packets no larger than |
| | | | the specified size. |
+------------------+------------+---------------+-------------------------------+
|lcp-echo-failure | uint32 | 0 | 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. |
+------------------+------------+---------------+-------------------------------+
|lcp-echo-interval | uint32 | 0 | 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. |
+------------------+------------+---------------+-------------------------------+
Table 16. pppoe setting
+---------------+------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+---------------+------------+---------------+-------------------------------+
|name | string | pppoe | The setting's 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. |
+---------------+------------+---------------+-------------------------------+
|service | string | | 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. |
+---------------+------------+---------------+-------------------------------+
|username | string | | Username used to authenticate |
| | | | with the PPPoE service. |
+---------------+------------+---------------+-------------------------------+
|password | string | | Password used to authenticate |
| | | | with the PPPoE service. |
+---------------+------------+---------------+-------------------------------+
|password-flags | uint32 | 0 | Flags indicating how to |
| | | | handle the PPPoE password. |
| | | | (see the section called |
| | | | "Secret flag types:" for flag |
| | | | values) |
+---------------+------------+---------------+-------------------------------+
Table 17. serial setting
+-----------+------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+-----------+------------+---------------+-------------------------------+
|name | string | serial | The setting's 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. |
+-----------+------------+---------------+-------------------------------+
|baud | uint32 | 57600 | Speed to use for |
| | | | communication over the serial |
| | | | port. Note that this value |
| | | | usually has no effect for |
| | | | mobile broadband modems as |
| | | | they generally ignore speed |
| | | | settings and use the highest |
| | | | available speed. |
+-----------+------------+---------------+-------------------------------+
|bits | uint32 | 8 | Byte-width of the serial |
| | | | communication. The 8 in |
| | | | '8n1' for example. |
+-----------+------------+---------------+-------------------------------+
|parity | gchar | 110 | Parity setting of the serial |
| | | | port. Either 'E' for even |
| | | | parity, 'o' for odd parity, |
| | | | or 'n' for no parity. |
+-----------+------------+---------------+-------------------------------+
|stopbits | uint32 | 1 | Number of stop bits for |
| | | | communication on the serial |
| | | | port. Either 1 or 2. The 1 |
| | | | in '8n1' for example. |
+-----------+------------+---------------+-------------------------------+
|send-delay | uint64 | 0 | Time to delay between each |
| | | | byte sent to the modem, in |
| | | | microseconds. |
+-----------+------------+---------------+-------------------------------+
Table 18. team setting
+---------------+------------+---------------+------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+---------------+------------+---------------+------------------------------+
|name | string | team | The setting's 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. |
+---------------+------------+---------------+------------------------------+
|interface-name | string | | The name of the virtual |
| | | | in-kernel team network |
| | | | interface |
+---------------+------------+---------------+------------------------------+
|config | string | | 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. |
+---------------+------------+---------------+------------------------------+
Table 19. team-port setting
+---------+------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+---------+------------+---------------+-------------------------------+
|name | string | team-port | The setting's 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. |
+---------+------------+---------------+-------------------------------+
|config | string | | 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. |
+---------+------------+---------------+-------------------------------+
Table 20. vlan setting
+---------------------+-----------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+---------------------+-----------------+---------------+-------------------------------+
|name | string | vlan | The setting's 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. |
+---------------------+-----------------+---------------+-------------------------------+
|interface-name | string | | 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 'id' |
| | | | property, ex 'eth2.1'. The |
| | | | parent interface may be given |
| | | | by the 'parent' property or |
| | | | by the 'mac-address' property |
| | | | of a 'wired' setting. |
+---------------------+-----------------+---------------+-------------------------------+
|parent | string | | 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 |
| | | | 'wired' setting with a |
| | | | 'mac-address' property. |
+---------------------+-----------------+---------------+-------------------------------+
|id | uint32 | 0 | The VLAN indentifier the |
| | | | interface created by this |
| | | | connection should be |
| | | | assigned. |
+---------------------+-----------------+---------------+-------------------------------+
|flags | uint32 | 0 | 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's operating state |
| | | | (0x04). |
+---------------------+-----------------+---------------+-------------------------------+
|ingress-priority-map | array of string | | 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'. |
+---------------------+-----------------+---------------+-------------------------------+
|egress-priority-map | array of string | | 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'. |
+---------------------+-----------------+---------------+-------------------------------+
Table 21. vpn setting
+-------------+--------------------------+---------------+-------------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+-------------+--------------------------+---------------+-------------------------------------+
|name | string | vpn | The setting's 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. |
+-------------+--------------------------+---------------+-------------------------------------+
|service-type | string | | 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. |
+-------------+--------------------------+---------------+-------------------------------------+
|user-name | string | | 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. |
+-------------+--------------------------+---------------+-------------------------------------+
|data | dict of (string::string) | | Dictionary of key/value pairs of |
| | | | VPN plugin specific data. Both |
| | | | keys and values must be strings. |
+-------------+--------------------------+---------------+-------------------------------------+
|secrets | dict of (string::string) | | Dictionary of key/value pairs of |
| | | | VPN plugin specific secrets like |
| | | | passwords or private keys. Both |
| | | | keys and values must be strings. |
+-------------+--------------------------+---------------+-------------------------------------+
Table 22. wimax setting
+-------------+------------+---------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+-------------+------------+---------------+-------------------------------+
|name | string | wimax | The setting's 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. |
+-------------+------------+---------------+-------------------------------+
|network-name | string | | Network Service Provider |
| | | | (NSP) name of the WiMAX |
| | | | network this connection |
| | | | should use. |
+-------------+------------+---------------+-------------------------------+
|mac-address | byte array | [] | 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). |
+-------------+------------+---------------+-------------------------------+
Table 23. 802-3-ethernet setting
+----------------------+--------------------------+----------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+----------------------+--------------------------+----------------+-------------------------------+
|name | string | 802-3-ethernet | The setting's 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. |
+----------------------+--------------------------+----------------+-------------------------------+
|port | string | | 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. |
+----------------------+--------------------------+----------------+-------------------------------+
|speed | uint32 | 0 | If non-zero, request that the |
| | | | device use only the specified |
| | | | speed. In Mbit/s, ie 100 == |
| | | | 100Mbit/s. |
+----------------------+--------------------------+----------------+-------------------------------+
|duplex | string | | If specified, request that |
| | | | the device only use the |
| | | | specified duplex mode. |
| | | | Either 'half' or 'full'. |
+----------------------+--------------------------+----------------+-------------------------------+
|auto-negotiate | boolean | TRUE | 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. |
+----------------------+--------------------------+----------------+-------------------------------+
|mac-address | byte array | [] | 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). |
+----------------------+--------------------------+----------------+-------------------------------+
|cloned-mac-address | byte array | [] | If specified, request that |
| | | | the device use this MAC |
| | | | address instead of its |
| | | | permanent MAC address. This |
| | | | is known as MAC cloning or |
| | | | spoofing. |
+----------------------+--------------------------+----------------+-------------------------------+
|mac-address-blacklist | array of string | | 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). |
+----------------------+--------------------------+----------------+-------------------------------+
|mtu | uint32 | 0 | If non-zero, only transmit |
| | | | packets of the specified size |
| | | | or smaller, breaking larger |
| | | | packets up into multiple |
| | | | Ethernet frames. |
+----------------------+--------------------------+----------------+-------------------------------+
|s390-subchannels | array of string | | Identifies specific |
| | | | subchannels that this network |
| | | | device uses for communcation |
| | | | 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. |
+----------------------+--------------------------+----------------+-------------------------------+
|s390-nettype | string | | s390 network device type; one |
| | | | of 'qeth', 'lcs', or 'ctc', |
| | | | representing the different |
| | | | types of virtual network |
| | | | devices available on s390 |
| | | | systems. |
+----------------------+--------------------------+----------------+-------------------------------+
|s390-options | dict of (string::string) | | 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. |
+----------------------+--------------------------+----------------+-------------------------------+
Table 24. 802-11-wireless setting
+----------------------+-----------------+-----------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+----------------------+-----------------+-----------------+-------------------------------+
|name | string | 802-11-wireless | The setting's 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. |
+----------------------+-----------------+-----------------+-------------------------------+
|ssid | byte array | [] | SSID of the WiFi network. |
| | | | Must be specified. |
+----------------------+-----------------+-----------------+-------------------------------+
|mode | string | | WiFi network mode; one of |
| | | | 'infrastructure', 'adhoc' or |
| | | | 'ap'. If blank, |
| | | | infrastructure is assumed. |
+----------------------+-----------------+-----------------+-------------------------------+
|band | string | | 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 WiFi |
| | | | 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's settings are |
| | | | compatible. This setting |
| | | | depends on specific driver |
| | | | capability and may not work |
| | | | with all drivers. |
+----------------------+-----------------+-----------------+-------------------------------+
|channel | uint32 | 0 | Wireless channel to use for |
| | | | the WiFi connection. The |
| | | | device will only join (or |
| | | | create for Ad-Hoc networks) a |
| | | | WiFi network on the specified |
| | | | channel. Because channel |
| | | | numbers overlap between |
| | | | bands, this property also |
| | | | requires the 'band' property |
| | | | to be set. |
+----------------------+-----------------+-----------------+-------------------------------+
|bssid | byte array | [] | 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. |
+----------------------+-----------------+-----------------+-------------------------------+
|rate | uint32 | 0 | 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. |
+----------------------+-----------------+-----------------+-------------------------------+
|tx-power | uint32 | 0 | 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. |
+----------------------+-----------------+-----------------+-------------------------------+
|mac-address | byte array | [] | If specified, this connection |
| | | | will only apply to the WiFi |
| | | | device whose permanent MAC |
| | | | address matches. This |
| | | | property does not change the |
| | | | MAC address of the device |
| | | | (i.e. MAC spoofing). |
+----------------------+-----------------+-----------------+-------------------------------+
|cloned-mac-address | byte array | [] | If specified, request that |
| | | | the WiFi device use this MAC |
| | | | address instead of its |
| | | | permanent MAC address. This |
| | | | is known as MAC cloning or |
| | | | spoofing. |
+----------------------+-----------------+-----------------+-------------------------------+
|mac-address-blacklist | array of string | | 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'). |
+----------------------+-----------------+-----------------+-------------------------------+
|mtu | uint32 | 0 | If non-zero, only transmit |
| | | | packets of the specified size |
| | | | or smaller, breaking larger |
| | | | packets up into multiple |
| | | | Ethernet frames. |
+----------------------+-----------------+-----------------+-------------------------------+
|seen-bssids | array of string | | 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 WiFI network. |
| | | | NetworkManager internally |
| | | | tracks previously seen |
| | | | BSSIDs. The property is only |
| | | | meant for reading and |
| | | | reflects the BBSID list of |
| | | | NetworkManager. The changes |
| | | | you make to this property |
| | | | will not be preserved. |
+----------------------+-----------------+-----------------+-------------------------------+
|security | string | | If the wireless connection |
| | | | has any security |
| | | | restrictions, like 802.1x, |
| | | | WEP, or WPA, set this |
| | | | property to |
| | | | '802-11-wireless-security' |
| | | | and ensure the connection |
| | | | contains a valid |
| | | | 802-11-wireless-security |
| | | | setting. |
+----------------------+-----------------+-----------------+-------------------------------+
|hidden | boolean | FALSE | 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. |
+----------------------+-----------------+-----------------+-------------------------------+
Table 25. 802-11-wireless-security setting
+--------------------+-----------------+--------------------------+-------------------------------+
|Key Name | Value Type | Default Value | Value Description |
+--------------------+-----------------+--------------------------+-------------------------------+
|name | string | 802-11-wireless-security | The setting's 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. |
+--------------------+-----------------+--------------------------+-------------------------------+
|key-mgmt | string | | Key management used for the |
| | | | connection. One of 'none' |
| | | | (WEP), 'ieee8021x' (Dynamic |
| | | | WEP), 'wpa-none' (WPA-PSK |
| | | | Ad-Hoc), 'wpa-psk' |
| | | | (infrastructure WPA-PSK), or |
| | | | 'wpa-eap' (WPA-Enterprise). |
| | | | This property must be set for |
| | | | any WiFi connection that uses |
| | | | security. |
+--------------------+-----------------+--------------------------+-------------------------------+
|wep-tx-keyidx | uint32 | 0 | 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. |
+--------------------+-----------------+--------------------------+-------------------------------+
|auth-alg | string | | 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. |
+--------------------+-----------------+--------------------------+-------------------------------+
|proto | array of string | | 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. |
+--------------------+-----------------+--------------------------+-------------------------------+
|pairwise | array of string | | 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'. |
+--------------------+-----------------+--------------------------+-------------------------------+
|group | array of string | | 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'. |
+--------------------+-----------------+--------------------------+-------------------------------+
|leap-username | string | | The login username for legacy |
| | | | LEAP connections (ie, |
| | | | key-mgmt = 'ieee8021x' and |
| | | | auth-alg = 'leap'). |
+--------------------+-----------------+--------------------------+-------------------------------+
|wep-key0 | string | | 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. |
+--------------------+-----------------+--------------------------+-------------------------------+
|wep-key1 | string | | 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. |
+--------------------+-----------------+--------------------------+-------------------------------+
|wep-key2 | string | | 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. |
+--------------------+-----------------+--------------------------+-------------------------------+
|wep-key3 | string | | 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. |
+--------------------+-----------------+--------------------------+-------------------------------+
|wep-key-flags | uint32 | 0 | Flags indicating how to |
| | | | handle the WEP keys. (see the |
| | | | section called "Secret flag |
| | | | types:" for flag values) |
+--------------------+-----------------+--------------------------+-------------------------------+
|wep-key-type | uint32 | 0 | 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. |
+--------------------+-----------------+--------------------------+-------------------------------+
|psk | string | | 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 |
| | | | WiFi network. |
+--------------------+-----------------+--------------------------+-------------------------------+
|psk-flags | uint32 | 0 | Flags indicating how to |
| | | | handle the WPA PSK key. (see |
| | | | the section called "Secret |
| | | | flag types:" for flag values) |
+--------------------+-----------------+--------------------------+-------------------------------+
|leap-password | string | | The login password for legacy |
| | | | LEAP connections (ie, |
| | | | key-mgmt = 'ieee8021x' and |
| | | | auth-alg = 'leap'). |
+--------------------+-----------------+--------------------------+-------------------------------+
|leap-password-flags | uint32 | 0 | Flags indicating how to |
| | | | handle the LEAP password. |
| | | | (see the section called |
| | | | "Secret flag types:" for flag |
| | | | values) |
+--------------------+-----------------+--------------------------+-------------------------------+
Secret flag types:
Each secret property in a setting has an associated flags property that describes how to handle that secret. The flags property is a
bitfield that contains zero or more of the following values logically OR-ed together.
o 0x0 (none) - the system is responsible for providing and storing this secret.
o 0x1 (agent-owned) - a user-session secret agent is responsible for providing and storing this secret; when it is required, agents will
be asked to provide it.
o 0x2 (not-saved) - this secret should not be saved but should be requested from the user each time it is required. This flag should be
used for One-Time-Pad secrets, PIN codes from hardware tokens, or if the user simply does not want to save the secret.
o 0x4 (not-required) - in some situations it cannot be automatically determined that a secret is required or not. This flag hints that
the secret is not required and should not be requested from the user.
AUTHOR
NetworkManager developers
FILES
/etc/NetworkManager/system-connections
or distro plugin-specific location
SEE ALSO
https://live.gnome.org/NetworkManagerConfiguration
NetworkManager(8), nmcli(1), nmcli-examples(5), NetworkManager.conf(5)
NetworkManager 0.9.9.1 NM-SETTINGS(5)