diff options
Diffstat (limited to 'docs/api/settings-spec.xml')
| -rw-r--r-- | docs/api/settings-spec.xml | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/api/settings-spec.xml b/docs/api/settings-spec.xml index 88502796..fed4f093 100644 --- a/docs/api/settings-spec.xml +++ b/docs/api/settings-spec.xml @@ -2,7 +2,7 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> <chapter><title>Configuration Settings</title><refentry id="settings-connection"><refnamediv><refname>connection</refname><refpurpose>General Connection Profile Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-connection.properties"> Properties - </title><para><table><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><screen>auth-retries<indexterm zone="settings-connection"><primary sortas="auth-retries">auth-retries</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection. Currently, this only applies to 802-1x authentication.</entry></row><row><entry><screen>autoconnect<indexterm zone="settings-connection"><primary sortas="autoconnect">autoconnect</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection. Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.</entry></row><row><entry><screen>autoconnect-priority<indexterm zone="settings-connection"><primary sortas="autoconnect-priority">autoconnect-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>The autoconnect priority. If the connection is set to autoconnect, connections with higher priority will be preferred. Defaults to 0. The higher number means higher priority.</entry></row><row><entry><screen>autoconnect-retries<indexterm zone="settings-connection"><primary sortas="autoconnect-retries">autoconnect-retries</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.</entry></row><row><entry><screen>autoconnect-slaves<indexterm zone="settings-connection"><primary sortas="autoconnect-slaves">autoconnect-slaves</primary></indexterm></screen></entry><entry><screen>NMSettingConnectionAutoconnectSlaves (int32)</screen></entry><entry><screen/></entry><entry>Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.</entry></row><row><entry><screen>gateway-ping-timeout<indexterm zone="settings-connection"><primary sortas="gateway-ping-timeout">gateway-ping-timeout</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</entry></row><row><entry><screen>id<indexterm zone="settings-connection"><primary sortas="id">id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</entry></row><row><entry><screen>interface-name<indexterm zone="settings-connection"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). For software devices this specifies the name of the created device. For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.</entry></row><row><entry><screen>lldp<indexterm zone="settings-connection"><primary sortas="lldp">lldp</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Whether LLDP is enabled for the connection.</entry></row><row><entry><screen>llmnr<indexterm zone="settings-connection"><primary sortas="llmnr">llmnr</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link. The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes"). This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</entry></row><row><entry><screen>master<indexterm zone="settings-connection"><primary sortas="master">master</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Interface name of the master device or UUID of the master connection.</entry></row><row><entry><screen>mdns<indexterm zone="settings-connection"><primary sortas="mdns">mdns</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Whether mDNS is enabled for the connection. The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no"). This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</entry></row><row><entry><screen>metered<indexterm zone="settings-connection"><primary sortas="metered">metered</primary></indexterm></screen></entry><entry><screen>NMMetered (int32)</screen></entry><entry><screen/></entry><entry>Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.</entry></row><row><entry><screen>mud-url<indexterm zone="settings-connection"><primary sortas="mud-url">mud-url</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://". The special value "none" is allowed to indicate that no MUD URL is used. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".</entry></row><row><entry><screen>multi-connect<indexterm zone="settings-connection"><primary sortas="multi-connect">multi-connect</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</entry></row><row><entry><screen>permissions<indexterm zone="settings-connection"><primary sortas="permissions">permissions</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></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 users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</entry></row><row><entry><screen>read-only<indexterm zone="settings-connection"><primary sortas="read-only">read-only</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>FALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.</entry></row><row><entry><screen>secondaries<indexterm zone="settings-connection"><primary sortas="secondaries">secondaries</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</entry></row><row><entry><screen>slave-type<indexterm zone="settings-connection"><primary sortas="slave-type">slave-type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</entry></row><row><entry><screen>stable-id<indexterm zone="settings-connection"><primary sortas="stable-id">stable-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context. The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used as DHCP client identifier with ipv4.dhcp-client-id=stable and to derive the DHCP DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid]. Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret-key. The '$' character is treated special to perform dynamic substitutions at runtime. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. Note that "${DEVICE}" corresponds to the interface name of the device and "${MAC}" is the permanent MAC address of the device. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates. If the value is unset, a global connection default is consulted. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection.</entry></row><row><entry><screen>timestamp<indexterm zone="settings-connection"><primary sortas="timestamp">timestamp</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>0</screen></entry><entry>The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).</entry></row><row><entry><screen>type<indexterm zone="settings-connection"><primary sortas="type">type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></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><screen>uuid<indexterm zone="settings-connection"><primary sortas="uuid">uuid</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").</entry></row><row><entry><screen>wait-device-timeout<indexterm zone="settings-connection"><primary sortas="wait-device-timeout">wait-device-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed. The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</entry></row><row><entry><screen>zone<indexterm zone="settings-connection"><primary sortas="zone">zone</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></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. When updating this property on a currently activated connection, the change takes effect immediately.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-6lowpan"><refnamediv><refname>6lowpan</refname><refpurpose>6LoWPAN Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-6lowpan.properties"> + </title><para><table><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><screen>auth-retries<indexterm zone="settings-connection"><primary sortas="auth-retries">auth-retries</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection. Currently, this only applies to 802-1x authentication.</entry></row><row><entry><screen>autoconnect<indexterm zone="settings-connection"><primary sortas="autoconnect">autoconnect</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection. Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile. Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.</entry></row><row><entry><screen>autoconnect-priority<indexterm zone="settings-connection"><primary sortas="autoconnect-priority">autoconnect-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.</entry></row><row><entry><screen>autoconnect-retries<indexterm zone="settings-connection"><primary sortas="autoconnect-retries">autoconnect-retries</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.</entry></row><row><entry><screen>autoconnect-slaves<indexterm zone="settings-connection"><primary sortas="autoconnect-slaves">autoconnect-slaves</primary></indexterm></screen></entry><entry><screen>NMSettingConnectionAutoconnectSlaves (int32)</screen></entry><entry><screen/></entry><entry>Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.</entry></row><row><entry><screen>dns-over-tls<indexterm zone="settings-connection"><primary sortas="dns-over-tls">dns-over-tls</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic. The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting. This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</entry></row><row><entry><screen>gateway-ping-timeout<indexterm zone="settings-connection"><primary sortas="gateway-ping-timeout">gateway-ping-timeout</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</entry></row><row><entry><screen>id<indexterm zone="settings-connection"><primary sortas="id">id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</entry></row><row><entry><screen>interface-name<indexterm zone="settings-connection"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). For software devices this specifies the name of the created device. For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.</entry></row><row><entry><screen>lldp<indexterm zone="settings-connection"><primary sortas="lldp">lldp</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Whether LLDP is enabled for the connection.</entry></row><row><entry><screen>llmnr<indexterm zone="settings-connection"><primary sortas="llmnr">llmnr</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link. The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes"). This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</entry></row><row><entry><screen>master<indexterm zone="settings-connection"><primary sortas="master">master</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Interface name of the master device or UUID of the master connection.</entry></row><row><entry><screen>mdns<indexterm zone="settings-connection"><primary sortas="mdns">mdns</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Whether mDNS is enabled for the connection. The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no"). This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</entry></row><row><entry><screen>metered<indexterm zone="settings-connection"><primary sortas="metered">metered</primary></indexterm></screen></entry><entry><screen>NMMetered (int32)</screen></entry><entry><screen/></entry><entry>Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.</entry></row><row><entry><screen>mud-url<indexterm zone="settings-connection"><primary sortas="mud-url">mud-url</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://". The special value "none" is allowed to indicate that no MUD URL is used. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".</entry></row><row><entry><screen>multi-connect<indexterm zone="settings-connection"><primary sortas="multi-connect">multi-connect</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</entry></row><row><entry><screen>permissions<indexterm zone="settings-connection"><primary sortas="permissions">permissions</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></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 users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</entry></row><row><entry><screen>read-only<indexterm zone="settings-connection"><primary sortas="read-only">read-only</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>FALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.</entry></row><row><entry><screen>secondaries<indexterm zone="settings-connection"><primary sortas="secondaries">secondaries</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</entry></row><row><entry><screen>slave-type<indexterm zone="settings-connection"><primary sortas="slave-type">slave-type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</entry></row><row><entry><screen>stable-id<indexterm zone="settings-connection"><primary sortas="stable-id">stable-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context. The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used as DHCP client identifier with ipv4.dhcp-client-id=stable and to derive the DHCP DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid]. Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret-key. The '$' character is treated special to perform dynamic substitutions at runtime. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. Note that "${DEVICE}" corresponds to the interface name of the device and "${MAC}" is the permanent MAC address of the device. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates. If the value is unset, a global connection default is consulted. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection.</entry></row><row><entry><screen>timestamp<indexterm zone="settings-connection"><primary sortas="timestamp">timestamp</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>0</screen></entry><entry>The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).</entry></row><row><entry><screen>type<indexterm zone="settings-connection"><primary sortas="type">type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></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><screen>uuid<indexterm zone="settings-connection"><primary sortas="uuid">uuid</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").</entry></row><row><entry><screen>wait-device-timeout<indexterm zone="settings-connection"><primary sortas="wait-device-timeout">wait-device-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed. The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</entry></row><row><entry><screen>zone<indexterm zone="settings-connection"><primary sortas="zone">zone</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></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. When updating this property on a currently activated connection, the change takes effect immediately.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-6lowpan"><refnamediv><refname>6lowpan</refname><refpurpose>6LoWPAN Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-6lowpan.properties"> Properties </title><para><table><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><screen>parent<indexterm zone="settings-6lowpan"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-1x"><refnamediv><refname>802-1x</refname><refpurpose>IEEE 802.1x Authentication Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-1x.properties"> Properties @@ -20,7 +20,7 @@ Properties </title><para><table><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><screen>mtu<indexterm zone="settings-cdma"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>number<indexterm zone="settings-cdma"><primary sortas="number">number</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.</entry></row><row><entry><screen>password<indexterm zone="settings-cdma"><primary sortas="password">password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.</entry></row><row><entry><screen>password-flags<indexterm zone="settings-cdma"><primary sortas="password-flags">password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry><screen>username<indexterm zone="settings-cdma"><primary sortas="username">username</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-dcb"><refnamediv><refname>dcb</refname><refpurpose>Data Center Bridging Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-dcb.properties"> Properties - </title><para><table><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><screen>app-fcoe-flags<indexterm zone="settings-dcb"><primary sortas="app-fcoe-flags">app-fcoe-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>app-fcoe-mode<indexterm zone="settings-dcb"><primary sortas="app-fcoe-mode">app-fcoe-mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen>"fabric"</screen></entry><entry>The FCoE controller mode; either "fabric" (default) or "vn2vn".</entry></row><row><entry><screen>app-fcoe-priority<indexterm zone="settings-dcb"><primary sortas="app-fcoe-priority">app-fcoe-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry><screen>app-fip-flags<indexterm zone="settings-dcb"><primary sortas="app-fip-flags">app-fip-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>app-fip-priority<indexterm zone="settings-dcb"><primary sortas="app-fip-priority">app-fip-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry><screen>app-iscsi-flags<indexterm zone="settings-dcb"><primary sortas="app-iscsi-flags">app-iscsi-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>app-iscsi-priority<indexterm zone="settings-dcb"><primary sortas="app-iscsi-priority">app-iscsi-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry><screen>priority-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-bandwidth">priority-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>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 percents.</entry></row><row><entry><screen>priority-flow-control<indexterm zone="settings-dcb"><primary sortas="priority-flow-control">priority-flow-control</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.</entry></row><row><entry><screen>priority-flow-control-flags<indexterm zone="settings-dcb"><primary sortas="priority-flow-control-flags">priority-flow-control-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>priority-group-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-group-bandwidth">priority-group-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>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 percents.</entry></row><row><entry><screen>priority-group-flags<indexterm zone="settings-dcb"><primary sortas="priority-group-flags">priority-group-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>priority-group-id<indexterm zone="settings-dcb"><primary sortas="priority-group-id">priority-group-id</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>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.</entry></row><row><entry><screen>priority-strict-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-strict-bandwidth">priority-strict-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.</entry></row><row><entry><screen>priority-traffic-class<indexterm zone="settings-dcb"><primary sortas="priority-traffic-class">priority-traffic-class</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>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.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-dummy"><refnamediv><refname>dummy</refname><refpurpose>Dummy Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-dummy.properties"> + </title><para><table><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><screen>app-fcoe-flags<indexterm zone="settings-dcb"><primary sortas="app-fcoe-flags">app-fcoe-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>app-fcoe-mode<indexterm zone="settings-dcb"><primary sortas="app-fcoe-mode">app-fcoe-mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The FCoE controller mode; either "fabric" or "vn2vn". Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".</entry></row><row><entry><screen>app-fcoe-priority<indexterm zone="settings-dcb"><primary sortas="app-fcoe-priority">app-fcoe-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry><screen>app-fip-flags<indexterm zone="settings-dcb"><primary sortas="app-fip-flags">app-fip-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>app-fip-priority<indexterm zone="settings-dcb"><primary sortas="app-fip-priority">app-fip-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry><screen>app-iscsi-flags<indexterm zone="settings-dcb"><primary sortas="app-iscsi-flags">app-iscsi-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>app-iscsi-priority<indexterm zone="settings-dcb"><primary sortas="app-iscsi-priority">app-iscsi-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry><screen>priority-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-bandwidth">priority-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>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 percents.</entry></row><row><entry><screen>priority-flow-control<indexterm zone="settings-dcb"><primary sortas="priority-flow-control">priority-flow-control</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.</entry></row><row><entry><screen>priority-flow-control-flags<indexterm zone="settings-dcb"><primary sortas="priority-flow-control-flags">priority-flow-control-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>priority-group-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-group-bandwidth">priority-group-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>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 percents.</entry></row><row><entry><screen>priority-group-flags<indexterm zone="settings-dcb"><primary sortas="priority-group-flags">priority-group-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>priority-group-id<indexterm zone="settings-dcb"><primary sortas="priority-group-id">priority-group-id</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>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.</entry></row><row><entry><screen>priority-strict-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-strict-bandwidth">priority-strict-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.</entry></row><row><entry><screen>priority-traffic-class<indexterm zone="settings-dcb"><primary sortas="priority-traffic-class">priority-traffic-class</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>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.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-dummy"><refnamediv><refname>dummy</refname><refpurpose>Dummy Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-dummy.properties"> Properties </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody/></tgroup></table></para></refsect1></refentry><refentry id="settings-ethtool"><refnamediv><refname>ethtool</refname><refpurpose>Ethtool Ethernet Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ethtool.properties"> Properties @@ -88,7 +88,7 @@ Properties </title><para><table><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><screen>mac-address<indexterm zone="settings-wimax"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></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). Deprecated: 1</entry></row><row><entry><screen>network-name<indexterm zone="settings-wimax"><primary sortas="network-name">network-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-3-ethernet"><refnamediv><refname>802-3-ethernet</refname><refpurpose>Wired Ethernet Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-3-ethernet.properties"> Properties - </title><para><table><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><screen>accept-all-mac-addresses<indexterm zone="settings-802-3-ethernet"><primary sortas="accept-all-mac-addresses">accept-all-mac-addresses</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.</entry></row><row><entry><screen>assigned-mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="assigned-mac-address">assigned-mac-address</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".</entry></row><row><entry><screen>auto-negotiate<indexterm zone="settings-802-3-ethernet"><primary sortas="auto-negotiate">auto-negotiate</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.</entry></row><row><entry><screen>cloned-mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="cloned-mac-address">cloned-mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".</entry></row><row><entry><screen>duplex<indexterm zone="settings-802-3-ethernet"><primary sortas="duplex">duplex</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.</entry></row><row><entry><screen>generate-mac-address-mask<indexterm zone="settings-802-3-ethernet"><primary sortas="generate-mac-address-mask">generate-mac-address-mask</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</entry></row><row><entry><screen>mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></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><screen>mac-address-blacklist<indexterm zone="settings-802-3-ethernet"><primary sortas="mac-address-blacklist">mac-address-blacklist</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></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><screen>mtu<indexterm zone="settings-802-3-ethernet"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>port<indexterm zone="settings-802-3-ethernet"><primary sortas="port">port</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Specific port type to use if 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><screen>s390-nettype<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-nettype">s390-nettype</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></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><screen>s390-options<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-options">s390-options</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></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. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</entry></row><row><entry><screen>s390-subchannels<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-subchannels">s390-subchannels</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</entry></row><row><entry><screen>speed<indexterm zone="settings-802-3-ethernet"><primary sortas="speed">speed</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.</entry></row><row><entry><screen>wake-on-lan<indexterm zone="settings-802-3-ethernet"><primary sortas="wake-on-lan">wake-on-lan</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry>The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</entry></row><row><entry><screen>wake-on-lan-password<indexterm zone="settings-802-3-ethernet"><primary sortas="wake-on-lan-password">wake-on-lan-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-wireguard"><refnamediv><refname>wireguard</refname><refpurpose>WireGuard Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wireguard.properties"> + </title><para><table><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><screen>accept-all-mac-addresses<indexterm zone="settings-802-3-ethernet"><primary sortas="accept-all-mac-addresses">accept-all-mac-addresses</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.</entry></row><row><entry><screen>assigned-mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="assigned-mac-address">assigned-mac-address</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".</entry></row><row><entry><screen>auto-negotiate<indexterm zone="settings-802-3-ethernet"><primary sortas="auto-negotiate">auto-negotiate</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.</entry></row><row><entry><screen>cloned-mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="cloned-mac-address">cloned-mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".</entry></row><row><entry><screen>duplex<indexterm zone="settings-802-3-ethernet"><primary sortas="duplex">duplex</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.</entry></row><row><entry><screen>generate-mac-address-mask<indexterm zone="settings-802-3-ethernet"><primary sortas="generate-mac-address-mask">generate-mac-address-mask</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</entry></row><row><entry><screen>mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></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><screen>mac-address-blacklist<indexterm zone="settings-802-3-ethernet"><primary sortas="mac-address-blacklist">mac-address-blacklist</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></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><screen>mtu<indexterm zone="settings-802-3-ethernet"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>port<indexterm zone="settings-802-3-ethernet"><primary sortas="port">port</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Specific port type to use if 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><screen>s390-nettype<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-nettype">s390-nettype</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></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><screen>s390-options<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-options">s390-options</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></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. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.</entry></row><row><entry><screen>s390-subchannels<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-subchannels">s390-subchannels</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</entry></row><row><entry><screen>speed<indexterm zone="settings-802-3-ethernet"><primary sortas="speed">speed</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.</entry></row><row><entry><screen>wake-on-lan<indexterm zone="settings-802-3-ethernet"><primary sortas="wake-on-lan">wake-on-lan</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry>The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</entry></row><row><entry><screen>wake-on-lan-password<indexterm zone="settings-802-3-ethernet"><primary sortas="wake-on-lan-password">wake-on-lan-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-wireguard"><refnamediv><refname>wireguard</refname><refpurpose>WireGuard Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wireguard.properties"> Properties </title><para><table><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><screen>fwmark<indexterm zone="settings-wireguard"><primary sortas="fwmark">fwmark</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets. Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.</entry></row><row><entry><screen>ip4-auto-default-route<indexterm zone="settings-wireguard"><primary sortas="ip4-auto-default-route">ip4-auto-default-route</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing". Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route. Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips.</entry></row><row><entry><screen>ip6-auto-default-route<indexterm zone="settings-wireguard"><primary sortas="ip6-auto-default-route">ip6-auto-default-route</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>Like ip4-auto-default-route, but for the IPv6 default route.</entry></row><row><entry><screen>listen-port<indexterm zone="settings-wireguard"><primary sortas="listen-port">listen-port</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</entry></row><row><entry><screen>mtu<indexterm zone="settings-wireguard"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.</entry></row><row><entry><screen>peer-routes<indexterm zone="settings-wireguard"><primary sortas="peer-routes">peer-routes</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Whether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively. Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.</entry></row><row><entry><screen>peers<indexterm zone="settings-wireguard"><primary sortas="peers">peers</primary></indexterm></screen></entry><entry><screen>array of 'a{sv}'</screen></entry><entry><screen/></entry><entry>Array of dictionaries for the WireGuard peers.</entry></row><row><entry><screen>private-key<indexterm zone="settings-wireguard"><primary sortas="private-key">private-key</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The 256 bit private-key in base64 encoding.</entry></row><row><entry><screen>private-key-flags<indexterm zone="settings-wireguard"><primary sortas="private-key-flags">private-key-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "private-key" property.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-11-wireless"><refnamediv><refname>802-11-wireless</refname><refpurpose>Wi-Fi Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-11-wireless.properties"> Properties @@ -96,7 +96,9 @@ Properties </title><para><table><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><screen>auth-alg<indexterm zone="settings-802-11-wireless-security"><primary sortas="auth-alg">auth-alg</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></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><screen>fils<indexterm zone="settings-802-11-wireless-security"><primary sortas="fils">fils</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled.</entry></row><row><entry><screen>group<indexterm zone="settings-802-11-wireless-security"><primary sortas="group">group</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>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".</entry></row><row><entry><screen>key-mgmt<indexterm zone="settings-802-11-wireless-security"><primary sortas="key-mgmt">key-mgmt</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only). This property must be set for any Wi-Fi connection that uses security.</entry></row><row><entry><screen>leap-password<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-password">leap-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row><row><entry><screen>leap-password-flags<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-password-flags">leap-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "leap-password" property.</entry></row><row><entry><screen>leap-username<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-username">leap-username</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row><row><entry><screen>pairwise<indexterm zone="settings-802-11-wireless-security"><primary sortas="pairwise">pairwise</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>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".</entry></row><row><entry><screen>pmf<indexterm zone="settings-802-11-wireless-security"><primary sortas="pmf">pmf</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled.</entry></row><row><entry><screen>proto<indexterm zone="settings-802-11-wireless-security"><primary sortas="proto">proto</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></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><screen>psk<indexterm zone="settings-802-11-wireless-security"><primary sortas="psk">psk</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.</entry></row><row><entry><screen>psk-flags<indexterm zone="settings-802-11-wireless-security"><primary sortas="psk-flags">psk-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "psk" property.</entry></row><row><entry><screen>wep-key-flags<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key-flags">wep-key-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</entry></row><row><entry><screen>wep-key-type<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key-type">wep-key-type</primary></indexterm></screen></entry><entry><screen>NMWepKeyType (uint32)</screen></entry><entry><screen/></entry><entry>Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.</entry></row><row><entry><screen>wep-key0<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key0">wep-key0</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></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><screen>wep-key1<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key1">wep-key1</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></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><screen>wep-key2<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key2">wep-key2</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></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><screen>wep-key3<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key3">wep-key3</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></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><screen>wep-tx-keyidx<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-tx-keyidx">wep-tx-keyidx</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>wps-method<indexterm zone="settings-802-11-wireless-security"><primary sortas="wps-method">wps-method</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Flags indicating which mode of WPS is to be used if any. There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities. WPS can be disabled by setting this property to a value of 1.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-wpan"><refnamediv><refname>wpan</refname><refpurpose>IEEE 802.15.4 (WPAN) MAC Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wpan.properties"> Properties - </title><para><table><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><screen>channel<indexterm zone="settings-wpan"><primary sortas="channel">channel</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</entry></row><row><entry><screen>mac-address<indexterm zone="settings-wpan"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.</entry></row><row><entry><screen>page<indexterm zone="settings-wpan"><primary sortas="page">page</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</entry></row><row><entry><screen>pan-id<indexterm zone="settings-wpan"><primary sortas="pan-id">pan-id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>65535</screen></entry><entry>IEEE 802.15.4 Personal Area Network (PAN) identifier.</entry></row><row><entry><screen>short-address<indexterm zone="settings-wpan"><primary sortas="short-address">short-address</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>65535</screen></entry><entry>Short IEEE 802.15.4 address to be used within a restricted environment.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-hostname"><refnamediv><refname>hostname</refname><refpurpose>Hostname settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-hostname.properties"> + </title><para><table><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><screen>channel<indexterm zone="settings-wpan"><primary sortas="channel">channel</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</entry></row><row><entry><screen>mac-address<indexterm zone="settings-wpan"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.</entry></row><row><entry><screen>page<indexterm zone="settings-wpan"><primary sortas="page">page</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</entry></row><row><entry><screen>pan-id<indexterm zone="settings-wpan"><primary sortas="pan-id">pan-id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>65535</screen></entry><entry>IEEE 802.15.4 Personal Area Network (PAN) identifier.</entry></row><row><entry><screen>short-address<indexterm zone="settings-wpan"><primary sortas="short-address">short-address</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>65535</screen></entry><entry>Short IEEE 802.15.4 address to be used within a restricted environment.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-bond-port"><refnamediv><refname>bond-port</refname><refpurpose>Bond Port Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-bond-port.properties"> + Properties + </title><para><table><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><screen>queue-id<indexterm zone="settings-bond-port"><primary sortas="queue-id">queue-id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-hostname"><refnamediv><refname>hostname</refname><refpurpose>Hostname settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-hostname.properties"> Properties </title><para><table><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><screen>from-dhcp<indexterm zone="settings-hostname"><primary sortas="from-dhcp">from-dhcp</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>Whether the system hostname can be determined from DHCP on this connection. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).</entry></row><row><entry><screen>from-dns-lookup<indexterm zone="settings-hostname"><primary sortas="from-dns-lookup">from-dns-lookup</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>Whether the system hostname can be determined from reverse DNS lookup of addresses on this device. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).</entry></row><row><entry><screen>only-from-default<indexterm zone="settings-hostname"><primary sortas="only-from-default">only-from-default</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>If set to NM_TERNARY_TRUE (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6). If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route. When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0).</entry></row><row><entry><screen>priority<indexterm zone="settings-hostname"><primary sortas="priority">priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority. If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100. Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ovs-external-ids"><refnamediv><refname>ovs-external-ids</refname><refpurpose>OVS External IDs Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-external-ids.properties"> Properties |