diff options
Diffstat (limited to 'man/nm-settings.xml')
| -rw-r--r-- | man/nm-settings.xml | 1687 |
1 files changed, 0 insertions, 1687 deletions
diff --git a/man/nm-settings.xml b/man/nm-settings.xml deleted file mode 100644 index 14f7a0f7..00000000 --- a/man/nm-settings.xml +++ /dev/null @@ -1,1687 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ -<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">]><refentry id="nm-settings"> - <refentryinfo> - <date>08 February 2013</date> - </refentryinfo> - <refmeta> - <refentrytitle>nm-settings</refentrytitle> - <manvolnum>5</manvolnum> - <refmiscinfo class="source">NetworkManager</refmiscinfo> - <refmiscinfo class="manual">Configuration</refmiscinfo> - <refmiscinfo class="version">0.9.7.997</refmiscinfo> - </refmeta> - <refnamediv> - <refname>nm-settings</refname> - <refpurpose>Description of settings and parameters of NetworkManager connections.</refpurpose> - </refnamediv> - <refsect1> - <title>DESCRIPTION</title> - <para> - NetworkManager is based on a concept of connections. These connections are - then applied to a device to make an active network connection. Users can create - as many connections as they see fit. The connections are handled by NetworkManager - via <emphasis>settings service</emphasis> and are exported on D-Bus - (<emphasis>/org/freedesktop/NetworkManager/Settings/<num></emphasis> objects). - The conceptual objects can be described as follows: - <variablelist> - <varlistentry> - <term>Connection</term> - <listitem> - <para> - 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 <emphasis>Settings</emphasis> - objects. - </para> - </listitem> - </varlistentry> - </variablelist> - <variablelist> - <varlistentry> - <term>Setting</term> - <listitem> - <para> - A group of related key/value pairs describing a specific piece of a - <emphasis>Connection</emphasis>. Settings keys and allowed values are - described in the tables below. Developers can find the settings - objects in the libnm-util sources. Look for the <function>class_init</function> - functions near the bottoms of each setting source file. - </para> - </listitem> - </varlistentry> - </variablelist> -<table> - <title>802-1x setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">802-1x</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">eap</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: 'leap', 'md5', 'tls', 'peap', 'ttls', and 'fast'. Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.</entry> - </row> - <row> - <entry align="left">identity</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Identity string for EAP authentication methods. Often the user's user or login name.</entry> - </row> - <row> - <entry align="left">anonymous-identity</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</entry> - </row> - <row> - <entry align="left">pac-file</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>UTF-8 encoded file path containing PAC for EAP-FAST.</entry> - </row> - <row> - <entry align="left">ca-cert</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">ca-path</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">subject-match</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">altsubject-matches</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">client-cert</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">phase1-peapver</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">phase1-peaplabel</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">phase1-fast-provisioning</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">phase2-auth</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">phase2-autheap</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">phase2-ca-cert</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">phase2-ca-path</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">phase2-subject-match</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">phase2-altsubject-matches</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">phase2-client-cert</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Password used for EAP authentication methods.</entry> - </row> - <row> - <entry align="left">password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the 802.1x password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">password-raw</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>Password used for EAP authentication methods as a byte array</entry> - </row> - <row> - <entry align="left">password-raw-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the 802.1x password byte array. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">private-key</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">private-key-password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">private-key-password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the 802.1x private key password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">phase2-private-key</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">phase2-private-key-password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">phase2-private-key-password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the 802.1x phase2 private key password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">system-ca-certs</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>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.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>adsl setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">adsl</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">username</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Username used to authenticate with the pppoa service.</entry> - </row> - <row> - <entry align="left">password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Password used to authenticate with the pppoa service.</entry> - </row> - <row> - <entry align="left">password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the ADSL password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">protocol</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>ADSL connection protocol.</entry> - </row> - <row> - <entry align="left">encapsulation</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Encapsulation of ADSL connection</entry> - </row> - <row> - <entry align="left">vpi</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>VPI of ADSL connection</entry> - </row> - <row> - <entry align="left">vci</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>VCI of ADSL connection</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>bluetooth setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">bluetooth</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">bdaddr</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>The Bluetooth address of the device</entry> - </row> - <row> - <entry align="left">type</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Either 'dun' for Dial-Up Networking connections or 'panu' for Personal Area Networking connections.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>bond setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">bond</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">interface-name</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The name of the virtual in-kernel bonding network interface</entry> - </row> - <row> - <entry align="left">options</entry> - <entry align="left">dict of (string::string)</entry> - <entry align="left">[ ]</entry> - <entry>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]).</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>bridge setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">bridge</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">interface-name</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The name of the virtual in-kernel bridging network interface</entry> - </row> - <row> - <entry align="left">stp</entry> - <entry align="left">boolean</entry> - <entry align="left">TRUE</entry> - <entry>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</entry> - </row> - <row> - <entry align="left">priority</entry> - <entry align="left">uint32</entry> - <entry align="left">128</entry> - <entry>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are 'better'; the lowest priority bridge will be elected the root bridge.</entry> - </row> - <row> - <entry align="left">forward-delay</entry> - <entry align="left">uint32</entry> - <entry align="left">15</entry> - <entry>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</entry> - </row> - <row> - <entry align="left">hello-time</entry> - <entry align="left">uint32</entry> - <entry align="left">2</entry> - <entry>The Spanning Tree Protocol (STP) hello time, in seconds.</entry> - </row> - <row> - <entry align="left">max-age</entry> - <entry align="left">uint32</entry> - <entry align="left">20</entry> - <entry>The Spanning Tree Protocol (STP) maximum message age, in seconds.</entry> - </row> - <row> - <entry align="left">ageing-time</entry> - <entry align="left">uint32</entry> - <entry align="left">300</entry> - <entry>The ethernet MAC address aging time, in seconds.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>bridge-port setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">bridge-port</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">priority</entry> - <entry align="left">uint32</entry> - <entry align="left">32</entry> - <entry>The Spanning Tree Protocol (STP) priority of this bridge port</entry> - </row> - <row> - <entry align="left">path-cost</entry> - <entry align="left">uint32</entry> - <entry align="left">100</entry> - <entry>The Spanning Tree Protocol (STP) port cost for destinations via this port.</entry> - </row> - <row> - <entry align="left">hairpin-mode</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>Enables or disabled 'hairpin mode' for the port, which allows frames to be sent back out through the port the frame was received on.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>cdma setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">cdma</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">number</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">username</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</entry> - </row> - <row> - <entry align="left">password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</entry> - </row> - <row> - <entry align="left">password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the CDMA password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>connection setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">connection</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">id</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">uuid</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">type</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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).</entry> - </row> - <row> - <entry align="left">permissions</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">autoconnect</entry> - <entry align="left">boolean</entry> - <entry align="left">TRUE</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">timestamp</entry> - <entry align="left">uint64</entry> - <entry align="left">0</entry> - <entry>Timestamp (in seconds since the Unix Epoch) that the connection was last successfully activated. Settings services should update the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp.</entry> - </row> - <row> - <entry align="left">read-only</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">zone</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">master</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Interface name of the master device or UUID of the master connection</entry> - </row> - <row> - <entry align="left">slave-type</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Setting name describing the type of slave this connection is (ie, 'bond') or NULL if this connection is not a slave.</entry> - </row> - <row> - <entry align="left">secondaries</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>List of connection UUIDs that should be activated when the base connection itself is activated.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>gsm setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">gsm</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">number</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">username</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</entry> - </row> - <row> - <entry align="left">password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</entry> - </row> - <row> - <entry align="left">password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the GSM password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">apn</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">network-id</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">network-type</entry> - <entry align="left">int32</entry> - <entry align="left">-1</entry> - <entry>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. Note that not all devices allow network preference control.</entry> - </row> - <row> - <entry align="left">pin</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">pin-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the GSM SIM PIN. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">allowed-bands</entry> - <entry align="left">uint32</entry> - <entry align="left">1</entry> - <entry>Bitfield of allowed frequency bands. Note that not all devices allow frequency band control.</entry> - </row> - <row> - <entry align="left">home-only</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>infiniband setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">infiniband</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">mac-address</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>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).</entry> - </row> - <row> - <entry align="left">mtu</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry> - </row> - <row> - <entry align="left">transport-mode</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The IPoIB transport mode. Either 'datagram' or 'connected'.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>ipv4 setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">ipv4</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">method</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">dns</entry> - <entry align="left">array of uint32</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">dns-search</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">addresses</entry> - <entry align="left">array of array of uint32</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">routes</entry> - <entry align="left">array of array of uint32</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">ignore-auto-routes</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">ignore-auto-dns</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">dhcp-client-id</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">dhcp-send-hostname</entry> - <entry align="left">boolean</entry> - <entry align="left">TRUE</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">dhcp-hostname</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>If the 'dhcp-send-hostname' property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.</entry> - </row> - <row> - <entry align="left">never-default</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, this connection will never be the default IPv4 connection, meaning it will never be assigned the default route by NetworkManager.</entry> - </row> - <row> - <entry align="left">may-fail</entry> - <entry align="left">boolean</entry> - <entry align="left">TRUE</entry> - <entry>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.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>ipv6 setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">ipv6</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">method</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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 'ignored' is specified, IPv6 configuration is not done. This property must be set. NOTE: the 'shared' methodis not yet supported.</entry> - </row> - <row> - <entry align="left">dhcp-hostname</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The specified name will be sent to the DHCP server when acquiring a lease.</entry> - </row> - <row> - <entry align="left">dns</entry> - <entry align="left">array of byte array</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">dns-search</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">addresses</entry> - <entry align="left">array of (byte array, uint32, byte array)</entry> - <entry align="left">[]</entry> - <entry>Array of IPv6 address structures. Each IPv6 address structure is composed of 3 members, the first being a byte array containing the IPv6 address (network byte order), the second a 32-bit integer containing the IPv6 address prefix, and the third a byte array containing the IPv6 address (network byte order) of the gateway associated with this address, if any. If no gateway is given, the third element should be given as all zeros. For the '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.</entry> - </row> - <row> - <entry align="left">routes</entry> - <entry align="left">array of (byte array, uint32, byte array, uint32)</entry> - <entry align="left">[]</entry> - <entry>Array of IPv6 route structures. Each IPv6 route structure is composed of 4 members; the first being the destination IPv6 network or address (network byte order) as a byte array, the second the destination network or address IPv6 prefix, the third being the next-hop IPv6 address (network byte order) if any, and the fourth being the route metric. For the '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.</entry> - </row> - <row> - <entry align="left">ignore-auto-routes</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">ignore-auto-dns</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">never-default</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, this connection will never be the default IPv6 connection, meaning it will never be assigned the default IPv6 route by NetworkManager.</entry> - </row> - <row> - <entry align="left">may-fail</entry> - <entry align="left">boolean</entry> - <entry align="left">TRUE</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">ip6-privacy</entry> - <entry align="left">int32</entry> - <entry align="left">-1</entry> - <entry>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).</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>802-11-olpc-mesh setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">802-11-olpc-mesh</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">ssid</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>SSID of the mesh network to join.</entry> - </row> - <row> - <entry align="left">channel</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Channel on which the mesh network to join is located.</entry> - </row> - <row> - <entry align="left">dhcp-anycast-address</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>ppp setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">ppp</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">noauth</entry> - <entry align="left">boolean</entry> - <entry align="left">TRUE</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">refuse-eap</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, the EAP authentication method will not be used.</entry> - </row> - <row> - <entry align="left">refuse-pap</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, the PAP authentication method will not be used.</entry> - </row> - <row> - <entry align="left">refuse-chap</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, the CHAP authentication method will not be used.</entry> - </row> - <row> - <entry align="left">refuse-mschap</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, the MSCHAP authentication method will not be used.</entry> - </row> - <row> - <entry align="left">refuse-mschapv2</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, the MSCHAPv2 authentication method will not be used.</entry> - </row> - <row> - <entry align="left">nobsdcomp</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, BSD compression will not be requested.</entry> - </row> - <row> - <entry align="left">nodeflate</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, 'deflate' compression will not be requested.</entry> - </row> - <row> - <entry align="left">no-vj-comp</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, Van Jacobsen TCP header compression will not be requested.</entry> - </row> - <row> - <entry align="left">require-mppe</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">require-mppe-128</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">mppe-stateful</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</entry> - </row> - <row> - <entry align="left">crtscts</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">baud</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">mru</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">mtu</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, instruct pppd to send packets no larger than the specified size.</entry> - </row> - <row> - <entry align="left">lcp-echo-failure</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">lcp-echo-interval</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>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.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>pppoe setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">pppoe</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">service</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified serivce. 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.</entry> - </row> - <row> - <entry align="left">username</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Username used to authenticate with the PPPoE service.</entry> - </row> - <row> - <entry align="left">password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Password used to authenticate with the PPPoE service.</entry> - </row> - <row> - <entry align="left">password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the PPPoE password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>serial setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">serial</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">baud</entry> - <entry align="left">uint32</entry> - <entry align="left">57600</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">bits</entry> - <entry align="left">uint32</entry> - <entry align="left">8</entry> - <entry>Byte-width of the serial communication. The 8 in '8n1' for example.</entry> - </row> - <row> - <entry align="left">parity</entry> - <entry align="left">gchar</entry> - <entry align="left">110</entry> - <entry>Parity setting of the serial port. Either 'E' for even parity, 'o' for odd parity, or 'n' for no parity.</entry> - </row> - <row> - <entry align="left">stopbits</entry> - <entry align="left">uint32</entry> - <entry align="left">1</entry> - <entry>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in '8n1' for example.</entry> - </row> - <row> - <entry align="left">send-delay</entry> - <entry align="left">uint64</entry> - <entry align="left">0</entry> - <entry>Time to delay between each byte sent to the modem, in microseconds.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>vlan setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">vlan</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">interface-name</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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 a hardware address property, eg the 'wired' settings' 'mac-address' property.</entry> - </row> - <row> - <entry align="left">parent</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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 hardware address in a hardware-specific setting, like the 'wired' settings' 'mac-address' property.</entry> - </row> - <row> - <entry align="left">id</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>The VLAN indentifier the interface created by this connection should be assigned.</entry> - </row> - <row> - <entry align="left">flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>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).</entry> - </row> - <row> - <entry align="left">ingress-priority-map</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>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'.</entry> - </row> - <row> - <entry align="left">egress-priority-map</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>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'.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>vpn setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">vpn</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">service-type</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">user-name</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">data</entry> - <entry align="left">dict of (string::string)</entry> - <entry align="left">[ ]</entry> - <entry>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</entry> - </row> - <row> - <entry align="left">secrets</entry> - <entry align="left">dict of (string::string)</entry> - <entry align="left">[ ]</entry> - <entry>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>wimax setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">wimax</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">network-name</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>Network Service Provider (NSP) name of the WiMAX network this connection should use.</entry> - </row> - <row> - <entry align="left">mac-address</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>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).</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>802-3-ethernet setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">802-3-ethernet</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">port</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">speed</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, request that the device use only the specified speed. In Mbit/s, ie 100 == 100Mbit/s.</entry> - </row> - <row> - <entry align="left">duplex</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>If specified, request that the device only use the specified duplex mode. Either 'half' or 'full'.</entry> - </row> - <row> - <entry align="left">auto-negotiate</entry> - <entry align="left">boolean</entry> - <entry align="left">TRUE</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">mac-address</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>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).</entry> - </row> - <row> - <entry align="left">cloned-mac-address</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>If specified, request that the device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</entry> - </row> - <row> - <entry align="left">mac-address-blacklist</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>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).</entry> - </row> - <row> - <entry align="left">mtu</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry> - </row> - <row> - <entry align="left">s390-subchannels</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">s390-nettype</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>s390 network device type; one of 'qeth', 'lcs', or 'ctc', representing the different types of virtual network devices available on s390 systems.</entry> - </row> - <row> - <entry align="left">s390-options</entry> - <entry align="left">dict of (string::string)</entry> - <entry align="left">[ ]</entry> - <entry>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.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>802-11-wireless setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">802-11-wireless</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">ssid</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>SSID of the WiFi network. Must be specified.</entry> - </row> - <row> - <entry align="left">mode</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>WiFi network mode; one of 'infrastructure', 'adhoc' or 'ap'. If blank, infrastructure is assumed.</entry> - </row> - <row> - <entry align="left">band</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">channel</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">bssid</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">rate</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">tx-power</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">mac-address</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>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).</entry> - </row> - <row> - <entry align="left">cloned-mac-address</entry> - <entry align="left">byte array</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">mac-address-blacklist</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>If specified, this connection will never apply to the WiFi 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).</entry> - </row> - <row> - <entry align="left">mtu</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry> - </row> - <row> - <entry align="left">seen-bssids</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">security</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">hidden</entry> - <entry align="left">boolean</entry> - <entry align="left">FALSE</entry> - <entry>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.</entry> - </row> - </tbody> - </tgroup> -</table> -<table> - <title>802-11-wireless-security setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <row> - <entry align="left">name</entry> - <entry align="left">string</entry> - <entry align="left">802-11-wireless-security</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">key-mgmt</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">wep-tx-keyidx</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">auth-alg</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">proto</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">pairwise</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>If specified, will only connect to WPA networks that provide the specified pairwise encryption capabilities. Each element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.</entry> - </row> - <row> - <entry align="left">group</entry> - <entry align="left">array of string</entry> - <entry align="left">[]</entry> - <entry>If specified, will only connect to WPA networks that provide the specified group/multicast encryption capabilities. Each element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.</entry> - </row> - <row> - <entry align="left">leap-username</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The login username for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</entry> - </row> - <row> - <entry align="left">wep-key0</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">wep-key1</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">wep-key2</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">wep-key3</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">wep-key-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the WEP keys. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">wep-key-type</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">psk</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>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.</entry> - </row> - <row> - <entry align="left">psk-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the WPA PSK key. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - <row> - <entry align="left">leap-password</entry> - <entry align="left">string</entry> - <entry align="left"></entry> - <entry>The login password for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</entry> - </row> - <row> - <entry align="left">leap-password-flags</entry> - <entry align="left">uint32</entry> - <entry align="left">0</entry> - <entry>Flags indicating how to handle the LEAP password. (see <xref linkend="secrets-flags"/> for flag values)</entry> - </row> - </tbody> - </tgroup> -</table> - </para> - <refsect2 id="secrets-flags"> - <title>Secret flag types:</title> - <para> - Each secret property in a setting has an associated <emphasis>flags</emphasis> property - that describes how to handle that secret. The <emphasis>flags</emphasis> property is a bitfield - that contains zero or more of the following values logically OR-ed together. - </para> - <itemizedlist> - <listitem> - <para>0x0 (none) - the system is responsible for providing and storing this secret.</para> - </listitem> - <listitem> - <para>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.</para> - </listitem> - <listitem> - <para>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.</para> - </listitem> - <listitem> - <para>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.</para> - </listitem> - </itemizedlist> - </refsect2> - </refsect1> - <refsect1> - <title>AUTHOR</title> - <para> - <author> - <firstname>NetworkManager developers</firstname> - </author> - </para> - </refsect1> - <refsect1> - <title>FILES</title> - <para>/etc/NetworkManager/system-connections</para> - <para>or distro plugin-specific location</para> - </refsect1> - <refsect1> - <title>SEE ALSO</title> - <para>https://live.gnome.org/NetworkManagerConfiguration</para> - <para>NetworkManager(8), nmcli(1), NetworkManager.conf(5)</para> - </refsect1> -</refentry> |