diff options
Diffstat (limited to 'docs/api/settings-spec.xml')
| -rw-r--r-- | docs/api/settings-spec.xml | 31 |
1 files changed, 22 insertions, 9 deletions
diff --git a/docs/api/settings-spec.xml b/docs/api/settings-spec.xml index 743e5a81..28dd913b 100644 --- a/docs/api/settings-spec.xml +++ b/docs/api/settings-spec.xml @@ -47,7 +47,8 @@ <row><entry><screen>client-cert<indexterm zone="settings-802-1x"><primary sortas="client-cert">client-cert</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>Contains the client certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.</entry></row> <row><entry><screen>client-cert-password<indexterm zone="settings-802-1x"><primary sortas="client-cert-password">client-cert-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</entry></row> <row><entry><screen>client-cert-password-flags<indexterm zone="settings-802-1x"><primary sortas="client-cert-password-flags">client-cert-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "client-cert-password" property.</entry></row> - <row><entry><screen>domain-suffix-match<indexterm zone="settings-802-1x"><primary sortas="domain-suffix-match">domain-suffix-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison.</entry></row> + <row><entry><screen>domain-match<indexterm zone="settings-802-1x"><primary sortas="domain-match">domain-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.</entry></row> + <row><entry><screen>domain-suffix-match<indexterm zone="settings-802-1x"><primary sortas="domain-suffix-match">domain-suffix-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.</entry></row> <row><entry><screen>eap<indexterm zone="settings-802-1x"><primary sortas="eap">eap</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.</entry></row> <row><entry><screen>identity<indexterm zone="settings-802-1x"><primary sortas="identity">identity</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Identity string for EAP authentication methods. Often the user's user or login name.</entry></row> <row><entry><screen>optional<indexterm zone="settings-802-1x"><primary sortas="optional">optional</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Whether the 802.1X authentication is optional. If TRUE, the activation will continue even after a timeout or an authentication failure. Setting the property to TRUE is currently allowed only for Ethernet connections. If set to FALSE, the activation can continue only after a successful authentication.</entry></row> @@ -70,7 +71,8 @@ <row><entry><screen>phase2-client-cert<indexterm zone="settings-802-1x"><primary sortas="phase2-client-cert">phase2-client-cert</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</entry></row> <row><entry><screen>phase2-client-cert-password<indexterm zone="settings-802-1x"><primary sortas="phase2-client-cert-password">phase2-client-cert-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</entry></row> <row><entry><screen>phase2-client-cert-password-flags<indexterm zone="settings-802-1x"><primary sortas="phase2-client-cert-password-flags">phase2-client-cert-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "phase2-client-cert-password" property.</entry></row> - <row><entry><screen>phase2-domain-suffix-match<indexterm zone="settings-802-1x"><primary sortas="phase2-domain-suffix-match">phase2-domain-suffix-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison.</entry></row> + <row><entry><screen>phase2-domain-match<indexterm zone="settings-802-1x"><primary sortas="phase2-domain-match">phase2-domain-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.</entry></row> + <row><entry><screen>phase2-domain-suffix-match<indexterm zone="settings-802-1x"><primary sortas="phase2-domain-suffix-match">phase2-domain-suffix-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.</entry></row> <row><entry><screen>phase2-private-key<indexterm zone="settings-802-1x"><primary sortas="phase2-private-key">phase2-private-key</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</entry></row> <row><entry><screen>phase2-private-key-password<indexterm zone="settings-802-1x"><primary sortas="phase2-private-key-password">phase2-private-key-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.</entry></row> <row><entry><screen>phase2-private-key-password-flags<indexterm zone="settings-802-1x"><primary sortas="phase2-private-key-password-flags">phase2-private-key-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "phase2-private-key-password" property.</entry></row> @@ -111,16 +113,22 @@ </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>ageing-time<indexterm zone="settings-bridge"><primary sortas="ageing-time">ageing-time</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>300</screen></entry><entry>The Ethernet MAC address aging time, in seconds.</entry></row> <row><entry><screen>forward-delay<indexterm zone="settings-bridge"><primary sortas="forward-delay">forward-delay</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>15</screen></entry><entry>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</entry></row> + <row><entry><screen>group-address<indexterm zone="settings-bridge"><primary sortas="group-address">group-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, The MAC address of the multicast group this bridge uses for STP. The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.</entry></row> <row><entry><screen>group-forward-mask<indexterm zone="settings-bridge"><primary sortas="group-forward-mask">group-forward-mask</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.</entry></row> <row><entry><screen>hello-time<indexterm zone="settings-bridge"><primary sortas="hello-time">hello-time</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>2</screen></entry><entry>The Spanning Tree Protocol (STP) hello time, in seconds.</entry></row> <row><entry><screen>interface-name<indexterm zone="settings-bridge"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name.</entry></row> <row><entry><screen>mac-address<indexterm zone="settings-bridge"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. Hence, this property is deprecated. Deprecated: 1</entry></row> <row><entry><screen>max-age<indexterm zone="settings-bridge"><primary sortas="max-age">max-age</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>20</screen></entry><entry>The Spanning Tree Protocol (STP) maximum message age, in seconds.</entry></row> + <row><entry><screen>multicast-querier<indexterm zone="settings-bridge"><primary sortas="multicast-querier">multicast-querier</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</entry></row> + <row><entry><screen>multicast-query-use-ifaddr<indexterm zone="settings-bridge"><primary sortas="multicast-query-use-ifaddr">multicast-query-use-ifaddr</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.</entry></row> + <row><entry><screen>multicast-router<indexterm zone="settings-bridge"><primary sortas="multicast-router">multicast-router</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Sets bridge's multicast router. multicast-snooping must be enabled for this option to work. Supported values are: 'auto', 'disabled', 'enabled'. If not specified the default value is 'auto'.</entry></row> <row><entry><screen>multicast-snooping<indexterm zone="settings-bridge"><primary sortas="multicast-snooping">multicast-snooping</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.</entry></row> <row><entry><screen>priority<indexterm zone="settings-bridge"><primary sortas="priority">priority</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>32768</screen></entry><entry>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</entry></row> <row><entry><screen>stp<indexterm zone="settings-bridge"><primary sortas="stp">stp</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</entry></row> <row><entry><screen>vlan-default-pvid<indexterm zone="settings-bridge"><primary sortas="vlan-default-pvid">vlan-default-pvid</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry>The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.</entry></row> <row><entry><screen>vlan-filtering<indexterm zone="settings-bridge"><primary sortas="vlan-filtering">vlan-filtering</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Control whether VLAN filtering is enabled on the bridge.</entry></row> + <row><entry><screen>vlan-protocol<indexterm zone="settings-bridge"><primary sortas="vlan-protocol">vlan-protocol</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If specified, the protocol used for VLAN filtering. Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</entry></row> + <row><entry><screen>vlan-stats-enabled<indexterm zone="settings-bridge"><primary sortas="vlan-stats-enabled">vlan-stats-enabled</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Controls whether per-VLAN stats accounting is enabled.</entry></row> <row><entry><screen>vlans<indexterm zone="settings-bridge"><primary sortas="vlans">vlans</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property. In nmcli the VLAN list can be specified with the following syntax: $vid [pvid] [untagged] [, $vid [pvid] [untagged]]... where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</entry></row> </tbody></tgroup></table></para></refsect1></refentry> <refentry id="settings-bridge-port"><refnamediv><refname>bridge-port</refname><refpurpose>Bridge Port Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-bridge-port.properties"> @@ -213,7 +221,7 @@ <row><entry><screen>dhcp-timeout<indexterm zone="settings-ipv4"><primary sortas="dhcp-timeout">dhcp-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). Set to 2147483647 (MAXINT32) for infinity.</entry></row> <row><entry><screen>dns<indexterm zone="settings-ipv4"><primary sortas="dns">dns</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>Array of IP addresses of DNS servers (as network-byte-order integers)</entry></row> <row><entry><screen>dns-options<indexterm zone="settings-ipv4"><primary sortas="dns-options">dns-options</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>Array of DNS options as described in man 5 resolv.conf. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.</entry></row> - <row><entry><screen>dns-priority<indexterm zone="settings-ipv4"><primary sortas="dns-priority">dns-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>DNS servers priority. The relative priority for DNS servers specified by this setting. A lower value is better (higher priority). Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. When using a DNS resolver that supports Conditional Forwarding as dns=dnsmasq or dns=systemd-resolved, each connection is used to query domains in its search list. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the highest priority (lowest numerical value) wins. If a connection specifies a domain which is subdomain of another domain with a negative DNS priority value, the subdomain is ignored.</entry></row> + <row><entry><screen>dns-priority<indexterm zone="settings-ipv4"><primary sortas="dns-priority">dns-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>DNS servers priority. The relative priority for DNS servers specified by this setting. A lower value is better (higher priority). Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. When using a DNS resolver that supports Conditional Forwarding as dns=dnsmasq or dns=systemd-resolved, each connection is used to query domains in its search list. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the highest priority (lowest numerical value) wins. If a connection specifies a domain which is subdomain of another domain with a negative DNS priority value, the subdomain is ignored.</entry></row> <row><entry><screen>dns-search<indexterm zone="settings-ipv4"><primary sortas="dns-search">dns-search</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>Array of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.</entry></row> <row><entry><screen>gateway<indexterm zone="settings-ipv4"><primary sortas="gateway">gateway</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</entry></row> <row><entry><screen>ignore-auto-dns<indexterm zone="settings-ipv4"><primary sortas="ignore-auto-dns">ignore-auto-dns</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</entry></row> @@ -241,7 +249,7 @@ <row><entry><screen>dhcp-timeout<indexterm zone="settings-ipv6"><primary sortas="dhcp-timeout">dhcp-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). Set to 2147483647 (MAXINT32) for infinity.</entry></row> <row><entry><screen>dns<indexterm zone="settings-ipv6"><primary sortas="dns">dns</primary></indexterm></screen></entry><entry><screen>array of byte array</screen></entry><entry><screen/></entry><entry>Array of IP addresses of DNS servers (in network byte order)</entry></row> <row><entry><screen>dns-options<indexterm zone="settings-ipv6"><primary sortas="dns-options">dns-options</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>Array of DNS options as described in man 5 resolv.conf. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.</entry></row> - <row><entry><screen>dns-priority<indexterm zone="settings-ipv6"><primary sortas="dns-priority">dns-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>DNS servers priority. The relative priority for DNS servers specified by this setting. A lower value is better (higher priority). Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. When using a DNS resolver that supports Conditional Forwarding as dns=dnsmasq or dns=systemd-resolved, each connection is used to query domains in its search list. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the highest priority (lowest numerical value) wins. If a connection specifies a domain which is subdomain of another domain with a negative DNS priority value, the subdomain is ignored.</entry></row> + <row><entry><screen>dns-priority<indexterm zone="settings-ipv6"><primary sortas="dns-priority">dns-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>DNS servers priority. The relative priority for DNS servers specified by this setting. A lower value is better (higher priority). Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. When using a DNS resolver that supports Conditional Forwarding as dns=dnsmasq or dns=systemd-resolved, each connection is used to query domains in its search list. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the highest priority (lowest numerical value) wins. If a connection specifies a domain which is subdomain of another domain with a negative DNS priority value, the subdomain is ignored.</entry></row> <row><entry><screen>dns-search<indexterm zone="settings-ipv6"><primary sortas="dns-search">dns-search</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>Array of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.</entry></row> <row><entry><screen>gateway<indexterm zone="settings-ipv6"><primary sortas="gateway">gateway</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</entry></row> <row><entry><screen>ignore-auto-dns<indexterm zone="settings-ipv6"><primary sortas="ignore-auto-dns">ignore-auto-dns</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</entry></row> @@ -295,7 +303,7 @@ <row><entry><screen>promiscuous<indexterm zone="settings-macvlan"><primary sortas="promiscuous">promiscuous</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Whether the interface should be put in promiscuous mode.</entry></row> <row><entry><screen>tap<indexterm zone="settings-macvlan"><primary sortas="tap">tap</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Whether the interface should be a MACVTAP.</entry></row> </tbody></tgroup></table></para></refsect1></refentry> - <refentry id="settings-match"><refnamediv><refname>match</refname><refpurpose>Match settings.</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-match.properties"> + <refentry id="settings-match"><refnamediv><refname>match</refname><refpurpose>Match settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-match.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>interface-name<indexterm zone="settings-match"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of interface names to match. Each element is a shell wildcard pattern. When an element is prefixed with exclamation mark (!) the condition is inverted. A candidate interface name is considered matching when both these conditions are satisfied: (a) any of the elements not prefixed with '!' matches or there aren't such elements; (b) none of the elements prefixed with '!' match.</entry></row> @@ -389,14 +397,14 @@ <row><entry><screen>send-delay<indexterm zone="settings-serial"><primary sortas="send-delay">send-delay</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>0</screen></entry><entry>Time to delay between each byte sent to the modem, in microseconds.</entry></row> <row><entry><screen>stopbits<indexterm zone="settings-serial"><primary sortas="stopbits">stopbits</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</entry></row> </tbody></tgroup></table></para></refsect1></refentry> - <refentry id="settings-sriov"><refnamediv><refname>sriov</refname><refpurpose>SR-IOV settings.</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-sriov.properties"> + <refentry id="settings-sriov"><refnamediv><refname>sriov</refname><refpurpose>SR-IOV settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-sriov.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>autoprobe-drivers<indexterm zone="settings-sriov"><primary sortas="autoprobe-drivers">autoprobe-drivers</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>Whether to autoprobe virtual functions by a compatible driver. If set to NM_TERNARY_TRUE (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF. If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them. When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_TRUE (1).</entry></row> - <row><entry><screen>total-vfs<indexterm zone="settings-sriov"><primary sortas="total-vfs">total-vfs</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The total number of virtual functions to create. Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface also when it is zero. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.</entry></row> + <row><entry><screen>total-vfs<indexterm zone="settings-sriov"><primary sortas="total-vfs">total-vfs</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The total number of virtual functions to create. Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.</entry></row> <row><entry><screen>vfs<indexterm zone="settings-sriov"><primary sortas="vfs">vfs</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>Array of virtual function descriptors. Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF. When represented as string a VF is in the form: "INDEX [ATTR=VALUE[ ATTR=VALUE]...]". for example: "2 mac=00:11:22:33:44:55 spoof-check=true". Multiple VFs can be specified using a comma as separator. Currently the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans. The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form "ID[.PRIORITY[.PROTO]]". PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.</entry></row> </tbody></tgroup></table></para></refsect1></refentry> - <refentry id="settings-tc"><refnamediv><refname>tc</refname><refpurpose>Linux Traffic Control Settings.</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-tc.properties"> + <refentry id="settings-tc"><refnamediv><refname>tc</refname><refpurpose>Linux Traffic Control Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-tc.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>qdiscs<indexterm zone="settings-tc"><primary sortas="qdiscs">qdiscs</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>Array of TC queueing disciplines.</entry></row> @@ -469,6 +477,11 @@ <row><entry><screen>timeout<indexterm zone="settings-vpn"><primary sortas="timeout">timeout</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.</entry></row> <row><entry><screen>user-name<indexterm zone="settings-vpn"><primary sortas="user-name">user-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.</entry></row> </tbody></tgroup></table></para></refsect1></refentry> + <refentry id="settings-vrf"><refnamediv><refname>vrf</refname><refpurpose>VRF settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-vrf.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>table<indexterm zone="settings-vrf"><primary sortas="table">table</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The routing table for this VRF.</entry></row> + </tbody></tgroup></table></para></refsect1></refentry> <refentry id="settings-vxlan"><refnamediv><refname>vxlan</refname><refpurpose>VXLAN Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-vxlan.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> @@ -563,7 +576,7 @@ <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), "ieee8021x" (Dynamic WEP), "wpa-psk" (infrastructure WPA-PSK), "sae" (SAE) or "wpa-eap" (WPA-Enterprise). This property must be set for any Wi-Fi connection that uses security.</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), "ieee8021x" (Dynamic WEP), "wpa-psk" (infrastructure WPA-PSK), "sae" (SAE), "owe" (Opportunistic Wireless Encryption) or "wpa-eap" (WPA-Enterprise). 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> |