diff options
Diffstat (limited to 'man')
29 files changed, 3218 insertions, 3496 deletions
diff --git a/man/NetworkManager-dispatcher.8 b/man/NetworkManager-dispatcher.8 index 529bfff8..f56114c2 100644 --- a/man/NetworkManager-dispatcher.8 +++ b/man/NetworkManager-dispatcher.8 @@ -2,9 +2,9 @@ .\" Title: NetworkManager-dispatcher .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: Network management daemons -.\" Source: NetworkManager-dispatcher 1.40.12 +.\" Source: NetworkManager-dispatcher 1.42.4 .\" Language: English .\" .TH "NETWORKMANAGER\-DISPATCHER" "8" "" "NetworkManager\-dispatcher 1\&" "Network management daemons" @@ -118,6 +118,11 @@ The DHCPv6 lease has changed (renewed, rebound, etc)\&. The network connectivity state has changed (no connectivity, went online, etc)\&. .RE .PP +\fIreapply\fR +.RS 4 +The connection was reapplied on the device\&. +.RE +.PP The environment contains more information about the interface and the connection\&. The following variables are available for the use in the dispatcher scripts: .PP \fINM_DISPATCHER_ACTION\fR diff --git a/man/NetworkManager-dispatcher.xml b/man/NetworkManager-dispatcher.xml index 4a603b15..036b3c8d 100644 --- a/man/NetworkManager-dispatcher.xml +++ b/man/NetworkManager-dispatcher.xml @@ -164,6 +164,12 @@ The network connectivity state has changed (no connectivity, went online, etc). </para></listitem> </varlistentry> + <varlistentry> + <term><varname>reapply</varname></term> + <listitem><para> + The connection was reapplied on the device. + </para></listitem> + </varlistentry> </variablelist> <para> The environment contains more information about the interface and the connection. diff --git a/man/NetworkManager-wait-online.service.8 b/man/NetworkManager-wait-online.service.8 index e5a086bb..d1ca0eb6 100644 --- a/man/NetworkManager-wait-online.service.8 +++ b/man/NetworkManager-wait-online.service.8 @@ -2,9 +2,9 @@ .\" Title: NetworkManager-wait-online.service .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: Network management daemons -.\" Source: NetworkManager-wait-online.service 1.40.12 +.\" Source: NetworkManager-wait-online.service 1.42.4 .\" Language: English .\" .TH "NETWORKMANAGER\-WAIT\-ONLINE\&" "8" "" "NetworkManager\-wait\-online\&" "Network management daemons" @@ -28,43 +28,36 @@ .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- .SH "NAME" -NetworkManager-wait-online.service \- Wait for network to come online +NetworkManager-wait-online.service \- Wait for the network to come online .SH "DESCRIPTION" .PP -NetworkManager\-wait\-online\&.service delays network\-online\&.target until network is ready\&. +The +NetworkManager\-wait\-online +service is a +oneshot +systemd service that delays reaching the +network\-online +target until NetworkManager reports that the startup is completed on the D\-Bus\&. .PP -The systemd target -network\-online\&.target -acts as a synchronization point for services to start after network is configured\&. Such services should order themselves +When the system boots, for example, remote mounts defined in +/etc/fstab, require that the network is up\&. For this, these systemd units contain the After=network\-online\&.target -(and never -After=NetworkManager\-wait\-online\&.service)\&. -NetworkManager\-wait\-online\&.service -is a one\-shot service that itself is ordered -Before=network\-online\&.target -and this way delays the target until the network is configured\&. -.PP -NetworkManager\-wait\-online\&.service -itself is almost not configurable itself\&. Instead the connection profiles and configuration in NetworkManager affects the behavior\&. -.PP -In the best case, all services on the system can react to networking changes dynamically and no service orders itself after -network\-online\&.target\&. That way, -NetworkManager\-wait\-online\&.service -has no effect and, for example, does not delay the boot\&. That means, if the problem is a long boot time related to -NetworkManager\-wait\-online\&.service, a possible solution is to investigate the services that claim to require network and fix those\&. +setting to order themselves after this target\&. +NetworkManager\-wait\-online +ensures that the +network\-online +target is reached only after the network is available\&. .PP -For services that require network configured, -NetworkManager\-wait\-online\&.service -is the default implementation provided by NetworkManager to delay the target\&. But it does nothing magical\&. With special requirements, it may be sensible to disable +Optimally, all services on the host react dynamically to network changes and systemd services do not need to be configured to start after reaching the +network\-online +target\&. In this case, NetworkManager\-wait\-online\&.service -and replace it with a similar service that better implements the requirement\&. +has no effect and does not delay the boot time\&. On the other hand, if you encounter a long boot time due to the delay of +NetworkManager\-wait\-online, investigate the services that require network access and fix them\&. .PP +Except for the time out value in the NetworkManager\-wait\-online\&.service -blocks until NetworkManager logs "startup complete" and announces startup complete on D\-Bus\&. How long that takes depends on the network and the NetworkManager configuration\&. If it takes longer than expected, then the reasons need to be investigated in NetworkManager\&. -.PP -There are various reasons what affects NetworkManager reaching "startup complete" and how long -NetworkManager\-wait\-online\&.service -blocks\&. +unit, you cannot configure this service\&. Instead, settings in NetworkManager and the connection profiles affect the behavior: .sp .RS 4 .ie n \{\ @@ -74,16 +67,13 @@ blocks\&. .sp -1 .IP \(bu 2.3 .\} -In general, startup complete is not reached as long as NetworkManager is busy activating a device and as long as there are profiles in activating state\&. During boot, NetworkManager starts autoactivating suitable profiles that are configured to autoconnect\&. If activation fails, NetworkManager might retry right away (depending on +Startup is not complete as long as NetworkManager profiles are in an activating state\&. During boot, NetworkManager starts profiles with the +connection\&.autoconnect=yes +setting\&. If activation fails, NetworkManager retries the activation depending on the value of the connection\&.autoconnect\-retries -setting)\&. While trying and retrying, NetworkManager is busy until all profiles and devices either reached an activated or disconnected state and no further events are expected\&. - -Basically, as long as there are devices and connections in -activating -state visible with -\fBnmcli device\fR -and -\fBnmcli connection\fR, startup is still pending\&. +setting\&. +.sp +NetworkManager reports startup complete when all profiles and devices are either activated or in a disconnect state and no further events are expected\&. .RE .sp .RS 4 @@ -94,19 +84,18 @@ and .sp -1 .IP \(bu 2.3 .\} -When a device reaches activated state, depends on its configuration\&. For example, with a profile with both IPv4 and IPv6 addressing enabled, the device is possibly considered fully activated when either of the address families is ready\&. This can be controlled with the +When a device reaches the activate state depends on its configuration\&. For example, with a profile that has both IPv4 and IPv6 enabled, by default, NetworkManager considers the device as fully activated already when only one of the address families is ready\&. +.sp +The ipv4\&.may\-fail and ipv6\&.may\-fail -settings, to indicate that the address family is required\&. There are also -ipv4\&.required\-timeout -and -ipv6\&.required\-timeout -settings which affect how long to wait for an address family\&. Likewise, properties like -ipv4\&.dhcp\-timeout -and -ipv6\&.ra\-timeout -affect how long NetworkManager will try the IP configuration before giving up\&. +settings control this behavior\&. Additionally, the following settings influence when the two address families complete: +ipv4\&.required\-timeout, +ipv6\&.required\-timeout, +ipv4\&.dhcp\-timeout, and +ipv6\&.ra\-timeout\&. For details, see +\fBnm-settings-nmcli\fR(5)\&. .RE .sp .RS 4 @@ -117,9 +106,9 @@ affect how long NetworkManager will try the IP configuration before giving up\&. .sp -1 .IP \(bu 2.3 .\} -For example, a bridge or bond profile cannot do IP configuration without ports\&. When booting with such profiles that autoactivate without ports, -NetworkManager\-wait\-online\&.service -blocks until timeout\&. This is a configuration error\&. +NetworkManager cannot set IP addresses on bridge and bond devices that have ports that do not auto\-activate\&. Because of this configuration error, +NetworkManager\-wait\-online +blocks until the service reaches its timeout value\&. .RE .sp .RS 4 @@ -130,9 +119,10 @@ blocks until timeout\&. This is a configuration error\&. .sp -1 .IP \(bu 2.3 .\} -Dispatcher scripts for the "pre\-up" event run at a late stage during activation of a profile\&. These scripts block the activation for when NetworkManager considers the profile fully activated\&. See also -\fBNetworkManager-dispatcher\fR(8) -for details\&. +Dispatcher scripts for the +pre\-up +event run at a late stage during activation of a profile\&. These scripts block the activation for when NetworkManager considers the profile fully activated\&. For details, see +\fBNetworkManager-dispatcher\fR(8)\&. .RE .sp .RS 4 @@ -143,9 +133,9 @@ for details\&. .sp -1 .IP \(bu 2.3 .\} -The connection property +The property connection\&.wait\-activation\-delay -also adds an additional delay during activation and delays startup complete\&. This is to workaround certain cases where a device is known to not be ready for a certain amount of time\&. +adds an additional delay during activation and delays startup complete\&. This setting works around certain cases where a device is known to not be ready for a certain amount of time\&. .RE .sp .RS 4 @@ -158,7 +148,7 @@ also adds an additional delay during activation and delays startup complete\&. T .\} The property connection\&.wait\-device\-timeout -of the connection profiles waits until the waited devices appear\&. This is useful if the driver takes a longer time to detect the networking interfaces\&. Similar with the +in the connection profiles cause a delay until the waiting devices appear\&. This is useful if the driver takes a longer time to detect the networking interfaces\&. This setting is similar to the connection\&.gateway\-ping\-timeout property\&. .RE @@ -171,7 +161,7 @@ property\&. .sp -1 .IP \(bu 2.3 .\} -With Wi\-Fi devices, NetworkManager needs to wait for the first scan result to know which networks might be available\&. That always adds a delay\&. +With Wi\-Fi devices, NetworkManager needs to wait for the first scan result to know which networks are available\&. That adds a delay\&. .RE .sp .RS 4 @@ -182,15 +172,11 @@ With Wi\-Fi devices, NetworkManager needs to wait for the first scan result to k .sp -1 .IP \(bu 2.3 .\} -With ethernet devices, NetworkManager waits for carrier until the configurable -[device*]\&.carrier\-timeout -is reached\&. This is because some devices take a long time to detect carrier and it means to boot with cable unplugged, will unnecessarily delay +With Ethernet devices, NetworkManager waits for the carrier until the value in +[device*]\&.carrier\-wait\-timeout +is reached\&. This is because some devices take a long time to detect the carrier\&. Consequently, booting with cable unplugged, unnecessarily delays NetworkManager\-wait\-online\&.service\&. .RE -.PP -NetworkManager\-wait\-online\&.service -internally uses -nm\-online\&. .SH "BUGS" .PP Please report any bugs in NetworkManager at the @@ -199,7 +185,10 @@ Please report any bugs in NetworkManager at the .PP \m[blue]\fBNetworkManager home page\fR\m[]\&\s-2\u[2]\d\s+2, \fBNetworkManager\fR(8), -\fBnm-online\fR(1), +\fBnm-online\fR(1), the +network\-online\&.target +description in +\fBsystemd.special\fR(7) .SH "NOTES" .IP " 1." 4 NetworkManager issue tracker diff --git a/man/NetworkManager-wait-online.service.xml b/man/NetworkManager-wait-online.service.xml index 9bc947e5..46068ea5 100644 --- a/man/NetworkManager-wait-online.service.xml +++ b/man/NetworkManager-wait-online.service.xml @@ -36,141 +36,113 @@ <refnamediv> <refname>NetworkManager-wait-online.service</refname> - <refpurpose>Wait for network to come online</refpurpose> + <refpurpose>Wait for the network to come online</refpurpose> </refnamediv> <refsect1> <title>Description</title> <para> - NetworkManager-wait-online.service delays network-online.target until network - is ready. + The <literal>NetworkManager-wait-online</literal> service is a <literal>oneshot</literal> + systemd service that delays reaching the <literal>network-online</literal> target until + NetworkManager reports that the startup is completed on the D-Bus. </para> <para> - The systemd target <literal>network-online.target</literal> acts as a synchronization point - for services to start after network is configured. Such services should - order themselves <literal>After=network-online.target</literal> - (and never <literal>After=NetworkManager-wait-online.service</literal>). - <literal>NetworkManager-wait-online.service</literal> is a one-shot service - that itself is ordered <literal>Before=network-online.target</literal> - and this way delays the target until the network is configured. + When the system boots, for example, remote mounts defined in <literal>/etc/fstab</literal>, + require that the network is up. For this, these systemd units contain the + <literal>After=network-online.target</literal> setting to order themselves after this + target. <literal>NetworkManager-wait-online</literal> ensures that the + <literal>network-online</literal> target is reached only after the network is available. </para> <para> - <literal>NetworkManager-wait-online.service</literal> itself is almost not configurable - itself. Instead the connection profiles and configuration in NetworkManager affects - the behavior. + Optimally, all services on the host react dynamically to network changes and systemd + services do not need to be configured to start after reaching the + <literal>network-online</literal> target. In this case, + <literal>NetworkManager-wait-online.service</literal> has no effect and does not delay + the boot time. On the other hand, if you encounter a long boot time due to the delay + of <literal>NetworkManager-wait-online</literal>, investigate the services that require + network access and fix them. </para> <para> - In the best case, all services on the system can react to networking changes dynamically and - no service orders itself after <literal>network-online.target</literal>. That way, - <literal>NetworkManager-wait-online.service</literal> has no effect and, for example, - does not delay the boot. That means, if the problem is a long boot time related to - <literal>NetworkManager-wait-online.service</literal>, a possible solution is to - investigate the services that claim to require network and fix those. - </para> - <para> - For services that require network configured, - <literal>NetworkManager-wait-online.service</literal> is the default implementation - provided by NetworkManager to delay the target. But it does nothing magical. With - special requirements, it may be sensible to disable <literal>NetworkManager-wait-online.service</literal> - and replace it with a similar service that better implements the requirement. - </para> - <para> - <literal>NetworkManager-wait-online.service</literal> blocks until - NetworkManager logs "startup complete" and announces startup complete - on D-Bus. How long that takes depends on the network - and the NetworkManager configuration. If it takes longer than expected, then - the reasons need to be investigated in NetworkManager. - </para> - <para> - There are various reasons what affects NetworkManager reaching "startup complete" - and how long <literal>NetworkManager-wait-online.service</literal> blocks. - <itemizedlist> - <listitem> - <para> - In general, startup complete is not reached as long as NetworkManager is busy - activating a device and as long as there are profiles in activating state. - During boot, NetworkManager starts autoactivating - suitable profiles that are configured to autoconnect. If activation fails, - NetworkManager might retry right away (depending on <literal>connection.autoconnect-retries</literal> - setting). While trying and retrying, NetworkManager is busy until all - profiles and devices either reached an activated or disconnected state - and no further events are expected. - <para> - </para> - Basically, as long as there are devices and connections in <literal>activating</literal> - state visible with <command>nmcli device</command> and <command>nmcli connection</command>, - startup is still pending. - </para> - </listitem> - <listitem> - <para> - When a device reaches activated state, depends on its configuration. - For example, with a profile with both IPv4 and IPv6 addressing - enabled, the device is possibly considered fully activated when - either of the address families is ready. This can be controlled with the - <literal>ipv4.may-fail</literal> and <literal>ipv6.may-fail</literal> - settings, to indicate that the address family is required. - There are also <literal>ipv4.required-timeout</literal> and <literal>ipv6.required-timeout</literal> - settings which affect how long to wait for an address family. - Likewise, properties like <literal>ipv4.dhcp-timeout</literal> and - <literal>ipv6.ra-timeout</literal> affect how long NetworkManager - will try the IP configuration before giving up. - </para> - </listitem> - <listitem> - <para> - For example, a bridge or bond profile cannot do IP configuration - without ports. When booting with such profiles that autoactivate - without ports, <literal>NetworkManager-wait-online.service</literal> blocks until timeout. - This is a configuration error. - </para> - </listitem> - <listitem> - <para> - Dispatcher scripts for the "pre-up" event run at a late stage during activation - of a profile. These scripts block the activation for when NetworkManager considers - the profile fully activated. - See also <link linkend='NetworkManager-dispatcher'><citerefentry><refentrytitle>NetworkManager-dispatcher</refentrytitle><manvolnum>8</manvolnum></citerefentry></link> - for details. - </para> - </listitem> - <listitem> - <para> - The connection property <literal>connection.wait-activation-delay</literal> also - adds an additional delay during activation and delays startup complete. This is to - workaround certain cases where a device is known to not be ready for a certain - amount of time. - </para> - </listitem> - <listitem> - <para> - The property <literal>connection.wait-device-timeout</literal> of the connection - profiles waits until the waited devices appear. This is useful if the driver - takes a longer time to detect the networking interfaces. Similar with the - <literal>connection.gateway-ping-timeout</literal> property. - </para> - </listitem> - <listitem> - <para> - With Wi-Fi devices, NetworkManager needs to wait for the first scan - result to know which networks might be available. That always adds a delay. - </para> - </listitem> - <listitem> - <para> - With ethernet devices, NetworkManager waits for carrier until the - configurable <literal>[device*].carrier-timeout</literal> is reached. - This is because some devices take a long time to detect carrier - and it means to boot with cable unplugged, will unnecessarily delay - <literal>NetworkManager-wait-online.service</literal>. - </para> - </listitem> - </itemizedlist> - </para> - <para> - <literal>NetworkManager-wait-online.service</literal> internally uses - <literal>nm-online</literal>. + Except for the time out value in the <literal>NetworkManager-wait-online.service</literal> + unit, you cannot configure this service. Instead, settings in NetworkManager and the + connection profiles affect the behavior: </para> + <itemizedlist> + <listitem> + <para> + Startup is not complete as long as NetworkManager profiles are in an activating + state. During boot, NetworkManager starts profiles with the + <literal>connection.autoconnect=yes</literal> setting. If activation fails, + NetworkManager retries the activation depending on the value of the + <literal>connection.autoconnect-retries</literal> setting. + </para> + <para> + NetworkManager reports startup complete when all profiles and devices are either + activated or in a disconnect state and no further events are expected. + </para> + </listitem> + <listitem> + <para> + When a device reaches the activate state depends on its configuration. For example, + with a profile that has both IPv4 and IPv6 enabled, by default, NetworkManager + considers the device as fully activated already when only one of the address + families is ready. + </para> + <para> + The <literal>ipv4.may-fail</literal> and <literal>ipv6.may-fail</literal> settings + control this behavior. Additionally, the following settings influence when the + two address families complete: <literal>ipv4.required-timeout</literal>, + <literal>ipv6.required-timeout</literal>, <literal>ipv4.dhcp-timeout</literal>, + and <literal>ipv6.ra-timeout</literal>. For details, see + <link linkend='nm-settings-nmcli'><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>. + </para> + </listitem> + <listitem> + <para> + NetworkManager cannot set IP addresses on bridge and bond devices that have ports + that do not auto-activate. Because of this configuration error, + <literal>NetworkManager-wait-online</literal> blocks until the service reaches + its timeout value. + </para> + </listitem> + <listitem> + <para> + Dispatcher scripts for the <literal>pre-up</literal> event run at a late stage + during activation of a profile. These scripts block the activation for when + NetworkManager considers the profile fully activated. For details, see + <link linkend='NetworkManager-dispatcher'><citerefentry><refentrytitle>NetworkManager-dispatcher</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>. + </para> + </listitem> + <listitem> + <para> + The property <literal>connection.wait-activation-delay</literal> adds an additional + delay during activation and delays startup complete. This setting works around + certain cases where a device is known to not be ready for a certain amount of time. + </para> + </listitem> + <listitem> + <para> + The property <literal>connection.wait-device-timeout</literal> in the connection + profiles cause a delay until the waiting devices appear. This is useful if the + driver takes a longer time to detect the networking interfaces. This setting is + similar to the <literal>connection.gateway-ping-timeout</literal> property. + </para> + </listitem> + <listitem> + <para> + With Wi-Fi devices, NetworkManager needs to wait for the first scan result to + know which networks are available. That adds a delay. + </para> + </listitem> + <listitem> + <para> + With Ethernet devices, NetworkManager waits for the carrier until the value in + <literal>[device*].carrier-wait-timeout</literal> is reached. This is because some + devices take a long time to detect the carrier. Consequently, booting with cable + unplugged, unnecessarily delays <literal>NetworkManager-wait-online.service</literal>. + </para> + </listitem> + </itemizedlist> </refsect1> <refsect1> @@ -187,6 +159,7 @@ <ulink url="https://networkmanager.dev">NetworkManager home page</ulink>, <link linkend='NetworkManager'><citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>, <link linkend='nm-online'><citerefentry><refentrytitle>nm-online</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, + the <literal>network-online.target</literal> description in <link linkend='systemd.special'><citerefentry><refentrytitle>systemd.special</refentrytitle><manvolnum>7</manvolnum></citerefentry></link> </para> </refsect1> </refentry> diff --git a/man/NetworkManager.8 b/man/NetworkManager.8 index 31979130..14eda221 100644 --- a/man/NetworkManager.8 +++ b/man/NetworkManager.8 @@ -2,12 +2,12 @@ .\" Title: NetworkManager .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: Network management daemons -.\" Source: NetworkManager 1.40.12 +.\" Source: NetworkManager 1.42.4 .\" Language: English .\" -.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.40\&.12" "Network management daemons" +.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.42\&.4" "Network management daemons" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -121,7 +121,11 @@ for more information\&. .PP \fB\-\-print\-config\fR .RS 4 -Print the NetworkManager configuration to stdout and exit\&. +Print the NetworkManager configuration to stdout and exit\&. See +\fBNetworkManager.conf\fR(5)\&. This does not include connection profiles\&. View them with +\fBnmcli connection\fR\&. +.sp +This reads configuration files from disk\&. If NetworkManager is currently running, make sure that it has the same configuration loaded\&. .RE .SH "UDEV PROPERTIES" .PP diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5 index b2c84edf..5cdb15ff 100644 --- a/man/NetworkManager.conf.5 +++ b/man/NetworkManager.conf.5 @@ -2,12 +2,12 @@ .\" Title: NetworkManager.conf .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: Configuration -.\" Source: NetworkManager 1.40.12 +.\" Source: NetworkManager 1.42.4 .\" Language: English .\" -.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.40\&.12" "Configuration" +.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.42\&.4" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -978,6 +978,11 @@ is unset, use the content of "/proc/sys/net/ipv6/conf/default/use_tempaddr" as l If left unspecified, routes are only added to the main table\&. Note that this is different from explicitly selecting the main table 254, because of how NetworkManager removes extraneous routes from the tables\&. .RE .PP +\fIloopback\&.mtu\fR +.RS 4 +If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints\&. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or the MTU is left unspecified on activation\&. +.RE +.PP \fIsriov\&.autoprobe\-drivers\fR .RS 4 If left unspecified, drivers are autoprobed when the SR\-IOV VF gets created\&. @@ -1277,7 +1282,7 @@ If set, controls what body content NetworkManager checks for when requesting the .RE .SH "GLOBAL\-DNS SECTION" .PP -This section specifies global DNS settings that override connection\-specific configuration\&. +This section specifies DNS settings that are applied globally, in addition to connection\-specific ones\&. .PP .PP \fIsearches\fR @@ -1291,7 +1296,7 @@ A list of options to be passed to the hostname resolver\&. .RE .SH "GLOBAL\-DNS\-DOMAIN SECTIONS" .PP -Sections with a name starting with the "global\-dns\-domain\-" prefix allow to define global DNS configuration for specific domains\&. The part of section name after "global\-dns\-domain\-" specifies the domain name a section applies to\&. More specific domains have the precedence over less specific ones and the default domain is represented by the wildcard "*"\&. A default domain section is mandatory\&. +Sections with a name starting with the "global\-dns\-domain\-" prefix allow to define global DNS configuration for specific domains\&. The part of section name after "global\-dns\-domain\-" specifies the domain name a section applies to (for example, a section could be named "global\-dns\-domain\-foobar\&.com")\&. More specific domains have the precedence over less specific ones and the default domain is represented by the wildcard "*"\&. To be valid, global DNS domains must include a section for the default domain "*"\&. When the global DNS domains are valid, the name servers and domains defined globally override the ones from active connections\&. .PP .PP \fIservers\fR diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml index 301172e4..0dcf805d 100644 --- a/man/NetworkManager.conf.xml +++ b/man/NetworkManager.conf.xml @@ -1011,6 +1011,10 @@ ipv6.ip6-privacy=0 </para></listitem> </varlistentry> <varlistentry> + <term><varname>loopback.mtu</varname></term> + <listitem><para>If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or the MTU is left unspecified on activation.</para></listitem> + </varlistentry> + <varlistentry> <term><varname>sriov.autoprobe-drivers</varname></term> <listitem><para>If left unspecified, drivers are autoprobed when the SR-IOV VF gets created.</para></listitem> </varlistentry> @@ -1449,8 +1453,8 @@ managed=1 <refsect1> <title><literal>global-dns</literal> section</title> - <para>This section specifies global DNS settings that override - connection-specific configuration.</para> + <para>This section specifies DNS settings that are applied + globally, in addition to connection-specific ones.</para> <para> <variablelist> <varlistentry> @@ -1478,10 +1482,15 @@ managed=1 <para>Sections with a name starting with the "global-dns-domain-" prefix allow to define global DNS configuration for specific domains. The part of section name after "global-dns-domain-" - specifies the domain name a section applies to. More specific - domains have the precedence over less specific ones and the - default domain is represented by the wildcard "*". A default - domain section is mandatory. + specifies the domain name a section applies to (for example, a + section could be named "global-dns-domain-foobar.com"). More + specific domains have the precedence over less specific ones and + the default domain is represented by the wildcard "*". + + To be valid, global DNS domains must include a section for the + default domain "*". When the global DNS domains are valid, the + name servers and domains defined globally override the ones from + active connections. </para> <para> <variablelist> diff --git a/man/NetworkManager.xml b/man/NetworkManager.xml index 80c4fbbd..f0b0f33f 100644 --- a/man/NetworkManager.xml +++ b/man/NetworkManager.xml @@ -166,9 +166,17 @@ </varlistentry> <varlistentry> <term><option>--print-config</option></term> - <listitem><para> - Print the NetworkManager configuration to stdout and exit. - </para></listitem> + <listitem> + <para> + Print the NetworkManager configuration to stdout and exit. See + <link linkend='NetworkManager.conf'><citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>. + This does not include connection profiles. View them with <command>nmcli connection</command>. + </para> + <para> + This reads configuration files from disk. If NetworkManager is currently running, + make sure that it has the same configuration loaded. + </para> + </listitem> </varlistentry> </variablelist> </refsect1> diff --git a/man/meson.build b/man/meson.build index c8146044..356759ba 100644 --- a/man/meson.build +++ b/man/meson.build @@ -87,7 +87,7 @@ if enable_introspection join_paths(meson.source_root(), 'tools', 'generate-docs-nm-settings-docs-merge.py'), '--only-from-first', '@OUTPUT@', - generate_docs_nm_settings_nmcli_xml, + gen_metadata_nm_settings_nmcli_xml, nm_property_infos_xml[name], nm_settings_docs_xml_gir, ], diff --git a/man/nm-cloud-setup.8 b/man/nm-cloud-setup.8 index 190943c0..9b851e33 100644 --- a/man/nm-cloud-setup.8 +++ b/man/nm-cloud-setup.8 @@ -2,12 +2,12 @@ .\" Title: nm-cloud-setup .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: Automatic Network Configuration in Cloud with NetworkManager -.\" Source: NetworkManager 1.40.12 +.\" Source: NetworkManager 1.42.4 .\" Language: English .\" -.TH "NM\-CLOUD\-SETUP" "8" "" "NetworkManager 1\&.40\&.12" "Automatic Network Configuratio" +.TH "NM\-CLOUD\-SETUP" "8" "" "NetworkManager 1\&.42\&.4" "Automatic Network Configuratio" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-initrd-generator.8 b/man/nm-initrd-generator.8 index 53500737..c9fc3411 100644 --- a/man/nm-initrd-generator.8 +++ b/man/nm-initrd-generator.8 @@ -2,12 +2,12 @@ .\" Title: nm-initrd-generator .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: System Administration -.\" Source: NetworkManager 1.40.12 +.\" Source: NetworkManager 1.42.4 .\" Language: English .\" -.TH "NM\-INITRD\-GENERATOR" "8" "" "NetworkManager 1\&.40\&.12" "System Administration" +.TH "NM\-INITRD\-GENERATOR" "8" "" "NetworkManager 1\&.42\&.4" "System Administration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-online.1 b/man/nm-online.1 index 4eaa0a3f..4676c956 100644 --- a/man/nm-online.1 +++ b/man/nm-online.1 @@ -2,12 +2,12 @@ .\" Title: nm-online .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.40.12 +.\" Source: NetworkManager 1.42.4 .\" Language: English .\" -.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.40\&.12" "General Commands Manual" +.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.42\&.4" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-openvswitch.7 b/man/nm-openvswitch.7 index 01d98678..2a1eddaa 100644 --- a/man/nm-openvswitch.7 +++ b/man/nm-openvswitch.7 @@ -2,12 +2,12 @@ .\" Title: nm-openvswitch .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: Open vSwitch support overview -.\" Source: NetworkManager 1.40.12 +.\" Source: NetworkManager 1.42.4 .\" Language: English .\" -.TH "NM\-OPENVSWITCH" "7" "" "NetworkManager 1\&.40\&.12" "Open vSwitch support overview" +.TH "NM\-OPENVSWITCH" "7" "" "NetworkManager 1\&.42\&.4" "Open vSwitch support overview" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-settings-dbus.5 b/man/nm-settings-dbus.5 index ebbf2ac6..48b070ba 100644 --- a/man/nm-settings-dbus.5 +++ b/man/nm-settings-dbus.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-dbus .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: Configuration -.\" Source: NetworkManager 1.40.12 +.\" Source: NetworkManager 1.42.4 .\" Language: English .\" -.TH "NM\-SETTINGS\-DBUS" "5" "" "NetworkManager 1\&.40\&.12" "Configuration" +.TH "NM\-SETTINGS\-DBUS" "5" "" "NetworkManager 1\&.42\&.4" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -111,7 +111,7 @@ T}:T{ T}:T{ 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\&. +Currently, this only applies to 802\-1x authentication\&. T} T{ autoconnect @@ -122,13 +122,13 @@ TRUE T}:T{ 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\&. +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\&. +Note that autoconnect is not implemented for VPN profiles\&. See "secondaries" as an alternative to automatically connect VPN profiles\&. - If multiple profiles are ready to autoconnect on the same device, the one with the better "connection\&.autoconnect\-priority" is chosen\&. If the priorities are equal, then the most recently connected profile is activated\&. If the profiles were not connected earlier or their "connection\&.timestamp" is identical, the choice is undefined\&. +If multiple profiles are ready to autoconnect on the same device, the one with the better "connection\&.autoconnect\-priority" is chosen\&. If the priorities are equal, then the most recently connected profile is activated\&. If the profiles were not connected earlier or their "connection\&.timestamp" is identical, the choice is undefined\&. - Depending on "connection\&.multi\-connect", a profile can (auto)connect only once at a time or multiple times\&. +Depending on "connection\&.multi\-connect", a profile can (auto)connect only once at a time or multiple times\&. T} T{ autoconnect\-priority @@ -166,9 +166,9 @@ T}:T{ T}:T{ 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\*(Aqt ever use DNSOverTls\&. If unspecified "default" depends on the plugin used\&. Systemd\-resolved uses global setting\&. +The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don\*(Aqt 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\&. +This feature requires a plugin which supports DNSOverTls\&. Otherwise, the setting has no effect\&. One such plugin is dns\-systemd\-resolved\&. T} T{ gateway\-ping\-timeout @@ -197,9 +197,9 @@ T}:T{ T}:T{ 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 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\&. +For connection types where interface names cannot easily be made persistent (e\&.g\&. mobile broadband or USB Ethernet), this property should not be used\&. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface\&. T} T{ lldp @@ -219,9 +219,9 @@ T}:T{ T}:T{ 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")\&. +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\&. +This feature requires a plugin which supports LLMNR\&. Otherwise, the setting has no effect\&. One such plugin is dns\-systemd\-resolved\&. T} T{ master @@ -241,9 +241,9 @@ T}:T{ T}:T{ 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")\&. +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\&. +This feature requires a plugin which supports mDNS\&. Otherwise, the setting has no effect\&. One such plugin is dns\-systemd\-resolved\&. T} T{ metered @@ -254,7 +254,7 @@ T}:T{ T}:T{ Whether the connection is metered\&. - When updating this property on a currently activated connection, the change takes effect immediately\&. +When updating this property on a currently activated connection, the change takes effect immediately\&. T} T{ mptcp\-flags @@ -265,21 +265,21 @@ T}:T{ T}:T{ Whether to configure MPTCP endpoints and the address flags\&. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints\&. Note that IPv4 loopback addresses (127\&.0\&.0\&.0/8), IPv4 link local addresses (169\&.254\&.0\&.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6\&.ip6\-privacy) will be excluded from being configured as endpoints\&. - If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered\&. +If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered\&. - The "enabled" (0x2) flag means that MPTCP handling is enabled\&. This flag can also be implied from the presence of other flags\&. +The "enabled" (0x2) flag means that MPTCP handling is enabled\&. This flag can also be implied from the presence of other flags\&. - Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on\&. NetworkManager does not change the sysctl and this is up to the administrator or distribution\&. To configure endpoints even if the sysctl is disabled, "also\-without\-sysctl" (0x4) flag can be used\&. In that case, NetworkManager doesn\*(Aqt look at the sysctl and configures endpoints regardless\&. +Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on\&. NetworkManager does not change the sysctl and this is up to the administrator or distribution\&. To configure endpoints even if the sysctl is disabled, "also\-without\-sysctl" (0x4) flag can be used\&. In that case, NetworkManager doesn\*(Aqt look at the sysctl and configures endpoints regardless\&. - Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0\&.0\&.0\&.0/0 or ::/0) in the main routing table\&. The flag "also\-without\-default\-route" (0x8) can override that\&. +Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0\&.0\&.0\&.0/0 or ::/0) in the main routing table\&. The flag "also\-without\-default\-route" (0x8) can override that\&. - When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80)\&. See ip\-mptcp(8) manual for additional information about the flags\&. +When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80)\&. See ip\-mptcp(8) manual for additional information about the flags\&. - If the flags are zero (0x0), the global connection default from NetworkManager\&.conf is honored\&. If still unspecified, the fallback is "enabled,subflow"\&. Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl\&. +If the flags are zero (0x0), the global connection default from NetworkManager\&.conf is honored\&. If still unspecified, the fallback is "enabled,subflow"\&. Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl\&. - NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled"\&. That is a host configuration which the admin can change via sysctl and ip\-mptcp\&. +NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled"\&. That is a host configuration which the admin can change via sysctl and ip\-mptcp\&. - Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2)\&. +Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2)\&. T} T{ mud\-url @@ -290,9 +290,9 @@ T}:T{ T}:T{ 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\&. +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"\&. +If the per\-profile value is unspecified (the default), a global connection default gets consulted\&. If still unspecified, the ultimate default is "none"\&. T} T{ multi\-connect @@ -312,7 +312,7 @@ T}:T{ T}:T{ An array of strings defining what access a given user has to this connection\&. If this is NULL or empty, all users are allowed to access this connection; otherwise 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\&. +At this time only the "user" [type] is allowed\&. Any other values are ignored and reserved for future use\&. [id] is the username that this permission refers to, which may not contain the ":" character\&. Any [reserved] information present must be ignored and is reserved for future use\&. All of [type], [id], and [reserved] must be valid UTF\-8\&. T} T{ read\-only @@ -350,13 +350,13 @@ T}:T{ T}:T{ 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]\&. +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\*(Aqs 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\&. See NetworkManager(8) manual about the secret\-key and the host identity\&. +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\*(Aqs 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\&. See NetworkManager(8) manual about the secret\-key and the host identity\&. - The \*(Aq$\*(Aq 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 \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq 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\&. +The \*(Aq$\*(Aq 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 \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq 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\&. +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\&. T} T{ timestamp @@ -367,7 +367,7 @@ T}:T{ T}:T{ The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated\&. - NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp\&. The property is only meant for reading (changes to this property will not be preserved)\&. +NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp\&. The property is only meant for reading (changes to this property will not be preserved)\&. T} T{ type @@ -387,7 +387,7 @@ T}:T{ T}:T{ 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 "\-")\&. +The UUID must be in the format "2815492f\-7e56\-435e\-b2e9\-246bd7cdc664" (ie, contains only hexadecimal characters and "\-")\&. T} T{ wait\-activation\-delay @@ -398,7 +398,7 @@ T}:T{ T}:T{ Time in milliseconds to wait for connection to be considered activated\&. The wait will start after the pre\-up dispatcher event\&. - The value 0 means no wait time\&. The default value is \-1, which currently has the same meaning as no wait time\&. +The value 0 means no wait time\&. The default value is \-1, which currently has the same meaning as no wait time\&. T} T{ wait\-device\-timeout @@ -409,7 +409,7 @@ T}:T{ T}:T{ 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\&. +The value 0 means no wait time\&. The default value is \-1, which currently has the same meaning as no wait time\&. T} T{ zone @@ -420,7 +420,7 @@ T}:T{ T}:T{ The trust level of a the connection\&. Free form case\-insensitive string (for example "Home", "Work", "Public")\&. NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall\&. - When updating this property on a currently activated connection, the change takes effect immediately\&. +When updating this property on a currently activated connection, the change takes effect immediately\&. T} .TE .sp 1 @@ -551,9 +551,9 @@ T}:T{ T}:T{ Contains the CA certificate if used by the EAP method specified in the "eap" property\&. - Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL\&. When using the blob scheme this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. +Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL\&. When using the blob scheme this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. - Note that enabling NMSetting8021x:system\-ca\-certs will override this setting to use the built\-in path, if the built\-in path is not a directory\&. +Note that enabling NMSetting8021x:system\-ca\-certs will override this setting to use the built\-in path, if the built\-in path is not a directory\&. T} T{ ca\-cert\-password @@ -582,7 +582,7 @@ T}:T{ T}:T{ UTF\-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca\-cert" property\&. - If NMSetting8021x:system\-ca\-certs is enabled and the built\-in CA path is an existing directory, then this setting is ignored\&. +If NMSetting8021x:system\-ca\-certs is enabled and the built\-in CA path is an existing directory, then this setting is ignored\&. T} T{ client\-cert @@ -593,7 +593,7 @@ T}:T{ T}:T{ Contains the client certificate if used by the EAP method specified in the "eap" property\&. - Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. +Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. T} T{ client\-cert\-password @@ -710,7 +710,7 @@ uint32 T}:T{ 0 T}:T{ -Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options\&. The individual TLS versions can be explicitly disabled\&. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it\&. The TLS options map to tls_disable_tlsv1_x settings\&. See the wpa_supplicant documentation for more details\&. +Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options\&. The individual TLS versions can be explicitly disabled\&. TLS time checks can be also disabled\&. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it\&. The TLS options map to tls_disable_tlsv1_x and tls_disable_time_checks settings\&. See the wpa_supplicant documentation for more details\&. T} T{ phase1\-fast\-provisioning @@ -775,9 +775,9 @@ T}:T{ T}:T{ Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2\-auth" or "phase2\-autheap" properties\&. - Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL\&. When using the blob scheme this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. +Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL\&. When using the blob scheme this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. - Note that enabling NMSetting8021x:system\-ca\-certs will override this setting to use the built\-in path, if the built\-in path is not a directory\&. +Note that enabling NMSetting8021x:system\-ca\-certs will override this setting to use the built\-in path, if the built\-in path is not a directory\&. T} T{ phase2\-ca\-cert\-password @@ -806,7 +806,7 @@ T}:T{ T}:T{ UTF\-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2\-ca\-cert" property\&. - If NMSetting8021x:system\-ca\-certs is enabled and the built\-in CA path is an existing directory, then this setting is ignored\&. +If NMSetting8021x:system\-ca\-certs is enabled and the built\-in CA path is an existing directory, then this setting is ignored\&. T} T{ phase2\-client\-cert @@ -817,7 +817,7 @@ T}:T{ T}:T{ Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2\-auth" or "phase2\-autheap" properties\&. - Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. +Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. T} T{ phase2\-client\-cert\-password @@ -864,7 +864,7 @@ T}:T{ T}:T{ Contains the "phase 2" inner private key when the "phase2\-auth" or "phase2\-autheap" property is set to "tls"\&. - Key data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme and private keys, this property should be set to the key\*(Aqs encrypted PEM encoded data\&. When using private keys with the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2\-private\-key\-password" property must be set to password used to decrypt the PKCS#12 certificate and key\&. When using PKCS#12 files and the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and 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\&. +Key data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme and private keys, this property should be set to the key\*(Aqs encrypted PEM encoded data\&. When using private keys with the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2\-private\-key\-password" property must be set to password used to decrypt the PKCS#12 certificate and key\&. When using PKCS#12 files and the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2\-private\-key\-password" property must be set to the password used to decode the PKCS#12 private key and certificate\&. T} T{ phase2\-private\-key\-password @@ -891,7 +891,9 @@ string T}:T{ \ \& T}:T{ -Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2\-domain\-suffix\-match\&. +Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and should not be used\&. + +This property is deprecated since version 1\&.2\&.Use "phase2\-domain\-suffix\-match" instead\&. T} T{ pin @@ -920,9 +922,9 @@ T}:T{ T}:T{ Contains the private key when the "eap" property is set to "tls"\&. - Key data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme and private keys, this property should be set to the key\*(Aqs encrypted PEM encoded data\&. When using private keys with the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private\-key\-password" property must be set to password used to decrypt the PKCS#12 certificate and key\&. When using PKCS#12 files and the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private\-key\-password" property must be set to the password used to decode the PKCS#12 private key and certificate\&. +Key data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme and private keys, this property should be set to the key\*(Aqs encrypted PEM encoded data\&. When using private keys with the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private\-key\-password" property must be set to password used to decrypt the PKCS#12 certificate and key\&. When using PKCS#12 files and the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private\-key\-password" property must be set to the password used to decode the PKCS#12 private key and certificate\&. - WARNING: "private\-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users\&. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data\&. +WARNING: "private\-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users\&. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data\&. T} T{ private\-key\-password @@ -949,7 +951,9 @@ string T}:T{ \ \& T}:T{ -Substring to be matched against the subject of the certificate presented by the authentication server\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain\-suffix\-match\&. +Substring to be matched against the subject of the certificate presented by the authentication server\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and should not be used\&. + +This property is deprecated since version 1\&.2\&.Use "phase2\-domain\-suffix\-match" instead\&. T} T{ system\-ca\-certs @@ -1197,7 +1201,7 @@ T}:T{ T}:T{ 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\&. +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\&. T} T{ group\-forward\-mask @@ -1235,7 +1239,9 @@ T}:T{ T}:T{ 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 +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\&. + +This property is deprecated since version 1\&.12\&.Use the "cloned\-mac\-address" property instead\&. T} T{ max\-age @@ -1336,7 +1342,7 @@ T}:T{ T}:T{ Sets bridge\*(Aqs multicast router\&. Multicast\-snooping must be enabled for this option to work\&. - Supported values are: \*(Aqauto\*(Aq, \*(Aqdisabled\*(Aq, \*(Aqenabled\*(Aq to which kernel assigns the numbers 1, 0, and 2, respectively\&. If not specified the default value is \*(Aqauto\*(Aq (1)\&. +Supported values are: \*(Aqauto\*(Aq, \*(Aqdisabled\*(Aq, \*(Aqenabled\*(Aq to which kernel assigns the numbers 1, 0, and 2, respectively\&. If not specified the default value is \*(Aqauto\*(Aq (1)\&. T} T{ multicast\-snooping @@ -1410,7 +1416,7 @@ T}:T{ T}:T{ If specified, the protocol used for VLAN filtering\&. - Supported values are: \*(Aq802\&.1Q\*(Aq, \*(Aq802\&.1ad\*(Aq\&. If not specified the default value is \*(Aq802\&.1Q\*(Aq\&. +Supported values are: \*(Aq802\&.1Q\*(Aq, \*(Aq802\&.1ad\*(Aq\&. If not specified the default value is \*(Aq802\&.1Q\*(Aq\&. T} T{ vlan\-stats\-enabled @@ -1430,11 +1436,11 @@ T}:T{ T}:T{ 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: +In nmcli the VLAN list can be specified with the following syntax: - $vid [pvid] [untagged] [, $vid [pvid] [untagged]]\&.\&.\&. +$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\&. +where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash\&. T} .TE .sp 1 @@ -1494,11 +1500,11 @@ T}:T{ T}:T{ Array of bridge VLAN objects\&. In addition to the VLANs specified here, the port will also have the default\-pvid VLAN configured on the bridge by the bridge\&.vlan\-default\-pvid property\&. - In nmcli the VLAN list can be specified with the following syntax: +In nmcli the VLAN list can be specified with the following syntax: - $vid [pvid] [untagged] [, $vid [pvid] [untagged]]\&.\&.\&. +$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\&. +where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash\&. T} .TE .sp 1 @@ -1619,7 +1625,7 @@ T}:T{ T}:T{ 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"\&. +Since 1\&.34, NULL is the default and means "fabric"\&. Before 1\&.34, NULL was rejected as invalid and the default was "fabric"\&. T} T{ app\-fcoe\-priority @@ -1888,7 +1894,9 @@ string T}:T{ \ \& T}:T{ -Legacy setting that used to help establishing PPP data sessions for GSM\-based modems\&. Deprecated: 1 +Legacy setting that used to help establishing PPP data sessions for GSM\-based modems\&. + +This property is deprecated since version 1\&.16\&.User\-provided values for this setting are no longer used\&. T} T{ password @@ -2066,6 +2074,10 @@ l l l l l l l l l l l l l l l l +l l l l +l l l l +l l l l +l l l l l l l l. T{ address\-data @@ -2083,7 +2095,19 @@ array of array of uint32 T}:T{ \ \& T}:T{ -Deprecated in favor of the \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq properties, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq\&. Array of IPv4 address structures\&. Each IPv4 address structure is composed of 3 32\-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 \- 32), and last the IPv4 gateway (network byte order)\&. The gateway may be left as 0 if no gateway exists for that subnet\&. +Deprecated in favor of the \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq properties, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq\&. +Array of IPv4 address structures\&. Each IPv4 address structure is composed of 3 32\-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 \- 32), and last the IPv4 gateway (network byte order)\&. The gateway may be left as 0 if no gateway exists for that subnet\&. +T} +T{ +auto\-route\-ext\-gw +T}:T{ +NMTernary (int32) +T}:T{ +\ \& +T}:T{ +VPN connections will default to add the route automatically unless this setting is set to FALSE\&. + +For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect\&. T} T{ dad\-timeout @@ -2094,7 +2118,7 @@ T}:T{ T}:T{ Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network\&. If an address conflict is detected, the activation will fail\&. A zero value means that no duplicate address detection is performed, \-1 means the default value (either configuration ipvx\&.dad\-timeout override or zero)\&. A value greater than zero is a timeout in milliseconds\&. - The property is currently implemented only for IPv4\&. +The property is currently implemented only for IPv4\&. T} T{ dhcp\-client\-id @@ -2105,15 +2129,15 @@ T}:T{ T}:T{ A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options\&. When the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary client ID, in which case the first byte is assumed to be the \*(Aqtype\*(Aq field as per RFC 2132 section 9\&.14 and the remaining bytes may be an hardware address (e\&.g\&. \*(Aq01:xx:xx:xx:xx:xx:xx\*(Aq where 1 is the Ethernet ARP type and the rest is a MAC address)\&. If the property is not a hex string it is considered as a non\-hardware\-address client ID and the \*(Aqtype\*(Aq field is set to 0\&. - The special values "mac" and "perm\-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01)\&. Currently, these options only work for ethernet type of links\&. +The special values "mac" and "perm\-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01)\&. Currently, these options only work for ethernet type of links\&. - The special value "ipv6\-duid" uses the DUID from "ipv6\&.dhcp\-duid" property as an RFC4361\-compliant client identifier\&. As IAID it uses "ipv4\&.dhcp\-iaid" and falls back to "ipv6\&.dhcp\-iaid" if unset\&. +The special value "ipv6\-duid" uses the DUID from "ipv6\&.dhcp\-duid" property as an RFC4361\-compliant client identifier\&. As IAID it uses "ipv4\&.dhcp\-iaid" and falls back to "ipv6\&.dhcp\-iaid" if unset\&. - The special value "duid" generates a RFC4361\-compliant client identifier based on "ipv4\&.dhcp\-iaid" and uses a DUID generated by hashing /etc/machine\-id\&. +The special value "duid" generates a RFC4361\-compliant client identifier based on "ipv4\&.dhcp\-iaid" and uses a DUID generated by hashing /etc/machine\-id\&. - The special value "stable" is supported to generate a type 0 client identifier based on the stable\-id (see connection\&.stable\-id) and a per\-host key\&. If you set the stable\-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per\-device key\&. +The special value "stable" is supported to generate a type 0 client identifier based on the stable\-id (see connection\&.stable\-id) and a per\-host key\&. If you set the stable\-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per\-device key\&. - If unset, a globally configured default is used\&. If still unset, the default depends on the DHCP plugin\&. +If unset, a globally configured default is used\&. If still unset, the default depends on the DHCP plugin\&. T} T{ dhcp\-fqdn @@ -2142,9 +2166,9 @@ T}:T{ T}:T{ Flags for the DHCP hostname and FQDN\&. - Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4)\&. When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6\&. +Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4)\&. When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6\&. - When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration\&. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests\&. +When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration\&. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests\&. T} T{ dhcp\-iaid @@ -2153,7 +2177,13 @@ string T}:T{ \ \& T}:T{ -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The property is a 32\-bit decimal value or a special value among "mac", "perm\-mac", "ifname" and "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address\&. +A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. + +For DHCPv4, the IAID is only used with "ipv4\&.dhcp\-client\-id" values "duid" and "ipv6\-duid" to generate the client\-id\&. + +For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin\&. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address\&. + +The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device\&. T} T{ dhcp\-reject\-servers @@ -2164,9 +2194,9 @@ T}:T{ T}:T{ Array of servers from which DHCP offers must be rejected\&. This property is useful to avoid getting a lease from misconfigured or rogue servers\&. - For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e\&.g\&. "192\&.168\&.122\&.0/24")\&. +For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e\&.g\&. "192\&.168\&.122\&.0/24")\&. - This property is currently not implemented for DHCPv6\&. +This property is currently not implemented for DHCPv6\&. T} T{ dhcp\-send\-hostname @@ -2186,7 +2216,7 @@ T}:T{ T}:T{ 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\&. +Set to 2147483647 (MAXINT32) for infinity\&. T} T{ dhcp\-vendor\-class\-identifier @@ -2207,6 +2237,15 @@ T}:T{ Array of IP addresses of DNS servers (as network\-byte\-order integers) T} T{ +dns\-data +T}:T{ +array of strings +T}:T{ +\ \& +T}:T{ +Array of DNS name servers\&. This replaces the deprecated "dns" property\&. Each name server can also contain a DoT server name\&. +T} +T{ dns\-options T}:T{ array of string @@ -2215,13 +2254,13 @@ T}:T{ T}:T{ 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\&. +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\&. - The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6\-bytestring", "ip6\-dotint", "ndots", "no\-check\-names", "no\-ip6\-dotint", "no\-reload", "no\-tld\-query", "rotate", "single\-request", "single\-request\-reopen", "timeout", "trust\-ad", "use\-vc"\&. +The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6\-bytestring", "ip6\-dotint", "ndots", "no\-check\-names", "no\-ip6\-dotint", "no\-reload", "no\-tld\-query", "rotate", "single\-request", "single\-request\-reopen", "timeout", "trust\-ad", "use\-vc"\&. - The "trust\-ad" setting is only honored if the profile contributes name servers to resolv\&.conf, and if all contributing profiles have "trust\-ad" enabled\&. +The "trust\-ad" setting is only honored if the profile contributes name servers to resolv\&.conf, and if all contributing profiles have "trust\-ad" enabled\&. - When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added\&. +When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added\&. T} T{ dns\-priority @@ -2232,19 +2271,19 @@ T}:T{ T}:T{ DNS servers priority\&. - The relative priority for DNS servers specified by this setting\&. A lower numerical value is better (higher priority)\&. +The relative priority for DNS servers specified by this setting\&. A lower numerical value is better (higher priority)\&. - Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used\&. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles\&. +Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used\&. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles\&. - 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\&. +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\&. +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 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\&. +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\&. - 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\&. Note that commonly the resolver tries name servers in /etc/resolv\&.conf in the order listed, proceeding with the next server in the list on failure\&. See for example the "rotate" option of the dns\-options setting\&. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered\&. +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\&. Note that commonly the resolver tries name servers in /etc/resolv\&.conf in the order listed, proceeding with the next server in the list on failure\&. See for example the "rotate" option of the dns\-options setting\&. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered\&. - When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd\-resolved settings), each connection is used to query domains in its search list\&. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain\&. Queries for domains not present in any search list are routed through connections having the \*(Aq~\&.\*(Aq 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 best priority (lowest numerical value) wins\&. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed\&. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured\&. +When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd\-resolved settings), each connection is used to query domains in its search list\&. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain\&. Queries for domains not present in any search list are routed through connections having the \*(Aq~\&.\*(Aq 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 best priority (lowest numerical value) wins\&. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed\&. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured\&. T} T{ dns\-search @@ -2255,9 +2294,9 @@ T}:T{ T}:T{ List of DNS search domains\&. Domains starting with a tilde (\*(Aq~\*(Aq) are considered \*(Aqrouting\*(Aq 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\&. - When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query\&. This makes the behavior different from running with plain /etc/resolv\&.conf\&. For more information see also the dns\-priority setting\&. +When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query\&. This makes the behavior different from running with plain /etc/resolv\&.conf\&. For more information see also the dns\-priority setting\&. - When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list\&. This can be prevented by setting "ignore\-auto\-dns"\&. Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15)\&. +When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list\&. This can be prevented by setting "ignore\-auto\-dns"\&. Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15)\&. T} T{ gateway @@ -2268,9 +2307,9 @@ T}:T{ T}:T{ The gateway associated with this configuration\&. This is only meaningful if "addresses" is also set\&. - Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop\&. This is ignored if "never\-default" is set\&. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length\&. +Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop\&. This is ignored if "never\-default" is set\&. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length\&. - Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case\&. See "ip4\-auto\-default\-route"\&. +Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case\&. See "ip4\-auto\-default\-route"\&. T} T{ ignore\-auto\-dns @@ -2299,7 +2338,7 @@ T}:T{ T}:T{ Enable and disable the IPv4 link\-local configuration independently of the ipv4\&.method configuration\&. This allows a link\-local address (169\&.254\&.x\&.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server\&. - When set to "auto", the value is dependent on "ipv4\&.method"\&. When set to "default", it honors the global connection default, before falling back to "auto"\&. Note that if "ipv4\&.method" is "disabled", then link local addressing is always disabled too\&. The default is "default"\&. +When set to "auto", the value is dependent on "ipv4\&.method"\&. When set to "default", it honors the global connection default, before falling back to "auto"\&. Note that if "ipv4\&.method" is "disabled", then link local addressing is always disabled too\&. The default is "default"\&. T} T{ may\-fail @@ -2319,13 +2358,13 @@ T}:T{ T}:T{ IP configuration method\&. - NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link\-local"\&. See the subclass\-specific documentation for other values\&. +NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link\-local"\&. See the subclass\-specific documentation for other values\&. - In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration\&. The "ignore\-auto\-routes" and "ignore\-auto\-dns" properties modify this behavior\&. +In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration\&. The "ignore\-auto\-routes" and "ignore\-auto\-dns" properties modify this behavior\&. - For methods that imply no upstream network, such as "shared" or "link\-local", these properties must be empty\&. +For methods that imply no upstream network, such as "shared" or "link\-local", these properties must be empty\&. - For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10\&.42\&.x\&.0/24 is chosen\&. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared\&. +For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10\&.42\&.x\&.0/24 is chosen\&. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared\&. T} T{ never\-default @@ -2337,6 +2376,15 @@ T}:T{ If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager\&. T} T{ +replace\-local\-rule +T}:T{ +NMTernary (int32) +T}:T{ +\ \& +T}:T{ +Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. +T} +T{ required\-timeout T}:T{ int32 @@ -2345,11 +2393,11 @@ T}:T{ T}:T{ The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds\&. - This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail\&. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e\&.g\&. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active\&. +This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail\&. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e\&.g\&. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active\&. - Note that if "may\-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout\&. +Note that if "may\-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout\&. - A zero value means that no required timeout is present, \-1 means the default value (either configuration ipvx\&.required\-timeout override or zero)\&. +A zero value means that no required timeout is present, \-1 means the default value (either configuration ipvx\&.required\-timeout override or zero)\&. T} T{ route\-data @@ -2378,11 +2426,11 @@ T}:T{ T}:T{ Enable policy routing (source routing) and set the routing table used when adding routes\&. - This affects all routes, including device\-routes, IPv4LL, DHCP, SLAAC, default\-routes and static routes\&. But note that static routes can individually overwrite the setting by explicitly specifying a non\-zero routing table\&. +This affects all routes, including device\-routes, IPv4LL, DHCP, SLAAC, default\-routes and static routes\&. But note that static routes can individually overwrite the setting by explicitly specifying a non\-zero routing table\&. - If the table setting is left at zero, it is eligible to be overwritten via global configuration\&. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection\&. +If the table setting is left at zero, it is eligible to be overwritten via global configuration\&. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection\&. - Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table)\&. Additionally, NetworkManager will not delete any extraneous routes from tables except the main table\&. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager\&. +Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table)\&. Additionally, NetworkManager will not delete any extraneous routes from tables except the main table\&. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager\&. T} T{ routes @@ -2391,7 +2439,17 @@ array of array of uint32 T}:T{ \ \& T}:T{ -Deprecated in favor of the \*(Aqroute\-data\*(Aq property, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqroute\-data\*(Aq\&. Array of IPv4 route structures\&. Each IPv4 route structure is composed of 4 32\-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 \- 32), the third being the next\-hop (network byte order) if any, and the fourth being the route metric\&. If the metric is 0, NM will choose an appropriate default metric for the device\&. (There is no way to explicitly specify an actual metric of 0 with this property\&.) +Deprecated in favor of the \*(Aqroute\-data\*(Aq property, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqroute\-data\*(Aq\&. +Array of IPv4 route structures\&. Each IPv4 route structure is composed of 4 32\-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 \- 32), the third being the next\-hop (network byte order) if any, and the fourth being the route metric\&. If the metric is 0, NM will choose an appropriate default metric for the device\&. (There is no way to explicitly specify an actual metric of 0 with this property\&.) +T} +T{ +routing\-rules +T}:T{ +array of \*(Aqa{sv}\*(Aq +T}:T{ +\ \& +T}:T{ +Array of dictionaries for routing rules\&. Each routing rule supports the following options: action (y), dport\-end (q), dport\-start (q), family (i), from (s), from\-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport\-end (q), sport\-start (q), supress\-prefixlength (i), table (u), to (s), tos (y), to\-len (y), range\-end (u), range\-start (u)\&. T} .TE .sp 1 @@ -2440,6 +2498,10 @@ l l l l l l l l l l l l l l l l +l l l l +l l l l +l l l l +l l l l l l l l. T{ addr\-gen\-mode @@ -2450,15 +2512,15 @@ T}:T{ T}:T{ Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration\&. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1)\&. NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3)\&. - If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address\&. This makes the host part of the address to stay constant, making it possible to track host\*(Aqs presence when it changes networks\&. The address changes when the interface hardware is replaced\&. +If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address\&. This makes the host part of the address to stay constant, making it possible to track host\*(Aqs presence when it changes networks\&. The address changes when the interface hardware is replaced\&. - The value of stable\-privacy enables use of cryptographically secure hash of a secret host\-specific key along with the connection\*(Aqs stable\-id and the network address as specified by RFC7217\&. This makes it impossible to use the address track host\*(Aqs presence, and makes the address stable when the network interface hardware is replaced\&. +The value of stable\-privacy enables use of cryptographically secure hash of a secret host\-specific key along with the connection\*(Aqs stable\-id and the network address as specified by RFC7217\&. This makes it impossible to use the address track host\*(Aqs presence, and makes the address stable when the network interface hardware is replaced\&. - The special values "default" and "default\-or\-eui64" will fallback to the global connection default in as documented in NetworkManager\&.conf(5) manual\&. If the global default is not specified, the fallback value is "stable\-privacy" or "eui64", respectively\&. +The special values "default" and "default\-or\-eui64" will fallback to the global connection default in as documented in NetworkManager\&.conf(5) manual\&. If the global default is not specified, the fallback value is "stable\-privacy" or "eui64", respectively\&. - For libnm, the property defaults to "default" since 1\&.40\&. Previously it defaulted to "stable\-privacy"\&. On D\-Bus, the absence of an addr\-gen\-mode setting equals "default"\&. For keyfile plugin, the absence of the setting on disk means "default\-or\-eui64" so that the property doesn\*(Aqt change on upgrade from older versions\&. +For libnm, the property defaults to "default" since 1\&.40\&. Previously it defaulted to "stable\-privacy"\&. On D\-Bus, the absence of an addr\-gen\-mode setting equals "default"\&. For keyfile plugin, the absence of the setting on disk means "default\-or\-eui64" so that the property doesn\*(Aqt change on upgrade from older versions\&. - Note that this setting is distinct from the Privacy Extensions as configured by "ip6\-privacy" property and it does not affect the temporary addresses configured with this option\&. +Note that this setting is distinct from the Privacy Extensions as configured by "ip6\-privacy" property and it does not affect the temporary addresses configured with this option\&. T} T{ address\-data @@ -2476,7 +2538,19 @@ array of legacy IPv6 address struct (a(ayuay)) T}:T{ \ \& T}:T{ -Deprecated in favor of the \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq properties, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq\&. Array of IPv6 address structures\&. Each IPv6 address structure is composed of an IPv6 address, a prefix length (0 \- 128), and an IPv6 gateway address\&. The gateway may be zeroed out if no gateway exists for that subnet\&. +Deprecated in favor of the \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq properties, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq\&. +Array of IPv6 address structures\&. Each IPv6 address structure is composed of an IPv6 address, a prefix length (0 \- 128), and an IPv6 gateway address\&. The gateway may be zeroed out if no gateway exists for that subnet\&. +T} +T{ +auto\-route\-ext\-gw +T}:T{ +NMTernary (int32) +T}:T{ +\ \& +T}:T{ +VPN connections will default to add the route automatically unless this setting is set to FALSE\&. + +For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect\&. T} T{ dad\-timeout @@ -2487,7 +2561,7 @@ T}:T{ T}:T{ Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network\&. If an address conflict is detected, the activation will fail\&. A zero value means that no duplicate address detection is performed, \-1 means the default value (either configuration ipvx\&.dad\-timeout override or zero)\&. A value greater than zero is a timeout in milliseconds\&. - The property is currently implemented only for IPv4\&. +The property is currently implemented only for IPv4\&. T} T{ dhcp\-duid @@ -2498,13 +2572,13 @@ T}:T{ T}:T{ A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315)\&. The DUID is carried in the Client Identifier option\&. If the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option\&. - The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection\&. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system\-wide dhclient lease file\&. If still no DUID is found, or another dhcp client is used, a global and permanent DUID\-UUID (RFC 6355) will be generated based on the machine\-id\&. +The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection\&. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system\-wide dhclient lease file\&. If still no DUID is found, or another dhcp client is used, a global and permanent DUID\-UUID (RFC 6355) will be generated based on the machine\-id\&. - The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device\&. In order to try providing a stable DUID\-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk\&. +The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device\&. In order to try providing a stable DUID\-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk\&. - The special values "stable\-llt", "stable\-ll" and "stable\-uuid" will generate a DUID of the corresponding type, derived from the connection\*(Aqs stable\-id and a per\-host unique key\&. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable\-id, in case this profile gets activated on multiple devices\&. So, the link\-layer address of "stable\-ll" and "stable\-llt" will be a generated address derived from the stable id\&. The DUID\-LLT time value in the "stable\-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt")\&. +The special values "stable\-llt", "stable\-ll" and "stable\-uuid" will generate a DUID of the corresponding type, derived from the connection\*(Aqs stable\-id and a per\-host unique key\&. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable\-id, in case this profile gets activated on multiple devices\&. So, the link\-layer address of "stable\-ll" and "stable\-llt" will be a generated address derived from the stable id\&. The DUID\-LLT time value in the "stable\-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt")\&. - When the property is unset, the global value provided for "ipv6\&.dhcp\-duid" is used\&. If no global value is provided, the default "lease" value is assumed\&. +When the property is unset, the global value provided for "ipv6\&.dhcp\-duid" is used\&. If no global value is provided, the default "lease" value is assumed\&. T} T{ dhcp\-hostname @@ -2524,9 +2598,9 @@ T}:T{ T}:T{ Flags for the DHCP hostname and FQDN\&. - Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4)\&. When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6\&. +Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4)\&. When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6\&. - When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration\&. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests\&. +When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration\&. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests\&. T} T{ dhcp\-iaid @@ -2535,7 +2609,13 @@ string T}:T{ \ \& T}:T{ -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The property is a 32\-bit decimal value or a special value among "mac", "perm\-mac", "ifname" and "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address\&. +A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. + +For DHCPv4, the IAID is only used with "ipv4\&.dhcp\-client\-id" values "duid" and "ipv6\-duid" to generate the client\-id\&. + +For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin\&. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address\&. + +The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device\&. T} T{ dhcp\-reject\-servers @@ -2546,9 +2626,9 @@ T}:T{ T}:T{ Array of servers from which DHCP offers must be rejected\&. This property is useful to avoid getting a lease from misconfigured or rogue servers\&. - For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e\&.g\&. "192\&.168\&.122\&.0/24")\&. +For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e\&.g\&. "192\&.168\&.122\&.0/24")\&. - This property is currently not implemented for DHCPv6\&. +This property is currently not implemented for DHCPv6\&. T} T{ dhcp\-send\-hostname @@ -2568,7 +2648,7 @@ T}:T{ T}:T{ 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\&. +Set to 2147483647 (MAXINT32) for infinity\&. T} T{ dns @@ -2580,6 +2660,15 @@ T}:T{ Array of IP addresses of DNS servers (in network byte order) T} T{ +dns\-data +T}:T{ +array of strings +T}:T{ +\ \& +T}:T{ +Array of DNS name servers\&. This replaces the deprecated "dns" property\&. Each name server can also contain a DoT server name\&. +T} +T{ dns\-options T}:T{ array of string @@ -2588,13 +2677,13 @@ T}:T{ T}:T{ 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\&. +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\&. - The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6\-bytestring", "ip6\-dotint", "ndots", "no\-check\-names", "no\-ip6\-dotint", "no\-reload", "no\-tld\-query", "rotate", "single\-request", "single\-request\-reopen", "timeout", "trust\-ad", "use\-vc"\&. +The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6\-bytestring", "ip6\-dotint", "ndots", "no\-check\-names", "no\-ip6\-dotint", "no\-reload", "no\-tld\-query", "rotate", "single\-request", "single\-request\-reopen", "timeout", "trust\-ad", "use\-vc"\&. - The "trust\-ad" setting is only honored if the profile contributes name servers to resolv\&.conf, and if all contributing profiles have "trust\-ad" enabled\&. +The "trust\-ad" setting is only honored if the profile contributes name servers to resolv\&.conf, and if all contributing profiles have "trust\-ad" enabled\&. - When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added\&. +When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added\&. T} T{ dns\-priority @@ -2605,19 +2694,19 @@ T}:T{ T}:T{ DNS servers priority\&. - The relative priority for DNS servers specified by this setting\&. A lower numerical value is better (higher priority)\&. +The relative priority for DNS servers specified by this setting\&. A lower numerical value is better (higher priority)\&. - Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used\&. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles\&. +Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used\&. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles\&. - 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\&. +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\&. +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 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\&. +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\&. - 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\&. Note that commonly the resolver tries name servers in /etc/resolv\&.conf in the order listed, proceeding with the next server in the list on failure\&. See for example the "rotate" option of the dns\-options setting\&. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered\&. +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\&. Note that commonly the resolver tries name servers in /etc/resolv\&.conf in the order listed, proceeding with the next server in the list on failure\&. See for example the "rotate" option of the dns\-options setting\&. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered\&. - When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd\-resolved settings), each connection is used to query domains in its search list\&. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain\&. Queries for domains not present in any search list are routed through connections having the \*(Aq~\&.\*(Aq 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 best priority (lowest numerical value) wins\&. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed\&. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured\&. +When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd\-resolved settings), each connection is used to query domains in its search list\&. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain\&. Queries for domains not present in any search list are routed through connections having the \*(Aq~\&.\*(Aq 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 best priority (lowest numerical value) wins\&. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed\&. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured\&. T} T{ dns\-search @@ -2628,9 +2717,9 @@ T}:T{ T}:T{ List of DNS search domains\&. Domains starting with a tilde (\*(Aq~\*(Aq) are considered \*(Aqrouting\*(Aq 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\&. - When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query\&. This makes the behavior different from running with plain /etc/resolv\&.conf\&. For more information see also the dns\-priority setting\&. +When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query\&. This makes the behavior different from running with plain /etc/resolv\&.conf\&. For more information see also the dns\-priority setting\&. - When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list\&. This can be prevented by setting "ignore\-auto\-dns"\&. Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15)\&. +When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list\&. This can be prevented by setting "ignore\-auto\-dns"\&. Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15)\&. T} T{ gateway @@ -2641,9 +2730,9 @@ T}:T{ T}:T{ The gateway associated with this configuration\&. This is only meaningful if "addresses" is also set\&. - Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop\&. This is ignored if "never\-default" is set\&. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length\&. +Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop\&. This is ignored if "never\-default" is set\&. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length\&. - Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case\&. See "ip4\-auto\-default\-route"\&. +Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case\&. See "ip4\-auto\-default\-route"\&. T} T{ ignore\-auto\-dns @@ -2672,11 +2761,11 @@ T}:T{ T}:T{ Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941\&. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI\-64\&. This enhances privacy, but could cause problems in some applications, on the other hand\&. The permitted values are: \-1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses)\&. - Having a per\-connection setting set to "\-1" (unknown) means fallback to global configuration "ipv6\&.ip6\-privacy"\&. +Having a per\-connection setting set to "\-1" (unknown) means fallback to global configuration "ipv6\&.ip6\-privacy"\&. - If also global configuration is unspecified or set to "\-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr"\&. +If also global configuration is unspecified or set to "\-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr"\&. - Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr\-gen\-mode" property\*(Aqs "stable\-privacy" setting as another way of avoiding host tracking with IPv6 addresses\&. +Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr\-gen\-mode" property\*(Aqs "stable\-privacy" setting as another way of avoiding host tracking with IPv6 addresses\&. T} T{ may\-fail @@ -2696,13 +2785,13 @@ T}:T{ T}:T{ IP configuration method\&. - NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link\-local"\&. See the subclass\-specific documentation for other values\&. +NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link\-local"\&. See the subclass\-specific documentation for other values\&. - In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration\&. The "ignore\-auto\-routes" and "ignore\-auto\-dns" properties modify this behavior\&. +In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration\&. The "ignore\-auto\-routes" and "ignore\-auto\-dns" properties modify this behavior\&. - For methods that imply no upstream network, such as "shared" or "link\-local", these properties must be empty\&. +For methods that imply no upstream network, such as "shared" or "link\-local", these properties must be empty\&. - For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10\&.42\&.x\&.0/24 is chosen\&. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared\&. +For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10\&.42\&.x\&.0/24 is chosen\&. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared\&. T} T{ mtu @@ -2731,7 +2820,16 @@ T}:T{ T}:T{ A timeout for waiting Router Advertisements in seconds\&. If zero (the default), a globally configured default is used\&. If still unspecified, the timeout depends on the sysctl settings of the device\&. - Set to 2147483647 (MAXINT32) for infinity\&. +Set to 2147483647 (MAXINT32) for infinity\&. +T} +T{ +replace\-local\-rule +T}:T{ +NMTernary (int32) +T}:T{ +\ \& +T}:T{ +Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. T} T{ required\-timeout @@ -2742,11 +2840,11 @@ T}:T{ T}:T{ The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds\&. - This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail\&. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e\&.g\&. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active\&. +This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail\&. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e\&.g\&. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active\&. - Note that if "may\-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout\&. +Note that if "may\-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout\&. - A zero value means that no required timeout is present, \-1 means the default value (either configuration ipvx\&.required\-timeout override or zero)\&. +A zero value means that no required timeout is present, \-1 means the default value (either configuration ipvx\&.required\-timeout override or zero)\&. T} T{ route\-data @@ -2775,11 +2873,11 @@ T}:T{ T}:T{ Enable policy routing (source routing) and set the routing table used when adding routes\&. - This affects all routes, including device\-routes, IPv4LL, DHCP, SLAAC, default\-routes and static routes\&. But note that static routes can individually overwrite the setting by explicitly specifying a non\-zero routing table\&. +This affects all routes, including device\-routes, IPv4LL, DHCP, SLAAC, default\-routes and static routes\&. But note that static routes can individually overwrite the setting by explicitly specifying a non\-zero routing table\&. - If the table setting is left at zero, it is eligible to be overwritten via global configuration\&. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection\&. +If the table setting is left at zero, it is eligible to be overwritten via global configuration\&. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection\&. - Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table)\&. Additionally, NetworkManager will not delete any extraneous routes from tables except the main table\&. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager\&. +Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table)\&. Additionally, NetworkManager will not delete any extraneous routes from tables except the main table\&. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager\&. T} T{ routes @@ -2788,7 +2886,17 @@ array of legacy IPv6 route struct (a(ayuayu)) T}:T{ \ \& T}:T{ -Deprecated in favor of the \*(Aqroute\-data\*(Aq property, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqroute\-data\*(Aq\&. Array of IPv6 route structures\&. Each IPv6 route structure is composed of an IPv6 address, a prefix length (0 \- 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric\&. If the metric is 0, NM will choose an appropriate default metric for the device\&. +Deprecated in favor of the \*(Aqroute\-data\*(Aq property, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqroute\-data\*(Aq\&. +Array of IPv6 route structures\&. Each IPv6 route structure is composed of an IPv6 address, a prefix length (0 \- 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric\&. If the metric is 0, NM will choose an appropriate default metric for the device\&. +T} +T{ +routing\-rules +T}:T{ +array of \*(Aqa{sv}\*(Aq +T}:T{ +\ \& +T}:T{ +Array of dictionaries for routing rules\&. Each routing rule supports the following options: action (y), dport\-end (q), dport\-start (q), family (i), from (s), from\-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport\-end (q), sport\-start (q), supress\-prefixlength (i), table (u), to (s), tos (y), to\-len (y), range\-end (u), range\-start (u)\&. T} T{ token @@ -2829,6 +2937,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ encapsulation\-limit @@ -2858,6 +2967,15 @@ T}:T{ The flow label to assign to tunnel packets\&. This property applies only to IPv6 tunnels\&. T} T{ +fwmark +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +The fwmark value to assign to tunnel packets\&. This property can be set to a non zero value only on VTI and VTI6 tunnels\&. +T} +T{ input\-key T}:T{ string @@ -3144,7 +3262,7 @@ T}:T{ T}:T{ A list of driver names to match\&. Each element is a shell wildcard pattern\&. - See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the pattern\&. +See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the pattern\&. T} T{ interface\-name @@ -3155,7 +3273,7 @@ T}:T{ T}:T{ A list of interface names to match\&. Each element is a shell wildcard pattern\&. - An element can be prefixed with a pipe symbol (|) or an ampersand (&)\&. The former means that the element is optional and the latter means that it is mandatory\&. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR)\&. If there are any mandatory elements, then they all must match (logical AND)\&. By default, an element is optional\&. This means that an element "foo" behaves the same as "|foo"\&. An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern\&. Note that "!foo" is a shortcut for the mandatory match "&!foo"\&. Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern\&. For example, "&\e\e!a" is an mandatory match for literally "!a"\&. +An element can be prefixed with a pipe symbol (|) or an ampersand (&)\&. The former means that the element is optional and the latter means that it is mandatory\&. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR)\&. If there are any mandatory elements, then they all must match (logical AND)\&. By default, an element is optional\&. This means that an element "foo" behaves the same as "|foo"\&. An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern\&. Note that "!foo" is a shortcut for the mandatory match "&!foo"\&. Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern\&. For example, "&\e\e!a" is an mandatory match for literally "!a"\&. T} T{ kernel\-command\-line @@ -3166,7 +3284,7 @@ T}:T{ T}:T{ A list of kernel command line arguments to match\&. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark)\&. The argument must either be a single word, or an assignment (i\&.e\&. two words, joined by "=")\&. In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment\&. In the latter case, the exact assignment is looked for with right and left hand side matching\&. Wildcard patterns are not supported\&. - See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the match\&. +See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the match\&. T} T{ path @@ -3177,13 +3295,13 @@ T}:T{ T}:T{ A list of paths to match against the ID_PATH udev property of devices\&. ID_PATH represents the topological persistent path of a device\&. It typically contains a subsystem string (pci, usb, platform, etc\&.) and a subsystem\-specific identifier\&. - For PCI devices the path has the form "pci\-$domain:$bus:$device\&.$function", where each variable is an hexadecimal value; for example "pci\-0000:0a:00\&.0"\&. +For PCI devices the path has the form "pci\-$domain:$bus:$device\&.$function", where each variable is an hexadecimal value; for example "pci\-0000:0a:00\&.0"\&. - The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli \-f general\&.path device show $dev")\&. +The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli \-f general\&.path device show $dev")\&. - Each element of the list is a shell wildcard pattern\&. +Each element of the list is a shell wildcard pattern\&. - See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the pattern\&. +See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the pattern\&. T} .TE .sp 1 @@ -3224,7 +3342,7 @@ T}:T{ T}:T{ Anycast DHCP MAC address used when requesting an IP address via DHCP\&. The specific anycast address used determines which DHCP server class answers the request\&. - This is currently only implemented by dhclient DHCP plugin\&. +This is currently only implemented by dhclient DHCP plugin\&. T} T{ ssid @@ -3322,6 +3440,8 @@ Value Description T} .T& l l l l +l l l l +l l l l l l l l. T{ devargs @@ -3341,6 +3461,24 @@ T}:T{ T}:T{ Open vSwitch DPDK number of rx queues\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue\&. T} +T{ +n\-rxq\-desc +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +The rx queue size (number of rx descriptors) for DPDK ports\&. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors\&. +T} +T{ +n\-txq\-desc +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +The tx queue size (number of tx descriptors) for DPDK ports\&. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors\&. +T} .TE .sp 1 .SS "ovs\-interface setting" @@ -3359,8 +3497,18 @@ T}:T{ Value Description T} .T& +l l l l l l l l. T{ +ofport\-request +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Open vSwitch openflow port number\&. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs\&. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network\&. OpenFlow switches connect logically to each other via their OpenFlow ports\&. +T} +T{ type T}:T{ string @@ -3420,6 +3568,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ bond\-downdelay @@ -3467,13 +3616,24 @@ T}:T{ The VLAN tag in the range 0\-4095\&. T} T{ +trunks +T}:T{ +array of vardict +T}:T{ +\ \& +T}:T{ +A list of VLAN ranges that this port trunks\&. + +The property is valid only for ports with mode "trunk", "native\-tagged", or "native\-untagged port"\&. If it is empty, the port trunks all VLANs\&. +T} +T{ vlan\-mode T}:T{ string T}:T{ \ \& T}:T{ -The VLAN mode\&. One of "access", "native\-tagged", "native\-untagged", "trunk" or unset\&. +The VLAN mode\&. One of "access", "native\-tagged", "native\-untagged", "trunk", "dot1q\-tunnel" or unset\&. T} .TE .sp 1 @@ -3897,11 +4057,11 @@ T}:T{ T}:T{ 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_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\&. +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)\&. +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)\&. T} T{ total\-vfs @@ -3912,7 +4072,7 @@ T}:T{ T}:T{ 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\*(Aqt add a sriov setting to the connection\&. +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\*(Aqt add a sriov setting to the connection\&. T} T{ vfs @@ -3923,23 +4083,23 @@ T}:T{ T}:T{ Array of virtual function descriptors\&. - Each VF descriptor is a dictionary mapping attribute names to GVariant values\&. The \*(Aqindex\*(Aq entry is mandatory for each VF\&. +Each VF descriptor is a dictionary mapping attribute names to GVariant values\&. The \*(Aqindex\*(Aq entry is mandatory for each VF\&. - When represented as string a VF is in the form: +When represented as string a VF is in the form: - "INDEX [ATTR=VALUE[ ATTR=VALUE]\&.\&.\&.]"\&. +"INDEX [ATTR=VALUE[ ATTR=VALUE]\&.\&.\&.]"\&. - for example: +for example: - "2 mac=00:11:22:33:44:55 spoof\-check=true"\&. +"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\&. +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 +The "vlans" attribute is represented as a semicolon\-separated list of VLAN descriptors, where each descriptor has the form - "ID[\&.PRIORITY[\&.PROTO]]"\&. +"ID[\&.PRIORITY[\&.PROTO]]"\&. - PROTO can be either \*(Aqq\*(Aq for 802\&.1Q (the default) or \*(Aqad\*(Aq for 802\&.1ad\&. +PROTO can be either \*(Aqq\*(Aq for 802\&.1Q (the default) or \*(Aqad\*(Aq for 802\&.1ad\&. T} .TE .sp 1 @@ -3970,9 +4130,9 @@ T}:T{ T}:T{ Array of TC queueing disciplines\&. - When the "tc" setting is present, qdiscs from this property are applied upon activation\&. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net\&.core\&.default_qdisc" sysctl\&. +When the "tc" setting is present, qdiscs from this property are applied upon activation\&. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net\&.core\&.default_qdisc" sysctl\&. - If the "tc" setting is not present, NetworkManager doesn\*(Aqt touch the qdiscs present on the interface\&. +If the "tc" setting is not present, NetworkManager doesn\*(Aqt touch the qdiscs present on the interface\&. T} T{ tfilters @@ -3983,9 +4143,9 @@ T}:T{ T}:T{ Array of TC traffic filters\&. - When the "tc" setting is present, filters from this property are applied upon activation\&. If the property is empty, NetworkManager removes all the filters\&. +When the "tc" setting is present, filters from this property are applied upon activation\&. If the property is empty, NetworkManager removes all the filters\&. - If the "tc" setting is not present, NetworkManager doesn\*(Aqt touch the filters present on the interface\&. +If the "tc" setting is not present, NetworkManager doesn\*(Aqt touch the filters present on the interface\&. T} .TE .sp 1 @@ -4392,6 +4552,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ egress\-priority\-map @@ -4411,7 +4572,7 @@ T}:T{ T}:T{ One or more flags which control the behavior and features of the VLAN interface\&. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device\*(Aqs operating state)\&. NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol)\&. - The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0\&. To preserve backward compatibility, the default\-value in the D\-Bus API continues to be 0 and a missing property on D\-Bus is still considered as 0\&. +The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0\&. To preserve backward compatibility, the default\-value in the D\-Bus API continues to be 0 and a missing property on D\-Bus is still considered as 0\&. T} T{ id @@ -4449,6 +4610,17 @@ T}:T{ T}:T{ If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created\&. If this property is not specified, the connection must contain an "802\-3\-ethernet" setting with a "mac\-address" property\&. T} +T{ +protocol +T}:T{ +string +T}:T{ +\ \& +T}:T{ +Specifies the VLAN protocol to use for encapsulation\&. + +Supported values are: \*(Aq802\&.1Q\*(Aq, \*(Aq802\&.1ad\*(Aq\&. If not specified the default value is \*(Aq802\&.1Q\*(Aq\&. +T} .TE .sp 1 .SS "vpn setting" @@ -4772,7 +4944,7 @@ T}:T{ T}:T{ The Wi\-Fi Display (WFD) Information Elements (IEs) to set\&. - Wi\-Fi Display requires a protocol specific information element to be set in certain Wi\-Fi frames\&. These can be specified here for the purpose of establishing a connection\&. This setting is only useful when implementing a Wi\-Fi Display client\&. +Wi\-Fi Display requires a protocol specific information element to be set in certain Wi\-Fi frames\&. These can be specified here for the purpose of establishing a connection\&. This setting is only useful when implementing a Wi\-Fi Display client\&. T} T{ wps\-method @@ -4783,7 +4955,7 @@ T}:T{ T}:T{ Flags indicating which mode of WPS is to be used\&. - There\*(Aqs little point in changing the default setting as NetworkManager will automatically determine the best method to use\&. +There\*(Aqs little point in changing the default setting as NetworkManager will automatically determine the best method to use\&. T} .TE .sp 1 @@ -4812,7 +4984,9 @@ byte array T}:T{ \ \& T}:T{ -If specified, this connection will only apply to the WiMAX device whose MAC address matches\&. This property does not change the MAC address of the device (known as MAC spoofing)\&. Deprecated: 1 +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)\&. + +This property is deprecated since version 1\&.2\&.WiMAX is no longer supported\&. T} T{ network\-name @@ -4821,7 +4995,9 @@ string T}:T{ \ \& T}:T{ -Network Service Provider (NSP) name of the WiMAX network this connection should use\&. Deprecated: 1 +Network Service Provider (NSP) name of the WiMAX network this connection should use\&. + +This property is deprecated since version 1\&.2\&.WiMAX is no longer supported\&. T} .TE .sp 1 @@ -4911,13 +5087,13 @@ T}:T{ T}:T{ 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 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 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 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\&. +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\&. T} T{ mac\-address @@ -4973,7 +5149,7 @@ T}:T{ T}:T{ 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\&. +Currently, NetworkManager itself does nothing with this information\&. However, s390utils ships a udev rule which parses this information and applies it to the interface\&. T} T{ s390\-subchannels @@ -5047,7 +5223,7 @@ T}:T{ T}:T{ 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\&. +Note that "ip4\-auto\-default\-route" or "ip6\-auto\-default\-route" enabled, implies to automatically choose a fwmark\&. T} T{ ip4\-auto\-default\-route @@ -5058,9 +5234,9 @@ T}:T{ T}:T{ 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\*(Aqt want to set ipv4\&.gateway, because that will result in a conflicting default route\&. +Note that for this automatism to work, you usually don\*(Aqt 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\&. Since this automatism only makes sense if you also have a peer with an /0 allowed\-ips, it is usually not necessary to enable this explicitly\&. However, you can disable it if you want to configure your own routing and rules\&. +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\&. Since this automatism only makes sense if you also have a peer with an /0 allowed\-ips, it is usually not necessary to enable this explicitly\&. However, you can disable it if you want to configure your own routing and rules\&. T} T{ ip6\-auto\-default\-route @@ -5089,7 +5265,7 @@ T}:T{ T}:T{ 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\*(Aqs MTU setting, this does not take into account the current routes at the time of activation\&. +If zero a default MTU is used\&. Note that contrary to wg\-quick\*(Aqs MTU setting, this does not take into account the current routes at the time of activation\&. T} T{ peer\-routes @@ -5100,7 +5276,7 @@ TRUE T}:T{ 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\*(Aqs AllowedIPs is "0\&.0\&.0\&.0/0" or "::/0" and the profile\*(Aqs ipv4\&.never\-default or ipv6\&.never\-default setting is enabled, the peer route for this peer won\*(Aqt be added automatically\&. +Note that if the peer\*(Aqs AllowedIPs is "0\&.0\&.0\&.0/0" or "::/0" and the profile\*(Aqs ipv4\&.never\-default or ipv6\&.never\-default setting is enabled, the peer route for this peer won\*(Aqt be added automatically\&. T} T{ peers @@ -5176,11 +5352,11 @@ T}:T{ T}:T{ Configures AP isolation, which prevents communication between wireless devices connected to this AP\&. This property can be set to a value different from NM_TERNARY_DEFAULT (\-1) only when the interface is configured in AP mode\&. - If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other\&. This increases security because it protects devices against attacks from other clients in the network\&. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc\&. +If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other\&. This increases security because it protects devices against attacks from other clients in the network\&. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc\&. - If set to NM_TERNARY_FALSE (0), devices can talk to each other\&. +If set to NM_TERNARY_FALSE (0), devices can talk to each other\&. - 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_FALSE (0)\&. +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_FALSE (0)\&. T} T{ assigned\-mac\-address @@ -5209,7 +5385,7 @@ T}:T{ T}:T{ If specified, directs the device to only associate with the given access point\&. This capability is highly driver dependent and not supported by all devices\&. Note: this property does not control the BSSID used when creating an Ad\-Hoc network and is unlikely to in the future\&. - Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning\&. That can be useful, if there is only one access point for the SSID\&. +Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning\&. That can be useful, if there is only one access point for the SSID\&. T} T{ channel @@ -5238,13 +5414,13 @@ T}:T{ T}:T{ 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 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 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 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\&. +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\&. T} T{ hidden @@ -5255,11 +5431,11 @@ FALSE T}:T{ If TRUE, indicates that the network is a non\-broadcasting network that hides its SSID\&. This works both in infrastructure and AP mode\&. - In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe\-scanning the SSID\&. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution\&. +In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe\-scanning the SSID\&. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution\&. - In AP mode, the created network does not broadcast its SSID\&. +In AP mode, the created network does not broadcast its SSID\&. - Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe\-scans are distinctly recognizable on the air\&. +Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe\-scans are distinctly recognizable on the air\&. T} T{ mac\-address @@ -5286,7 +5462,9 @@ uint32 T}:T{ 0 T}:T{ -One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address)\&. This property is deprecated for \*(Aqcloned\-mac\-address\*(Aq\&. Deprecated: 1 +One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address)\&. + +This property is deprecated since version 1\&.4\&.Use the "cloned\-mac\-address" property instead\&. T} T{ mode @@ -5443,7 +5621,7 @@ T}:T{ T}:T{ 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\&. +This property must be set for any Wi\-Fi connection that uses security\&. T} T{ leap\-password @@ -5589,9 +5767,9 @@ T}:T{ T}:T{ Flags indicating which mode of WPS is to be used if any\&. - There\*(Aqs little point in changing the default setting as NetworkManager will automatically determine whether it\*(Aqs feasible to start WPS enrollment from the Access Point capabilities\&. +There\*(Aqs little point in changing the default setting as NetworkManager will automatically determine whether it\*(Aqs feasible to start WPS enrollment from the Access Point capabilities\&. - WPS can be disabled by setting this property to a value of 1\&. +WPS can be disabled by setting this property to a value of 1\&. T} .TE .sp 1 @@ -5720,7 +5898,7 @@ T}:T{ T}:T{ 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\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1)\&. +When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1)\&. T} T{ from\-dns\-lookup @@ -5731,7 +5909,7 @@ T}:T{ T}:T{ 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\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1)\&. +When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1)\&. T} T{ only\-from\-default @@ -5742,9 +5920,9 @@ T}:T{ T}:T{ 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\*(Aqt have the default route\&. +If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn\*(Aqt have the default route\&. - When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0)\&. +When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0)\&. T} T{ priority @@ -5755,9 +5933,37 @@ T}:T{ T}:T{ 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\*(Aqt have a value in the global configuration, the value is assumed to be 100\&. +If the value is zero, it can be overridden by a global value from NetworkManager configuration\&. If the property doesn\*(Aqt 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\&. +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\&. +T} +.TE +.sp 1 +.SS "loopback setting" +.PP +Loopback Link Settings\&. +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l. +T{ +mtu +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. T} .TE .sp 1 @@ -5785,7 +5991,35 @@ dict of string to string T}:T{ {} T}:T{ -A dictionary of key/value pairs with exernal\-ids for OVS\&. +A dictionary of key/value pairs with external\-ids for OVS\&. +T} +.TE +.sp 1 +.SS "ovs\-other\-config setting" +.PP +OVS Other Config Settings\&. +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l. +T{ +data +T}:T{ +dict of string to string +T}:T{ +{} +T}:T{ +A dictionary of key/value pairs with other_config settings for OVS\&. See also "other_config" in the "ovs\-vswitchd\&.conf\&.db" manual for the keys that OVS supports\&. T} .TE .sp 1 diff --git a/man/nm-settings-dbus.xml b/man/nm-settings-dbus.xml index 57cc34e9..85a0ccc5 100644 --- a/man/nm-settings-dbus.xml +++ b/man/nm-settings-dbus.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-dbus"><refentryinfo><title>nm-settings-dbus</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-dbus</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.40.12</refmiscinfo></refmeta><refnamediv><refname>nm-settings-dbus</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles on the D-Bus API</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> +<refentry id="nm-settings-dbus"><refentryinfo><title>nm-settings-dbus</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-dbus</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.42.4</refmiscinfo></refmeta><refnamediv><refname>nm-settings-dbus</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles on the D-Bus API</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on a concept of connection profiles, sometimes referred to as connections only. These connection profiles contain a network configuration. When NetworkManager activates a connection profile on a network device the configuration will @@ -32,397 +32,435 @@ profile type. <emphasis>nmcli</emphasis> connection editor has also a built-in <emphasis>describe</emphasis> command that can display description of particular settings and properties of this page. - </para></variablelist></para><refsect2><title>connection setting</title><para> General Connection Profile Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.connection.auth-retries">auth-retries</entry><entry align="left">int32</entry><entry align="left">-1</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. + </para></variablelist></para><refsect2><title>connection setting</title><para>General Connection Profile Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.connection.auth-retries">auth-retries</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.connection.autoconnect">autoconnect</entry><entry align="left">boolean</entry><entry align="left">TRUE</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. +Currently, this only applies to 802-1x authentication.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.autoconnect">autoconnect</entry><entry align="left">boolean</entry><entry align="left">TRUE</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. +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. +Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles. - If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined. +If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined. - Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.autoconnect-priority">autoconnect-priority</entry><entry align="left">int32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.connection.autoconnect-retries">autoconnect-retries</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.connection.autoconnect-slaves">autoconnect-slaves</entry><entry align="left">NMSettingConnectionAutoconnectSlaves (int32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.connection.dns-over-tls">dns-over-tls</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic. +Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.autoconnect-priority">autoconnect-priority</entry><entry align="left">int32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.connection.autoconnect-retries">autoconnect-retries</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.connection.autoconnect-slaves">autoconnect-slaves</entry><entry align="left">NMSettingConnectionAutoconnectSlaves (int32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.connection.dns-over-tls">dns-over-tls</entry><entry align="left">int32</entry><entry align="left">-1</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. +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 align="left" id="nm-settings-dbus.property.connection.gateway-ping-timeout">gateway-ping-timeout</entry><entry align="left">uint32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.connection.id">id</entry><entry align="left">string</entry><entry align="left"/><entry> A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><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). +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 align="left" id="nm-settings-dbus.property.connection.gateway-ping-timeout">gateway-ping-timeout</entry><entry align="left">uint32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.connection.id">id</entry><entry align="left">string</entry><entry align="left"/><entry>A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><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 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 align="left" id="nm-settings-dbus.property.connection.lldp">lldp</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Whether LLDP is enabled for the connection.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.llmnr">llmnr</entry><entry align="left">int32</entry><entry align="left">-1</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. +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 align="left" id="nm-settings-dbus.property.connection.lldp">lldp</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Whether LLDP is enabled for the connection.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.llmnr">llmnr</entry><entry align="left">int32</entry><entry align="left">-1</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"). +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 align="left" id="nm-settings-dbus.property.connection.master">master</entry><entry align="left">string</entry><entry align="left"/><entry> Interface name of the master device or UUID of the master connection.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.mdns">mdns</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Whether mDNS is enabled for the connection. +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 align="left" id="nm-settings-dbus.property.connection.master">master</entry><entry align="left">string</entry><entry align="left"/><entry>Interface name of the master device or UUID of the master connection.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.mdns">mdns</entry><entry align="left">int32</entry><entry align="left">-1</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"). +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 align="left" id="nm-settings-dbus.property.connection.metered">metered</entry><entry align="left">NMMetered (int32)</entry><entry align="left"/><entry> Whether the connection is metered. +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 align="left" id="nm-settings-dbus.property.connection.metered">metered</entry><entry align="left">NMMetered (int32)</entry><entry align="left"/><entry>Whether the connection is metered. - When updating this property on a currently activated connection, the change takes effect immediately.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.mptcp-flags">mptcp-flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints. +When updating this property on a currently activated connection, the change takes effect immediately.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.mptcp-flags">mptcp-flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints. - If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered. +If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered. - The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags. +The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags. - Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless. +Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless. - Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that. +Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that. - When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags. +When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags. - If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl. +If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl. - NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp. +NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp. - Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.mud-url">mud-url</entry><entry align="left">string</entry><entry align="left"/><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://". +Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.mud-url">mud-url</entry><entry align="left">string</entry><entry align="left"/><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. +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 align="left" id="nm-settings-dbus.property.connection.multi-connect">multi-connect</entry><entry align="left">int32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.connection.permissions">permissions</entry><entry align="left">array of string</entry><entry align="left"/><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". +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 align="left" id="nm-settings-dbus.property.connection.multi-connect">multi-connect</entry><entry align="left">int32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.connection.permissions">permissions</entry><entry align="left">array of string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.connection.read-only">read-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</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 align="left" id="nm-settings-dbus.property.connection.secondaries">secondaries</entry><entry align="left">array of string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.connection.slave-type">slave-type</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.connection.stable-id">stable-id</entry><entry align="left">string</entry><entry align="left"/><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. +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 align="left" id="nm-settings-dbus.property.connection.read-only">read-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</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 align="left" id="nm-settings-dbus.property.connection.secondaries">secondaries</entry><entry align="left">array of string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.connection.slave-type">slave-type</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.connection.stable-id">stable-id</entry><entry align="left">string</entry><entry align="left"/><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]. +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. See NetworkManager(8) manual about the secret-key and the host identity. +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. See NetworkManager(8) manual about the secret-key and the host identity. - 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. +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 align="left" id="nm-settings-dbus.property.connection.timestamp">timestamp</entry><entry align="left">uint64</entry><entry align="left">0</entry><entry> The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. +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 align="left" id="nm-settings-dbus.property.connection.timestamp">timestamp</entry><entry align="left">uint64</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.connection.type">type</entry><entry align="left">string</entry><entry align="left"/><entry> Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.uuid">uuid</entry><entry align="left">string</entry><entry align="left"/><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. +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 align="left" id="nm-settings-dbus.property.connection.type">type</entry><entry align="left">string</entry><entry align="left"/><entry>Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.uuid">uuid</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.connection.wait-activation-delay">wait-activation-delay</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event. +The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.wait-activation-delay">wait-activation-delay</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event. - 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 align="left" id="nm-settings-dbus.property.connection.wait-device-timeout">wait-device-timeout</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.connection.wait-device-timeout">wait-device-timeout</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.connection.zone">zone</entry><entry align="left">string</entry><entry align="left"/><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. +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 align="left" id="nm-settings-dbus.property.connection.zone">zone</entry><entry align="left">string</entry><entry align="left"/><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></informaltable></refsect2><refsect2><title>6lowpan setting</title><para> 6LoWPAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.6lowpan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry> If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-1x setting</title><para> IEEE 802.1x Authentication Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-1x.altsubject-matches">altsubject-matches</entry><entry align="left">array of string</entry><entry align="left"/><entry> List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.anonymous-identity">anonymous-identity</entry><entry align="left">string</entry><entry align="left"/><entry> Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.auth-timeout">auth-timeout</entry><entry align="left">int32</entry><entry align="left">0</entry><entry> A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.ca-cert">ca-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry> Contains the CA certificate if used by the EAP method specified in the "eap" property. +When updating this property on a currently activated connection, the change takes effect immediately.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>6lowpan setting</title><para>6LoWPAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.6lowpan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-1x setting</title><para>IEEE 802.1x Authentication Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-1x.altsubject-matches">altsubject-matches</entry><entry align="left">array of string</entry><entry align="left"/><entry>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.anonymous-identity">anonymous-identity</entry><entry align="left">string</entry><entry align="left"/><entry>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.auth-timeout">auth-timeout</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.ca-cert">ca-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry>Contains the CA certificate if used by the EAP method specified in the "eap" property. - Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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. +Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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. - Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.ca-cert-password">ca-cert-password</entry><entry align="left">string</entry><entry align="left"/><entry> The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.ca-cert-password-flags">ca-cert-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "ca-cert-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.ca-path">ca-path</entry><entry align="left">string</entry><entry align="left"/><entry> UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property. +Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.ca-cert-password">ca-cert-password</entry><entry align="left">string</entry><entry align="left"/><entry>The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.ca-cert-password-flags">ca-cert-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "ca-cert-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.ca-path">ca-path</entry><entry align="left">string</entry><entry align="left"/><entry>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property. - If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.client-cert">client-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry> Contains the client certificate if used by the EAP method specified in the "eap" property. +If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.client-cert">client-cert</entry><entry align="left">byte array</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.client-cert-password">client-cert-password</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.client-cert-password-flags">client-cert-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "client-cert-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.domain-match">domain-match</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.domain-suffix-match">domain-suffix-match</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.eap">eap</entry><entry align="left">array of string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.identity">identity</entry><entry align="left">string</entry><entry align="left"/><entry> Identity string for EAP authentication methods. Often the user's user or login name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.optional">optional</entry><entry align="left">boolean</entry><entry align="left">FALSE</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><row><entry align="left" id="nm-settings-dbus.property.802-1x.pac-file">pac-file</entry><entry align="left">string</entry><entry align="left"/><entry> UTF-8 encoded file path containing PAC for EAP-FAST.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.password">password</entry><entry align="left">string</entry><entry align="left"/><entry> UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.password-raw">password-raw</entry><entry align="left">byte array</entry><entry align="left"/><entry> Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.password-raw-flags">password-raw-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "password-raw" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase1-auth-flags">phase1-auth-flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x settings. See the wpa_supplicant documentation for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase1-fast-provisioning">phase1-fast-provisioning</entry><entry align="left">string</entry><entry align="left"/><entry> Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase1-peaplabel">phase1-peaplabel</entry><entry align="left">string</entry><entry align="left"/><entry> Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase1-peapver">phase1-peapver</entry><entry align="left">string</entry><entry align="left"/><entry> Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-altsubject-matches">phase2-altsubject-matches</entry><entry align="left">array of string</entry><entry align="left"/><entry> List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-auth">phase2-auth</entry><entry align="left">string</entry><entry align="left"/><entry> Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-autheap">phase2-autheap</entry><entry align="left">string</entry><entry align="left"/><entry> Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-ca-cert">phase2-ca-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry> Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. +Certificate data is specified using a "scheme"; two are 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 align="left" id="nm-settings-dbus.property.802-1x.client-cert-password">client-cert-password</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.client-cert-password-flags">client-cert-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "client-cert-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.domain-match">domain-match</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.domain-suffix-match">domain-suffix-match</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.eap">eap</entry><entry align="left">array of string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.identity">identity</entry><entry align="left">string</entry><entry align="left"/><entry>Identity string for EAP authentication methods. Often the user's user or login name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.optional">optional</entry><entry align="left">boolean</entry><entry align="left">FALSE</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><row><entry align="left" id="nm-settings-dbus.property.802-1x.pac-file">pac-file</entry><entry align="left">string</entry><entry align="left"/><entry>UTF-8 encoded file path containing PAC for EAP-FAST.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.password">password</entry><entry align="left">string</entry><entry align="left"/><entry>UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.password-raw">password-raw</entry><entry align="left">byte array</entry><entry align="left"/><entry>Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.password-raw-flags">password-raw-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password-raw" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase1-auth-flags">phase1-auth-flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. TLS time checks can be also disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x and tls_disable_time_checks settings. See the wpa_supplicant documentation for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase1-fast-provisioning">phase1-fast-provisioning</entry><entry align="left">string</entry><entry align="left"/><entry>Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase1-peaplabel">phase1-peaplabel</entry><entry align="left">string</entry><entry align="left"/><entry>Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase1-peapver">phase1-peapver</entry><entry align="left">string</entry><entry align="left"/><entry>Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-altsubject-matches">phase2-altsubject-matches</entry><entry align="left">array of string</entry><entry align="left"/><entry>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-auth">phase2-auth</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-autheap">phase2-autheap</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-ca-cert">phase2-ca-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry>Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. - Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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. +Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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. - Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-ca-cert-password">phase2-ca-cert-password</entry><entry align="left">string</entry><entry align="left"/><entry> The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-ca-cert-password-flags">phase2-ca-cert-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "phase2-ca-cert-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-ca-path">phase2-ca-path</entry><entry align="left">string</entry><entry align="left"/><entry> UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property. +Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-ca-cert-password">phase2-ca-cert-password</entry><entry align="left">string</entry><entry align="left"/><entry>The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-ca-cert-password-flags">phase2-ca-cert-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "phase2-ca-cert-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-ca-path">phase2-ca-path</entry><entry align="left">string</entry><entry align="left"/><entry>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property. - If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-client-cert">phase2-client-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry> Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. +If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-client-cert">phase2-client-cert</entry><entry align="left">byte array</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.phase2-client-cert-password">phase2-client-cert-password</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.phase2-client-cert-password-flags">phase2-client-cert-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "phase2-client-cert-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-domain-match">phase2-domain-match</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.phase2-domain-suffix-match">phase2-domain-suffix-match</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.phase2-private-key">phase2-private-key</entry><entry align="left">byte array</entry><entry align="left"/><entry> Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". +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 align="left" id="nm-settings-dbus.property.802-1x.phase2-client-cert-password">phase2-client-cert-password</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.phase2-client-cert-password-flags">phase2-client-cert-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "phase2-client-cert-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-domain-match">phase2-domain-match</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.phase2-domain-suffix-match">phase2-domain-suffix-match</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.phase2-private-key">phase2-private-key</entry><entry align="left">byte array</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.phase2-private-key-password">phase2-private-key-password</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.phase2-private-key-password-flags">phase2-private-key-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "phase2-private-key-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-subject-match">phase2-subject-match</entry><entry align="left">string</entry><entry align="left"/><entry> Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.pin">pin</entry><entry align="left">string</entry><entry align="left"/><entry> PIN used for EAP authentication methods.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.pin-flags">pin-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "pin" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.private-key">private-key</entry><entry align="left">byte array</entry><entry align="left"/><entry> Contains the private key when the "eap" property is set to "tls". +Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating 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 align="left" id="nm-settings-dbus.property.802-1x.phase2-private-key-password">phase2-private-key-password</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-1x.phase2-private-key-password-flags">phase2-private-key-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "phase2-private-key-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.phase2-subject-match">phase2-subject-match</entry><entry align="left">string</entry><entry align="left"/><entry>Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used. - 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 "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 "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. +This property is deprecated since version 1.2.Use "phase2-domain-suffix-match" instead.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.pin">pin</entry><entry align="left">string</entry><entry align="left"/><entry>PIN used for EAP authentication methods.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.pin-flags">pin-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "pin" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.private-key">private-key</entry><entry align="left">byte array</entry><entry align="left"/><entry>Contains the private key when the "eap" property is set to "tls". - WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.private-key-password">private-key-password</entry><entry align="left">string</entry><entry align="left"/><entry> The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.private-key-password-flags">private-key-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "private-key-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.subject-match">subject-match</entry><entry align="left">string</entry><entry align="left"/><entry> Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.system-ca-certs">system-ca-certs</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>adsl setting</title><para> ADSL Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.adsl.encapsulation">encapsulation</entry><entry align="left">string</entry><entry align="left"/><entry> Encapsulation of ADSL connection. Can be "vcmux" or "llc".</entry></row><row><entry align="left" id="nm-settings-dbus.property.adsl.password">password</entry><entry align="left">string</entry><entry align="left"/><entry> Password used to authenticate with the ADSL service.</entry></row><row><entry align="left" id="nm-settings-dbus.property.adsl.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.adsl.protocol">protocol</entry><entry align="left">string</entry><entry align="left"/><entry> ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</entry></row><row><entry align="left" id="nm-settings-dbus.property.adsl.username">username</entry><entry align="left">string</entry><entry align="left"/><entry> Username used to authenticate with the ADSL service.</entry></row><row><entry align="left" id="nm-settings-dbus.property.adsl.vci">vci</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> VCI of ADSL connection</entry></row><row><entry align="left" id="nm-settings-dbus.property.adsl.vpi">vpi</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> VPI of ADSL connection</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>bluetooth setting</title><para> Bluetooth Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.bluetooth.bdaddr">bdaddr</entry><entry align="left">byte array</entry><entry align="left"/><entry> The Bluetooth address of the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bluetooth.type">type</entry><entry align="left">string</entry><entry align="left"/><entry> Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>bond setting</title><para> Bonding Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.bond.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bond.options">options</entry><entry align="left">dict of string to string</entry><entry align="left">{'mode': 'balance-rr'}</entry><entry> Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>bridge setting</title><para> Bridging Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.bridge.ageing-time">ageing-time</entry><entry align="left">uint32</entry><entry align="left">300</entry><entry> The Ethernet MAC address aging time, in seconds.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.forward-delay">forward-delay</entry><entry align="left">uint32</entry><entry align="left">15</entry><entry> The Spanning Tree Protocol (STP) forwarding delay, in seconds.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.group-address">group-address</entry><entry align="left">byte array</entry><entry align="left"/><entry> If specified, The MAC address of the multicast group this bridge uses for STP. +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 "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 "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. - 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 align="left" id="nm-settings-dbus.property.bridge.group-forward-mask">group-forward-mask</entry><entry align="left">uint32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.bridge.hello-time">hello-time</entry><entry align="left">uint32</entry><entry align="left">2</entry><entry> The Spanning Tree Protocol (STP) hello time, in seconds.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.bridge.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry> If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. +WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.private-key-password">private-key-password</entry><entry align="left">string</entry><entry align="left"/><entry>The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.private-key-password-flags">private-key-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "private-key-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.subject-match">subject-match</entry><entry align="left">string</entry><entry align="left"/><entry>Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used. - 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 align="left" id="nm-settings-dbus.property.bridge.max-age">max-age</entry><entry align="left">uint32</entry><entry align="left">20</entry><entry> The Spanning Tree Protocol (STP) maximum message age, in seconds.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-hash-max">multicast-hash-max</entry><entry align="left">uint32</entry><entry align="left">4096</entry><entry> Set maximum size of multicast hash table (value must be a power of 2).</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-last-member-count">multicast-last-member-count</entry><entry align="left">uint32</entry><entry align="left">2</entry><entry> Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-last-member-interval">multicast-last-member-interval</entry><entry align="left">uint64</entry><entry align="left">100</entry><entry> Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-membership-interval">multicast-membership-interval</entry><entry align="left">uint64</entry><entry align="left">26000</entry><entry> Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-querier">multicast-querier</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-querier-interval">multicast-querier-interval</entry><entry align="left">uint64</entry><entry align="left">25500</entry><entry> If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-query-interval">multicast-query-interval</entry><entry align="left">uint64</entry><entry align="left">12500</entry><entry> Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-query-response-interval">multicast-query-response-interval</entry><entry align="left">uint64</entry><entry align="left">1000</entry><entry> Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-query-use-ifaddr">multicast-query-use-ifaddr</entry><entry align="left">boolean</entry><entry align="left">FALSE</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 align="left" id="nm-settings-dbus.property.bridge.multicast-router">multicast-router</entry><entry align="left">string</entry><entry align="left"/><entry> Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work. +This property is deprecated since version 1.2.Use "phase2-domain-suffix-match" instead.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-1x.system-ca-certs">system-ca-certs</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>adsl setting</title><para>ADSL Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.adsl.encapsulation">encapsulation</entry><entry align="left">string</entry><entry align="left"/><entry>Encapsulation of ADSL connection. Can be "vcmux" or "llc".</entry></row><row><entry align="left" id="nm-settings-dbus.property.adsl.password">password</entry><entry align="left">string</entry><entry align="left"/><entry>Password used to authenticate with the ADSL service.</entry></row><row><entry align="left" id="nm-settings-dbus.property.adsl.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.adsl.protocol">protocol</entry><entry align="left">string</entry><entry align="left"/><entry>ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</entry></row><row><entry align="left" id="nm-settings-dbus.property.adsl.username">username</entry><entry align="left">string</entry><entry align="left"/><entry>Username used to authenticate with the ADSL service.</entry></row><row><entry align="left" id="nm-settings-dbus.property.adsl.vci">vci</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>VCI of ADSL connection</entry></row><row><entry align="left" id="nm-settings-dbus.property.adsl.vpi">vpi</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>VPI of ADSL connection</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>bluetooth setting</title><para>Bluetooth Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.bluetooth.bdaddr">bdaddr</entry><entry align="left">byte array</entry><entry align="left"/><entry>The Bluetooth address of the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bluetooth.type">type</entry><entry align="left">string</entry><entry align="left"/><entry>Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>bond setting</title><para>Bonding Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.bond.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bond.options">options</entry><entry align="left">dict of string to string</entry><entry align="left">{'mode': 'balance-rr'}</entry><entry>Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>bridge setting</title><para>Bridging Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.bridge.ageing-time">ageing-time</entry><entry align="left">uint32</entry><entry align="left">300</entry><entry>The Ethernet MAC address aging time, in seconds.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.forward-delay">forward-delay</entry><entry align="left">uint32</entry><entry align="left">15</entry><entry>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.group-address">group-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, The MAC address of the multicast group this bridge uses for STP. - Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-snooping">multicast-snooping</entry><entry align="left">boolean</entry><entry align="left">TRUE</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 align="left" id="nm-settings-dbus.property.bridge.multicast-startup-query-count">multicast-startup-query-count</entry><entry align="left">uint32</entry><entry align="left">2</entry><entry> Set the number of IGMP queries to send during startup phase.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-startup-query-interval">multicast-startup-query-interval</entry><entry align="left">uint64</entry><entry align="left">3125</entry><entry> Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.priority">priority</entry><entry align="left">uint32</entry><entry align="left">32768</entry><entry> Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.stp">stp</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry> Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.vlan-default-pvid">vlan-default-pvid</entry><entry align="left">uint32</entry><entry align="left">1</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 align="left" id="nm-settings-dbus.property.bridge.vlan-filtering">vlan-filtering</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Control whether VLAN filtering is enabled on the bridge.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.vlan-protocol">vlan-protocol</entry><entry align="left">string</entry><entry align="left"/><entry> If specified, the protocol used for VLAN filtering. +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 align="left" id="nm-settings-dbus.property.bridge.group-forward-mask">group-forward-mask</entry><entry align="left">uint32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.bridge.hello-time">hello-time</entry><entry align="left">uint32</entry><entry align="left">2</entry><entry>The Spanning Tree Protocol (STP) hello time, in seconds.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.bridge.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. - Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.vlan-stats-enabled">vlan-stats-enabled</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Controls whether per-VLAN stats accounting is enabled.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.vlans">vlans</entry><entry align="left">array of vardict</entry><entry align="left"/><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. +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. - In nmcli the VLAN list can be specified with the following syntax: +This property is deprecated since version 1.12.Use the "cloned-mac-address" property instead.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.max-age">max-age</entry><entry align="left">uint32</entry><entry align="left">20</entry><entry>The Spanning Tree Protocol (STP) maximum message age, in seconds.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-hash-max">multicast-hash-max</entry><entry align="left">uint32</entry><entry align="left">4096</entry><entry>Set maximum size of multicast hash table (value must be a power of 2).</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-last-member-count">multicast-last-member-count</entry><entry align="left">uint32</entry><entry align="left">2</entry><entry>Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-last-member-interval">multicast-last-member-interval</entry><entry align="left">uint64</entry><entry align="left">100</entry><entry>Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-membership-interval">multicast-membership-interval</entry><entry align="left">uint64</entry><entry align="left">26000</entry><entry>Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-querier">multicast-querier</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-querier-interval">multicast-querier-interval</entry><entry align="left">uint64</entry><entry align="left">25500</entry><entry>If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-query-interval">multicast-query-interval</entry><entry align="left">uint64</entry><entry align="left">12500</entry><entry>Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-query-response-interval">multicast-query-response-interval</entry><entry align="left">uint64</entry><entry align="left">1000</entry><entry>Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-query-use-ifaddr">multicast-query-use-ifaddr</entry><entry align="left">boolean</entry><entry align="left">FALSE</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 align="left" id="nm-settings-dbus.property.bridge.multicast-router">multicast-router</entry><entry align="left">string</entry><entry align="left"/><entry>Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work. - $vid [pvid] [untagged] [, $vid [pvid] [untagged]]... +Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-snooping">multicast-snooping</entry><entry align="left">boolean</entry><entry align="left">TRUE</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 align="left" id="nm-settings-dbus.property.bridge.multicast-startup-query-count">multicast-startup-query-count</entry><entry align="left">uint32</entry><entry align="left">2</entry><entry>Set the number of IGMP queries to send during startup phase.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.multicast-startup-query-interval">multicast-startup-query-interval</entry><entry align="left">uint64</entry><entry align="left">3125</entry><entry>Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.priority">priority</entry><entry align="left">uint32</entry><entry align="left">32768</entry><entry>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.stp">stp</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.vlan-default-pvid">vlan-default-pvid</entry><entry align="left">uint32</entry><entry align="left">1</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 align="left" id="nm-settings-dbus.property.bridge.vlan-filtering">vlan-filtering</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Control whether VLAN filtering is enabled on the bridge.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.vlan-protocol">vlan-protocol</entry><entry align="left">string</entry><entry align="left"/><entry>If specified, the protocol used for VLAN filtering. - 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></informaltable></refsect2><refsect2><title>bridge-port setting</title><para> Bridge Port Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.bridge-port.hairpin-mode">hairpin-mode</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge-port.path-cost">path-cost</entry><entry align="left">uint32</entry><entry align="left">100</entry><entry> The Spanning Tree Protocol (STP) port cost for destinations via this port.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge-port.priority">priority</entry><entry align="left">uint32</entry><entry align="left">32</entry><entry> The Spanning Tree Protocol (STP) priority of this bridge port.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge-port.vlans">vlans</entry><entry align="left">array of vardict</entry><entry align="left"/><entry> Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property. +Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.vlan-stats-enabled">vlan-stats-enabled</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Controls whether per-VLAN stats accounting is enabled.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge.vlans">vlans</entry><entry align="left">array of vardict</entry><entry align="left"/><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: +In nmcli the VLAN list can be specified with the following syntax: - $vid [pvid] [untagged] [, $vid [pvid] [untagged]]... +$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></informaltable></refsect2><refsect2><title>cdma setting</title><para> CDMA-based Mobile Broadband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.cdma.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.cdma.number">number</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.cdma.password">password</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.cdma.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.cdma.username">username</entry><entry align="left">string</entry><entry align="left"/><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></informaltable></refsect2><refsect2><title>dcb setting</title><para> Data Center Bridging Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fcoe-flags">app-fcoe-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.app-fcoe-mode">app-fcoe-mode</entry><entry align="left">string</entry><entry align="left"/><entry> The FCoE controller mode; either "fabric" or "vn2vn". +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></informaltable></refsect2><refsect2><title>bridge-port setting</title><para>Bridge Port Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.bridge-port.hairpin-mode">hairpin-mode</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge-port.path-cost">path-cost</entry><entry align="left">uint32</entry><entry align="left">100</entry><entry>The Spanning Tree Protocol (STP) port cost for destinations via this port.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge-port.priority">priority</entry><entry align="left">uint32</entry><entry align="left">32</entry><entry>The Spanning Tree Protocol (STP) priority of this bridge port.</entry></row><row><entry align="left" id="nm-settings-dbus.property.bridge-port.vlans">vlans</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property. - 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 align="left" id="nm-settings-dbus.property.dcb.app-fcoe-priority">app-fcoe-priority</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.dcb.app-fip-flags">app-fip-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.app-fip-priority">app-fip-priority</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.dcb.app-iscsi-flags">app-iscsi-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.app-iscsi-priority">app-iscsi-priority</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.dcb.priority-bandwidth">priority-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.priority-flow-control">priority-flow-control</entry><entry align="left">array of uint32</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.priority-flow-control-flags">priority-flow-control-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.priority-group-bandwidth">priority-group-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.priority-group-flags">priority-group-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.priority-group-id">priority-group-id</entry><entry align="left">array of uint32</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.priority-strict-bandwidth">priority-strict-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.priority-traffic-class">priority-traffic-class</entry><entry align="left">array of uint32</entry><entry align="left"/><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></informaltable></refsect2><refsect2><title>dummy setting</title><para> Dummy Link Settings.</para><informaltable><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></informaltable></refsect2><refsect2><title>ethtool setting</title><para> Ethtool Ethernet Settings.</para><informaltable><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></informaltable></refsect2><refsect2><title>generic setting</title><para> Generic Link Settings.</para><informaltable><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></informaltable></refsect2><refsect2><title>gsm setting</title><para> GSM-based Mobile Broadband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.gsm.apn">apn</entry><entry align="left">string</entry><entry align="left"/><entry> The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.auto-config">auto-config</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.device-id">device-id</entry><entry align="left">string</entry><entry align="left"/><entry> The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.home-only">home-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.network-id">network-id</entry><entry align="left">string</entry><entry align="left"/><entry> The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.number">number</entry><entry align="left">string</entry><entry align="left"/><entry> Legacy setting that used to help establishing PPP data sessions for GSM-based modems. Deprecated: 1</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.password">password</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.gsm.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.pin">pin</entry><entry align="left">string</entry><entry align="left"/><entry> If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.pin-flags">pin-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "pin" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.sim-id">sim-id</entry><entry align="left">string</entry><entry align="left"/><entry> The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.sim-operator-id">sim-operator-id</entry><entry align="left">string</entry><entry align="left"/><entry> A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.username">username</entry><entry align="left">string</entry><entry align="left"/><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></informaltable></refsect2><refsect2><title>infiniband setting</title><para> Infiniband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.infiniband.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry> If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.infiniband.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.infiniband.p-key">p-key</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.</entry></row><row><entry align="left" id="nm-settings-dbus.property.infiniband.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry> The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".</entry></row><row><entry align="left" id="nm-settings-dbus.property.infiniband.transport-mode">transport-mode</entry><entry align="left">string</entry><entry align="left"/><entry> The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ipv4 setting</title><para> IPv4 Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ipv4.address-data">address-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv4 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.addresses">addresses</entry><entry align="left">array of array of uint32</entry><entry align="left"/><entry>Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dad-timeout">dad-timeout</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. +In nmcli the VLAN list can be specified with the following syntax: - The property is currently implemented only for IPv4.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-client-id">dhcp-client-id</entry><entry align="left">string</entry><entry align="left"/><entry> A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. +$vid [pvid] [untagged] [, $vid [pvid] [untagged]]... - The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links. +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></informaltable></refsect2><refsect2><title>cdma setting</title><para>CDMA-based Mobile Broadband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.cdma.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.cdma.number">number</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.cdma.password">password</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.cdma.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.cdma.username">username</entry><entry align="left">string</entry><entry align="left"/><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></informaltable></refsect2><refsect2><title>dcb setting</title><para>Data Center Bridging Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fcoe-flags">app-fcoe-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.app-fcoe-mode">app-fcoe-mode</entry><entry align="left">string</entry><entry align="left"/><entry>The FCoE controller mode; either "fabric" or "vn2vn". - The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset. +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 align="left" id="nm-settings-dbus.property.dcb.app-fcoe-priority">app-fcoe-priority</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.dcb.app-fip-flags">app-fip-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.app-fip-priority">app-fip-priority</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.dcb.app-iscsi-flags">app-iscsi-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.app-iscsi-priority">app-iscsi-priority</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.dcb.priority-bandwidth">priority-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.priority-flow-control">priority-flow-control</entry><entry align="left">array of uint32</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.priority-flow-control-flags">priority-flow-control-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.priority-group-bandwidth">priority-group-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.priority-group-flags">priority-group-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.priority-group-id">priority-group-id</entry><entry align="left">array of uint32</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.priority-strict-bandwidth">priority-strict-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.dcb.priority-traffic-class">priority-traffic-class</entry><entry align="left">array of uint32</entry><entry align="left"/><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></informaltable></refsect2><refsect2><title>dummy setting</title><para>Dummy Link Settings.</para><informaltable><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></informaltable></refsect2><refsect2><title>ethtool setting</title><para>Ethtool Ethernet Settings.</para><informaltable><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></informaltable></refsect2><refsect2><title>generic setting</title><para>Generic Link Settings.</para><informaltable><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></informaltable></refsect2><refsect2><title>gsm setting</title><para>GSM-based Mobile Broadband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.gsm.apn">apn</entry><entry align="left">string</entry><entry align="left"/><entry>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.auto-config">auto-config</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.device-id">device-id</entry><entry align="left">string</entry><entry align="left"/><entry>The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.home-only">home-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.network-id">network-id</entry><entry align="left">string</entry><entry align="left"/><entry>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.number">number</entry><entry align="left">string</entry><entry align="left"/><entry>Legacy setting that used to help establishing PPP data sessions for GSM-based modems. - The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id. +This property is deprecated since version 1.16.User-provided values for this setting are no longer used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.password">password</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.gsm.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.pin">pin</entry><entry align="left">string</entry><entry align="left"/><entry>If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.pin-flags">pin-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "pin" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.sim-id">sim-id</entry><entry align="left">string</entry><entry align="left"/><entry>The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.sim-operator-id">sim-operator-id</entry><entry align="left">string</entry><entry align="left"/><entry>A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.username">username</entry><entry align="left">string</entry><entry align="left"/><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></informaltable></refsect2><refsect2><title>infiniband setting</title><para>Infiniband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.infiniband.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.infiniband.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.infiniband.p-key">p-key</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.</entry></row><row><entry align="left" id="nm-settings-dbus.property.infiniband.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".</entry></row><row><entry align="left" id="nm-settings-dbus.property.infiniband.transport-mode">transport-mode</entry><entry align="left">string</entry><entry align="left"/><entry>The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ipv4 setting</title><para>IPv4 Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ipv4.address-data">address-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv4 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.addresses">addresses</entry><entry align="left">array of array of uint32</entry><entry align="left"/><entry>Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. +Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.auto-route-ext-gw">auto-route-ext-gw</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>VPN connections will default to add the route automatically unless this setting is set to FALSE. - The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key. +For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dad-timeout">dad-timeout</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. - If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-fqdn">dhcp-fqdn</entry><entry align="left">string</entry><entry align="left"/><entry> If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-hostname">dhcp-hostname</entry><entry align="left">string</entry><entry align="left"/><entry> If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-hostname-flags">dhcp-hostname-flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Flags for the DHCP hostname and FQDN. +The property is currently implemented only for IPv4.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-client-id">dhcp-client-id</entry><entry align="left">string</entry><entry align="left"/><entry>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. - Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. +The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links. - When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-iaid">dhcp-iaid</entry><entry align="left">string</entry><entry align="left"/><entry> A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-reject-servers">dhcp-reject-servers</entry><entry align="left">array of string</entry><entry align="left"/><entry> Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. +The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset. - For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). +The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id. - This property is currently not implemented for DHCPv6.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-send-hostname">dhcp-send-hostname</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry> If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-timeout">dhcp-timeout</entry><entry align="left">int32</entry><entry align="left">0</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). +The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key. - Set to 2147483647 (MAXINT32) for infinity.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-vendor-class-identifier">dhcp-vendor-class-identifier</entry><entry align="left">string</entry><entry align="left"/><entry> The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns">dns</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>Array of IP addresses of DNS servers (as network-byte-order integers)</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns-options">dns-options</entry><entry align="left">array of string</entry><entry align="left"/><entry> Array of DNS options as described in man 5 resolv.conf. +If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-fqdn">dhcp-fqdn</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-hostname">dhcp-hostname</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-hostname-flags">dhcp-hostname-flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Flags for the DHCP hostname and FQDN. - 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. +Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. - The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". +When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-iaid">dhcp-iaid</entry><entry align="left">string</entry><entry align="left"/><entry>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". - The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. +For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id. - When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns-priority">dns-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry> DNS servers priority. +For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address. - The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). +The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-reject-servers">dhcp-reject-servers</entry><entry align="left">array of string</entry><entry align="left"/><entry>Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. - Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. +For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). - 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. +This property is currently not implemented for DHCPv6.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-send-hostname">dhcp-send-hostname</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-timeout">dhcp-timeout</entry><entry align="left">int32</entry><entry align="left">0</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). - 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. +Set to 2147483647 (MAXINT32) for infinity.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-vendor-class-identifier">dhcp-vendor-class-identifier</entry><entry align="left">string</entry><entry align="left"/><entry>The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns">dns</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>Array of IP addresses of DNS servers (as network-byte-order integers)</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns-data">dns-data</entry><entry align="left">array of strings</entry><entry align="left"/><entry>Array of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns-options">dns-options</entry><entry align="left">array of string</entry><entry align="left"/><entry>Array of DNS options as described in man 5 resolv.conf. - 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. +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. - 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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. +The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". - When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns-search">dns-search</entry><entry align="left">array of string</entry><entry align="left"/><entry> List 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. +The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. - When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. +When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns-priority">dns-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>DNS servers priority. - When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.gateway">gateway</entry><entry align="left">string</entry><entry align="left"/><entry> The gateway associated with this configuration. This is only meaningful if "addresses" is also set. +The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). - Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. +Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. - Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.ignore-auto-dns">ignore-auto-dns</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.ignore-auto-routes">ignore-auto-routes</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.link-local">link-local</entry><entry align="left">int32</entry><entry align="left">0</entry><entry> Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server. +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. - When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.may-fail">may-fail</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry> If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.method">method</entry><entry align="left">string</entry><entry align="left"/><entry> IP configuration method. +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. - NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. +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. - In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. +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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. - For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. +When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns-search">dns-search</entry><entry align="left">array of string</entry><entry align="left"/><entry>List 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. - For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.never-default">never-default</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.required-timeout">required-timeout</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. +When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. - This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. +When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.gateway">gateway</entry><entry align="left">string</entry><entry align="left"/><entry>The gateway associated with this configuration. This is only meaningful if "addresses" is also set. - Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. +Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. - A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.route-data">route-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv4 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.route-metric">route-metric</entry><entry align="left">int64</entry><entry align="left">-1</entry><entry> The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.route-table">route-table</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Enable policy routing (source routing) and set the routing table used when adding routes. +Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.ignore-auto-dns">ignore-auto-dns</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.ignore-auto-routes">ignore-auto-routes</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.link-local">link-local</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server. - This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. +When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.may-fail">may-fail</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.method">method</entry><entry align="left">string</entry><entry align="left"/><entry>IP configuration method. - If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. +NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. - Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.routes">routes</entry><entry align="left">array of array of uint32</entry><entry align="left"/><entry>Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. If the metric is 0, NM will choose an appropriate default metric for the device. (There is no way to explicitly specify an actual metric of 0 with this property.)</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ipv6 setting</title><para> IPv6 Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ipv6.addr-gen-mode">addr-gen-mode</entry><entry align="left">int32</entry><entry align="left">3</entry><entry> Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3). +In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. - If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. +For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. - The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. +For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.never-default">never-default</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.replace-local-rule">replace-local-rule</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.required-timeout">required-timeout</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. - The special values "default" and "default-or-eui64" will fallback to the global connection default in as documented in NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively. +This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. - For libnm, the property defaults to "default" since 1.40. Previously it defaulted to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions. +Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. - Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.address-data">address-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv6 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.addresses">addresses</entry><entry align="left">array of legacy IPv6 address struct (a(ayuay))</entry><entry align="left"/><entry>Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv6 address structures. Each IPv6 address structure is composed of an IPv6 address, a prefix length (0 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dad-timeout">dad-timeout</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. +A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.route-data">route-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv4 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.route-metric">route-metric</entry><entry align="left">int64</entry><entry align="left">-1</entry><entry>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.route-table">route-table</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Enable policy routing (source routing) and set the routing table used when adding routes. - The property is currently implemented only for IPv4.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-duid">dhcp-duid</entry><entry align="left">string</entry><entry align="left"/><entry> A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option. +This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. - The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id. +If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. - The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk. +Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.routes">routes</entry><entry align="left">array of array of uint32</entry><entry align="left"/><entry>Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. +Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. If the metric is 0, NM will choose an appropriate default metric for the device. (There is no way to explicitly specify an actual metric of 0 with this property.)</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.routing-rules">routing-rules</entry><entry align="left">array of 'a{sv}'</entry><entry align="left"/><entry>Array of dictionaries for routing rules. Each routing rule supports the following options: action (y), dport-end (q), dport-start (q), family (i), from (s), from-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport-end (q), sport-start (q), supress-prefixlength (i), table (u), to (s), tos (y), to-len (y), range-end (u), range-start (u).</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ipv6 setting</title><para>IPv6 Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ipv6.addr-gen-mode">addr-gen-mode</entry><entry align="left">int32</entry><entry align="left">3</entry><entry>Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3). - The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt"). +If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. - When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-hostname">dhcp-hostname</entry><entry align="left">string</entry><entry align="left"/><entry> If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-hostname-flags">dhcp-hostname-flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Flags for the DHCP hostname and FQDN. +The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. - Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. +The special values "default" and "default-or-eui64" will fallback to the global connection default in as documented in NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively. - When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-iaid">dhcp-iaid</entry><entry align="left">string</entry><entry align="left"/><entry> A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-reject-servers">dhcp-reject-servers</entry><entry align="left">array of string</entry><entry align="left"/><entry> Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. +For libnm, the property defaults to "default" since 1.40. Previously it defaulted to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions. - For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). +Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.address-data">address-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv6 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.addresses">addresses</entry><entry align="left">array of legacy IPv6 address struct (a(ayuay))</entry><entry align="left"/><entry>Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. +Array of IPv6 address structures. Each IPv6 address structure is composed of an IPv6 address, a prefix length (0 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.auto-route-ext-gw">auto-route-ext-gw</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>VPN connections will default to add the route automatically unless this setting is set to FALSE. - This property is currently not implemented for DHCPv6.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-send-hostname">dhcp-send-hostname</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry> If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-timeout">dhcp-timeout</entry><entry align="left">int32</entry><entry align="left">0</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). +For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dad-timeout">dad-timeout</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. - Set to 2147483647 (MAXINT32) for infinity.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns">dns</entry><entry align="left">array of byte array</entry><entry align="left"/><entry>Array of IP addresses of DNS servers (in network byte order)</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns-options">dns-options</entry><entry align="left">array of string</entry><entry align="left"/><entry> Array of DNS options as described in man 5 resolv.conf. +The property is currently implemented only for IPv4.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-duid">dhcp-duid</entry><entry align="left">string</entry><entry align="left"/><entry>A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option. - 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. +The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id. - The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". +The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk. - The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. +The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt"). - When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns-priority">dns-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry> DNS servers priority. +When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-hostname">dhcp-hostname</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-hostname-flags">dhcp-hostname-flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Flags for the DHCP hostname and FQDN. - The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). +Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. - Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. +When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-iaid">dhcp-iaid</entry><entry align="left">string</entry><entry align="left"/><entry>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". - 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. +For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id. - 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. +For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address. - 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. +The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-reject-servers">dhcp-reject-servers</entry><entry align="left">array of string</entry><entry align="left"/><entry>Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. - 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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. +For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). - When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns-search">dns-search</entry><entry align="left">array of string</entry><entry align="left"/><entry> List 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. +This property is currently not implemented for DHCPv6.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-send-hostname">dhcp-send-hostname</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-timeout">dhcp-timeout</entry><entry align="left">int32</entry><entry align="left">0</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). - When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. +Set to 2147483647 (MAXINT32) for infinity.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns">dns</entry><entry align="left">array of byte array</entry><entry align="left"/><entry>Array of IP addresses of DNS servers (in network byte order)</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns-data">dns-data</entry><entry align="left">array of strings</entry><entry align="left"/><entry>Array of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns-options">dns-options</entry><entry align="left">array of string</entry><entry align="left"/><entry>Array of DNS options as described in man 5 resolv.conf. - When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.gateway">gateway</entry><entry align="left">string</entry><entry align="left"/><entry> The gateway associated with this configuration. This is only meaningful if "addresses" is also set. +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. - Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. +The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". - Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.ignore-auto-dns">ignore-auto-dns</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.ignore-auto-routes">ignore-auto-routes</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.ip6-privacy">ip6-privacy</entry><entry align="left">NMSettingIP6ConfigPrivacy (int32)</entry><entry align="left"/><entry> Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). +The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. - Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". +When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns-priority">dns-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>DNS servers priority. - If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". +The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). - Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.may-fail">may-fail</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry> If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.method">method</entry><entry align="left">string</entry><entry align="left"/><entry> IP configuration method. +Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. - NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. +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. - In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. +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. - For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. +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. - For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.never-default">never-default</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.ra-timeout">ra-timeout</entry><entry align="left">int32</entry><entry align="left">0</entry><entry> A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device. +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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. - Set to 2147483647 (MAXINT32) for infinity.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.required-timeout">required-timeout</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. +When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns-search">dns-search</entry><entry align="left">array of string</entry><entry align="left"/><entry>List 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. - This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. +When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. - Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. +When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.gateway">gateway</entry><entry align="left">string</entry><entry align="left"/><entry>The gateway associated with this configuration. This is only meaningful if "addresses" is also set. - A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.route-data">route-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv6 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.route-metric">route-metric</entry><entry align="left">int64</entry><entry align="left">-1</entry><entry> The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.route-table">route-table</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Enable policy routing (source routing) and set the routing table used when adding routes. +Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. - This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. +Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.ignore-auto-dns">ignore-auto-dns</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.ignore-auto-routes">ignore-auto-routes</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.ip6-privacy">ip6-privacy</entry><entry align="left">NMSettingIP6ConfigPrivacy (int32)</entry><entry align="left"/><entry>Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). - If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. +Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". - Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.routes">routes</entry><entry align="left">array of legacy IPv6 route struct (a(ayuayu))</entry><entry align="left"/><entry>Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv6 route structures. Each IPv6 route structure is composed of an IPv6 address, a prefix length (0 - 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric. If the metric is 0, NM will choose an appropriate default metric for the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.token">token</entry><entry align="left">string</entry><entry align="left"/><entry> Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ip-tunnel setting</title><para> IP Tunneling Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.encapsulation-limit">encapsulation-limit</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.flags">flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.flow-label">flow-label</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.input-key">input-key</entry><entry align="left">string</entry><entry align="left"/><entry> The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.local">local</entry><entry align="left">string</entry><entry align="left"/><entry> The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.mode">mode</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.output-key">output-key</entry><entry align="left">string</entry><entry align="left"/><entry> The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry> If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.path-mtu-discovery">path-mtu-discovery</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry> Whether to enable Path MTU Discovery on this tunnel.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.remote">remote</entry><entry align="left">string</entry><entry align="left"/><entry> The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.tos">tos</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.ttl">ttl</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>macsec setting</title><para> MACSec Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.macsec.encrypt">encrypt</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry> Whether the transmitted traffic must be encrypted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-cak">mka-cak</entry><entry align="left">string</entry><entry align="left"/><entry> The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-cak-flags">mka-cak-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "mka-cak" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-ckn">mka-ckn</entry><entry align="left">string</entry><entry align="left"/><entry> The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mode">mode</entry><entry align="left">int32</entry><entry align="left">0</entry><entry> Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry> If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.port">port</entry><entry align="left">int32</entry><entry align="left">1</entry><entry> The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.send-sci">send-sci</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry> Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.validation">validation</entry><entry align="left">int32</entry><entry align="left">2</entry><entry> Specifies the validation mode for incoming frames.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>macvlan setting</title><para> MAC VLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.macvlan.mode">mode</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry> If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.promiscuous">promiscuous</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry> Whether the interface should be put in promiscuous mode.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.tap">tap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Whether the interface should be a MACVTAP.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>match setting</title><para> Match settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.match.driver">driver</entry><entry align="left">array of string</entry><entry align="left"/><entry> A list of driver names to match. Each element is a shell wildcard pattern. +If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". - See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</entry></row><row><entry align="left" id="nm-settings-dbus.property.match.interface-name">interface-name</entry><entry align="left">array of string</entry><entry align="left"/><entry> A list of interface names to match. Each element is a shell wildcard pattern. +Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.may-fail">may-fail</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.method">method</entry><entry align="left">string</entry><entry align="left"/><entry>IP configuration method. - An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".</entry></row><row><entry align="left" id="nm-settings-dbus.property.match.kernel-command-line">kernel-command-line</entry><entry align="left">array of string</entry><entry align="left"/><entry> A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported. +NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. - See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.</entry></row><row><entry align="left" id="nm-settings-dbus.property.match.path">path</entry><entry align="left">array of string</entry><entry align="left"/><entry> A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier. +In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. - For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0". +For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. - The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev"). +For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.never-default">never-default</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.ra-timeout">ra-timeout</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device. - Each element of the list is a shell wildcard pattern. +Set to 2147483647 (MAXINT32) for infinity.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.replace-local-rule">replace-local-rule</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.required-timeout">required-timeout</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. - See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-11-olpc-mesh setting</title><para> OLPC Wireless Mesh Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-11-olpc-mesh.channel">channel</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Channel on which the mesh network to join is located.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-olpc-mesh.dhcp-anycast-address">dhcp-anycast-address</entry><entry align="left">byte array</entry><entry align="left"/><entry> Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. +This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. - This is currently only implemented by dhclient DHCP plugin.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-olpc-mesh.ssid">ssid</entry><entry align="left">byte array</entry><entry align="left"/><entry> SSID of the mesh network to join.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-bridge setting</title><para> OvsBridge Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.datapath-type">datapath-type</entry><entry align="left">string</entry><entry align="left"/><entry> The data path type. One of "system", "netdev" or empty.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.fail-mode">fail-mode</entry><entry align="left">string</entry><entry align="left"/><entry> The bridge failure mode. One of "secure", "standalone" or empty.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.mcast-snooping-enable">mcast-snooping-enable</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Enable or disable multicast snooping.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.rstp-enable">rstp-enable</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Enable or disable RSTP.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.stp-enable">stp-enable</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Enable or disable STP.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-dpdk setting</title><para> OvsDpdk Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-dpdk.devargs">devargs</entry><entry align="left">string</entry><entry align="left"/><entry> Open vSwitch DPDK device arguments.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-dpdk.n-rxq">n-rxq</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-interface setting</title><para> Open vSwitch Interface Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-interface.type">type</entry><entry align="left">string</entry><entry align="left"/><entry> The interface type. Either "internal", "system", "patch", "dpdk", or empty.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-patch setting</title><para> OvsPatch Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-patch.peer">peer</entry><entry align="left">string</entry><entry align="left"/><entry> Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-port setting</title><para> OvsPort Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-port.bond-downdelay">bond-downdelay</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> The time port must be inactive in order to be considered down.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.bond-mode">bond-mode</entry><entry align="left">string</entry><entry align="left"/><entry> Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.bond-updelay">bond-updelay</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> The time port must be active before it starts forwarding traffic.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.lacp">lacp</entry><entry align="left">string</entry><entry align="left"/><entry> LACP mode. One of "active", "off", or "passive".</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.tag">tag</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> The VLAN tag in the range 0-4095.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.vlan-mode">vlan-mode</entry><entry align="left">string</entry><entry align="left"/><entry> The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ppp setting</title><para> Point-to-Point Protocol Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ppp.baud">baud</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.crtscts">crtscts</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.lcp-echo-failure">lcp-echo-failure</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.lcp-echo-interval">lcp-echo-interval</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.mppe-stateful">mppe-stateful</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.mru">mru</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> If non-zero, instruct pppd to send packets no larger than the specified size.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.no-vj-comp">no-vj-comp</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, Van Jacobsen TCP header compression will not be requested.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.noauth">noauth</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry> If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.nobsdcomp">nobsdcomp</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, BSD compression will not be requested.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.nodeflate">nodeflate</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, "deflate" compression will not be requested.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-chap">refuse-chap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, the CHAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-eap">refuse-eap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, the EAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-mschap">refuse-mschap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, the MSCHAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-mschapv2">refuse-mschapv2</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, the MSCHAPv2 authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-pap">refuse-pap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, the PAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.require-mppe">require-mppe</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.require-mppe-128">require-mppe-128</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>pppoe setting</title><para> PPP-over-Ethernet Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.pppoe.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry> If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.password">password</entry><entry align="left">string</entry><entry align="left"/><entry> Password used to authenticate with the PPPoE service.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.service">service</entry><entry align="left">string</entry><entry align="left"/><entry> If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.username">username</entry><entry align="left">string</entry><entry align="left"/><entry> Username used to authenticate with the PPPoE service.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>proxy setting</title><para> WWW Proxy Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.proxy.browser-only">browser-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Whether the proxy configuration is for browser only.</entry></row><row><entry align="left" id="nm-settings-dbus.property.proxy.method">method</entry><entry align="left">int32</entry><entry align="left">0</entry><entry> Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</entry></row><row><entry align="left" id="nm-settings-dbus.property.proxy.pac-script">pac-script</entry><entry align="left">string</entry><entry align="left"/><entry> PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.</entry></row><row><entry align="left" id="nm-settings-dbus.property.proxy.pac-url">pac-url</entry><entry align="left">string</entry><entry align="left"/><entry> PAC URL for obtaining PAC file.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>serial setting</title><para> Serial Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.serial.baud">baud</entry><entry align="left">uint32</entry><entry align="left">57600</entry><entry> Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.bits">bits</entry><entry align="left">uint32</entry><entry align="left">8</entry><entry> Byte-width of the serial communication. The 8 in "8n1" for example.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.parity">parity</entry><entry align="left">byte</entry><entry align="left"/><entry>The connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.send-delay">send-delay</entry><entry align="left">uint64</entry><entry align="left">0</entry><entry> Time to delay between each byte sent to the modem, in microseconds.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.stopbits">stopbits</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry> Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>sriov setting</title><para> SR-IOV settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.sriov.autoprobe-drivers">autoprobe-drivers</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry> Whether to autoprobe virtual functions by a compatible driver. +Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. - 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. +A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.route-data">route-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv6 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.route-metric">route-metric</entry><entry align="left">int64</entry><entry align="left">-1</entry><entry>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.route-table">route-table</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Enable policy routing (source routing) and set the routing table used when adding routes. - If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them. +This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. - 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 align="left" id="nm-settings-dbus.property.sriov.total-vfs">total-vfs</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> The total number of virtual functions to create. +If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. - 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 align="left" id="nm-settings-dbus.property.sriov.vfs">vfs</entry><entry align="left">array of vardict</entry><entry align="left"/><entry> Array of virtual function descriptors. +Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.routes">routes</entry><entry align="left">array of legacy IPv6 route struct (a(ayuayu))</entry><entry align="left"/><entry>Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. +Array of IPv6 route structures. Each IPv6 route structure is composed of an IPv6 address, a prefix length (0 - 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric. If the metric is 0, NM will choose an appropriate default metric for the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.routing-rules">routing-rules</entry><entry align="left">array of 'a{sv}'</entry><entry align="left"/><entry>Array of dictionaries for routing rules. Each routing rule supports the following options: action (y), dport-end (q), dport-start (q), family (i), from (s), from-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport-end (q), sport-start (q), supress-prefixlength (i), table (u), to (s), tos (y), to-len (y), range-end (u), range-start (u).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.token">token</entry><entry align="left">string</entry><entry align="left"/><entry>Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ip-tunnel setting</title><para>IP Tunneling Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.encapsulation-limit">encapsulation-limit</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.flags">flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.flow-label">flow-label</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.fwmark">fwmark</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.input-key">input-key</entry><entry align="left">string</entry><entry align="left"/><entry>The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.local">local</entry><entry align="left">string</entry><entry align="left"/><entry>The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.mode">mode</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.output-key">output-key</entry><entry align="left">string</entry><entry align="left"/><entry>The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.path-mtu-discovery">path-mtu-discovery</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether to enable Path MTU Discovery on this tunnel.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.remote">remote</entry><entry align="left">string</entry><entry align="left"/><entry>The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.tos">tos</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.ttl">ttl</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>macsec setting</title><para>MACSec Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.macsec.encrypt">encrypt</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether the transmitted traffic must be encrypted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-cak">mka-cak</entry><entry align="left">string</entry><entry align="left"/><entry>The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-cak-flags">mka-cak-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "mka-cak" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-ckn">mka-ckn</entry><entry align="left">string</entry><entry align="left"/><entry>The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mode">mode</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.port">port</entry><entry align="left">int32</entry><entry align="left">1</entry><entry>The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.send-sci">send-sci</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.validation">validation</entry><entry align="left">int32</entry><entry align="left">2</entry><entry>Specifies the validation mode for incoming frames.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>macvlan setting</title><para>MAC VLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.macvlan.mode">mode</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.promiscuous">promiscuous</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether the interface should be put in promiscuous mode.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.tap">tap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Whether the interface should be a MACVTAP.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>match setting</title><para>Match settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.match.driver">driver</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of driver names to match. Each element is a shell wildcard pattern. - Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF. +See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</entry></row><row><entry align="left" id="nm-settings-dbus.property.match.interface-name">interface-name</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of interface names to match. Each element is a shell wildcard pattern. - When represented as string a VF is in the form: +An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".</entry></row><row><entry align="left" id="nm-settings-dbus.property.match.kernel-command-line">kernel-command-line</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported. - "INDEX [ATTR=VALUE[ ATTR=VALUE]...]". +See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.</entry></row><row><entry align="left" id="nm-settings-dbus.property.match.path">path</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier. - for example: +For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0". - "2 mac=00:11:22:33:44:55 spoof-check=true". +The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev"). - 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. +Each element of the list is a shell wildcard pattern. - The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form +See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-11-olpc-mesh setting</title><para>OLPC Wireless Mesh Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-11-olpc-mesh.channel">channel</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Channel on which the mesh network to join is located.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-olpc-mesh.dhcp-anycast-address">dhcp-anycast-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. - "ID[.PRIORITY[.PROTO]]". +This is currently only implemented by dhclient DHCP plugin.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-olpc-mesh.ssid">ssid</entry><entry align="left">byte array</entry><entry align="left"/><entry>SSID of the mesh network to join.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-bridge setting</title><para>OvsBridge Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.datapath-type">datapath-type</entry><entry align="left">string</entry><entry align="left"/><entry>The data path type. One of "system", "netdev" or empty.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.fail-mode">fail-mode</entry><entry align="left">string</entry><entry align="left"/><entry>The bridge failure mode. One of "secure", "standalone" or empty.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.mcast-snooping-enable">mcast-snooping-enable</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Enable or disable multicast snooping.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.rstp-enable">rstp-enable</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Enable or disable RSTP.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.stp-enable">stp-enable</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Enable or disable STP.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-dpdk setting</title><para>OvsDpdk Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-dpdk.devargs">devargs</entry><entry align="left">string</entry><entry align="left"/><entry>Open vSwitch DPDK device arguments.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-dpdk.n-rxq">n-rxq</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-dpdk.n-rxq-desc">n-rxq-desc</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The rx queue size (number of rx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-dpdk.n-txq-desc">n-txq-desc</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The tx queue size (number of tx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-interface setting</title><para>Open vSwitch Interface Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-interface.ofport-request">ofport-request</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Open vSwitch openflow port number. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network. OpenFlow switches connect logically to each other via their OpenFlow ports.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-interface.type">type</entry><entry align="left">string</entry><entry align="left"/><entry>The interface type. Either "internal", "system", "patch", "dpdk", or empty.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-patch setting</title><para>OvsPatch Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-patch.peer">peer</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-port setting</title><para>OvsPort Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-port.bond-downdelay">bond-downdelay</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The time port must be inactive in order to be considered down.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.bond-mode">bond-mode</entry><entry align="left">string</entry><entry align="left"/><entry>Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.bond-updelay">bond-updelay</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The time port must be active before it starts forwarding traffic.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.lacp">lacp</entry><entry align="left">string</entry><entry align="left"/><entry>LACP mode. One of "active", "off", or "passive".</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.tag">tag</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The VLAN tag in the range 0-4095.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.trunks">trunks</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>A list of VLAN ranges that this port trunks. - PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>tc setting</title><para> Linux Traffic Control Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.tc.qdiscs">qdiscs</entry><entry align="left">array of vardict</entry><entry align="left"/><entry> Array of TC queueing disciplines. +The property is valid only for ports with mode "trunk", "native-tagged", or "native-untagged port". If it is empty, the port trunks all VLANs.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.vlan-mode">vlan-mode</entry><entry align="left">string</entry><entry align="left"/><entry>The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ppp setting</title><para>Point-to-Point Protocol Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ppp.baud">baud</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.crtscts">crtscts</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.lcp-echo-failure">lcp-echo-failure</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.lcp-echo-interval">lcp-echo-interval</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.mppe-stateful">mppe-stateful</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.mru">mru</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to send packets no larger than the specified size.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.no-vj-comp">no-vj-comp</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, Van Jacobsen TCP header compression will not be requested.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.noauth">noauth</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.nobsdcomp">nobsdcomp</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, BSD compression will not be requested.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.nodeflate">nodeflate</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, "deflate" compression will not be requested.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-chap">refuse-chap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the CHAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-eap">refuse-eap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the EAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-mschap">refuse-mschap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the MSCHAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-mschapv2">refuse-mschapv2</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the MSCHAPv2 authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-pap">refuse-pap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the PAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.require-mppe">require-mppe</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.require-mppe-128">require-mppe-128</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>pppoe setting</title><para>PPP-over-Ethernet Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.pppoe.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.password">password</entry><entry align="left">string</entry><entry align="left"/><entry>Password used to authenticate with the PPPoE service.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.service">service</entry><entry align="left">string</entry><entry align="left"/><entry>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.username">username</entry><entry align="left">string</entry><entry align="left"/><entry>Username used to authenticate with the PPPoE service.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>proxy setting</title><para>WWW Proxy Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.proxy.browser-only">browser-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Whether the proxy configuration is for browser only.</entry></row><row><entry align="left" id="nm-settings-dbus.property.proxy.method">method</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</entry></row><row><entry align="left" id="nm-settings-dbus.property.proxy.pac-script">pac-script</entry><entry align="left">string</entry><entry align="left"/><entry>PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.</entry></row><row><entry align="left" id="nm-settings-dbus.property.proxy.pac-url">pac-url</entry><entry align="left">string</entry><entry align="left"/><entry>PAC URL for obtaining PAC file.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>serial setting</title><para>Serial Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.serial.baud">baud</entry><entry align="left">uint32</entry><entry align="left">57600</entry><entry>Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.bits">bits</entry><entry align="left">uint32</entry><entry align="left">8</entry><entry>Byte-width of the serial communication. The 8 in "8n1" for example.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.parity">parity</entry><entry align="left">byte</entry><entry align="left"/><entry>The connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.send-delay">send-delay</entry><entry align="left">uint64</entry><entry align="left">0</entry><entry>Time to delay between each byte sent to the modem, in microseconds.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.stopbits">stopbits</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>sriov setting</title><para>SR-IOV settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.sriov.autoprobe-drivers">autoprobe-drivers</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>Whether to autoprobe virtual functions by a compatible driver. - When the "tc" setting is present, qdiscs from this property are applied upon activation. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net.core.default_qdisc" sysctl. +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 the "tc" setting is not present, NetworkManager doesn't touch the qdiscs present on the interface.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tc.tfilters">tfilters</entry><entry align="left">array of vardict</entry><entry align="left"/><entry> Array of TC traffic filters. +If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them. - When the "tc" setting is present, filters from this property are applied upon activation. If the property is empty, NetworkManager removes all the filters. +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 align="left" id="nm-settings-dbus.property.sriov.total-vfs">total-vfs</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The total number of virtual functions to create. - If the "tc" setting is not present, NetworkManager doesn't touch the filters present on the interface.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>team setting</title><para> Teaming Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.team.config">config</entry><entry align="left">string</entry><entry align="left"/><entry> The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.link-watchers">link-watchers</entry><entry align="left">array of vardict</entry><entry align="left"/><entry> Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.mcast-rejoin-count">mcast-rejoin-count</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Corresponds to the teamd mcast_rejoin.count.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.mcast-rejoin-interval">mcast-rejoin-interval</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Corresponds to the teamd mcast_rejoin.interval.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.notify-peers-count">notify-peers-count</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Corresponds to the teamd notify_peers.count.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.notify-peers-interval">notify-peers-interval</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Corresponds to the teamd notify_peers.interval.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner">runner</entry><entry align="left">string</entry><entry align="left"/><entry> Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-active">runner-active</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry> Corresponds to the teamd runner.active.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-agg-select-policy">runner-agg-select-policy</entry><entry align="left">string</entry><entry align="left"/><entry> Corresponds to the teamd runner.agg_select_policy.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-fast-rate">runner-fast-rate</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Corresponds to the teamd runner.fast_rate.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-hwaddr-policy">runner-hwaddr-policy</entry><entry align="left">string</entry><entry align="left"/><entry> Corresponds to the teamd runner.hwaddr_policy.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-min-ports">runner-min-ports</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Corresponds to the teamd runner.min_ports.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-sys-prio">runner-sys-prio</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Corresponds to the teamd runner.sys_prio.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-tx-balancer">runner-tx-balancer</entry><entry align="left">string</entry><entry align="left"/><entry> Corresponds to the teamd runner.tx_balancer.name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-tx-balancer-interval">runner-tx-balancer-interval</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Corresponds to the teamd runner.tx_balancer.interval.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-tx-hash">runner-tx-hash</entry><entry align="left">array of string</entry><entry align="left"/><entry> Corresponds to the teamd runner.tx_hash.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>team-port setting</title><para> Team Port Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.team-port.config">config</entry><entry align="left">string</entry><entry align="left"/><entry> The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.lacp-key">lacp-key</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Corresponds to the teamd ports.PORTIFNAME.lacp_key.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.lacp-prio">lacp-prio</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.link-watchers">link-watchers</entry><entry align="left">array of vardict</entry><entry align="left"/><entry> Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.prio">prio</entry><entry align="left">int32</entry><entry align="left">0</entry><entry> Corresponds to the teamd ports.PORTIFNAME.prio.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.queue-id">queue-id</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry> Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.sticky">sticky</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Corresponds to the teamd ports.PORTIFNAME.sticky.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>tun setting</title><para> Tunnel Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.tun.group">group</entry><entry align="left">string</entry><entry align="left"/><entry> The group ID which will own the device. If set to NULL everyone will be able to use the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.mode">mode</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry> The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.multi-queue">multi-queue</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.owner">owner</entry><entry align="left">string</entry><entry align="left"/><entry> The user ID which will own the device. If set to NULL everyone will be able to use the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.pi">pi</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.vnet-hdr">vnet-hdr</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>user setting</title><para> General User Profile Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.user.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry> A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>vlan setting</title><para> VLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.vlan.egress-priority-map">egress-priority-map</entry><entry align="left">array of string</entry><entry align="left"/><entry> For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.flags">flags</entry><entry align="left">NMVlanFlags (uint32)</entry><entry align="left"/><entry> One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). +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 align="left" id="nm-settings-dbus.property.sriov.vfs">vfs</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of virtual function descriptors. - The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.id">id</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.ingress-priority-map">ingress-priority-map</entry><entry align="left">array of string</entry><entry align="left"/><entry> For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry> If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>vpn setting</title><para> VPN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.vpn.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry> Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vpn.persistent">persistent</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vpn.secrets">secrets</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry> Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vpn.service-type">service-type</entry><entry align="left">string</entry><entry align="left"/><entry> D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vpn.timeout">timeout</entry><entry align="left">uint32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.vpn.user-name">user-name</entry><entry align="left">string</entry><entry align="left"/><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></informaltable></refsect2><refsect2><title>vrf setting</title><para> VRF settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.vrf.table">table</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> The routing table for this VRF.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>vxlan setting</title><para> VXLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.vxlan.ageing">ageing</entry><entry align="left">uint32</entry><entry align="left">300</entry><entry> Specifies the lifetime in seconds of FDB entries learnt by the kernel.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.destination-port">destination-port</entry><entry align="left">uint32</entry><entry align="left">8472</entry><entry> Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.id">id</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.l2-miss">l2-miss</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Specifies whether netlink LL ADDR miss notifications are generated.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.l3-miss">l3-miss</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Specifies whether netlink IP ADDR miss notifications are generated.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.learning">learning</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry> Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.limit">limit</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.local">local</entry><entry align="left">string</entry><entry align="left"/><entry> If given, specifies the source IP address to use in outgoing packets.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry> If given, specifies the parent interface name or parent connection UUID.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.proxy">proxy</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Specifies whether ARP proxy is turned on.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.remote">remote</entry><entry align="left">string</entry><entry align="left"/><entry> Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.rsc">rsc</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> Specifies whether route short circuit is turned on.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.source-port-max">source-port-max</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.source-port-min">source-port-min</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.tos">tos</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Specifies the TOS value to use in outgoing packets.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.ttl">ttl</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Specifies the time-to-live value to use in outgoing packets.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>wifi-p2p setting</title><para> Wi-Fi P2P Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.wifi-p2p.peer">peer</entry><entry align="left">string</entry><entry align="left"/><entry> The P2P device that should be connected to. Currently, this is the only way to create or join a group.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wifi-p2p.wfd-ies">wfd-ies</entry><entry align="left">byte array</entry><entry align="left"/><entry> The Wi-Fi Display (WFD) Information Elements (IEs) to set. +Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF. - Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wifi-p2p.wps-method">wps-method</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Flags indicating which mode of WPS is to be used. +When represented as string a VF is in the form: - There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>wimax setting</title><para> WiMax Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.wimax.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.wimax.network-name">network-name</entry><entry align="left">string</entry><entry align="left"/><entry> Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-3-ethernet setting</title><para> Wired Ethernet Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.accept-all-mac-addresses">accept-all-mac-addresses</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-3-ethernet.assigned-mac-address">assigned-mac-address</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-3-ethernet.auto-negotiate">auto-negotiate</entry><entry align="left">boolean</entry><entry align="left">FALSE</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 align="left" id="nm-settings-dbus.property.802-3-ethernet.cloned-mac-address">cloned-mac-address</entry><entry align="left">byte array</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-3-ethernet.duplex">duplex</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-3-ethernet.generate-mac-address-mask">generate-mac-address-mask</entry><entry align="left">string</entry><entry align="left"/><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. +"INDEX [ATTR=VALUE[ ATTR=VALUE]...]". - 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. +for example: - 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. +"2 mac=00:11:22:33:44:55 spoof-check=true". - 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. +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. - 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 align="left" id="nm-settings-dbus.property.802-3-ethernet.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry> If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.mac-address-blacklist">mac-address-blacklist</entry><entry align="left">array of string</entry><entry align="left"/><entry> If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.port">port</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-3-ethernet.s390-nettype">s390-nettype</entry><entry align="left">string</entry><entry align="left"/><entry> s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.s390-options">s390-options</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry> Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). +The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form - 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 align="left" id="nm-settings-dbus.property.802-3-ethernet.s390-subchannels">s390-subchannels</entry><entry align="left">array of string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-3-ethernet.speed">speed</entry><entry align="left">uint32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.802-3-ethernet.wake-on-lan">wake-on-lan</entry><entry align="left">uint32</entry><entry align="left">1</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 align="left" id="nm-settings-dbus.property.802-3-ethernet.wake-on-lan-password">wake-on-lan-password</entry><entry align="left">string</entry><entry align="left"/><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></informaltable></refsect2><refsect2><title>wireguard setting</title><para> WireGuard Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.wireguard.fwmark">fwmark</entry><entry align="left">uint32</entry><entry align="left">0</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. +"ID[.PRIORITY[.PROTO]]". - Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.ip4-auto-default-route">ip4-auto-default-route</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><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". +PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>tc setting</title><para>Linux Traffic Control Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.tc.qdiscs">qdiscs</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of TC queueing disciplines. - 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. +When the "tc" setting is present, qdiscs from this property are applied upon activation. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net.core.default_qdisc" sysctl. - 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. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.ip6-auto-default-route">ip6-auto-default-route</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry> Like ip4-auto-default-route, but for the IPv6 default route.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.listen-port">listen-port</entry><entry align="left">uint32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.wireguard.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. +If the "tc" setting is not present, NetworkManager doesn't touch the qdiscs present on the interface.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tc.tfilters">tfilters</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of TC traffic filters. - 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 align="left" id="nm-settings-dbus.property.wireguard.peer-routes">peer-routes</entry><entry align="left">boolean</entry><entry align="left">TRUE</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. +When the "tc" setting is present, filters from this property are applied upon activation. If the property is empty, NetworkManager removes all the filters. - 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 align="left" id="nm-settings-dbus.property.wireguard.peers">peers</entry><entry align="left">array of 'a{sv}'</entry><entry align="left"/><entry>Array of dictionaries for the WireGuard peers.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.private-key">private-key</entry><entry align="left">string</entry><entry align="left"/><entry> The 256 bit private-key in base64 encoding.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.private-key-flags">private-key-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "private-key" property.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-11-wireless setting</title><para> Wi-Fi Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.ap-isolation">ap-isolation</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry> Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode. +If the "tc" setting is not present, NetworkManager doesn't touch the filters present on the interface.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>team setting</title><para>Teaming Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.team.config">config</entry><entry align="left">string</entry><entry align="left"/><entry>The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.link-watchers">link-watchers</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.mcast-rejoin-count">mcast-rejoin-count</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd mcast_rejoin.count.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.mcast-rejoin-interval">mcast-rejoin-interval</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd mcast_rejoin.interval.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.notify-peers-count">notify-peers-count</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd notify_peers.count.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.notify-peers-interval">notify-peers-interval</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd notify_peers.interval.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner">runner</entry><entry align="left">string</entry><entry align="left"/><entry>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-active">runner-active</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Corresponds to the teamd runner.active.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-agg-select-policy">runner-agg-select-policy</entry><entry align="left">string</entry><entry align="left"/><entry>Corresponds to the teamd runner.agg_select_policy.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-fast-rate">runner-fast-rate</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Corresponds to the teamd runner.fast_rate.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-hwaddr-policy">runner-hwaddr-policy</entry><entry align="left">string</entry><entry align="left"/><entry>Corresponds to the teamd runner.hwaddr_policy.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-min-ports">runner-min-ports</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd runner.min_ports.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-sys-prio">runner-sys-prio</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd runner.sys_prio.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-tx-balancer">runner-tx-balancer</entry><entry align="left">string</entry><entry align="left"/><entry>Corresponds to the teamd runner.tx_balancer.name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-tx-balancer-interval">runner-tx-balancer-interval</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd runner.tx_balancer.interval.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-tx-hash">runner-tx-hash</entry><entry align="left">array of string</entry><entry align="left"/><entry>Corresponds to the teamd runner.tx_hash.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>team-port setting</title><para>Team Port Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.team-port.config">config</entry><entry align="left">string</entry><entry align="left"/><entry>The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.lacp-key">lacp-key</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd ports.PORTIFNAME.lacp_key.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.lacp-prio">lacp-prio</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.link-watchers">link-watchers</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.prio">prio</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Corresponds to the teamd ports.PORTIFNAME.prio.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.queue-id">queue-id</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.sticky">sticky</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Corresponds to the teamd ports.PORTIFNAME.sticky.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>tun setting</title><para>Tunnel Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.tun.group">group</entry><entry align="left">string</entry><entry align="left"/><entry>The group ID which will own the device. If set to NULL everyone will be able to use the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.mode">mode</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.multi-queue">multi-queue</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.owner">owner</entry><entry align="left">string</entry><entry align="left"/><entry>The user ID which will own the device. If set to NULL everyone will be able to use the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.pi">pi</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.vnet-hdr">vnet-hdr</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>user setting</title><para>General User Profile Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.user.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>vlan setting</title><para>VLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.vlan.egress-priority-map">egress-priority-map</entry><entry align="left">array of string</entry><entry align="left"/><entry>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.flags">flags</entry><entry align="left">NMVlanFlags (uint32)</entry><entry align="left"/><entry>One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). - If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. +The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.id">id</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.ingress-priority-map">ingress-priority-map</entry><entry align="left">array of string</entry><entry align="left"/><entry>For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.protocol">protocol</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the VLAN protocol to use for encapsulation. - If set to NM_TERNARY_FALSE (0), devices can talk to each other. +Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>vpn setting</title><para>VPN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.vpn.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vpn.persistent">persistent</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vpn.secrets">secrets</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vpn.service-type">service-type</entry><entry align="left">string</entry><entry align="left"/><entry>D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vpn.timeout">timeout</entry><entry align="left">uint32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.vpn.user-name">user-name</entry><entry align="left">string</entry><entry align="left"/><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></informaltable></refsect2><refsect2><title>vrf setting</title><para>VRF settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.vrf.table">table</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The routing table for this VRF.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>vxlan setting</title><para>VXLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.vxlan.ageing">ageing</entry><entry align="left">uint32</entry><entry align="left">300</entry><entry>Specifies the lifetime in seconds of FDB entries learnt by the kernel.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.destination-port">destination-port</entry><entry align="left">uint32</entry><entry align="left">8472</entry><entry>Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.id">id</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.l2-miss">l2-miss</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Specifies whether netlink LL ADDR miss notifications are generated.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.l3-miss">l3-miss</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Specifies whether netlink IP ADDR miss notifications are generated.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.learning">learning</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.limit">limit</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.local">local</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the source IP address to use in outgoing packets.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.proxy">proxy</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Specifies whether ARP proxy is turned on.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.remote">remote</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.rsc">rsc</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Specifies whether route short circuit is turned on.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.source-port-max">source-port-max</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.source-port-min">source-port-min</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.tos">tos</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the TOS value to use in outgoing packets.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vxlan.ttl">ttl</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the time-to-live value to use in outgoing packets.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>wifi-p2p setting</title><para>Wi-Fi P2P Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.wifi-p2p.peer">peer</entry><entry align="left">string</entry><entry align="left"/><entry>The P2P device that should be connected to. Currently, this is the only way to create or join a group.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wifi-p2p.wfd-ies">wfd-ies</entry><entry align="left">byte array</entry><entry align="left"/><entry>The Wi-Fi Display (WFD) Information Elements (IEs) to set. - 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_FALSE (0).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.assigned-mac-address">assigned-mac-address</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-11-wireless.band">band</entry><entry align="left">string</entry><entry align="left"/><entry> 802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.bssid">bssid</entry><entry align="left">byte array</entry><entry align="left"/><entry> If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future. +Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wifi-p2p.wps-method">wps-method</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Flags indicating which mode of WPS is to be used. - Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.channel">channel</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.cloned-mac-address">cloned-mac-address</entry><entry align="left">byte array</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-11-wireless.generate-mac-address-mask">generate-mac-address-mask</entry><entry align="left">string</entry><entry align="left"/><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. +There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>wimax setting</title><para>WiMax Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.wimax.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><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). - 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. +This property is deprecated since version 1.2.WiMAX is no longer supported.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wimax.network-name">network-name</entry><entry align="left">string</entry><entry align="left"/><entry>Network Service Provider (NSP) name of the WiMAX network this connection should use. - 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. +This property is deprecated since version 1.2.WiMAX is no longer supported.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-3-ethernet setting</title><para>Wired Ethernet Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.accept-all-mac-addresses">accept-all-mac-addresses</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-3-ethernet.assigned-mac-address">assigned-mac-address</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-3-ethernet.auto-negotiate">auto-negotiate</entry><entry align="left">boolean</entry><entry align="left">FALSE</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 align="left" id="nm-settings-dbus.property.802-3-ethernet.cloned-mac-address">cloned-mac-address</entry><entry align="left">byte array</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-3-ethernet.duplex">duplex</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-3-ethernet.generate-mac-address-mask">generate-mac-address-mask</entry><entry align="left">string</entry><entry align="left"/><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 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 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 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 align="left" id="nm-settings-dbus.property.802-11-wireless.hidden">hidden</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry> If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode. +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. - In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. +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. - In AP mode, the created network does not broadcast its SSID. +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 align="left" id="nm-settings-dbus.property.802-3-ethernet.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.mac-address-blacklist">mac-address-blacklist</entry><entry align="left">array of string</entry><entry align="left"/><entry>If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.port">port</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-3-ethernet.s390-nettype">s390-nettype</entry><entry align="left">string</entry><entry align="left"/><entry>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.s390-options">s390-options</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). - Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry> If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address-blacklist">mac-address-blacklist</entry><entry align="left">array of string</entry><entry align="left"/><entry> A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address-randomization">mac-address-randomization</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'. Deprecated: 1</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mode">mode</entry><entry align="left">string</entry><entry align="left"/><entry> Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.powersave">powersave</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.rate">rate</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.security">security</entry><entry align="left"/><entry align="left"/><entry>This property is deprecated, but can be set to the value '802-11-wireless-security' when a wireless security setting is also present in the connection dictionary, for compatibility with very old NetworkManager daemons.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.seen-bssids">seen-bssids</entry><entry align="left">array of string</entry><entry align="left"/><entry> A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.ssid">ssid</entry><entry align="left">byte array</entry><entry align="left"/><entry> SSID of the Wi-Fi network. Must be specified.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.tx-power">tx-power</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.wake-on-wlan">wake-on-wlan</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry> The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-11-wireless-security setting</title><para> Wi-Fi Security Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.auth-alg">auth-alg</entry><entry align="left">string</entry><entry align="left"/><entry> When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.fils">fils</entry><entry align="left">int32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.802-11-wireless-security.group">group</entry><entry align="left">array of string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-11-wireless-security.key-mgmt">key-mgmt</entry><entry align="left">string</entry><entry align="left"/><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). +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 align="left" id="nm-settings-dbus.property.802-3-ethernet.s390-subchannels">s390-subchannels</entry><entry align="left">array of string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-3-ethernet.speed">speed</entry><entry align="left">uint32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.802-3-ethernet.wake-on-lan">wake-on-lan</entry><entry align="left">uint32</entry><entry align="left">1</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 align="left" id="nm-settings-dbus.property.802-3-ethernet.wake-on-lan-password">wake-on-lan-password</entry><entry align="left">string</entry><entry align="left"/><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></informaltable></refsect2><refsect2><title>wireguard setting</title><para>WireGuard Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.wireguard.fwmark">fwmark</entry><entry align="left">uint32</entry><entry align="left">0</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. - This property must be set for any Wi-Fi connection that uses security.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.leap-password">leap-password</entry><entry align="left">string</entry><entry align="left"/><entry> The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.leap-password-flags">leap-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "leap-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.leap-username">leap-username</entry><entry align="left">string</entry><entry align="left"/><entry> The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.pairwise">pairwise</entry><entry align="left">array of string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-11-wireless-security.pmf">pmf</entry><entry align="left">int32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.802-11-wireless-security.proto">proto</entry><entry align="left">array of string</entry><entry align="left"/><entry> List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.psk">psk</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-11-wireless-security.psk-flags">psk-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "psk" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key-flags">wep-key-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry> Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key-type">wep-key-type</entry><entry align="left">NMWepKeyType (uint32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key0">wep-key0</entry><entry align="left">string</entry><entry align="left"/><entry> Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key1">wep-key1</entry><entry align="left">string</entry><entry align="left"/><entry> Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key2">wep-key2</entry><entry align="left">string</entry><entry align="left"/><entry> Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key3">wep-key3</entry><entry align="left">string</entry><entry align="left"/><entry> Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-tx-keyidx">wep-tx-keyidx</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wps-method">wps-method</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry> Flags indicating which mode of WPS is to be used if any. +Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.ip4-auto-default-route">ip4-auto-default-route</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><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". - 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. +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. - WPS can be disabled by setting this property to a value of 1.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>wpan setting</title><para> IEEE 802.15.4 (WPAN) MAC Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.wpan.channel">channel</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.wpan.mac-address">mac-address</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.wpan.page">page</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.wpan.pan-id">pan-id</entry><entry align="left">uint32</entry><entry align="left">65535</entry><entry> IEEE 802.15.4 Personal Area Network (PAN) identifier.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wpan.short-address">short-address</entry><entry align="left">uint32</entry><entry align="left">65535</entry><entry> Short IEEE 802.15.4 address to be used within a restricted environment.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>bond-port setting</title><para> Bond Port Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.bond-port.queue-id">queue-id</entry><entry align="left">uint32</entry><entry align="left">0</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></informaltable></refsect2><refsect2><title>hostname setting</title><para> Hostname settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.hostname.from-dhcp">from-dhcp</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry> Whether the system hostname can be determined from DHCP on this connection. +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. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.ip6-auto-default-route">ip6-auto-default-route</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>Like ip4-auto-default-route, but for the IPv6 default route.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.listen-port">listen-port</entry><entry align="left">uint32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.wireguard.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. - 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 align="left" id="nm-settings-dbus.property.hostname.from-dns-lookup">from-dns-lookup</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry> Whether the system hostname can be determined from reverse DNS lookup of addresses on this device. +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 align="left" id="nm-settings-dbus.property.wireguard.peer-routes">peer-routes</entry><entry align="left">boolean</entry><entry align="left">TRUE</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. - 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 align="left" id="nm-settings-dbus.property.hostname.only-from-default">only-from-default</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><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). +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 align="left" id="nm-settings-dbus.property.wireguard.peers">peers</entry><entry align="left">array of 'a{sv}'</entry><entry align="left"/><entry>Array of dictionaries for the WireGuard peers.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.private-key">private-key</entry><entry align="left">string</entry><entry align="left"/><entry>The 256 bit private-key in base64 encoding.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.private-key-flags">private-key-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "private-key" property.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-11-wireless setting</title><para>Wi-Fi Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.ap-isolation">ap-isolation</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode. - If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route. +If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. - 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 align="left" id="nm-settings-dbus.property.hostname.priority">priority</entry><entry align="left">int32</entry><entry align="left">0</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 set to NM_TERNARY_FALSE (0), devices can talk to each other. - 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. +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_FALSE (0).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.assigned-mac-address">assigned-mac-address</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-11-wireless.band">band</entry><entry align="left">string</entry><entry align="left"/><entry>802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.bssid">bssid</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future. - 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></informaltable></refsect2><refsect2><title>ovs-external-ids setting</title><para> OVS External IDs Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-external-ids.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry> A dictionary of key/value pairs with exernal-ids for OVS.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>veth setting</title><para> Veth Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.veth.peer">peer</entry><entry align="left">string</entry><entry align="left"/><entry> This property specifies the peer interface name of the veth. This property is mandatory.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2 id="secrets-flags"><title>Secret flag types:</title><para> +Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.channel">channel</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.cloned-mac-address">cloned-mac-address</entry><entry align="left">byte array</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-11-wireless.generate-mac-address-mask">generate-mac-address-mask</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-11-wireless.hidden">hidden</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode. + +In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. + +In AP mode, the created network does not broadcast its SSID. + +Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address-blacklist">mac-address-blacklist</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address-randomization">mac-address-randomization</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). + +This property is deprecated since version 1.4.Use the "cloned-mac-address" property instead.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mode">mode</entry><entry align="left">string</entry><entry align="left"/><entry>Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.powersave">powersave</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.rate">rate</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.security">security</entry><entry align="left"/><entry align="left"/><entry>This property is deprecated, but can be set to the value '802-11-wireless-security' when a wireless security setting is also present in the connection dictionary, for compatibility with very old NetworkManager daemons.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.seen-bssids">seen-bssids</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.ssid">ssid</entry><entry align="left">byte array</entry><entry align="left"/><entry>SSID of the Wi-Fi network. Must be specified.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.tx-power">tx-power</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.wake-on-wlan">wake-on-wlan</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-11-wireless-security setting</title><para>Wi-Fi Security Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.auth-alg">auth-alg</entry><entry align="left">string</entry><entry align="left"/><entry>When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.fils">fils</entry><entry align="left">int32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.802-11-wireless-security.group">group</entry><entry align="left">array of string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-11-wireless-security.key-mgmt">key-mgmt</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-11-wireless-security.leap-password">leap-password</entry><entry align="left">string</entry><entry align="left"/><entry>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.leap-password-flags">leap-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "leap-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.leap-username">leap-username</entry><entry align="left">string</entry><entry align="left"/><entry>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.pairwise">pairwise</entry><entry align="left">array of string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-11-wireless-security.pmf">pmf</entry><entry align="left">int32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.802-11-wireless-security.proto">proto</entry><entry align="left">array of string</entry><entry align="left"/><entry>List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.psk">psk</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-11-wireless-security.psk-flags">psk-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "psk" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key-flags">wep-key-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key-type">wep-key-type</entry><entry align="left">NMWepKeyType (uint32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key0">wep-key0</entry><entry align="left">string</entry><entry align="left"/><entry>Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key1">wep-key1</entry><entry align="left">string</entry><entry align="left"/><entry>Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key2">wep-key2</entry><entry align="left">string</entry><entry align="left"/><entry>Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key3">wep-key3</entry><entry align="left">string</entry><entry align="left"/><entry>Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-tx-keyidx">wep-tx-keyidx</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wps-method">wps-method</entry><entry align="left">uint32</entry><entry align="left">0</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></informaltable></refsect2><refsect2><title>wpan setting</title><para>IEEE 802.15.4 (WPAN) MAC Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.wpan.channel">channel</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.wpan.mac-address">mac-address</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.wpan.page">page</entry><entry align="left">int32</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.wpan.pan-id">pan-id</entry><entry align="left">uint32</entry><entry align="left">65535</entry><entry>IEEE 802.15.4 Personal Area Network (PAN) identifier.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wpan.short-address">short-address</entry><entry align="left">uint32</entry><entry align="left">65535</entry><entry>Short IEEE 802.15.4 address to be used within a restricted environment.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>bond-port setting</title><para>Bond Port Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.bond-port.queue-id">queue-id</entry><entry align="left">uint32</entry><entry align="left">0</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></informaltable></refsect2><refsect2><title>hostname setting</title><para>Hostname settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.hostname.from-dhcp">from-dhcp</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.hostname.from-dns-lookup">from-dns-lookup</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.hostname.only-from-default">only-from-default</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.hostname.priority">priority</entry><entry align="left">int32</entry><entry align="left">0</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></informaltable></refsect2><refsect2><title>loopback setting</title><para>Loopback Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.loopback.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-external-ids setting</title><para>OVS External IDs Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-external-ids.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>A dictionary of key/value pairs with external-ids for OVS.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-other-config setting</title><para>OVS Other Config Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-other-config.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>A dictionary of key/value pairs with other_config settings for OVS. See also "other_config" in the "ovs-vswitchd.conf.db" manual for the keys that OVS supports.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>veth setting</title><para>Veth Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.veth.peer">peer</entry><entry align="left">string</entry><entry align="left"/><entry>This property specifies the peer interface name of the veth. This property is mandatory.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2 id="secrets-flags"><title>Secret flag types:</title><para> Each password or secret property in a setting has an associated <emphasis>flags</emphasis> property that describes how to handle that secret. The <emphasis>flags</emphasis> property is a bitfield that contains zero or more of the following values logically OR-ed together. diff --git a/man/nm-settings-dbus.xsl b/man/nm-settings-dbus.xsl index a0c12cd8..665105ee 100644 --- a/man/nm-settings-dbus.xsl +++ b/man/nm-settings-dbus.xsl @@ -162,7 +162,9 @@ <entry align="left"><xsl:attribute name="id">nm-settings-dbus.property.<xsl:value-of select="../@name"/>.<xsl:value-of select="@name"/></xsl:attribute><xsl:value-of select="@name"/></entry> <entry align="left"><xsl:value-of select="@type"/></entry> <entry align="left"><xsl:value-of select="@default"/></entry> - <entry><xsl:apply-templates select="description"/></entry> + <entry><xsl:apply-templates select="description"/><xsl:if test="deprecated"> + +This property is deprecated since version <xsl:value-of select="deprecated/@since"/>.<xsl:value-of select="deprecated"/></xsl:if></entry> </row> </xsl:template> diff --git a/man/nm-settings-docs-dbus.xml b/man/nm-settings-docs-dbus.xml deleted file mode 100644 index 9b2273ee..00000000 --- a/man/nm-settings-docs-dbus.xml +++ /dev/null @@ -1,391 +0,0 @@ -<nm-setting-docs><setting name="connection" description=" General Connection Profile Settings" name_upper="CONNECTION"><property name="auth-retries" name_upper="AUTH_RETRIES" type="int32" default="-1"><description-docbook><para> 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.</para><para> Currently, this only applies to 802-1x authentication.</para></description-docbook><description> 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.</description></property><property name="autoconnect" name_upper="AUTOCONNECT" type="boolean" default="TRUE"><description-docbook><para> 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.</para><para> 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.</para><para> Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.</para><para> If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined.</para><para> Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.</para></description-docbook><description> 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. - - If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined. - - Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.</description></property><property name="autoconnect-priority" name_upper="AUTOCONNECT_PRIORITY" type="int32" default="0"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="autoconnect-retries" name_upper="AUTOCONNECT_RETRIES" type="int32" default="-1"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="autoconnect-slaves" name_upper="AUTOCONNECT_SLAVES" type="NMSettingConnectionAutoconnectSlaves (int32)"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="dns-over-tls" name_upper="DNS_OVER_TLS" type="int32" default="-1"><description-docbook><para> Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic.</para><para> 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.</para><para> This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para></description-docbook><description> 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.</description></property><property name="gateway-ping-timeout" name_upper="GATEWAY_PING_TIMEOUT" type="uint32" default="0"><description-docbook><para> If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</para></description-docbook><description> If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</description></property><property name="id" name_upper="ID" type="string"><description-docbook><para> A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</para></description-docbook><description> A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</description></property><property name="interface-name" name_upper="INTERFACE_NAME" type="string"><description-docbook><para> 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).</para><para> For software devices this specifies the name of the created device.</para><para> 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.</para></description-docbook><description> 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.</description></property><property name="lldp" name_upper="LLDP" type="int32" default="-1"><description-docbook><para> Whether LLDP is enabled for the connection.</para></description-docbook><description> Whether LLDP is enabled for the connection.</description></property><property name="llmnr" name_upper="LLMNR" type="int32" default="-1"><description-docbook><para> 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.</para><para> 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").</para><para> This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para></description-docbook><description> 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.</description></property><property name="master" name_upper="MASTER" type="string"><description-docbook><para> Interface name of the master device or UUID of the master connection.</para></description-docbook><description> Interface name of the master device or UUID of the master connection.</description></property><property name="mdns" name_upper="MDNS" type="int32" default="-1"><description-docbook><para> Whether mDNS is enabled for the connection.</para><para> 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").</para><para> This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para></description-docbook><description> 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.</description></property><property name="metered" name_upper="METERED" type="NMMetered (int32)"><description-docbook><para> Whether the connection is metered.</para><para> When updating this property on a currently activated connection, the change takes effect immediately.</para></description-docbook><description> Whether the connection is metered. - - When updating this property on a currently activated connection, the change takes effect immediately.</description></property><property name="mptcp-flags" name_upper="MPTCP_FLAGS" type="uint32" default="0"><description-docbook><para> Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints.</para><para> If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.</para><para> The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags.</para><para> Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless.</para><para> Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that.</para><para> When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.</para><para> If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl.</para><para> NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.</para><para> Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).</para></description-docbook><description> Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints. - - If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered. - - The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags. - - Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless. - - Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that. - - When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags. - - If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl. - - NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp. - - Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).</description></property><property name="mud-url" name_upper="MUD_URL" type="string"><description-docbook><para> 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://".</para><para> The special value "none" is allowed to indicate that no MUD URL is used.</para><para> If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".</para></description-docbook><description> 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".</description></property><property name="multi-connect" name_upper="MULTI_CONNECT" type="int32" default="0"><description-docbook><para> Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</para></description-docbook><description> Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</description></property><property name="permissions" name_upper="PERMISSIONS" type="array of string"><description-docbook><para> 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".</para><para> 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.</para></description-docbook><description> 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.</description></property><property name="read-only" name_upper="READ_ONLY" type="boolean" default="FALSE"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="secondaries" name_upper="SECONDARIES" type="array of string"><description-docbook><para> List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</para></description-docbook><description> List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</description></property><property name="slave-type" name_upper="SLAVE_TYPE" type="string"><description-docbook><para> Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</para></description-docbook><description> Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</description></property><property name="stable-id" name_upper="STABLE_ID" type="string"><description-docbook><para> 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.</para><para> 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].</para><para> 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. See NetworkManager(8) manual about the secret-key and the host identity.</para><para> 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.</para><para> 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.</para></description-docbook><description> 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. See NetworkManager(8) manual about the secret-key and the host identity. - - 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.</description></property><property name="timestamp" name_upper="TIMESTAMP" type="uint64" default="0"><description-docbook><para> The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated.</para><para> 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).</para></description-docbook><description> 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).</description></property><property name="type" name_upper="TYPE" type="string"><description-docbook><para> 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).</para></description-docbook><description> 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).</description></property><property name="uuid" name_upper="UUID" type="string"><description-docbook><para> 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.</para><para> The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").</para></description-docbook><description> 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 "-").</description></property><property name="wait-activation-delay" name_upper="WAIT_ACTIVATION_DELAY" type="int32" default="-1"><description-docbook><para> Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event.</para><para> The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</para></description-docbook><description> Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event. - - The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</description></property><property name="wait-device-timeout" name_upper="WAIT_DEVICE_TIMEOUT" type="int32" default="-1"><description-docbook><para> 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.</para><para> The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</para></description-docbook><description> 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.</description></property><property name="zone" name_upper="ZONE" type="string"><description-docbook><para> 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.</para><para> When updating this property on a currently activated connection, the change takes effect immediately.</para></description-docbook><description> 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.</description></property></setting><setting name="6lowpan" description=" 6LoWPAN Settings" name_upper="6LOWPAN"><property name="parent" name_upper="PARENT" type="string"><description-docbook><para> If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.</para></description-docbook><description> If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.</description></property></setting><setting name="802-1x" description=" IEEE 802.1x Authentication Settings" name_upper="802_1X"><property name="altsubject-matches" name_upper="ALTSUBJECT_MATCHES" type="array of string"><description-docbook><para> List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</para></description-docbook><description> List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</description></property><property name="anonymous-identity" name_upper="ANONYMOUS_IDENTITY" type="string"><description-docbook><para> Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</para></description-docbook><description> Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</description></property><property name="auth-timeout" name_upper="AUTH_TIMEOUT" type="int32" default="0"><description-docbook><para> A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.</para></description-docbook><description> A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.</description></property><property name="ca-cert" name_upper="CA_CERT" type="byte array"><description-docbook><para> Contains the CA certificate if used by the EAP method specified in the "eap" property.</para><para> Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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.</para><para> Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</para></description-docbook><description> Contains the CA certificate if used by the EAP method specified in the "eap" property. - - Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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. - - Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</description></property><property name="ca-cert-password" name_upper="CA_CERT_PASSWORD" type="string"><description-docbook><para> The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para></description-docbook><description> The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</description></property><property name="ca-cert-password-flags" name_upper="CA_CERT_PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "ca-cert-password" property.</para></description-docbook><description> Flags indicating how to handle the "ca-cert-password" property.</description></property><property name="ca-path" name_upper="CA_PATH" type="string"><description-docbook><para> UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property.</para><para> If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</para></description-docbook><description> UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property. - - If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</description></property><property name="client-cert" name_upper="CLIENT_CERT" type="byte array"><description-docbook><para> Contains the client certificate if used by the EAP method specified in the "eap" property.</para><para> 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.</para></description-docbook><description> 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.</description></property><property name="client-cert-password" name_upper="CLIENT_CERT_PASSWORD" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="client-cert-password-flags" name_upper="CLIENT_CERT_PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "client-cert-password" property.</para></description-docbook><description> Flags indicating how to handle the "client-cert-password" property.</description></property><property name="domain-match" name_upper="DOMAIN_MATCH" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="domain-suffix-match" name_upper="DOMAIN_SUFFIX_MATCH" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="eap" name_upper="EAP" type="array of string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="identity" name_upper="IDENTITY" type="string"><description-docbook><para> Identity string for EAP authentication methods. Often the user's user or login name.</para></description-docbook><description> Identity string for EAP authentication methods. Often the user's user or login name.</description></property><property name="optional" name_upper="OPTIONAL" type="boolean" default="FALSE"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="pac-file" name_upper="PAC_FILE" type="string"><description-docbook><para> UTF-8 encoded file path containing PAC for EAP-FAST.</para></description-docbook><description> UTF-8 encoded file path containing PAC for EAP-FAST.</description></property><property name="password" name_upper="PASSWORD" type="string"><description-docbook><para> UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</para></description-docbook><description> UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</description></property><property name="password-flags" name_upper="PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "password" property.</para></description-docbook><description> Flags indicating how to handle the "password" property.</description></property><property name="password-raw" name_upper="PASSWORD_RAW" type="byte array"><description-docbook><para> Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</para></description-docbook><description> Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</description></property><property name="password-raw-flags" name_upper="PASSWORD_RAW_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "password-raw" property.</para></description-docbook><description> Flags indicating how to handle the "password-raw" property.</description></property><property name="phase1-auth-flags" name_upper="PHASE1_AUTH_FLAGS" type="uint32" default="0"><description-docbook><para> Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x settings. See the wpa_supplicant documentation for more details.</para></description-docbook><description> Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x settings. See the wpa_supplicant documentation for more details.</description></property><property name="phase1-fast-provisioning" name_upper="PHASE1_FAST_PROVISIONING" type="string"><description-docbook><para> Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.</para></description-docbook><description> Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.</description></property><property name="phase1-peaplabel" name_upper="PHASE1_PEAPLABEL" type="string"><description-docbook><para> Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</para></description-docbook><description> Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</description></property><property name="phase1-peapver" name_upper="PHASE1_PEAPVER" type="string"><description-docbook><para> Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.</para></description-docbook><description> Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.</description></property><property name="phase2-altsubject-matches" name_upper="PHASE2_ALTSUBJECT_MATCHES" type="array of string"><description-docbook><para> List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</para></description-docbook><description> List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</description></property><property name="phase2-auth" name_upper="PHASE2_AUTH" type="string"><description-docbook><para> Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.</para></description-docbook><description> Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.</description></property><property name="phase2-autheap" name_upper="PHASE2_AUTHEAP" type="string"><description-docbook><para> Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</para></description-docbook><description> Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</description></property><property name="phase2-ca-cert" name_upper="PHASE2_CA_CERT" type="byte array"><description-docbook><para> Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</para><para> Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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.</para><para> Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</para></description-docbook><description> Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. - - Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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. - - Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</description></property><property name="phase2-ca-cert-password" name_upper="PHASE2_CA_CERT_PASSWORD" type="string"><description-docbook><para> The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para></description-docbook><description> The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</description></property><property name="phase2-ca-cert-password-flags" name_upper="PHASE2_CA_CERT_PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "phase2-ca-cert-password" property.</para></description-docbook><description> Flags indicating how to handle the "phase2-ca-cert-password" property.</description></property><property name="phase2-ca-path" name_upper="PHASE2_CA_PATH" type="string"><description-docbook><para> UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property.</para><para> If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</para></description-docbook><description> UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property. - - If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</description></property><property name="phase2-client-cert" name_upper="PHASE2_CLIENT_CERT" type="byte array"><description-docbook><para> Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</para><para> 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.</para></description-docbook><description> 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.</description></property><property name="phase2-client-cert-password" name_upper="PHASE2_CLIENT_CERT_PASSWORD" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="phase2-client-cert-password-flags" name_upper="PHASE2_CLIENT_CERT_PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "phase2-client-cert-password" property.</para></description-docbook><description> Flags indicating how to handle the "phase2-client-cert-password" property.</description></property><property name="phase2-domain-match" name_upper="PHASE2_DOMAIN_MATCH" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="phase2-domain-suffix-match" name_upper="PHASE2_DOMAIN_SUFFIX_MATCH" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="phase2-private-key" name_upper="PHASE2_PRIVATE_KEY" type="byte array"><description-docbook><para> Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls".</para><para> 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.</para></description-docbook><description> 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.</description></property><property name="phase2-private-key-password" name_upper="PHASE2_PRIVATE_KEY_PASSWORD" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="phase2-private-key-password-flags" name_upper="PHASE2_PRIVATE_KEY_PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "phase2-private-key-password" property.</para></description-docbook><description> Flags indicating how to handle the "phase2-private-key-password" property.</description></property><property name="phase2-subject-match" name_upper="PHASE2_SUBJECT_MATCH" type="string"><description-docbook><para> Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match.</para></description-docbook><description> Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match.</description></property><property name="pin" name_upper="PIN" type="string"><description-docbook><para> PIN used for EAP authentication methods.</para></description-docbook><description> PIN used for EAP authentication methods.</description></property><property name="pin-flags" name_upper="PIN_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "pin" property.</para></description-docbook><description> Flags indicating how to handle the "pin" property.</description></property><property name="private-key" name_upper="PRIVATE_KEY" type="byte array"><description-docbook><para> Contains the private key when the "eap" property is set to "tls".</para><para> 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 "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 "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</para><para> WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.</para></description-docbook><description> Contains the private key when the "eap" property is set to "tls". - - Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. - - WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.</description></property><property name="private-key-password" name_upper="PRIVATE_KEY_PASSWORD" type="string"><description-docbook><para> The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</para></description-docbook><description> The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</description></property><property name="private-key-password-flags" name_upper="PRIVATE_KEY_PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "private-key-password" property.</para></description-docbook><description> Flags indicating how to handle the "private-key-password" property.</description></property><property name="subject-match" name_upper="SUBJECT_MATCH" type="string"><description-docbook><para> Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match.</para></description-docbook><description> Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match.</description></property><property name="system-ca-certs" name_upper="SYSTEM_CA_CERTS" type="boolean" default="FALSE"><description-docbook><para> When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).</para></description-docbook><description> When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).</description></property></setting><setting name="adsl" description=" ADSL Settings" name_upper="ADSL"><property name="encapsulation" name_upper="ENCAPSULATION" type="string"><description-docbook><para> Encapsulation of ADSL connection. Can be "vcmux" or "llc".</para></description-docbook><description> Encapsulation of ADSL connection. Can be "vcmux" or "llc".</description></property><property name="password" name_upper="PASSWORD" type="string"><description-docbook><para> Password used to authenticate with the ADSL service.</para></description-docbook><description> Password used to authenticate with the ADSL service.</description></property><property name="password-flags" name_upper="PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "password" property.</para></description-docbook><description> Flags indicating how to handle the "password" property.</description></property><property name="protocol" name_upper="PROTOCOL" type="string"><description-docbook><para> ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</para></description-docbook><description> ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</description></property><property name="username" name_upper="USERNAME" type="string"><description-docbook><para> Username used to authenticate with the ADSL service.</para></description-docbook><description> Username used to authenticate with the ADSL service.</description></property><property name="vci" name_upper="VCI" type="uint32" default="0"><description-docbook><para> VCI of ADSL connection</para></description-docbook><description> VCI of ADSL connection</description></property><property name="vpi" name_upper="VPI" type="uint32" default="0"><description-docbook><para> VPI of ADSL connection</para></description-docbook><description> VPI of ADSL connection</description></property></setting><setting name="bluetooth" description=" Bluetooth Settings" name_upper="BLUETOOTH"><property name="bdaddr" name_upper="BDADDR" type="byte array"><description-docbook><para> The Bluetooth address of the device.</para></description-docbook><description> The Bluetooth address of the device.</description></property><property name="type" name_upper="TYPE" type="string"><description-docbook><para> Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.</para></description-docbook><description> Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.</description></property></setting><setting name="bond" description=" Bonding Settings" name_upper="BOND"><property name="interface-name" name_upper="INTERFACE_NAME" type="string"><description>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.</description></property><property name="options" name_upper="OPTIONS" type="dict of string to string" default="{'mode': 'balance-rr'}"><description-docbook><para> Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</para></description-docbook><description> Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</description></property></setting><setting name="bridge" description=" Bridging Settings" name_upper="BRIDGE"><property name="ageing-time" name_upper="AGEING_TIME" type="uint32" default="300"><description-docbook><para> The Ethernet MAC address aging time, in seconds.</para></description-docbook><description> The Ethernet MAC address aging time, in seconds.</description></property><property name="forward-delay" name_upper="FORWARD_DELAY" type="uint32" default="15"><description-docbook><para> The Spanning Tree Protocol (STP) forwarding delay, in seconds.</para></description-docbook><description> The Spanning Tree Protocol (STP) forwarding delay, in seconds.</description></property><property name="group-address" name_upper="GROUP_ADDRESS" type="byte array"><description-docbook><para> If specified, The MAC address of the multicast group this bridge uses for STP.</para><para> 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.</para></description-docbook><description> 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.</description></property><property name="group-forward-mask" name_upper="GROUP_FORWARD_MASK" type="uint32" default="0"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="hello-time" name_upper="HELLO_TIME" type="uint32" default="2"><description-docbook><para> The Spanning Tree Protocol (STP) hello time, in seconds.</para></description-docbook><description> The Spanning Tree Protocol (STP) hello time, in seconds.</description></property><property name="interface-name" name_upper="INTERFACE_NAME" type="string"><description>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name.</description></property><property name="mac-address" name_upper="MAC_ADDRESS" type="byte array"><description-docbook><para> If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set.</para><para> 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</para></description-docbook><description> 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</description></property><property name="max-age" name_upper="MAX_AGE" type="uint32" default="20"><description-docbook><para> The Spanning Tree Protocol (STP) maximum message age, in seconds.</para></description-docbook><description> The Spanning Tree Protocol (STP) maximum message age, in seconds.</description></property><property name="multicast-hash-max" name_upper="MULTICAST_HASH_MAX" type="uint32" default="4096"><description-docbook><para> Set maximum size of multicast hash table (value must be a power of 2).</para></description-docbook><description> Set maximum size of multicast hash table (value must be a power of 2).</description></property><property name="multicast-last-member-count" name_upper="MULTICAST_LAST_MEMBER_COUNT" type="uint32" default="2"><description-docbook><para> Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.</para></description-docbook><description> Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.</description></property><property name="multicast-last-member-interval" name_upper="MULTICAST_LAST_MEMBER_INTERVAL" type="uint64" default="100"><description-docbook><para> Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.</para></description-docbook><description> Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.</description></property><property name="multicast-membership-interval" name_upper="MULTICAST_MEMBERSHIP_INTERVAL" type="uint64" default="26000"><description-docbook><para> Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.</para></description-docbook><description> Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.</description></property><property name="multicast-querier" name_upper="MULTICAST_QUERIER" type="boolean" default="FALSE"><description-docbook><para> Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</para></description-docbook><description> Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</description></property><property name="multicast-querier-interval" name_upper="MULTICAST_QUERIER_INTERVAL" type="uint64" default="25500"><description-docbook><para> If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.</para></description-docbook><description> If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.</description></property><property name="multicast-query-interval" name_upper="MULTICAST_QUERY_INTERVAL" type="uint64" default="12500"><description-docbook><para> Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</para></description-docbook><description> Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</description></property><property name="multicast-query-response-interval" name_upper="MULTICAST_QUERY_RESPONSE_INTERVAL" type="uint64" default="1000"><description-docbook><para> Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</para></description-docbook><description> Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</description></property><property name="multicast-query-use-ifaddr" name_upper="MULTICAST_QUERY_USE_IFADDR" type="boolean" default="FALSE"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="multicast-router" name_upper="MULTICAST_ROUTER" type="string"><description-docbook><para> Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work.</para><para> Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).</para></description-docbook><description> Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work. - - Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).</description></property><property name="multicast-snooping" name_upper="MULTICAST_SNOOPING" type="boolean" default="TRUE"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="multicast-startup-query-count" name_upper="MULTICAST_STARTUP_QUERY_COUNT" type="uint32" default="2"><description-docbook><para> Set the number of IGMP queries to send during startup phase.</para></description-docbook><description> Set the number of IGMP queries to send during startup phase.</description></property><property name="multicast-startup-query-interval" name_upper="MULTICAST_STARTUP_QUERY_INTERVAL" type="uint64" default="3125"><description-docbook><para> Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</para></description-docbook><description> Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</description></property><property name="priority" name_upper="PRIORITY" type="uint32" default="32768"><description-docbook><para> Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</para></description-docbook><description> Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</description></property><property name="stp" name_upper="STP" type="boolean" default="TRUE"><description-docbook><para> Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</para></description-docbook><description> Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</description></property><property name="vlan-default-pvid" name_upper="VLAN_DEFAULT_PVID" type="uint32" default="1"><description-docbook><para> The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.</para></description-docbook><description> The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.</description></property><property name="vlan-filtering" name_upper="VLAN_FILTERING" type="boolean" default="FALSE"><description-docbook><para> Control whether VLAN filtering is enabled on the bridge.</para></description-docbook><description> Control whether VLAN filtering is enabled on the bridge.</description></property><property name="vlan-protocol" name_upper="VLAN_PROTOCOL" type="string"><description-docbook><para> If specified, the protocol used for VLAN filtering.</para><para> Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</para></description-docbook><description> If specified, the protocol used for VLAN filtering. - - Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</description></property><property name="vlan-stats-enabled" name_upper="VLAN_STATS_ENABLED" type="boolean" default="FALSE"><description-docbook><para> Controls whether per-VLAN stats accounting is enabled.</para></description-docbook><description> Controls whether per-VLAN stats accounting is enabled.</description></property><property name="vlans" name_upper="VLANS" type="array of vardict"><description-docbook><para> 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.</para><para> In nmcli the VLAN list can be specified with the following syntax:</para><para> $vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</para><para> where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</para></description-docbook><description> 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.</description></property></setting><setting name="bridge-port" description=" Bridge Port Settings" name_upper="BRIDGE_PORT"><property name="hairpin-mode" name_upper="HAIRPIN_MODE" type="boolean" default="FALSE"><description-docbook><para> Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.</para></description-docbook><description> Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.</description></property><property name="path-cost" name_upper="PATH_COST" type="uint32" default="100"><description-docbook><para> The Spanning Tree Protocol (STP) port cost for destinations via this port.</para></description-docbook><description> The Spanning Tree Protocol (STP) port cost for destinations via this port.</description></property><property name="priority" name_upper="PRIORITY" type="uint32" default="32"><description-docbook><para> The Spanning Tree Protocol (STP) priority of this bridge port.</para></description-docbook><description> The Spanning Tree Protocol (STP) priority of this bridge port.</description></property><property name="vlans" name_upper="VLANS" type="array of vardict"><description-docbook><para> Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property.</para><para> In nmcli the VLAN list can be specified with the following syntax:</para><para> $vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</para><para> where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</para></description-docbook><description> Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge 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.</description></property></setting><setting name="cdma" description=" CDMA-based Mobile Broadband Settings" name_upper="CDMA"><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para></description-docbook><description> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</description></property><property name="number" name_upper="NUMBER" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="password" name_upper="PASSWORD" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="password-flags" name_upper="PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "password" property.</para></description-docbook><description> Flags indicating how to handle the "password" property.</description></property><property name="username" name_upper="USERNAME" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property></setting><setting name="dcb" description=" Data Center Bridging Settings" name_upper="DCB"><property name="app-fcoe-flags" name_upper="APP_FCOE_FLAGS" type="NMSettingDcbFlags (uint32)"><description-docbook><para> 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).</para></description-docbook><description> 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).</description></property><property name="app-fcoe-mode" name_upper="APP_FCOE_MODE" type="string"><description-docbook><para> The FCoE controller mode; either "fabric" or "vn2vn".</para><para> Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".</para></description-docbook><description> 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".</description></property><property name="app-fcoe-priority" name_upper="APP_FCOE_PRIORITY" type="int32" default="-1"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="app-fip-flags" name_upper="APP_FIP_FLAGS" type="NMSettingDcbFlags (uint32)"><description-docbook><para> 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).</para></description-docbook><description> 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).</description></property><property name="app-fip-priority" name_upper="APP_FIP_PRIORITY" type="int32" default="-1"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="app-iscsi-flags" name_upper="APP_ISCSI_FLAGS" type="NMSettingDcbFlags (uint32)"><description-docbook><para> 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).</para></description-docbook><description> 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).</description></property><property name="app-iscsi-priority" name_upper="APP_ISCSI_PRIORITY" type="int32" default="-1"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="priority-bandwidth" name_upper="PRIORITY_BANDWIDTH" type="array of uint32"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="priority-flow-control" name_upper="PRIORITY_FLOW_CONTROL" type="array of uint32"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="priority-flow-control-flags" name_upper="PRIORITY_FLOW_CONTROL_FLAGS" type="NMSettingDcbFlags (uint32)"><description-docbook><para> 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).</para></description-docbook><description> 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).</description></property><property name="priority-group-bandwidth" name_upper="PRIORITY_GROUP_BANDWIDTH" type="array of uint32"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="priority-group-flags" name_upper="PRIORITY_GROUP_FLAGS" type="NMSettingDcbFlags (uint32)"><description-docbook><para> 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).</para></description-docbook><description> 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).</description></property><property name="priority-group-id" name_upper="PRIORITY_GROUP_ID" type="array of uint32"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="priority-strict-bandwidth" name_upper="PRIORITY_STRICT_BANDWIDTH" type="array of uint32"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="priority-traffic-class" name_upper="PRIORITY_TRAFFIC_CLASS" type="array of uint32"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property></setting><setting name="dummy" description=" Dummy Link Settings" name_upper="DUMMY" /><setting name="ethtool" description=" Ethtool Ethernet Settings" name_upper="ETHTOOL" /><setting name="generic" description=" Generic Link Settings" name_upper="GENERIC" /><setting name="gsm" description=" GSM-based Mobile Broadband Settings" name_upper="GSM"><property name="apn" name_upper="APN" type="string"><description-docbook><para> The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</para></description-docbook><description> The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</description></property><property name="auto-config" name_upper="AUTO_CONFIG" type="boolean" default="FALSE"><description-docbook><para> When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.</para></description-docbook><description> When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.</description></property><property name="device-id" name_upper="DEVICE_ID" type="string"><description-docbook><para> The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</para></description-docbook><description> The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</description></property><property name="home-only" name_upper="HOME_ONLY" type="boolean" default="FALSE"><description-docbook><para> When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</para></description-docbook><description> When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para></description-docbook><description> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</description></property><property name="network-id" name_upper="NETWORK_ID" type="string"><description-docbook><para> The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</para></description-docbook><description> The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</description></property><property name="number" name_upper="NUMBER" type="string"><description-docbook><para> Legacy setting that used to help establishing PPP data sessions for GSM-based modems. Deprecated: 1</para></description-docbook><description> Legacy setting that used to help establishing PPP data sessions for GSM-based modems. Deprecated: 1</description></property><property name="password" name_upper="PASSWORD" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="password-flags" name_upper="PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "password" property.</para></description-docbook><description> Flags indicating how to handle the "password" property.</description></property><property name="pin" name_upper="PIN" type="string"><description-docbook><para> If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</para></description-docbook><description> If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</description></property><property name="pin-flags" name_upper="PIN_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "pin" property.</para></description-docbook><description> Flags indicating how to handle the "pin" property.</description></property><property name="sim-id" name_upper="SIM_ID" type="string"><description-docbook><para> The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.</para></description-docbook><description> The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.</description></property><property name="sim-operator-id" name_upper="SIM_OPERATOR_ID" type="string"><description-docbook><para> A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.</para></description-docbook><description> A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.</description></property><property name="username" name_upper="USERNAME" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property></setting><setting name="infiniband" description=" Infiniband Settings" name_upper="INFINIBAND"><property name="mac-address" name_upper="MAC_ADDRESS" type="byte array"><description-docbook><para> If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</para></description-docbook><description> If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para></description-docbook><description> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</description></property><property name="p-key" name_upper="P_KEY" type="int32" default="-1"><description-docbook><para> The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.</para></description-docbook><description> The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.</description></property><property name="parent" name_upper="PARENT" type="string"><description-docbook><para> The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".</para></description-docbook><description> The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".</description></property><property name="transport-mode" name_upper="TRANSPORT_MODE" type="string"><description-docbook><para> The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</para></description-docbook><description> The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</description></property></setting><setting name="ipv4" description=" IPv4 Settings" name_upper="IP4_CONFIG"><property name="address-data" name_upper="ADDRESS_DATA" type="array of vardict"><description>Array of IPv4 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.</description></property><property name="addresses" name_upper="ADDRESSES" type="array of array of uint32"><description-docbook><para> Array of IP addresses.</para></description-docbook><description>Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet.</description></property><property name="dad-timeout" name_upper="DAD_TIMEOUT" type="int32" default="-1"><description-docbook><para> Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds.</para><para> The property is currently implemented only for IPv4.</para></description-docbook><description> Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. - - The property is currently implemented only for IPv4.</description></property><property name="dhcp-client-id" name_upper="DHCP_CLIENT_ID" type="string"><description-docbook><para> A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0.</para><para> The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links.</para><para> The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset.</para><para> The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id.</para><para> The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key.</para><para> If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.</para></description-docbook><description> A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. - - The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links. - - The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset. - - The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id. - - The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key. - - If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.</description></property><property name="dhcp-fqdn" name_upper="DHCP_FQDN" type="string"><description-docbook><para> If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</para></description-docbook><description> If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</description></property><property name="dhcp-hostname" name_upper="DHCP_HOSTNAME" type="string"><description-docbook><para> If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</para></description-docbook><description> If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</description></property><property name="dhcp-hostname-flags" name_upper="DHCP_HOSTNAME_FLAGS" type="uint32" default="0"><description-docbook><para> Flags for the DHCP hostname and FQDN.</para><para> Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.</para><para> When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</para></description-docbook><description> Flags for the DHCP hostname and FQDN. - - Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. - - When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</description></property><property name="dhcp-iaid" name_upper="DHCP_IAID" type="string"><description-docbook><para> A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.</para></description-docbook><description> A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.</description></property><property name="dhcp-reject-servers" name_upper="DHCP_REJECT_SERVERS" type="array of string"><description-docbook><para> Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers.</para><para> For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24").</para><para> This property is currently not implemented for DHCPv6.</para></description-docbook><description> Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. - - For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). - - This property is currently not implemented for DHCPv6.</description></property><property name="dhcp-send-hostname" name_upper="DHCP_SEND_HOSTNAME" type="boolean" default="TRUE"><description-docbook><para> If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</para></description-docbook><description> If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</description></property><property name="dhcp-timeout" name_upper="DHCP_TIMEOUT" type="int32" default="0"><description-docbook><para> 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).</para><para> Set to 2147483647 (MAXINT32) for infinity.</para></description-docbook><description> 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.</description></property><property name="dhcp-vendor-class-identifier" name_upper="DHCP_VENDOR_CLASS_IDENTIFIER" type="string"><description-docbook><para> The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</para></description-docbook><description> The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</description></property><property name="dns" name_upper="DNS" type="array of uint32"><description-docbook><para> Array of IP addresses of DNS servers.</para></description-docbook><description>Array of IP addresses of DNS servers (as network-byte-order integers)</description></property><property name="dns-options" name_upper="DNS_OPTIONS" type="array of string"><description-docbook><para> Array of DNS options as described in man 5 resolv.conf.</para><para> 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.</para><para> The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc".</para><para> The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.</para><para> When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</para></description-docbook><description> 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. - - The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". - - The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. - - When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</description></property><property name="dns-priority" name_upper="DNS_PRIORITY" type="int32" default="0"><description-docbook><para> DNS servers priority.</para><para> The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</para><para> Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.</para><para> 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.</para><para> 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.</para><para> 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.</para><para> 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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</para><para> When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</para></description-docbook><description> DNS servers priority. - - The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). - - Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. - - 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 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. - - 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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. - - When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</description></property><property name="dns-search" name_upper="DNS_SEARCH" type="array of string"><description-docbook><para> List 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.</para><para> When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</para><para> When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</para></description-docbook><description> List 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. - - When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. - - When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</description></property><property name="gateway" name_upper="GATEWAY" type="string"><description-docbook><para> The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</para><para> Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</para><para> Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</para></description-docbook><description> The gateway associated with this configuration. This is only meaningful if "addresses" is also set. - - Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. - - Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</description></property><property name="ignore-auto-dns" name_upper="IGNORE_AUTO_DNS" type="boolean" default="FALSE"><description-docbook><para> When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</para></description-docbook><description> When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</description></property><property name="ignore-auto-routes" name_upper="IGNORE_AUTO_ROUTES" type="boolean" default="FALSE"><description-docbook><para> When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</para></description-docbook><description> When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</description></property><property name="link-local" name_upper="LINK_LOCAL" type="int32" default="0"><description-docbook><para> Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server.</para><para> When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".</para></description-docbook><description> Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server. - - When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".</description></property><property name="may-fail" name_upper="MAY_FAIL" type="boolean" default="TRUE"><description-docbook><para> If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</para></description-docbook><description> If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</description></property><property name="method" name_upper="METHOD" type="string"><description-docbook><para> IP configuration method.</para><para> NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.</para><para> In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.</para><para> For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.</para><para> For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</para></description-docbook><description> IP configuration method. - - NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. - - In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. - - For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. - - For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</description></property><property name="never-default" name_upper="NEVER_DEFAULT" type="boolean" default="FALSE"><description-docbook><para> If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</para></description-docbook><description> If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</description></property><property name="required-timeout" name_upper="REQUIRED_TIMEOUT" type="int32" default="-1"><description-docbook><para> The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</para><para> This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.</para><para> Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</para><para> A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</para></description-docbook><description> The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. - - This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. - - Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. - - A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</description></property><property name="route-data" name_upper="ROUTE_DATA" type="array of vardict"><description>Array of IPv4 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.</description></property><property name="route-metric" name_upper="ROUTE_METRIC" type="int64" default="-1"><description-docbook><para> The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</para></description-docbook><description> The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</description></property><property name="route-table" name_upper="ROUTE_TABLE" type="uint32" default="0"><description-docbook><para> Enable policy routing (source routing) and set the routing table used when adding routes.</para><para> This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para> If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para> Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para></description-docbook><description> Enable policy routing (source routing) and set the routing table used when adding routes. - - This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. - - If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. - - Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</description></property><property name="routes" name_upper="ROUTES" type="array of array of uint32"><description-docbook><para> Array of IP routes.</para></description-docbook><description>Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. If the metric is 0, NM will choose an appropriate default metric for the device. (There is no way to explicitly specify an actual metric of 0 with this property.)</description></property></setting><setting name="ipv6" description=" IPv6 Settings" name_upper="IP6_CONFIG"><property name="addr-gen-mode" name_upper="ADDR_GEN_MODE" type="int32" default="3"><description-docbook><para> Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3).</para><para> If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced.</para><para> The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced.</para><para> The special values "default" and "default-or-eui64" will fallback to the global connection default in as documented in NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively.</para><para> For libnm, the property defaults to "default" since 1.40. Previously it defaulted to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions.</para><para> Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</para></description-docbook><description> Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3). - - If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. - - The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. - - The special values "default" and "default-or-eui64" will fallback to the global connection default in as documented in NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively. - - For libnm, the property defaults to "default" since 1.40. Previously it defaulted to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions. - - Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</description></property><property name="address-data" name_upper="ADDRESS_DATA" type="array of vardict"><description>Array of IPv6 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.</description></property><property name="addresses" name_upper="ADDRESSES" type="array of legacy IPv6 address struct (a(ayuay))"><description-docbook><para> Array of IP addresses.</para></description-docbook><description>Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv6 address structures. Each IPv6 address structure is composed of an IPv6 address, a prefix length (0 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.</description></property><property name="dad-timeout" name_upper="DAD_TIMEOUT" type="int32" default="-1"><description-docbook><para> Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds.</para><para> The property is currently implemented only for IPv4.</para></description-docbook><description> Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. - - The property is currently implemented only for IPv4.</description></property><property name="dhcp-duid" name_upper="DHCP_DUID" type="string"><description-docbook><para> A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option.</para><para> The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id.</para><para> The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk.</para><para> The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt").</para><para> When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.</para></description-docbook><description> A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option. - - The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id. - - The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk. - - The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt"). - - When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.</description></property><property name="dhcp-hostname" name_upper="DHCP_HOSTNAME" type="string"><description-docbook><para> If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</para></description-docbook><description> If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</description></property><property name="dhcp-hostname-flags" name_upper="DHCP_HOSTNAME_FLAGS" type="uint32" default="0"><description-docbook><para> Flags for the DHCP hostname and FQDN.</para><para> Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.</para><para> When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</para></description-docbook><description> Flags for the DHCP hostname and FQDN. - - Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. - - When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</description></property><property name="dhcp-iaid" name_upper="DHCP_IAID" type="string"><description-docbook><para> A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.</para></description-docbook><description> A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.</description></property><property name="dhcp-reject-servers" name_upper="DHCP_REJECT_SERVERS" type="array of string"><description-docbook><para> Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers.</para><para> For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24").</para><para> This property is currently not implemented for DHCPv6.</para></description-docbook><description> Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. - - For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). - - This property is currently not implemented for DHCPv6.</description></property><property name="dhcp-send-hostname" name_upper="DHCP_SEND_HOSTNAME" type="boolean" default="TRUE"><description-docbook><para> If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</para></description-docbook><description> If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</description></property><property name="dhcp-timeout" name_upper="DHCP_TIMEOUT" type="int32" default="0"><description-docbook><para> 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).</para><para> Set to 2147483647 (MAXINT32) for infinity.</para></description-docbook><description> 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.</description></property><property name="dns" name_upper="DNS" type="array of byte array"><description-docbook><para> Array of IP addresses of DNS servers.</para></description-docbook><description>Array of IP addresses of DNS servers (in network byte order)</description></property><property name="dns-options" name_upper="DNS_OPTIONS" type="array of string"><description-docbook><para> Array of DNS options as described in man 5 resolv.conf.</para><para> 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.</para><para> The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc".</para><para> The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.</para><para> When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</para></description-docbook><description> 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. - - The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". - - The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. - - When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</description></property><property name="dns-priority" name_upper="DNS_PRIORITY" type="int32" default="0"><description-docbook><para> DNS servers priority.</para><para> The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</para><para> Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.</para><para> 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.</para><para> 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.</para><para> 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.</para><para> 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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</para><para> When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</para></description-docbook><description> DNS servers priority. - - The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). - - Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. - - 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 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. - - 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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. - - When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</description></property><property name="dns-search" name_upper="DNS_SEARCH" type="array of string"><description-docbook><para> List 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.</para><para> When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</para><para> When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</para></description-docbook><description> List 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. - - When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. - - When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</description></property><property name="gateway" name_upper="GATEWAY" type="string"><description-docbook><para> The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</para><para> Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</para><para> Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</para></description-docbook><description> The gateway associated with this configuration. This is only meaningful if "addresses" is also set. - - Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. - - Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</description></property><property name="ignore-auto-dns" name_upper="IGNORE_AUTO_DNS" type="boolean" default="FALSE"><description-docbook><para> When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</para></description-docbook><description> When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</description></property><property name="ignore-auto-routes" name_upper="IGNORE_AUTO_ROUTES" type="boolean" default="FALSE"><description-docbook><para> When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</para></description-docbook><description> When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</description></property><property name="ip6-privacy" name_upper="IP6_PRIVACY" type="NMSettingIP6ConfigPrivacy (int32)"><description-docbook><para> Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).</para><para> Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy".</para><para> If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr".</para><para> Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.</para></description-docbook><description> Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). - - Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". - - If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". - - Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.</description></property><property name="may-fail" name_upper="MAY_FAIL" type="boolean" default="TRUE"><description-docbook><para> If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</para></description-docbook><description> If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</description></property><property name="method" name_upper="METHOD" type="string"><description-docbook><para> IP configuration method.</para><para> NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.</para><para> In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.</para><para> For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.</para><para> For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</para></description-docbook><description> IP configuration method. - - NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. - - In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. - - For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. - - For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.</para></description-docbook><description> Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.</description></property><property name="never-default" name_upper="NEVER_DEFAULT" type="boolean" default="FALSE"><description-docbook><para> If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</para></description-docbook><description> If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</description></property><property name="ra-timeout" name_upper="RA_TIMEOUT" type="int32" default="0"><description-docbook><para> A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device.</para><para> Set to 2147483647 (MAXINT32) for infinity.</para></description-docbook><description> A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device. - - Set to 2147483647 (MAXINT32) for infinity.</description></property><property name="required-timeout" name_upper="REQUIRED_TIMEOUT" type="int32" default="-1"><description-docbook><para> The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</para><para> This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.</para><para> Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</para><para> A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</para></description-docbook><description> The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. - - This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. - - Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. - - A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</description></property><property name="route-data" name_upper="ROUTE_DATA" type="array of vardict"><description>Array of IPv6 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.</description></property><property name="route-metric" name_upper="ROUTE_METRIC" type="int64" default="-1"><description-docbook><para> The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</para></description-docbook><description> The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</description></property><property name="route-table" name_upper="ROUTE_TABLE" type="uint32" default="0"><description-docbook><para> Enable policy routing (source routing) and set the routing table used when adding routes.</para><para> This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para> If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para> Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para></description-docbook><description> Enable policy routing (source routing) and set the routing table used when adding routes. - - This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. - - If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. - - Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</description></property><property name="routes" name_upper="ROUTES" type="array of legacy IPv6 route struct (a(ayuayu))"><description-docbook><para> Array of IP routes.</para></description-docbook><description>Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv6 route structures. Each IPv6 route structure is composed of an IPv6 address, a prefix length (0 - 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric. If the metric is 0, NM will choose an appropriate default metric for the device.</description></property><property name="token" name_upper="TOKEN" type="string"><description-docbook><para> Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</para></description-docbook><description> Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</description></property></setting><setting name="ip-tunnel" description=" IP Tunneling Settings" name_upper="IP_TUNNEL"><property name="encapsulation-limit" name_upper="ENCAPSULATION_LIMIT" type="uint32" default="0"><description-docbook><para> How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</para></description-docbook><description> How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</description></property><property name="flags" name_upper="FLAGS" type="uint32" default="0"><description-docbook><para> Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</para></description-docbook><description> Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</description></property><property name="flow-label" name_upper="FLOW_LABEL" type="uint32" default="0"><description-docbook><para> The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</para></description-docbook><description> The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</description></property><property name="input-key" name_upper="INPUT_KEY" type="string"><description-docbook><para> The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para></description-docbook><description> The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</description></property><property name="local" name_upper="LOCAL" type="string"><description-docbook><para> The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</para></description-docbook><description> The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</description></property><property name="mode" name_upper="MODE" type="uint32" default="0"><description-docbook><para> The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</para></description-docbook><description> The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para></description-docbook><description> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</description></property><property name="output-key" name_upper="OUTPUT_KEY" type="string"><description-docbook><para> The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para></description-docbook><description> The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</description></property><property name="parent" name_upper="PARENT" type="string"><description-docbook><para> If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</para></description-docbook><description> If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</description></property><property name="path-mtu-discovery" name_upper="PATH_MTU_DISCOVERY" type="boolean" default="TRUE"><description-docbook><para> Whether to enable Path MTU Discovery on this tunnel.</para></description-docbook><description> Whether to enable Path MTU Discovery on this tunnel.</description></property><property name="remote" name_upper="REMOTE" type="string"><description-docbook><para> The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</para></description-docbook><description> The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</description></property><property name="tos" name_upper="TOS" type="uint32" default="0"><description-docbook><para> The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</para></description-docbook><description> The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</description></property><property name="ttl" name_upper="TTL" type="uint32" default="0"><description-docbook><para> The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</para></description-docbook><description> The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</description></property></setting><setting name="macsec" description=" MACSec Settings" name_upper="MACSEC"><property name="encrypt" name_upper="ENCRYPT" type="boolean" default="TRUE"><description-docbook><para> Whether the transmitted traffic must be encrypted.</para></description-docbook><description> Whether the transmitted traffic must be encrypted.</description></property><property name="mka-cak" name_upper="MKA_CAK" type="string"><description-docbook><para> The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</para></description-docbook><description> The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</description></property><property name="mka-cak-flags" name_upper="MKA_CAK_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "mka-cak" property.</para></description-docbook><description> Flags indicating how to handle the "mka-cak" property.</description></property><property name="mka-ckn" name_upper="MKA_CKN" type="string"><description-docbook><para> The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</para></description-docbook><description> The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</description></property><property name="mode" name_upper="MODE" type="int32" default="0"><description-docbook><para> Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</para></description-docbook><description> Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</description></property><property name="parent" name_upper="PARENT" type="string"><description-docbook><para> If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para></description-docbook><description> If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</description></property><property name="port" name_upper="PORT" type="int32" default="1"><description-docbook><para> The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</para></description-docbook><description> The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</description></property><property name="send-sci" name_upper="SEND_SCI" type="boolean" default="TRUE"><description-docbook><para> Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</para></description-docbook><description> Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</description></property><property name="validation" name_upper="VALIDATION" type="int32" default="2"><description-docbook><para> Specifies the validation mode for incoming frames.</para></description-docbook><description> Specifies the validation mode for incoming frames.</description></property></setting><setting name="macvlan" description=" MAC VLAN Settings" name_upper="MACVLAN"><property name="mode" name_upper="MODE" type="uint32" default="0"><description-docbook><para> The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</para></description-docbook><description> The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</description></property><property name="parent" name_upper="PARENT" type="string"><description-docbook><para> If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para></description-docbook><description> If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</description></property><property name="promiscuous" name_upper="PROMISCUOUS" type="boolean" default="TRUE"><description-docbook><para> Whether the interface should be put in promiscuous mode.</para></description-docbook><description> Whether the interface should be put in promiscuous mode.</description></property><property name="tap" name_upper="TAP" type="boolean" default="FALSE"><description-docbook><para> Whether the interface should be a MACVTAP.</para></description-docbook><description> Whether the interface should be a MACVTAP.</description></property></setting><setting name="match" description=" Match settings" name_upper="MATCH"><property name="driver" name_upper="DRIVER" type="array of string"><description-docbook><para> A list of driver names to match. Each element is a shell wildcard pattern.</para><para> See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</para></description-docbook><description> A list of driver names to match. Each element is a shell wildcard pattern. - - See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</description></property><property name="interface-name" name_upper="INTERFACE_NAME" type="array of string"><description-docbook><para> A list of interface names to match. Each element is a shell wildcard pattern.</para><para> An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".</para></description-docbook><description> A list of interface names to match. Each element is a shell wildcard pattern. - - An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".</description></property><property name="kernel-command-line" name_upper="KERNEL_COMMAND_LINE" type="array of string"><description-docbook><para> A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported.</para><para> See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.</para></description-docbook><description> A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported. - - See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.</description></property><property name="path" name_upper="PATH" type="array of string"><description-docbook><para> A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier.</para><para> For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0".</para><para> The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev").</para><para> Each element of the list is a shell wildcard pattern.</para><para> See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</para></description-docbook><description> A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier. - - For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0". - - The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev"). - - Each element of the list is a shell wildcard pattern. - - See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</description></property></setting><setting name="802-11-olpc-mesh" description=" OLPC Wireless Mesh Settings" name_upper="OLPC_MESH"><property name="channel" name_upper="CHANNEL" type="uint32" default="0"><description-docbook><para> Channel on which the mesh network to join is located.</para></description-docbook><description> Channel on which the mesh network to join is located.</description></property><property name="dhcp-anycast-address" name_upper="DHCP_ANYCAST_ADDRESS" type="byte array"><description-docbook><para> Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.</para><para> This is currently only implemented by dhclient DHCP plugin.</para></description-docbook><description> Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. - - This is currently only implemented by dhclient DHCP plugin.</description></property><property name="ssid" name_upper="SSID" type="byte array"><description-docbook><para> SSID of the mesh network to join.</para></description-docbook><description> SSID of the mesh network to join.</description></property></setting><setting name="ovs-bridge" description=" OvsBridge Link Settings" name_upper="OVS_BRIDGE"><property name="datapath-type" name_upper="DATAPATH_TYPE" type="string"><description-docbook><para> The data path type. One of "system", "netdev" or empty.</para></description-docbook><description> The data path type. One of "system", "netdev" or empty.</description></property><property name="fail-mode" name_upper="FAIL_MODE" type="string"><description-docbook><para> The bridge failure mode. One of "secure", "standalone" or empty.</para></description-docbook><description> The bridge failure mode. One of "secure", "standalone" or empty.</description></property><property name="mcast-snooping-enable" name_upper="MCAST_SNOOPING_ENABLE" type="boolean" default="FALSE"><description-docbook><para> Enable or disable multicast snooping.</para></description-docbook><description> Enable or disable multicast snooping.</description></property><property name="rstp-enable" name_upper="RSTP_ENABLE" type="boolean" default="FALSE"><description-docbook><para> Enable or disable RSTP.</para></description-docbook><description> Enable or disable RSTP.</description></property><property name="stp-enable" name_upper="STP_ENABLE" type="boolean" default="FALSE"><description-docbook><para> Enable or disable STP.</para></description-docbook><description> Enable or disable STP.</description></property></setting><setting name="ovs-dpdk" description=" OvsDpdk Link Settings" name_upper="OVS_DPDK"><property name="devargs" name_upper="DEVARGS" type="string"><description-docbook><para> Open vSwitch DPDK device arguments.</para></description-docbook><description> Open vSwitch DPDK device arguments.</description></property><property name="n-rxq" name_upper="N_RXQ" type="uint32" default="0"><description-docbook><para> Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.</para></description-docbook><description> Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.</description></property></setting><setting name="ovs-interface" description=" Open vSwitch Interface Settings" name_upper="OVS_INTERFACE"><property name="type" name_upper="TYPE" type="string"><description-docbook><para> The interface type. Either "internal", "system", "patch", "dpdk", or empty.</para></description-docbook><description> The interface type. Either "internal", "system", "patch", "dpdk", or empty.</description></property></setting><setting name="ovs-patch" description=" OvsPatch Link Settings" name_upper="OVS_PATCH"><property name="peer" name_upper="PEER" type="string"><description-docbook><para> Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.</para></description-docbook><description> Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.</description></property></setting><setting name="ovs-port" description=" OvsPort Link Settings" name_upper="OVS_PORT"><property name="bond-downdelay" name_upper="BOND_DOWNDELAY" type="uint32" default="0"><description-docbook><para> The time port must be inactive in order to be considered down.</para></description-docbook><description> The time port must be inactive in order to be considered down.</description></property><property name="bond-mode" name_upper="BOND_MODE" type="string"><description-docbook><para> Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</para></description-docbook><description> Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</description></property><property name="bond-updelay" name_upper="BOND_UPDELAY" type="uint32" default="0"><description-docbook><para> The time port must be active before it starts forwarding traffic.</para></description-docbook><description> The time port must be active before it starts forwarding traffic.</description></property><property name="lacp" name_upper="LACP" type="string"><description-docbook><para> LACP mode. One of "active", "off", or "passive".</para></description-docbook><description> LACP mode. One of "active", "off", or "passive".</description></property><property name="tag" name_upper="TAG" type="uint32" default="0"><description-docbook><para> The VLAN tag in the range 0-4095.</para></description-docbook><description> The VLAN tag in the range 0-4095.</description></property><property name="vlan-mode" name_upper="VLAN_MODE" type="string"><description-docbook><para> The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset.</para></description-docbook><description> The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset.</description></property></setting><setting name="ppp" description=" Point-to-Point Protocol Settings" name_upper="PPP"><property name="baud" name_upper="BAUD" type="uint32" default="0"><description-docbook><para> If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</para></description-docbook><description> If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</description></property><property name="crtscts" name_upper="CRTSCTS" type="boolean" default="FALSE"><description-docbook><para> If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</para></description-docbook><description> If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</description></property><property name="lcp-echo-failure" name_upper="LCP_ECHO_FAILURE" type="uint32" default="0"><description-docbook><para> If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.</para></description-docbook><description> If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.</description></property><property name="lcp-echo-interval" name_upper="LCP_ECHO_INTERVAL" type="uint32" default="0"><description-docbook><para> If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</para></description-docbook><description> If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</description></property><property name="mppe-stateful" name_upper="MPPE_STATEFUL" type="boolean" default="FALSE"><description-docbook><para> If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</para></description-docbook><description> If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</description></property><property name="mru" name_upper="MRU" type="uint32" default="0"><description-docbook><para> If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</para></description-docbook><description> If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> If non-zero, instruct pppd to send packets no larger than the specified size.</para></description-docbook><description> If non-zero, instruct pppd to send packets no larger than the specified size.</description></property><property name="no-vj-comp" name_upper="NO_VJ_COMP" type="boolean" default="FALSE"><description-docbook><para> If TRUE, Van Jacobsen TCP header compression will not be requested.</para></description-docbook><description> If TRUE, Van Jacobsen TCP header compression will not be requested.</description></property><property name="noauth" name_upper="NOAUTH" type="boolean" default="TRUE"><description-docbook><para> If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</para></description-docbook><description> If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</description></property><property name="nobsdcomp" name_upper="NOBSDCOMP" type="boolean" default="FALSE"><description-docbook><para> If TRUE, BSD compression will not be requested.</para></description-docbook><description> If TRUE, BSD compression will not be requested.</description></property><property name="nodeflate" name_upper="NODEFLATE" type="boolean" default="FALSE"><description-docbook><para> If TRUE, "deflate" compression will not be requested.</para></description-docbook><description> If TRUE, "deflate" compression will not be requested.</description></property><property name="refuse-chap" name_upper="REFUSE_CHAP" type="boolean" default="FALSE"><description-docbook><para> If TRUE, the CHAP authentication method will not be used.</para></description-docbook><description> If TRUE, the CHAP authentication method will not be used.</description></property><property name="refuse-eap" name_upper="REFUSE_EAP" type="boolean" default="FALSE"><description-docbook><para> If TRUE, the EAP authentication method will not be used.</para></description-docbook><description> If TRUE, the EAP authentication method will not be used.</description></property><property name="refuse-mschap" name_upper="REFUSE_MSCHAP" type="boolean" default="FALSE"><description-docbook><para> If TRUE, the MSCHAP authentication method will not be used.</para></description-docbook><description> If TRUE, the MSCHAP authentication method will not be used.</description></property><property name="refuse-mschapv2" name_upper="REFUSE_MSCHAPV2" type="boolean" default="FALSE"><description-docbook><para> If TRUE, the MSCHAPv2 authentication method will not be used.</para></description-docbook><description> If TRUE, the MSCHAPv2 authentication method will not be used.</description></property><property name="refuse-pap" name_upper="REFUSE_PAP" type="boolean" default="FALSE"><description-docbook><para> If TRUE, the PAP authentication method will not be used.</para></description-docbook><description> If TRUE, the PAP authentication method will not be used.</description></property><property name="require-mppe" name_upper="REQUIRE_MPPE" type="boolean" default="FALSE"><description-docbook><para> If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</para></description-docbook><description> If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</description></property><property name="require-mppe-128" name_upper="REQUIRE_MPPE_128" type="boolean" default="FALSE"><description-docbook><para> If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</para></description-docbook><description> If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</description></property></setting><setting name="pppoe" description=" PPP-over-Ethernet Settings" name_upper="PPPOE"><property name="parent" name_upper="PARENT" type="string"><description-docbook><para> If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.</para></description-docbook><description> If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.</description></property><property name="password" name_upper="PASSWORD" type="string"><description-docbook><para> Password used to authenticate with the PPPoE service.</para></description-docbook><description> Password used to authenticate with the PPPoE service.</description></property><property name="password-flags" name_upper="PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "password" property.</para></description-docbook><description> Flags indicating how to handle the "password" property.</description></property><property name="service" name_upper="SERVICE" type="string"><description-docbook><para> If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</para></description-docbook><description> If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</description></property><property name="username" name_upper="USERNAME" type="string"><description-docbook><para> Username used to authenticate with the PPPoE service.</para></description-docbook><description> Username used to authenticate with the PPPoE service.</description></property></setting><setting name="proxy" description=" WWW Proxy Settings" name_upper="PROXY"><property name="browser-only" name_upper="BROWSER_ONLY" type="boolean" default="FALSE"><description-docbook><para> Whether the proxy configuration is for browser only.</para></description-docbook><description> Whether the proxy configuration is for browser only.</description></property><property name="method" name_upper="METHOD" type="int32" default="0"><description-docbook><para> Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</para></description-docbook><description> Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</description></property><property name="pac-script" name_upper="PAC_SCRIPT" type="string"><description-docbook><para> PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.</para></description-docbook><description> PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.</description></property><property name="pac-url" name_upper="PAC_URL" type="string"><description-docbook><para> PAC URL for obtaining PAC file.</para></description-docbook><description> PAC URL for obtaining PAC file.</description></property></setting><setting name="serial" description=" Serial Link Settings" name_upper="SERIAL"><property name="baud" name_upper="BAUD" type="uint32" default="57600"><description-docbook><para> Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</para></description-docbook><description> Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</description></property><property name="bits" name_upper="BITS" type="uint32" default="8"><description-docbook><para> Byte-width of the serial communication. The 8 in "8n1" for example.</para></description-docbook><description> Byte-width of the serial communication. The 8 in "8n1" for example.</description></property><property name="parity" name_upper="PARITY" type="byte"><description-docbook><para> Parity setting of the serial port.</para></description-docbook><description>The connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.</description></property><property name="send-delay" name_upper="SEND_DELAY" type="uint64" default="0"><description-docbook><para> Time to delay between each byte sent to the modem, in microseconds.</para></description-docbook><description> Time to delay between each byte sent to the modem, in microseconds.</description></property><property name="stopbits" name_upper="STOPBITS" type="uint32" default="1"><description-docbook><para> Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</para></description-docbook><description> Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</description></property></setting><setting name="sriov" description=" SR-IOV settings" name_upper="SRIOV"><property name="autoprobe-drivers" name_upper="AUTOPROBE_DRIVERS" type="NMTernary (int32)"><description-docbook><para> Whether to autoprobe virtual functions by a compatible driver.</para><para> 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.</para><para> If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them.</para><para> 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).</para></description-docbook><description> 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).</description></property><property name="total-vfs" name_upper="TOTAL_VFS" type="uint32" default="0"><description-docbook><para> The total number of virtual functions to create.</para><para> 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.</para></description-docbook><description> 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.</description></property><property name="vfs" name_upper="VFS" type="array of vardict"><description-docbook><para> Array of virtual function descriptors.</para><para> Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF.</para><para> When represented as string a VF is in the form:</para><para> "INDEX [ATTR=VALUE[ ATTR=VALUE]...]".</para><para> for example:</para><para> "2 mac=00:11:22:33:44:55 spoof-check=true".</para><para> 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.</para><para> The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form</para><para> "ID[.PRIORITY[.PROTO]]".</para><para> PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.</para></description-docbook><description> 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.</description></property></setting><setting name="tc" description=" Linux Traffic Control Settings" name_upper="TC_CONFIG"><property name="qdiscs" name_upper="QDISCS" type="array of vardict"><description-docbook><para> Array of TC queueing disciplines.</para><para> When the "tc" setting is present, qdiscs from this property are applied upon activation. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net.core.default_qdisc" sysctl.</para><para> If the "tc" setting is not present, NetworkManager doesn't touch the qdiscs present on the interface.</para></description-docbook><description> Array of TC queueing disciplines. - - When the "tc" setting is present, qdiscs from this property are applied upon activation. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net.core.default_qdisc" sysctl. - - If the "tc" setting is not present, NetworkManager doesn't touch the qdiscs present on the interface.</description></property><property name="tfilters" name_upper="TFILTERS" type="array of vardict"><description-docbook><para> Array of TC traffic filters.</para><para> When the "tc" setting is present, filters from this property are applied upon activation. If the property is empty, NetworkManager removes all the filters.</para><para> If the "tc" setting is not present, NetworkManager doesn't touch the filters present on the interface.</para></description-docbook><description> Array of TC traffic filters. - - When the "tc" setting is present, filters from this property are applied upon activation. If the property is empty, NetworkManager removes all the filters. - - If the "tc" setting is not present, NetworkManager doesn't touch the filters present on the interface.</description></property></setting><setting name="team" description=" Teaming Settings" name_upper="TEAM"><property name="config" name_upper="CONFIG" type="string"><description-docbook><para> The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</para></description-docbook><description> The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</description></property><property name="interface-name" name_upper="INTERFACE_NAME" type="string"><description>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.</description></property><property name="link-watchers" name_upper="LINK_WATCHERS" type="array of vardict"><description-docbook><para> Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</para></description-docbook><description> Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</description></property><property name="mcast-rejoin-count" name_upper="MCAST_REJOIN_COUNT" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd mcast_rejoin.count.</para></description-docbook><description> Corresponds to the teamd mcast_rejoin.count.</description></property><property name="mcast-rejoin-interval" name_upper="MCAST_REJOIN_INTERVAL" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd mcast_rejoin.interval.</para></description-docbook><description> Corresponds to the teamd mcast_rejoin.interval.</description></property><property name="notify-peers-count" name_upper="NOTIFY_PEERS_COUNT" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd notify_peers.count.</para></description-docbook><description> Corresponds to the teamd notify_peers.count.</description></property><property name="notify-peers-interval" name_upper="NOTIFY_PEERS_INTERVAL" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd notify_peers.interval.</para></description-docbook><description> Corresponds to the teamd notify_peers.interval.</description></property><property name="runner" name_upper="RUNNER" type="string"><description-docbook><para> Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</para></description-docbook><description> Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</description></property><property name="runner-active" name_upper="RUNNER_ACTIVE" type="boolean" default="TRUE"><description-docbook><para> Corresponds to the teamd runner.active.</para></description-docbook><description> Corresponds to the teamd runner.active.</description></property><property name="runner-agg-select-policy" name_upper="RUNNER_AGG_SELECT_POLICY" type="string"><description-docbook><para> Corresponds to the teamd runner.agg_select_policy.</para></description-docbook><description> Corresponds to the teamd runner.agg_select_policy.</description></property><property name="runner-fast-rate" name_upper="RUNNER_FAST_RATE" type="boolean" default="FALSE"><description-docbook><para> Corresponds to the teamd runner.fast_rate.</para></description-docbook><description> Corresponds to the teamd runner.fast_rate.</description></property><property name="runner-hwaddr-policy" name_upper="RUNNER_HWADDR_POLICY" type="string"><description-docbook><para> Corresponds to the teamd runner.hwaddr_policy.</para></description-docbook><description> Corresponds to the teamd runner.hwaddr_policy.</description></property><property name="runner-min-ports" name_upper="RUNNER_MIN_PORTS" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd runner.min_ports.</para></description-docbook><description> Corresponds to the teamd runner.min_ports.</description></property><property name="runner-sys-prio" name_upper="RUNNER_SYS_PRIO" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd runner.sys_prio.</para></description-docbook><description> Corresponds to the teamd runner.sys_prio.</description></property><property name="runner-tx-balancer" name_upper="RUNNER_TX_BALANCER" type="string"><description-docbook><para> Corresponds to the teamd runner.tx_balancer.name.</para></description-docbook><description> Corresponds to the teamd runner.tx_balancer.name.</description></property><property name="runner-tx-balancer-interval" name_upper="RUNNER_TX_BALANCER_INTERVAL" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd runner.tx_balancer.interval.</para></description-docbook><description> Corresponds to the teamd runner.tx_balancer.interval.</description></property><property name="runner-tx-hash" name_upper="RUNNER_TX_HASH" type="array of string"><description-docbook><para> Corresponds to the teamd runner.tx_hash.</para></description-docbook><description> Corresponds to the teamd runner.tx_hash.</description></property></setting><setting name="team-port" description=" Team Port Settings" name_upper="TEAM_PORT"><property name="config" name_upper="CONFIG" type="string"><description-docbook><para> The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</para></description-docbook><description> The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</description></property><property name="lacp-key" name_upper="LACP_KEY" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd ports.PORTIFNAME.lacp_key.</para></description-docbook><description> Corresponds to the teamd ports.PORTIFNAME.lacp_key.</description></property><property name="lacp-prio" name_upper="LACP_PRIO" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</para></description-docbook><description> Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</description></property><property name="link-watchers" name_upper="LINK_WATCHERS" type="array of vardict"><description-docbook><para> Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</para></description-docbook><description> Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</description></property><property name="prio" name_upper="PRIO" type="int32" default="0"><description-docbook><para> Corresponds to the teamd ports.PORTIFNAME.prio.</para></description-docbook><description> Corresponds to the teamd ports.PORTIFNAME.prio.</description></property><property name="queue-id" name_upper="QUEUE_ID" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</para></description-docbook><description> Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</description></property><property name="sticky" name_upper="STICKY" type="boolean" default="FALSE"><description-docbook><para> Corresponds to the teamd ports.PORTIFNAME.sticky.</para></description-docbook><description> Corresponds to the teamd ports.PORTIFNAME.sticky.</description></property></setting><setting name="tun" description=" Tunnel Settings" name_upper="TUN"><property name="group" name_upper="GROUP" type="string"><description-docbook><para> The group ID which will own the device. If set to NULL everyone will be able to use the device.</para></description-docbook><description> The group ID which will own the device. If set to NULL everyone will be able to use the device.</description></property><property name="mode" name_upper="MODE" type="uint32" default="1"><description-docbook><para> The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.</para></description-docbook><description> The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.</description></property><property name="multi-queue" name_upper="MULTI_QUEUE" type="boolean" default="FALSE"><description-docbook><para> If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</para></description-docbook><description> If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</description></property><property name="owner" name_upper="OWNER" type="string"><description-docbook><para> The user ID which will own the device. If set to NULL everyone will be able to use the device.</para></description-docbook><description> The user ID which will own the device. If set to NULL everyone will be able to use the device.</description></property><property name="pi" name_upper="PI" type="boolean" default="FALSE"><description-docbook><para> If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</para></description-docbook><description> If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</description></property><property name="vnet-hdr" name_upper="VNET_HDR" type="boolean" default="FALSE"><description-docbook><para> If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</para></description-docbook><description> If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</description></property></setting><setting name="user" description=" General User Profile Settings" name_upper="USER"><property name="data" name_upper="DATA" type="dict of string to string" default="{}"><description-docbook><para> A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.</para></description-docbook><description> A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.</description></property></setting><setting name="vlan" description=" VLAN Settings" name_upper="VLAN"><property name="egress-priority-map" name_upper="EGRESS_PRIORITY_MAP" type="array of string"><description-docbook><para> For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</para></description-docbook><description> For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</description></property><property name="flags" name_upper="FLAGS" type="NMVlanFlags (uint32)"><description-docbook><para> One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol).</para><para> The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.</para></description-docbook><description> One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). - - The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.</description></property><property name="id" name_upper="ID" type="uint32" default="0"><description-docbook><para> The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.</para></description-docbook><description> The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.</description></property><property name="ingress-priority-map" name_upper="INGRESS_PRIORITY_MAP" type="array of string"><description-docbook><para> For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</para></description-docbook><description> For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</description></property><property name="interface-name" name_upper="INTERFACE_NAME" type="string"><description>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.</description></property><property name="parent" name_upper="PARENT" type="string"><description-docbook><para> If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para></description-docbook><description> If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</description></property></setting><setting name="vpn" description=" VPN Settings" name_upper="VPN"><property name="data" name_upper="DATA" type="dict of string to string" default="{}"><description-docbook><para> Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</para></description-docbook><description> Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</description></property><property name="persistent" name_upper="PERSISTENT" type="boolean" default="FALSE"><description-docbook><para> If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.</para></description-docbook><description> If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.</description></property><property name="secrets" name_upper="SECRETS" type="dict of string to string" default="{}"><description-docbook><para> Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</para></description-docbook><description> Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</description></property><property name="service-type" name_upper="SERVICE_TYPE" type="string"><description-docbook><para> D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</para></description-docbook><description> D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</description></property><property name="timeout" name_upper="TIMEOUT" type="uint32" default="0"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="user-name" name_upper="USER_NAME" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property></setting><setting name="vrf" description=" VRF settings" name_upper="VRF"><property name="table" name_upper="TABLE" type="uint32" default="0"><description-docbook><para> The routing table for this VRF.</para></description-docbook><description> The routing table for this VRF.</description></property></setting><setting name="vxlan" description=" VXLAN Settings" name_upper="VXLAN"><property name="ageing" name_upper="AGEING" type="uint32" default="300"><description-docbook><para> Specifies the lifetime in seconds of FDB entries learnt by the kernel.</para></description-docbook><description> Specifies the lifetime in seconds of FDB entries learnt by the kernel.</description></property><property name="destination-port" name_upper="DESTINATION_PORT" type="uint32" default="8472"><description-docbook><para> Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</para></description-docbook><description> Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</description></property><property name="id" name_upper="ID" type="uint32" default="0"><description-docbook><para> Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.</para></description-docbook><description> Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.</description></property><property name="l2-miss" name_upper="L2_MISS" type="boolean" default="FALSE"><description-docbook><para> Specifies whether netlink LL ADDR miss notifications are generated.</para></description-docbook><description> Specifies whether netlink LL ADDR miss notifications are generated.</description></property><property name="l3-miss" name_upper="L3_MISS" type="boolean" default="FALSE"><description-docbook><para> Specifies whether netlink IP ADDR miss notifications are generated.</para></description-docbook><description> Specifies whether netlink IP ADDR miss notifications are generated.</description></property><property name="learning" name_upper="LEARNING" type="boolean" default="TRUE"><description-docbook><para> Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</para></description-docbook><description> Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</description></property><property name="limit" name_upper="LIMIT" type="uint32" default="0"><description-docbook><para> Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</para></description-docbook><description> Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</description></property><property name="local" name_upper="LOCAL" type="string"><description-docbook><para> If given, specifies the source IP address to use in outgoing packets.</para></description-docbook><description> If given, specifies the source IP address to use in outgoing packets.</description></property><property name="parent" name_upper="PARENT" type="string"><description-docbook><para> If given, specifies the parent interface name or parent connection UUID.</para></description-docbook><description> If given, specifies the parent interface name or parent connection UUID.</description></property><property name="proxy" name_upper="PROXY" type="boolean" default="FALSE"><description-docbook><para> Specifies whether ARP proxy is turned on.</para></description-docbook><description> Specifies whether ARP proxy is turned on.</description></property><property name="remote" name_upper="REMOTE" type="string"><description-docbook><para> Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.</para></description-docbook><description> Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.</description></property><property name="rsc" name_upper="RSC" type="boolean" default="FALSE"><description-docbook><para> Specifies whether route short circuit is turned on.</para></description-docbook><description> Specifies whether route short circuit is turned on.</description></property><property name="source-port-max" name_upper="SOURCE_PORT_MAX" type="uint32" default="0"><description-docbook><para> Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</para></description-docbook><description> Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</description></property><property name="source-port-min" name_upper="SOURCE_PORT_MIN" type="uint32" default="0"><description-docbook><para> Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</para></description-docbook><description> Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</description></property><property name="tos" name_upper="TOS" type="uint32" default="0"><description-docbook><para> Specifies the TOS value to use in outgoing packets.</para></description-docbook><description> Specifies the TOS value to use in outgoing packets.</description></property><property name="ttl" name_upper="TTL" type="uint32" default="0"><description-docbook><para> Specifies the time-to-live value to use in outgoing packets.</para></description-docbook><description> Specifies the time-to-live value to use in outgoing packets.</description></property></setting><setting name="wifi-p2p" description=" Wi-Fi P2P Settings" name_upper="WIFI_P2P"><property name="peer" name_upper="PEER" type="string"><description-docbook><para> The P2P device that should be connected to. Currently, this is the only way to create or join a group.</para></description-docbook><description> The P2P device that should be connected to. Currently, this is the only way to create or join a group.</description></property><property name="wfd-ies" name_upper="WFD_IES" type="byte array"><description-docbook><para> The Wi-Fi Display (WFD) Information Elements (IEs) to set.</para><para> Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.</para></description-docbook><description> The Wi-Fi Display (WFD) Information Elements (IEs) to set. - - Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.</description></property><property name="wps-method" name_upper="WPS_METHOD" type="uint32" default="0"><description-docbook><para> Flags indicating which mode of WPS is to be used.</para><para> There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.</para></description-docbook><description> Flags indicating which mode of WPS is to be used. - - There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.</description></property></setting><setting name="wimax" description=" WiMax Settings" name_upper="WIMAX"><property name="mac-address" name_upper="MAC_ADDRESS" type="byte array"><description-docbook><para> 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</para></description-docbook><description> 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</description></property><property name="network-name" name_upper="NETWORK_NAME" type="string"><description-docbook><para> Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1</para></description-docbook><description> Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1</description></property></setting><setting name="802-3-ethernet" description=" Wired Ethernet Settings" name_upper="WIRED"><property name="accept-all-mac-addresses" name_upper="ACCEPT_ALL_MAC_ADDRESSES" type="NMTernary (int32)"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="assigned-mac-address" name_upper="ASSIGNED_MAC_ADDRESS" type="string"><description>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".</description></property><property name="auto-negotiate" name_upper="AUTO_NEGOTIATE" type="boolean" default="FALSE"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="cloned-mac-address" name_upper="CLONED_MAC_ADDRESS" type="byte array"><description-docbook><para> If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.</para><para> Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address if the device has one (otherwise this is treated as "preserve"). "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.</para><para> If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).</para><para> On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</para></description-docbook><description>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".</description></property><property name="duplex" name_upper="DUPLEX" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="generate-mac-address-mask" name_upper="GENERATE_MAC_ADDRESS_MASK" type="string"><description-docbook><para> 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.</para><para> 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.</para><para> 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.</para><para> 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.</para><para> 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.</para></description-docbook><description> 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.</description></property><property name="mac-address" name_upper="MAC_ADDRESS" type="byte array"><description-docbook><para> 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).</para></description-docbook><description> 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).</description></property><property name="mac-address-blacklist" name_upper="MAC_ADDRESS_BLACKLIST" type="array of string"><description-docbook><para> 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).</para></description-docbook><description> 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).</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</para></description-docbook><description> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</description></property><property name="port" name_upper="PORT" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="s390-nettype" name_upper="S390_NETTYPE" type="string"><description-docbook><para> s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</para></description-docbook><description> s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</description></property><property name="s390-options" name_upper="S390_OPTIONS" type="dict of string to string" default="{}"><description-docbook><para> 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]).</para><para> Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.</para></description-docbook><description> 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.</description></property><property name="s390-subchannels" name_upper="S390_SUBCHANNELS" type="array of string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="speed" name_upper="SPEED" type="uint32" default="0"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="wake-on-lan" name_upper="WAKE_ON_LAN" type="uint32" default="1"><description-docbook><para> 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).</para></description-docbook><description> 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).</description></property><property name="wake-on-lan-password" name_upper="WAKE_ON_LAN_PASSWORD" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property></setting><setting name="wireguard" description=" WireGuard Settings" name_upper="WIREGUARD"><property name="fwmark" name_upper="FWMARK" type="uint32" default="0"><description-docbook><para> 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.</para><para> Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.</para></description-docbook><description> 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.</description></property><property name="ip4-auto-default-route" name_upper="IP4_AUTO_DEFAULT_ROUTE" type="NMTernary (int32)"><description-docbook><para> 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".</para><para> 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.</para><para> 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. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.</para></description-docbook><description> 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. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.</description></property><property name="ip6-auto-default-route" name_upper="IP6_AUTO_DEFAULT_ROUTE" type="NMTernary (int32)"><description-docbook><para> Like ip4-auto-default-route, but for the IPv6 default route.</para></description-docbook><description> Like ip4-auto-default-route, but for the IPv6 default route.</description></property><property name="listen-port" name_upper="LISTEN_PORT" type="uint32" default="0"><description-docbook><para> The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</para></description-docbook><description> The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para><para> 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.</para></description-docbook><description> 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.</description></property><property name="peer-routes" name_upper="PEER_ROUTES" type="boolean" default="TRUE"><description-docbook><para> 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.</para><para> 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.</para></description-docbook><description> 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.</description></property><property name="peers" name_upper="PEERS" type="array of 'a{sv}'"><description>Array of dictionaries for the WireGuard peers.</description></property><property name="private-key" name_upper="PRIVATE_KEY" type="string"><description-docbook><para> The 256 bit private-key in base64 encoding.</para></description-docbook><description> The 256 bit private-key in base64 encoding.</description></property><property name="private-key-flags" name_upper="PRIVATE_KEY_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "private-key" property.</para></description-docbook><description> Flags indicating how to handle the "private-key" property.</description></property></setting><setting name="802-11-wireless" description=" Wi-Fi Settings" name_upper="WIRELESS"><property name="ap-isolation" name_upper="AP_ISOLATION" type="NMTernary (int32)"><description-docbook><para> Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode.</para><para> If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.</para><para> If set to NM_TERNARY_FALSE (0), devices can talk to each other.</para><para> 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_FALSE (0).</para></description-docbook><description> Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode. - - If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. - - If set to NM_TERNARY_FALSE (0), devices can talk to each other. - - 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_FALSE (0).</description></property><property name="assigned-mac-address" name_upper="ASSIGNED_MAC_ADDRESS" type="string"><description>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".</description></property><property name="band" name_upper="BAND" type="string"><description-docbook><para> 802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</para></description-docbook><description> 802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</description></property><property name="bssid" name_upper="BSSID" type="byte array"><description-docbook><para> If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.</para><para> Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.</para></description-docbook><description> If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future. - - Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.</description></property><property name="channel" name_upper="CHANNEL" type="uint32" default="0"><description-docbook><para> Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.</para></description-docbook><description> Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.</description></property><property name="cloned-mac-address" name_upper="CLONED_MAC_ADDRESS" type="byte array"><description-docbook><para> If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.</para><para> Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.</para><para> If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).</para><para> On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</para></description-docbook><description>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".</description></property><property name="generate-mac-address-mask" name_upper="GENERATE_MAC_ADDRESS_MASK" type="string"><description-docbook><para> 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.</para><para> 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.</para><para> 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.</para><para> 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.</para><para> 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.</para></description-docbook><description> 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.</description></property><property name="hidden" name_upper="HIDDEN" type="boolean" default="FALSE"><description-docbook><para> If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.</para><para> In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.</para><para> In AP mode, the created network does not broadcast its SSID.</para><para> Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</para></description-docbook><description> If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode. - - In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. - - In AP mode, the created network does not broadcast its SSID. - - Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</description></property><property name="mac-address" name_upper="MAC_ADDRESS" type="byte array"><description-docbook><para> If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</para></description-docbook><description> If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</description></property><property name="mac-address-blacklist" name_upper="MAC_ADDRESS_BLACKLIST" type="array of string"><description-docbook><para> A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</para></description-docbook><description> A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</description></property><property name="mac-address-randomization" name_upper="MAC_ADDRESS_RANDOMIZATION" type="uint32" default="0"><description-docbook><para> One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'. Deprecated: 1</para></description-docbook><description> One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'. Deprecated: 1</description></property><property name="mode" name_upper="MODE" type="string"><description-docbook><para> Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</para></description-docbook><description> Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</para></description-docbook><description> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</description></property><property name="powersave" name_upper="POWERSAVE" type="uint32" default="0"><description-docbook><para> One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</para></description-docbook><description> One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</description></property><property name="rate" name_upper="RATE" type="uint32" default="0"><description-docbook><para> If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</para></description-docbook><description> If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</description></property><property name="security" name_upper="SECURITY"><description>This property is deprecated, but can be set to the value '802-11-wireless-security' when a wireless security setting is also present in the connection dictionary, for compatibility with very old NetworkManager daemons.</description></property><property name="seen-bssids" name_upper="SEEN_BSSIDS" type="array of string"><description-docbook><para> A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</para></description-docbook><description> A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</description></property><property name="ssid" name_upper="SSID" type="byte array"><description-docbook><para> SSID of the Wi-Fi network. Must be specified.</para></description-docbook><description> SSID of the Wi-Fi network. Must be specified.</description></property><property name="tx-power" name_upper="TX_POWER" type="uint32" default="0"><description-docbook><para> If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</para></description-docbook><description> If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</description></property><property name="wake-on-wlan" name_upper="WAKE_ON_WLAN" type="uint32" default="1"><description-docbook><para> The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</para></description-docbook><description> The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</description></property></setting><setting name="802-11-wireless-security" description=" Wi-Fi Security Settings" name_upper="WIRELESS_SECURITY"><property name="auth-alg" name_upper="AUTH_ALG" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="fils" name_upper="FILS" type="int32" default="0"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="group" name_upper="GROUP" type="array of string"><description-docbook><para> 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".</para></description-docbook><description> 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".</description></property><property name="key-mgmt" name_upper="KEY_MGMT" type="string"><description-docbook><para> 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).</para><para> This property must be set for any Wi-Fi connection that uses security.</para></description-docbook><description> 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.</description></property><property name="leap-password" name_upper="LEAP_PASSWORD" type="string"><description-docbook><para> The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</para></description-docbook><description> The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</description></property><property name="leap-password-flags" name_upper="LEAP_PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "leap-password" property.</para></description-docbook><description> Flags indicating how to handle the "leap-password" property.</description></property><property name="leap-username" name_upper="LEAP_USERNAME" type="string"><description-docbook><para> The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</para></description-docbook><description> The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</description></property><property name="pairwise" name_upper="PAIRWISE" type="array of string"><description-docbook><para> 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".</para></description-docbook><description> 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".</description></property><property name="pmf" name_upper="PMF" type="int32" default="0"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="proto" name_upper="PROTO" type="array of string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="psk" name_upper="PSK" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="psk-flags" name_upper="PSK_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "psk" property.</para></description-docbook><description> Flags indicating how to handle the "psk" property.</description></property><property name="wep-key-flags" name_upper="WEP_KEY_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</para></description-docbook><description> Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</description></property><property name="wep-key-type" name_upper="WEP_KEY_TYPE" type="NMWepKeyType (uint32)"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="wep-key0" name_upper="WEP_KEY0" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="wep-key1" name_upper="WEP_KEY1" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="wep-key2" name_upper="WEP_KEY2" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="wep-key3" name_upper="WEP_KEY3" type="string"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="wep-tx-keyidx" name_upper="WEP_TX_KEYIDX" type="uint32" default="0"><description-docbook><para> 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.</para></description-docbook><description> 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.</description></property><property name="wps-method" name_upper="WPS_METHOD" type="uint32" default="0"><description-docbook><para> Flags indicating which mode of WPS is to be used if any.</para><para> 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.</para><para> WPS can be disabled by setting this property to a value of 1.</para></description-docbook><description> 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.</description></property></setting><setting name="wpan" description=" IEEE 802.15.4 (WPAN) MAC Settings" name_upper="WPAN"><property name="channel" name_upper="CHANNEL" type="int32" default="-1"><description-docbook><para> IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</para></description-docbook><description> IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</description></property><property name="mac-address" name_upper="MAC_ADDRESS" type="string"><description-docbook><para> If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.</para></description-docbook><description> If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.</description></property><property name="page" name_upper="PAGE" type="int32" default="-1"><description-docbook><para> IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</para></description-docbook><description> IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</description></property><property name="pan-id" name_upper="PAN_ID" type="uint32" default="65535"><description-docbook><para> IEEE 802.15.4 Personal Area Network (PAN) identifier.</para></description-docbook><description> IEEE 802.15.4 Personal Area Network (PAN) identifier.</description></property><property name="short-address" name_upper="SHORT_ADDRESS" type="uint32" default="65535"><description-docbook><para> Short IEEE 802.15.4 address to be used within a restricted environment.</para></description-docbook><description> Short IEEE 802.15.4 address to be used within a restricted environment.</description></property></setting><setting name="bond-port" description=" Bond Port Settings" name_upper="BOND_PORT"><property name="queue-id" name_upper="QUEUE_ID" type="uint32" default="0"><description-docbook><para> The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.</para></description-docbook><description> The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.</description></property></setting><setting name="hostname" description=" Hostname settings" name_upper="HOSTNAME"><property name="from-dhcp" name_upper="FROM_DHCP" type="NMTernary (int32)"><description-docbook><para> Whether the system hostname can be determined from DHCP on this connection.</para><para> 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).</para></description-docbook><description> 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).</description></property><property name="from-dns-lookup" name_upper="FROM_DNS_LOOKUP" type="NMTernary (int32)"><description-docbook><para> Whether the system hostname can be determined from reverse DNS lookup of addresses on this device.</para><para> 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).</para></description-docbook><description> 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).</description></property><property name="only-from-default" name_upper="ONLY_FROM_DEFAULT" type="NMTernary (int32)"><description-docbook><para> 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).</para><para> If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route.</para><para> 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).</para></description-docbook><description> 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).</description></property><property name="priority" name_upper="PRIORITY" type="int32" default="0"><description-docbook><para> 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.</para><para> 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.</para><para> 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.</para></description-docbook><description> 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.</description></property></setting><setting name="ovs-external-ids" description=" OVS External IDs Settings" name_upper="OVS_EXTERNAL_IDS"><property name="data" name_upper="DATA" type="dict of string to string" default="{}"><description-docbook><para> A dictionary of key/value pairs with exernal-ids for OVS.</para></description-docbook><description> A dictionary of key/value pairs with exernal-ids for OVS.</description></property></setting><setting name="veth" description=" Veth Settings" name_upper="VETH"><property name="peer" name_upper="PEER" type="string"><description-docbook><para> This property specifies the peer interface name of the veth. This property is mandatory.</para></description-docbook><description> This property specifies the peer interface name of the veth. This property is mandatory.</description></property></setting></nm-setting-docs> \ No newline at end of file diff --git a/man/nm-settings-docs-nmcli.xml b/man/nm-settings-docs-nmcli.xml deleted file mode 100644 index 7323d72b..00000000 --- a/man/nm-settings-docs-nmcli.xml +++ /dev/null @@ -1,536 +0,0 @@ -<nm-setting-docs><setting name="connection" description=" General Connection Profile Settings" name_upper="CONNECTION"><property name="auth-retries" name_upper="AUTH_RETRIES" type="int32" default="-1"><description-docbook><para> 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.</para><para> Currently, this only applies to 802-1x authentication.</para></description-docbook><description>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.</description></property><property name="autoconnect" name_upper="AUTOCONNECT" type="boolean" default="TRUE" alias="autoconnect"><description-docbook><para> 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.</para><para> 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.</para><para> Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.</para><para> If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined.</para><para> Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.</para></description-docbook><description>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. If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined. Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.</description></property><property name="autoconnect-priority" name_upper="AUTOCONNECT_PRIORITY" type="int32" default="0"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="autoconnect-retries" name_upper="AUTOCONNECT_RETRIES" type="int32" default="-1"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="autoconnect-slaves" name_upper="AUTOCONNECT_SLAVES" type="NMSettingConnectionAutoconnectSlaves (int32)"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="dns-over-tls" name_upper="DNS_OVER_TLS" type="int32" default="-1"><description-docbook><para> Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic.</para><para> 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.</para><para> This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para></description-docbook><description>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.</description></property><property name="gateway-ping-timeout" name_upper="GATEWAY_PING_TIMEOUT" type="uint32" default="0"><description-docbook><para> If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</para></description-docbook><description>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</description></property><property name="id" name_upper="ID" type="string" alias="con-name"><description-docbook><para> A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</para></description-docbook><description>A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</description></property><property name="interface-name" name_upper="INTERFACE_NAME" type="string" alias="ifname"><description-docbook><para> 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).</para><para> For software devices this specifies the name of the created device.</para><para> 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.</para></description-docbook><description>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.</description></property><property name="lldp" name_upper="LLDP" type="int32" default="-1"><description-docbook><para> Whether LLDP is enabled for the connection.</para></description-docbook><description>Whether LLDP is enabled for the connection.</description></property><property name="llmnr" name_upper="LLMNR" type="int32" default="-1"><description-docbook><para> 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.</para><para> 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").</para><para> This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para></description-docbook><description>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.</description></property><property name="master" name_upper="MASTER" type="string" alias="master"><description-docbook><para> Interface name of the master device or UUID of the master connection.</para></description-docbook><description>Interface name of the master device or UUID of the master connection.</description></property><property name="mdns" name_upper="MDNS" type="int32" default="-1"><description-docbook><para> Whether mDNS is enabled for the connection.</para><para> 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").</para><para> This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para></description-docbook><description>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.</description></property><property name="metered" name_upper="METERED" type="NMMetered (int32)"><description-docbook><para> Whether the connection is metered.</para><para> When updating this property on a currently activated connection, the change takes effect immediately.</para></description-docbook><description>Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.</description></property><property name="mptcp-flags" name_upper="MPTCP_FLAGS" type="uint32" default="0"><description-docbook><para> Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints.</para><para> If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.</para><para> The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags.</para><para> Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless.</para><para> Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that.</para><para> When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.</para><para> If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl.</para><para> NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.</para><para> Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).</para></description-docbook><description>Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints. If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered. The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags. Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless. Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that. When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags. If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl. NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp. Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).</description></property><property name="mud-url" name_upper="MUD_URL" type="string"><description-docbook><para> 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://".</para><para> The special value "none" is allowed to indicate that no MUD URL is used.</para><para> If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".</para></description-docbook><description>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".</description></property><property name="multi-connect" name_upper="MULTI_CONNECT" type="int32" default="0"><description-docbook><para> Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</para></description-docbook><description>Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</description></property><property name="permissions" name_upper="PERMISSIONS" type="array of string"><description-docbook><para> 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".</para><para> 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.</para></description-docbook><description>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.</description></property><property name="read-only" name_upper="READ_ONLY" type="boolean" default="FALSE"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="secondaries" name_upper="SECONDARIES" type="array of string"><description-docbook><para> List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</para></description-docbook><description>List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</description></property><property name="slave-type" name_upper="SLAVE_TYPE" type="string" alias="slave-type"><description-docbook><para> Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</para></description-docbook><description>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</description></property><property name="stable-id" name_upper="STABLE_ID" type="string"><description-docbook><para> 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.</para><para> 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].</para><para> 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. See NetworkManager(8) manual about the secret-key and the host identity.</para><para> 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.</para><para> 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.</para></description-docbook><description>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. See NetworkManager(8) manual about the secret-key and the host identity. 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.</description></property><property name="timestamp" name_upper="TIMESTAMP" type="uint64" default="0"><description-docbook><para> The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated.</para><para> 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).</para></description-docbook><description>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).</description></property><property name="type" name_upper="TYPE" type="string" alias="type"><description-docbook><para> 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).</para></description-docbook><description>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).</description></property><property name="uuid" name_upper="UUID" type="string"><description-docbook><para> 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.</para><para> The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").</para></description-docbook><description>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 "-").</description></property><property name="wait-activation-delay" name_upper="WAIT_ACTIVATION_DELAY" type="int32" default="-1"><description-docbook><para> Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event.</para><para> The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</para></description-docbook><description>Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event. The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</description></property><property name="wait-device-timeout" name_upper="WAIT_DEVICE_TIMEOUT" type="int32" default="-1"><description-docbook><para> 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.</para><para> The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</para></description-docbook><description>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.</description></property><property name="zone" name_upper="ZONE" type="string"><description-docbook><para> 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.</para><para> When updating this property on a currently activated connection, the change takes effect immediately.</para></description-docbook><description>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.</description></property></setting><setting name="6lowpan" description=" 6LoWPAN Settings" name_upper="6LOWPAN"><property name="parent" name_upper="PARENT" type="string" alias="dev"><description-docbook><para> If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.</para></description-docbook><description>If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.</description></property></setting><setting name="802-1x" description=" IEEE 802.1x Authentication Settings" name_upper="802_1X"><property name="altsubject-matches" name_upper="ALTSUBJECT_MATCHES" type="array of string"><description-docbook><para> List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</para></description-docbook><description>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</description></property><property name="anonymous-identity" name_upper="ANONYMOUS_IDENTITY" type="string"><description-docbook><para> Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</para></description-docbook><description>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</description></property><property name="auth-timeout" name_upper="AUTH_TIMEOUT" type="int32" default="0"><description-docbook><para> A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.</para></description-docbook><description>A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.</description></property><property name="ca-cert" name_upper="CA_CERT" type="byte array"><description-docbook><para> Contains the CA certificate if used by the EAP method specified in the "eap" property.</para><para> Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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.</para><para> Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</para></description-docbook><description>Contains the CA certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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. Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</description></property><property name="ca-cert-password" name_upper="CA_CERT_PASSWORD" type="string"><description-docbook><para> The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para></description-docbook><description>The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</description></property><property name="ca-cert-password-flags" name_upper="CA_CERT_PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "ca-cert-password" property.</para></description-docbook><description>Flags indicating how to handle the "ca-cert-password" property.</description></property><property name="ca-path" name_upper="CA_PATH" type="string"><description-docbook><para> UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property.</para><para> If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</para></description-docbook><description>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property. If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</description></property><property name="client-cert" name_upper="CLIENT_CERT" type="byte array"><description-docbook><para> Contains the client certificate if used by the EAP method specified in the "eap" property.</para><para> 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.</para></description-docbook><description>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.</description></property><property name="client-cert-password" name_upper="CLIENT_CERT_PASSWORD" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="client-cert-password-flags" name_upper="CLIENT_CERT_PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "client-cert-password" property.</para></description-docbook><description>Flags indicating how to handle the "client-cert-password" property.</description></property><property name="domain-match" name_upper="DOMAIN_MATCH" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="domain-suffix-match" name_upper="DOMAIN_SUFFIX_MATCH" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="eap" name_upper="EAP" type="array of string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="identity" name_upper="IDENTITY" type="string"><description-docbook><para> Identity string for EAP authentication methods. Often the user's user or login name.</para></description-docbook><description>Identity string for EAP authentication methods. Often the user's user or login name.</description></property><property name="optional" name_upper="OPTIONAL" type="boolean" default="FALSE"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="pac-file" name_upper="PAC_FILE" type="string"><description-docbook><para> UTF-8 encoded file path containing PAC for EAP-FAST.</para></description-docbook><description>UTF-8 encoded file path containing PAC for EAP-FAST.</description></property><property name="password" name_upper="PASSWORD" type="string"><description-docbook><para> UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</para></description-docbook><description>UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</description></property><property name="password-flags" name_upper="PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "password" property.</para></description-docbook><description>Flags indicating how to handle the "password" property.</description></property><property name="password-raw" name_upper="PASSWORD_RAW" type="byte array"><description-docbook><para> Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</para></description-docbook><description>Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</description></property><property name="password-raw-flags" name_upper="PASSWORD_RAW_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "password-raw" property.</para></description-docbook><description>Flags indicating how to handle the "password-raw" property.</description></property><property name="phase1-auth-flags" name_upper="PHASE1_AUTH_FLAGS" type="uint32" default="0"><description-docbook><para> Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x settings. See the wpa_supplicant documentation for more details.</para></description-docbook><description>Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x settings. See the wpa_supplicant documentation for more details.</description></property><property name="phase1-fast-provisioning" name_upper="PHASE1_FAST_PROVISIONING" type="string"><description-docbook><para> Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.</para></description-docbook><description>Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.</description></property><property name="phase1-peaplabel" name_upper="PHASE1_PEAPLABEL" type="string"><description-docbook><para> Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</para></description-docbook><description>Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</description></property><property name="phase1-peapver" name_upper="PHASE1_PEAPVER" type="string"><description-docbook><para> Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.</para></description-docbook><description>Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.</description></property><property name="phase2-altsubject-matches" name_upper="PHASE2_ALTSUBJECT_MATCHES" type="array of string"><description-docbook><para> List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</para></description-docbook><description>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</description></property><property name="phase2-auth" name_upper="PHASE2_AUTH" type="string"><description-docbook><para> Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.</para></description-docbook><description>Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.</description></property><property name="phase2-autheap" name_upper="PHASE2_AUTHEAP" type="string"><description-docbook><para> Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</para></description-docbook><description>Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</description></property><property name="phase2-ca-cert" name_upper="PHASE2_CA_CERT" type="byte array"><description-docbook><para> Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</para><para> Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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.</para><para> Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</para></description-docbook><description>Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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. Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</description></property><property name="phase2-ca-cert-password" name_upper="PHASE2_CA_CERT_PASSWORD" type="string"><description-docbook><para> The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para></description-docbook><description>The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</description></property><property name="phase2-ca-cert-password-flags" name_upper="PHASE2_CA_CERT_PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "phase2-ca-cert-password" property.</para></description-docbook><description>Flags indicating how to handle the "phase2-ca-cert-password" property.</description></property><property name="phase2-ca-path" name_upper="PHASE2_CA_PATH" type="string"><description-docbook><para> UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property.</para><para> If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</para></description-docbook><description>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property. If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</description></property><property name="phase2-client-cert" name_upper="PHASE2_CLIENT_CERT" type="byte array"><description-docbook><para> Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</para><para> 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.</para></description-docbook><description>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.</description></property><property name="phase2-client-cert-password" name_upper="PHASE2_CLIENT_CERT_PASSWORD" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="phase2-client-cert-password-flags" name_upper="PHASE2_CLIENT_CERT_PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "phase2-client-cert-password" property.</para></description-docbook><description>Flags indicating how to handle the "phase2-client-cert-password" property.</description></property><property name="phase2-domain-match" name_upper="PHASE2_DOMAIN_MATCH" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="phase2-domain-suffix-match" name_upper="PHASE2_DOMAIN_SUFFIX_MATCH" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="phase2-private-key" name_upper="PHASE2_PRIVATE_KEY" type="byte array"><description-docbook><para> Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls".</para><para> 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.</para></description-docbook><description>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.</description></property><property name="phase2-private-key-password" name_upper="PHASE2_PRIVATE_KEY_PASSWORD" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="phase2-private-key-password-flags" name_upper="PHASE2_PRIVATE_KEY_PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "phase2-private-key-password" property.</para></description-docbook><description>Flags indicating how to handle the "phase2-private-key-password" property.</description></property><property name="phase2-subject-match" name_upper="PHASE2_SUBJECT_MATCH" type="string"><description-docbook><para> Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match.</para></description-docbook><description>Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match.</description></property><property name="pin" name_upper="PIN" type="string"><description-docbook><para> PIN used for EAP authentication methods.</para></description-docbook><description>PIN used for EAP authentication methods.</description></property><property name="pin-flags" name_upper="PIN_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "pin" property.</para></description-docbook><description>Flags indicating how to handle the "pin" property.</description></property><property name="private-key" name_upper="PRIVATE_KEY" type="byte array"><description-docbook><para> Contains the private key when the "eap" property is set to "tls".</para><para> 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 "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 "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</para><para> WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.</para></description-docbook><description>Contains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.</description></property><property name="private-key-password" name_upper="PRIVATE_KEY_PASSWORD" type="string"><description-docbook><para> The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</para></description-docbook><description>The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</description></property><property name="private-key-password-flags" name_upper="PRIVATE_KEY_PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "private-key-password" property.</para></description-docbook><description>Flags indicating how to handle the "private-key-password" property.</description></property><property name="subject-match" name_upper="SUBJECT_MATCH" type="string"><description-docbook><para> Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match.</para></description-docbook><description>Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match.</description></property><property name="system-ca-certs" name_upper="SYSTEM_CA_CERTS" type="boolean" default="FALSE"><description-docbook><para> When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).</para></description-docbook><description>When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).</description></property></setting><setting name="adsl" description=" ADSL Settings" name_upper="ADSL"><property name="encapsulation" name_upper="ENCAPSULATION" type="string" alias="encapsulation"><description-docbook><para> Encapsulation of ADSL connection. Can be "vcmux" or "llc".</para></description-docbook><description>Encapsulation of ADSL connection. Can be "vcmux" or "llc".</description></property><property name="password" name_upper="PASSWORD" type="string" alias="password"><description-docbook><para> Password used to authenticate with the ADSL service.</para></description-docbook><description>Password used to authenticate with the ADSL service.</description></property><property name="password-flags" name_upper="PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "password" property.</para></description-docbook><description>Flags indicating how to handle the "password" property.</description></property><property name="protocol" name_upper="PROTOCOL" type="string" alias="protocol"><description-docbook><para> ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</para></description-docbook><description>ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</description></property><property name="username" name_upper="USERNAME" type="string" alias="username"><description-docbook><para> Username used to authenticate with the ADSL service.</para></description-docbook><description>Username used to authenticate with the ADSL service.</description></property><property name="vci" name_upper="VCI" type="uint32" default="0"><description-docbook><para> VCI of ADSL connection</para></description-docbook><description>VCI of ADSL connection</description></property><property name="vpi" name_upper="VPI" type="uint32" default="0"><description-docbook><para> VPI of ADSL connection</para></description-docbook><description>VPI of ADSL connection</description></property></setting><setting name="bluetooth" description=" Bluetooth Settings" name_upper="BLUETOOTH"><property name="bdaddr" name_upper="BDADDR" type="byte array" alias="addr"><description-docbook><para> The Bluetooth address of the device.</para></description-docbook><description>The Bluetooth address of the device.</description></property><property name="type" name_upper="TYPE" type="string" alias="bt-type"><description-docbook><para> Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.</para></description-docbook><description>Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.</description></property></setting><setting name="bond" description=" Bonding Settings" name_upper="BOND"><property name="options" name_upper="OPTIONS" type="dict of string to string" default="{'mode': 'balance-rr'}"><description-docbook><para> Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</para></description-docbook><description>Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</description></property></setting><setting name="bridge" description=" Bridging Settings" name_upper="BRIDGE"><property name="ageing-time" name_upper="AGEING_TIME" type="uint32" default="300" alias="ageing-time"><description-docbook><para> The Ethernet MAC address aging time, in seconds.</para></description-docbook><description>The Ethernet MAC address aging time, in seconds.</description></property><property name="forward-delay" name_upper="FORWARD_DELAY" type="uint32" default="15" alias="forward-delay"><description-docbook><para> The Spanning Tree Protocol (STP) forwarding delay, in seconds.</para></description-docbook><description>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</description></property><property name="group-address" name_upper="GROUP_ADDRESS" type="byte array"><description-docbook><para> If specified, The MAC address of the multicast group this bridge uses for STP.</para><para> 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.</para></description-docbook><description>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.</description></property><property name="group-forward-mask" name_upper="GROUP_FORWARD_MASK" type="uint32" default="0" alias="group-forward-mask"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="hello-time" name_upper="HELLO_TIME" type="uint32" default="2" alias="hello-time"><description-docbook><para> The Spanning Tree Protocol (STP) hello time, in seconds.</para></description-docbook><description>The Spanning Tree Protocol (STP) hello time, in seconds.</description></property><property name="mac-address" name_upper="MAC_ADDRESS" type="byte array" alias="mac"><description-docbook><para> If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set.</para><para> 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</para></description-docbook><description>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</description></property><property name="max-age" name_upper="MAX_AGE" type="uint32" default="20" alias="max-age"><description-docbook><para> The Spanning Tree Protocol (STP) maximum message age, in seconds.</para></description-docbook><description>The Spanning Tree Protocol (STP) maximum message age, in seconds.</description></property><property name="multicast-hash-max" name_upper="MULTICAST_HASH_MAX" type="uint32" default="4096"><description-docbook><para> Set maximum size of multicast hash table (value must be a power of 2).</para></description-docbook><description>Set maximum size of multicast hash table (value must be a power of 2).</description></property><property name="multicast-last-member-count" name_upper="MULTICAST_LAST_MEMBER_COUNT" type="uint32" default="2"><description-docbook><para> Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.</para></description-docbook><description>Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.</description></property><property name="multicast-last-member-interval" name_upper="MULTICAST_LAST_MEMBER_INTERVAL" type="uint64" default="100"><description-docbook><para> Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.</para></description-docbook><description>Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.</description></property><property name="multicast-membership-interval" name_upper="MULTICAST_MEMBERSHIP_INTERVAL" type="uint64" default="26000"><description-docbook><para> Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.</para></description-docbook><description>Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.</description></property><property name="multicast-querier" name_upper="MULTICAST_QUERIER" type="boolean" default="FALSE"><description-docbook><para> Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</para></description-docbook><description>Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</description></property><property name="multicast-querier-interval" name_upper="MULTICAST_QUERIER_INTERVAL" type="uint64" default="25500"><description-docbook><para> If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.</para></description-docbook><description>If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.</description></property><property name="multicast-query-interval" name_upper="MULTICAST_QUERY_INTERVAL" type="uint64" default="12500"><description-docbook><para> Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</para></description-docbook><description>Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</description></property><property name="multicast-query-response-interval" name_upper="MULTICAST_QUERY_RESPONSE_INTERVAL" type="uint64" default="1000"><description-docbook><para> Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</para></description-docbook><description>Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</description></property><property name="multicast-query-use-ifaddr" name_upper="MULTICAST_QUERY_USE_IFADDR" type="boolean" default="FALSE"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="multicast-router" name_upper="MULTICAST_ROUTER" type="string"><description-docbook><para> Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work.</para><para> Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).</para></description-docbook><description>Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work. Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).</description></property><property name="multicast-snooping" name_upper="MULTICAST_SNOOPING" type="boolean" default="TRUE" alias="multicast-snooping"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="multicast-startup-query-count" name_upper="MULTICAST_STARTUP_QUERY_COUNT" type="uint32" default="2"><description-docbook><para> Set the number of IGMP queries to send during startup phase.</para></description-docbook><description>Set the number of IGMP queries to send during startup phase.</description></property><property name="multicast-startup-query-interval" name_upper="MULTICAST_STARTUP_QUERY_INTERVAL" type="uint64" default="3125"><description-docbook><para> Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</para></description-docbook><description>Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</description></property><property name="priority" name_upper="PRIORITY" type="uint32" default="32768" alias="priority"><description-docbook><para> Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</para></description-docbook><description>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</description></property><property name="stp" name_upper="STP" type="boolean" default="TRUE" alias="stp"><description-docbook><para> Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</para></description-docbook><description>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</description></property><property name="vlan-default-pvid" name_upper="VLAN_DEFAULT_PVID" type="uint32" default="1"><description-docbook><para> The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.</para></description-docbook><description>The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.</description></property><property name="vlan-filtering" name_upper="VLAN_FILTERING" type="boolean" default="FALSE"><description-docbook><para> Control whether VLAN filtering is enabled on the bridge.</para></description-docbook><description>Control whether VLAN filtering is enabled on the bridge.</description></property><property name="vlan-protocol" name_upper="VLAN_PROTOCOL" type="string"><description-docbook><para> If specified, the protocol used for VLAN filtering.</para><para> Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</para></description-docbook><description>If specified, the protocol used for VLAN filtering. Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</description></property><property name="vlan-stats-enabled" name_upper="VLAN_STATS_ENABLED" type="boolean" default="FALSE"><description-docbook><para> Controls whether per-VLAN stats accounting is enabled.</para></description-docbook><description>Controls whether per-VLAN stats accounting is enabled.</description></property><property name="vlans" name_upper="VLANS" type="array of vardict"><description-docbook><para> 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.</para><para> In nmcli the VLAN list can be specified with the following syntax:</para><para> $vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</para><para> where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</para></description-docbook><description>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.</description></property></setting><setting name="bridge-port" description=" Bridge Port Settings" name_upper="BRIDGE_PORT"><property name="hairpin-mode" name_upper="HAIRPIN_MODE" type="boolean" default="FALSE" alias="hairpin"><description-docbook><para> Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.</para></description-docbook><description>Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.</description></property><property name="path-cost" name_upper="PATH_COST" type="uint32" default="100" alias="path-cost"><description-docbook><para> The Spanning Tree Protocol (STP) port cost for destinations via this port.</para></description-docbook><description>The Spanning Tree Protocol (STP) port cost for destinations via this port.</description></property><property name="priority" name_upper="PRIORITY" type="uint32" default="32" alias="priority"><description-docbook><para> The Spanning Tree Protocol (STP) priority of this bridge port.</para></description-docbook><description>The Spanning Tree Protocol (STP) priority of this bridge port.</description></property><property name="vlans" name_upper="VLANS" type="array of vardict"><description-docbook><para> Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property.</para><para> In nmcli the VLAN list can be specified with the following syntax:</para><para> $vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</para><para> where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</para></description-docbook><description>Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge 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.</description></property></setting><setting name="cdma" description=" CDMA-based Mobile Broadband Settings" name_upper="CDMA"><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para></description-docbook><description>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</description></property><property name="number" name_upper="NUMBER" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="password" name_upper="PASSWORD" type="string" alias="password"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="password-flags" name_upper="PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "password" property.</para></description-docbook><description>Flags indicating how to handle the "password" property.</description></property><property name="username" name_upper="USERNAME" type="string" alias="user"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property></setting><setting name="dcb" description=" Data Center Bridging Settings" name_upper="DCB"><property name="app-fcoe-flags" name_upper="APP_FCOE_FLAGS" type="NMSettingDcbFlags (uint32)"><description-docbook><para> 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).</para></description-docbook><description>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).</description></property><property name="app-fcoe-mode" name_upper="APP_FCOE_MODE" type="string"><description-docbook><para> The FCoE controller mode; either "fabric" or "vn2vn".</para><para> Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".</para></description-docbook><description>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".</description></property><property name="app-fcoe-priority" name_upper="APP_FCOE_PRIORITY" type="int32" default="-1"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="app-fip-flags" name_upper="APP_FIP_FLAGS" type="NMSettingDcbFlags (uint32)"><description-docbook><para> 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).</para></description-docbook><description>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).</description></property><property name="app-fip-priority" name_upper="APP_FIP_PRIORITY" type="int32" default="-1"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="app-iscsi-flags" name_upper="APP_ISCSI_FLAGS" type="NMSettingDcbFlags (uint32)"><description-docbook><para> 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).</para></description-docbook><description>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).</description></property><property name="app-iscsi-priority" name_upper="APP_ISCSI_PRIORITY" type="int32" default="-1"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="priority-bandwidth" name_upper="PRIORITY_BANDWIDTH" type="array of uint32"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="priority-flow-control" name_upper="PRIORITY_FLOW_CONTROL" type="array of uint32"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="priority-flow-control-flags" name_upper="PRIORITY_FLOW_CONTROL_FLAGS" type="NMSettingDcbFlags (uint32)"><description-docbook><para> 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).</para></description-docbook><description>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).</description></property><property name="priority-group-bandwidth" name_upper="PRIORITY_GROUP_BANDWIDTH" type="array of uint32"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="priority-group-flags" name_upper="PRIORITY_GROUP_FLAGS" type="NMSettingDcbFlags (uint32)"><description-docbook><para> 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).</para></description-docbook><description>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).</description></property><property name="priority-group-id" name_upper="PRIORITY_GROUP_ID" type="array of uint32"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="priority-strict-bandwidth" name_upper="PRIORITY_STRICT_BANDWIDTH" type="array of uint32"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="priority-traffic-class" name_upper="PRIORITY_TRAFFIC_CLASS" type="array of uint32"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property></setting><setting name="ethtool" description=" Ethtool Ethernet Settings" name_upper="ETHTOOL"><property name="coalesce-adaptive-rx" name_upper="COALESCE_ADAPTIVE_RX" /><property name="coalesce-adaptive-tx" name_upper="COALESCE_ADAPTIVE_TX" /><property name="coalesce-pkt-rate-high" name_upper="COALESCE_PKT_RATE_HIGH" /><property name="coalesce-pkt-rate-low" name_upper="COALESCE_PKT_RATE_LOW" /><property name="coalesce-rx-frames" name_upper="COALESCE_RX_FRAMES" /><property name="coalesce-rx-frames-high" name_upper="COALESCE_RX_FRAMES_HIGH" /><property name="coalesce-rx-frames-irq" name_upper="COALESCE_RX_FRAMES_IRQ" /><property name="coalesce-rx-frames-low" name_upper="COALESCE_RX_FRAMES_LOW" /><property name="coalesce-rx-usecs" name_upper="COALESCE_RX_USECS" /><property name="coalesce-rx-usecs-high" name_upper="COALESCE_RX_USECS_HIGH" /><property name="coalesce-rx-usecs-irq" name_upper="COALESCE_RX_USECS_IRQ" /><property name="coalesce-rx-usecs-low" name_upper="COALESCE_RX_USECS_LOW" /><property name="coalesce-sample-interval" name_upper="COALESCE_SAMPLE_INTERVAL" /><property name="coalesce-stats-block-usecs" name_upper="COALESCE_STATS_BLOCK_USECS" /><property name="coalesce-tx-frames" name_upper="COALESCE_TX_FRAMES" /><property name="coalesce-tx-frames-high" name_upper="COALESCE_TX_FRAMES_HIGH" /><property name="coalesce-tx-frames-irq" name_upper="COALESCE_TX_FRAMES_IRQ" /><property name="coalesce-tx-frames-low" name_upper="COALESCE_TX_FRAMES_LOW" /><property name="coalesce-tx-usecs" name_upper="COALESCE_TX_USECS" /><property name="coalesce-tx-usecs-high" name_upper="COALESCE_TX_USECS_HIGH" /><property name="coalesce-tx-usecs-irq" name_upper="COALESCE_TX_USECS_IRQ" /><property name="coalesce-tx-usecs-low" name_upper="COALESCE_TX_USECS_LOW" /><property name="feature-esp-hw-offload" name_upper="FEATURE_ESP_HW_OFFLOAD" /><property name="feature-esp-tx-csum-hw-offload" name_upper="FEATURE_ESP_TX_CSUM_HW_OFFLOAD" /><property name="feature-fcoe-mtu" name_upper="FEATURE_FCOE_MTU" /><property name="feature-gro" name_upper="FEATURE_GRO" /><property name="feature-gso" name_upper="FEATURE_GSO" /><property name="feature-highdma" name_upper="FEATURE_HIGHDMA" /><property name="feature-hw-tc-offload" name_upper="FEATURE_HW_TC_OFFLOAD" /><property name="feature-l2-fwd-offload" name_upper="FEATURE_L2_FWD_OFFLOAD" /><property name="feature-loopback" name_upper="FEATURE_LOOPBACK" /><property name="feature-lro" name_upper="FEATURE_LRO" /><property name="feature-macsec-hw-offload" name_upper="FEATURE_MACSEC_HW_OFFLOAD" /><property name="feature-ntuple" name_upper="FEATURE_NTUPLE" /><property name="feature-rx" name_upper="FEATURE_RX" /><property name="feature-rx-all" name_upper="FEATURE_RX_ALL" /><property name="feature-rx-fcs" name_upper="FEATURE_RX_FCS" /><property name="feature-rx-gro-hw" name_upper="FEATURE_RX_GRO_HW" /><property name="feature-rx-gro-list" name_upper="FEATURE_RX_GRO_LIST" /><property name="feature-rx-udp-gro-forwarding" name_upper="FEATURE_RX_UDP_GRO_FORWARDING" /><property name="feature-rx-udp_tunnel-port-offload" name_upper="FEATURE_RX_UDP_TUNNEL_PORT_OFFLOAD" /><property name="feature-rx-vlan-filter" name_upper="FEATURE_RX_VLAN_FILTER" /><property name="feature-rx-vlan-stag-filter" name_upper="FEATURE_RX_VLAN_STAG_FILTER" /><property name="feature-rx-vlan-stag-hw-parse" name_upper="FEATURE_RX_VLAN_STAG_HW_PARSE" /><property name="feature-rxhash" name_upper="FEATURE_RXHASH" /><property name="feature-rxvlan" name_upper="FEATURE_RXVLAN" /><property name="feature-sg" name_upper="FEATURE_SG" /><property name="feature-tls-hw-record" name_upper="FEATURE_TLS_HW_RECORD" /><property name="feature-tls-hw-rx-offload" name_upper="FEATURE_TLS_HW_RX_OFFLOAD" /><property name="feature-tls-hw-tx-offload" name_upper="FEATURE_TLS_HW_TX_OFFLOAD" /><property name="feature-tso" name_upper="FEATURE_TSO" /><property name="feature-tx" name_upper="FEATURE_TX" /><property name="feature-tx-checksum-fcoe-crc" name_upper="FEATURE_TX_CHECKSUM_FCOE_CRC" /><property name="feature-tx-checksum-ip-generic" name_upper="FEATURE_TX_CHECKSUM_IP_GENERIC" /><property name="feature-tx-checksum-ipv4" name_upper="FEATURE_TX_CHECKSUM_IPV4" /><property name="feature-tx-checksum-ipv6" name_upper="FEATURE_TX_CHECKSUM_IPV6" /><property name="feature-tx-checksum-sctp" name_upper="FEATURE_TX_CHECKSUM_SCTP" /><property name="feature-tx-esp-segmentation" name_upper="FEATURE_TX_ESP_SEGMENTATION" /><property name="feature-tx-fcoe-segmentation" name_upper="FEATURE_TX_FCOE_SEGMENTATION" /><property name="feature-tx-gre-csum-segmentation" name_upper="FEATURE_TX_GRE_CSUM_SEGMENTATION" /><property name="feature-tx-gre-segmentation" name_upper="FEATURE_TX_GRE_SEGMENTATION" /><property name="feature-tx-gso-list" name_upper="FEATURE_TX_GSO_LIST" /><property name="feature-tx-gso-partial" name_upper="FEATURE_TX_GSO_PARTIAL" /><property name="feature-tx-gso-robust" name_upper="FEATURE_TX_GSO_ROBUST" /><property name="feature-tx-ipxip4-segmentation" name_upper="FEATURE_TX_IPXIP4_SEGMENTATION" /><property name="feature-tx-ipxip6-segmentation" name_upper="FEATURE_TX_IPXIP6_SEGMENTATION" /><property name="feature-tx-nocache-copy" name_upper="FEATURE_TX_NOCACHE_COPY" /><property name="feature-tx-scatter-gather" name_upper="FEATURE_TX_SCATTER_GATHER" /><property name="feature-tx-scatter-gather-fraglist" name_upper="FEATURE_TX_SCATTER_GATHER_FRAGLIST" /><property name="feature-tx-sctp-segmentation" name_upper="FEATURE_TX_SCTP_SEGMENTATION" /><property name="feature-tx-tcp-ecn-segmentation" name_upper="FEATURE_TX_TCP_ECN_SEGMENTATION" /><property name="feature-tx-tcp-mangleid-segmentation" name_upper="FEATURE_TX_TCP_MANGLEID_SEGMENTATION" /><property name="feature-tx-tcp-segmentation" name_upper="FEATURE_TX_TCP_SEGMENTATION" /><property name="feature-tx-tcp6-segmentation" name_upper="FEATURE_TX_TCP6_SEGMENTATION" /><property name="feature-tx-tunnel-remcsum-segmentation" name_upper="FEATURE_TX_TUNNEL_REMCSUM_SEGMENTATION" /><property name="feature-tx-udp-segmentation" name_upper="FEATURE_TX_UDP_SEGMENTATION" /><property name="feature-tx-udp_tnl-csum-segmentation" name_upper="FEATURE_TX_UDP_TNL_CSUM_SEGMENTATION" /><property name="feature-tx-udp_tnl-segmentation" name_upper="FEATURE_TX_UDP_TNL_SEGMENTATION" /><property name="feature-tx-vlan-stag-hw-insert" name_upper="FEATURE_TX_VLAN_STAG_HW_INSERT" /><property name="feature-txvlan" name_upper="FEATURE_TXVLAN" /><property name="pause-autoneg" name_upper="PAUSE_AUTONEG"><description>Whether to automatically negotiate on pause frame of flow control mechanism defined by IEEE 802.3x standard.</description></property><property name="pause-rx" name_upper="PAUSE_RX"><description>Whether RX pause should be enabled. Only valid when automatic negotiation is disabled</description></property><property name="pause-tx" name_upper="PAUSE_TX"><description>Whether TX pause should be enabled. Only valid when automatic negotiation is disabled</description></property><property name="ring-rx" name_upper="RING_RX" /><property name="ring-rx-jumbo" name_upper="RING_RX_JUMBO" /><property name="ring-rx-mini" name_upper="RING_RX_MINI" /><property name="ring-tx" name_upper="RING_TX" /></setting><setting name="gsm" description=" GSM-based Mobile Broadband Settings" name_upper="GSM"><property name="apn" name_upper="APN" type="string" alias="apn"><description-docbook><para> The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</para></description-docbook><description>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</description></property><property name="auto-config" name_upper="AUTO_CONFIG" type="boolean" default="FALSE"><description-docbook><para> When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.</para></description-docbook><description>When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.</description></property><property name="device-id" name_upper="DEVICE_ID" type="string"><description-docbook><para> The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</para></description-docbook><description>The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</description></property><property name="home-only" name_upper="HOME_ONLY" type="boolean" default="FALSE"><description-docbook><para> When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</para></description-docbook><description>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para></description-docbook><description>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</description></property><property name="network-id" name_upper="NETWORK_ID" type="string"><description-docbook><para> The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</para></description-docbook><description>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</description></property><property name="number" name_upper="NUMBER" type="string"><description-docbook><para> Legacy setting that used to help establishing PPP data sessions for GSM-based modems. Deprecated: 1</para></description-docbook><description>Legacy setting that used to help establishing PPP data sessions for GSM-based modems. Deprecated: 1</description></property><property name="password" name_upper="PASSWORD" type="string" alias="password"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="password-flags" name_upper="PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "password" property.</para></description-docbook><description>Flags indicating how to handle the "password" property.</description></property><property name="pin" name_upper="PIN" type="string"><description-docbook><para> If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</para></description-docbook><description>If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</description></property><property name="pin-flags" name_upper="PIN_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "pin" property.</para></description-docbook><description>Flags indicating how to handle the "pin" property.</description></property><property name="sim-id" name_upper="SIM_ID" type="string"><description-docbook><para> The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.</para></description-docbook><description>The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.</description></property><property name="sim-operator-id" name_upper="SIM_OPERATOR_ID" type="string"><description-docbook><para> A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.</para></description-docbook><description>A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.</description></property><property name="username" name_upper="USERNAME" type="string" alias="user"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property></setting><setting name="infiniband" description=" Infiniband Settings" name_upper="INFINIBAND"><property name="mac-address" name_upper="MAC_ADDRESS" type="byte array" alias="mac"><description-docbook><para> If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</para></description-docbook><description>If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0" alias="mtu"><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para></description-docbook><description>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</description></property><property name="p-key" name_upper="P_KEY" type="int32" default="-1" alias="p-key"><description-docbook><para> The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.</para></description-docbook><description>The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.</description></property><property name="parent" name_upper="PARENT" type="string" alias="parent"><description-docbook><para> The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".</para></description-docbook><description>The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".</description></property><property name="transport-mode" name_upper="TRANSPORT_MODE" type="string" alias="transport-mode"><description-docbook><para> The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</para></description-docbook><description>The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</description></property></setting><setting name="ipv4" description=" IPv4 Settings" name_upper="IP4_CONFIG"><property name="addresses" name_upper="ADDRESSES" type="a comma separated list of addresses" alias="ip4"><description-docbook><para> Array of IP addresses.</para></description-docbook><description>A list of IPv4 addresses and their prefix length. Multiple addresses can be separated by comma. For example "192.168.1.5/24, 10.1.0.5/24". The addresses are listed in decreasing priority, meaning the first address will be the primary address.</description></property><property name="dad-timeout" name_upper="DAD_TIMEOUT" type="int32" default="-1"><description-docbook><para> Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds.</para><para> The property is currently implemented only for IPv4.</para></description-docbook><description>Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. The property is currently implemented only for IPv4.</description></property><property name="dhcp-client-id" name_upper="DHCP_CLIENT_ID" type="string"><description-docbook><para> A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0.</para><para> The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links.</para><para> The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset.</para><para> The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id.</para><para> The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key.</para><para> If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.</para></description-docbook><description>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links. The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset. The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id. The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key. If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.</description></property><property name="dhcp-fqdn" name_upper="DHCP_FQDN" type="string"><description-docbook><para> If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</para></description-docbook><description>If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</description></property><property name="dhcp-hostname" name_upper="DHCP_HOSTNAME" type="string"><description-docbook><para> If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</para></description-docbook><description>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</description></property><property name="dhcp-hostname-flags" name_upper="DHCP_HOSTNAME_FLAGS" type="uint32" default="0"><description-docbook><para> Flags for the DHCP hostname and FQDN.</para><para> Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.</para><para> When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</para></description-docbook><description>Flags for the DHCP hostname and FQDN. Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</description></property><property name="dhcp-iaid" name_upper="DHCP_IAID" type="string"><description-docbook><para> A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.</para></description-docbook><description>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.</description></property><property name="dhcp-reject-servers" name_upper="DHCP_REJECT_SERVERS" type="array of string"><description-docbook><para> Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers.</para><para> For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24").</para><para> This property is currently not implemented for DHCPv6.</para></description-docbook><description>Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). This property is currently not implemented for DHCPv6.</description></property><property name="dhcp-send-hostname" name_upper="DHCP_SEND_HOSTNAME" type="boolean" default="TRUE"><description-docbook><para> If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</para></description-docbook><description>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</description></property><property name="dhcp-timeout" name_upper="DHCP_TIMEOUT" type="int32" default="0"><description-docbook><para> 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).</para><para> Set to 2147483647 (MAXINT32) for infinity.</para></description-docbook><description>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.</description></property><property name="dhcp-vendor-class-identifier" name_upper="DHCP_VENDOR_CLASS_IDENTIFIER" type="string"><description-docbook><para> The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</para></description-docbook><description>The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</description></property><property name="dns" name_upper="DNS" type="array of uint32"><description-docbook><para> Array of IP addresses of DNS servers.</para></description-docbook><description>Array of IP addresses of DNS servers.</description></property><property name="dns-options" name_upper="DNS_OPTIONS" type="array of string"><description-docbook><para> Array of DNS options as described in man 5 resolv.conf.</para><para> 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.</para><para> The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc".</para><para> The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.</para><para> When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</para></description-docbook><description>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. The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</description></property><property name="dns-priority" name_upper="DNS_PRIORITY" type="int32" default="0"><description-docbook><para> DNS servers priority.</para><para> The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</para><para> Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.</para><para> 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.</para><para> 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.</para><para> 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.</para><para> 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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</para><para> When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</para></description-docbook><description>DNS servers priority. The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. 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 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. 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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</description></property><property name="dns-search" name_upper="DNS_SEARCH" type="array of string"><description-docbook><para> List 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.</para><para> When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</para><para> When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</para></description-docbook><description>List 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. When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</description></property><property name="gateway" name_upper="GATEWAY" type="string" alias="gw4"><description-docbook><para> The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</para><para> Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</para><para> Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</para></description-docbook><description>The gateway associated with this configuration. This is only meaningful if "addresses" is also set. Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</description></property><property name="ignore-auto-dns" name_upper="IGNORE_AUTO_DNS" type="boolean" default="FALSE"><description-docbook><para> When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</para></description-docbook><description>When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</description></property><property name="ignore-auto-routes" name_upper="IGNORE_AUTO_ROUTES" type="boolean" default="FALSE"><description-docbook><para> When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</para></description-docbook><description>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</description></property><property name="link-local" name_upper="LINK_LOCAL" type="int32" default="0"><description-docbook><para> Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server.</para><para> When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".</para></description-docbook><description>Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server. When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".</description></property><property name="may-fail" name_upper="MAY_FAIL" type="boolean" default="TRUE"><description-docbook><para> If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</para></description-docbook><description>If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</description></property><property name="method" name_upper="METHOD" type="string"><description-docbook><para> IP configuration method.</para><para> NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.</para><para> In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.</para><para> For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.</para><para> For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</para></description-docbook><description>IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</description></property><property name="never-default" name_upper="NEVER_DEFAULT" type="boolean" default="FALSE"><description-docbook><para> If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</para></description-docbook><description>If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</description></property><property name="required-timeout" name_upper="REQUIRED_TIMEOUT" type="int32" default="-1"><description-docbook><para> The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</para><para> This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.</para><para> Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</para><para> A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</para></description-docbook><description>The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</description></property><property name="route-metric" name_upper="ROUTE_METRIC" type="int64" default="-1"><description-docbook><para> The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</para></description-docbook><description>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</description></property><property name="route-table" name_upper="ROUTE_TABLE" type="uint32" default="0"><description-docbook><para> Enable policy routing (source routing) and set the routing table used when adding routes.</para><para> This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para> If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para> Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para></description-docbook><description>Enable policy routing (source routing) and set the routing table used when adding routes. This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</description></property><property name="routes" name_upper="ROUTES" type="a comma separated list of routes"><description-docbook> -<para> -A list of IPv4 destination addresses, prefix length, optional IPv4 -next hop addresses, optional route metric, optional attribute. The valid syntax is: -"ip[/prefix] [next-hop] [metric] [attribute=val]...[,ip[/prefix]...]". -For example "192.0.2.0/24 10.1.1.1 77, 198.51.100.0/24". -</para> -<para> -Various attributes are supported: -<itemizedlist> -<listitem> -<para><literal>"advmss"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"cwnd"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"initcwnd"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"initrwnd"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"lock-advmss"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-cwnd"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-initcwnd"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-initrwnd"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-mtu"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-window"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"mtu"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"onlink"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"quickack"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"rto_min"</literal> - an unsigned 32 bit integer. -The value is in milliseconds.</para> -</listitem> -<listitem> -<para><literal>"scope"</literal> - an unsigned 8 bit integer. IPv4 only.</para> -</listitem> -<listitem> -<para><literal>"src"</literal> - an IPv4 address.</para> -</listitem> -<listitem> -<para><literal>"table"</literal> - an unsigned 32 bit integer. The default depends on ipv4.route-table.</para> -</listitem> -<listitem> -<para><literal>"tos"</literal> - an unsigned 8 bit integer. IPv4 only.</para> -</listitem> -<listitem> -<para><literal>"type"</literal> - one of <literal>unicast</literal>, <literal>local</literal>, <literal>blackhole</literal>, -<literal>unavailable</literal>, <literal>prohibit</literal>, <literal>throw</literal>. -The default is <literal>unicast</literal>.</para> -</listitem> -<listitem> -<para><literal>"window"</literal> - an unsigned 32 bit integer.</para> -</listitem> -</itemizedlist> -</para> -<para> -For details see also `man ip-route`. -</para></description-docbook><description>A list of IPv4 destination addresses, prefix length, optional IPv4 next hop addresses, optional route metric, optional attribute. The valid syntax is: "ip[/prefix] [next-hop] [metric] [attribute=val]...[,ip[/prefix]...]". For example "192.0.2.0/24 10.1.1.1 77, 198.51.100.0/24".</description></property><property name="routing-rules" name_upper="ROUTING_RULES" type="a comma separated list of routing rules"><description-docbook> -<para> -A comma separated list of routing rules for policy routing. The format -is based on <command>ip rule add</command> syntax and mostly compatible. -One difference is that routing rules in NetworkManager always need a -fixed priority. -</para> -<para> -Example: <literal>priority 5 from 192.167.4.0/24 table 45</literal> -</para></description-docbook><description>A comma separated list of routing rules for policy routing.</description></property></setting><setting name="ipv6" description=" IPv6 Settings" name_upper="IP6_CONFIG"><property name="addr-gen-mode" name_upper="ADDR_GEN_MODE" type="int32" default="3"><description-docbook><para> Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3).</para><para> If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced.</para><para> The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced.</para><para> The special values "default" and "default-or-eui64" will fallback to the global connection default in as documented in NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively.</para><para> For libnm, the property defaults to "default" since 1.40. Previously it defaulted to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions.</para><para> Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</para></description-docbook><description>Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3). If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. The special values "default" and "default-or-eui64" will fallback to the global connection default in as documented in NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively. For libnm, the property defaults to "default" since 1.40. Previously it defaulted to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions. Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</description></property><property name="addresses" name_upper="ADDRESSES" type="a comma separated list of addresses" alias="ip6"><description-docbook><para> Array of IP addresses.</para></description-docbook><description>A list of IPv6 addresses and their prefix length. Multiple addresses can be separated by comma. For example "2001:db8:85a3::8a2e:370:7334/64, 2001:db8:85a3::5/64". The addresses are listed in decreasing priority, meaning the first address will be the primary address. This can make a difference with IPv6 source address selection (RFC 6724, section 5).</description></property><property name="dhcp-duid" name_upper="DHCP_DUID" type="string"><description-docbook><para> A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option.</para><para> The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id.</para><para> The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk.</para><para> The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt").</para><para> When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.</para></description-docbook><description>A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option. The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id. The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk. The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt"). When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.</description></property><property name="dhcp-hostname" name_upper="DHCP_HOSTNAME" type="string"><description-docbook><para> If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</para></description-docbook><description>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</description></property><property name="dhcp-hostname-flags" name_upper="DHCP_HOSTNAME_FLAGS" type="uint32" default="0"><description-docbook><para> Flags for the DHCP hostname and FQDN.</para><para> Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.</para><para> When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</para></description-docbook><description>Flags for the DHCP hostname and FQDN. Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</description></property><property name="dhcp-iaid" name_upper="DHCP_IAID" type="string"><description-docbook><para> A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.</para></description-docbook><description>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.</description></property><property name="dhcp-send-hostname" name_upper="DHCP_SEND_HOSTNAME" type="boolean" default="TRUE"><description-docbook><para> If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</para></description-docbook><description>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</description></property><property name="dhcp-timeout" name_upper="DHCP_TIMEOUT" type="int32" default="0"><description-docbook><para> 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).</para><para> Set to 2147483647 (MAXINT32) for infinity.</para></description-docbook><description>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.</description></property><property name="dns" name_upper="DNS" type="array of byte array"><description-docbook><para> Array of IP addresses of DNS servers.</para></description-docbook><description>Array of IP addresses of DNS servers.</description></property><property name="dns-options" name_upper="DNS_OPTIONS" type="array of string"><description-docbook><para> Array of DNS options as described in man 5 resolv.conf.</para><para> 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.</para><para> The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc".</para><para> The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.</para><para> When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</para></description-docbook><description>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. The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</description></property><property name="dns-priority" name_upper="DNS_PRIORITY" type="int32" default="0"><description-docbook><para> DNS servers priority.</para><para> The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</para><para> Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.</para><para> 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.</para><para> 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.</para><para> 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.</para><para> 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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</para><para> When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</para></description-docbook><description>DNS servers priority. The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. 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 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. 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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</description></property><property name="dns-search" name_upper="DNS_SEARCH" type="array of string"><description-docbook><para> List 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.</para><para> When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</para><para> When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</para></description-docbook><description>List 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. When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</description></property><property name="gateway" name_upper="GATEWAY" type="string" alias="gw6"><description-docbook><para> The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</para><para> Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</para><para> Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</para></description-docbook><description>The gateway associated with this configuration. This is only meaningful if "addresses" is also set. Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</description></property><property name="ignore-auto-dns" name_upper="IGNORE_AUTO_DNS" type="boolean" default="FALSE"><description-docbook><para> When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</para></description-docbook><description>When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</description></property><property name="ignore-auto-routes" name_upper="IGNORE_AUTO_ROUTES" type="boolean" default="FALSE"><description-docbook><para> When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</para></description-docbook><description>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</description></property><property name="ip6-privacy" name_upper="IP6_PRIVACY" type="NMSettingIP6ConfigPrivacy (int32)"><description-docbook><para> Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).</para><para> Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy".</para><para> If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr".</para><para> Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.</para></description-docbook><description>Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.</description></property><property name="may-fail" name_upper="MAY_FAIL" type="boolean" default="TRUE"><description-docbook><para> If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</para></description-docbook><description>If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</description></property><property name="method" name_upper="METHOD" type="string"><description-docbook><para> IP configuration method.</para><para> NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.</para><para> In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.</para><para> For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.</para><para> For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</para></description-docbook><description>IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.</para></description-docbook><description>Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.</description></property><property name="never-default" name_upper="NEVER_DEFAULT" type="boolean" default="FALSE"><description-docbook><para> If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</para></description-docbook><description>If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</description></property><property name="ra-timeout" name_upper="RA_TIMEOUT" type="int32" default="0"><description-docbook><para> A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device.</para><para> Set to 2147483647 (MAXINT32) for infinity.</para></description-docbook><description>A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device. Set to 2147483647 (MAXINT32) for infinity.</description></property><property name="required-timeout" name_upper="REQUIRED_TIMEOUT" type="int32" default="-1"><description-docbook><para> The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</para><para> This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.</para><para> Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</para><para> A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</para></description-docbook><description>The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</description></property><property name="route-metric" name_upper="ROUTE_METRIC" type="int64" default="-1"><description-docbook><para> The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</para></description-docbook><description>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</description></property><property name="route-table" name_upper="ROUTE_TABLE" type="uint32" default="0"><description-docbook><para> Enable policy routing (source routing) and set the routing table used when adding routes.</para><para> This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para> If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para> Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para></description-docbook><description>Enable policy routing (source routing) and set the routing table used when adding routes. This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</description></property><property name="routes" name_upper="ROUTES" type="a comma separated list of routes"><description-docbook> -<para> -A list of IPv6 destination addresses, prefix length, optional IPv6 -next hop addresses, optional route metric, optional attribute. The valid syntax is: -"ip[/prefix] [next-hop] [metric] [attribute=val]...[,ip[/prefix]...]". -</para> -<para> -Various attributes are supported: -<itemizedlist> -<listitem> -<para><literal>"advmss"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"cwnd"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"from"</literal> - an IPv6 address with optional prefix. IPv6 only.</para> -</listitem> -<listitem> -<para><literal>"initcwnd"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"initrwnd"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"lock-advmss"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-cwnd"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-initcwnd"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-initrwnd"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-mtu"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-window"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"mtu"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"onlink"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"quickack"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"rto_min"</literal> - an unsigned 32 bit integer. -The value is in milliseconds.</para> -</listitem> -<listitem> -<para><literal>"src"</literal> - an IPv6 address.</para> -</listitem> -<listitem> -<para><literal>"table"</literal> - an unsigned 32 bit integer. The default depends on ipv6.route-table.</para> -</listitem> -<listitem> -<para><literal>"type"</literal> - one of <literal>unicast</literal>, <literal>local</literal>, <literal>blackhole</literal>, -<literal>unavailable</literal>, <literal>prohibit</literal>, <literal>throw</literal>. -The default is <literal>unicast</literal>.</para> -</listitem> -<listitem> -<para><literal>"window"</literal> - an unsigned 32 bit integer.</para> -</listitem> -</itemizedlist> -</para> -<para> -For details see also `man ip-route`. -</para></description-docbook><description>Array of IP routes.</description></property><property name="routing-rules" name_upper="ROUTING_RULES" type="a comma separated list of routing rules"><description-docbook> -<para> -A comma separated list of routing rules for policy routing. The format -is based on <command>ip rule add</command> syntax and mostly compatible. -One difference is that routing rules in NetworkManager always need a -fixed priority. -</para> -<para> -Example: <literal>priority 5 from 1:2:3::5/128 table 45</literal> -</para></description-docbook><description>A comma separated list of routing rules for policy routing.</description></property><property name="token" name_upper="TOKEN" type="string"><description-docbook><para> Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</para></description-docbook><description>Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</description></property></setting><setting name="ip-tunnel" description=" IP Tunneling Settings" name_upper="IP_TUNNEL"><property name="encapsulation-limit" name_upper="ENCAPSULATION_LIMIT" type="uint32" default="0"><description-docbook><para> How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</para></description-docbook><description>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</description></property><property name="flags" name_upper="FLAGS" type="uint32" default="0"><description-docbook><para> Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</para></description-docbook><description>Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</description></property><property name="flow-label" name_upper="FLOW_LABEL" type="uint32" default="0"><description-docbook><para> The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</para></description-docbook><description>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</description></property><property name="input-key" name_upper="INPUT_KEY" type="string"><description-docbook><para> The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para></description-docbook><description>The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</description></property><property name="local" name_upper="LOCAL" type="string" alias="local"><description-docbook><para> The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</para></description-docbook><description>The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</description></property><property name="mode" name_upper="MODE" type="uint32" default="0" alias="mode"><description-docbook><para> The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</para></description-docbook><description>The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para></description-docbook><description>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</description></property><property name="output-key" name_upper="OUTPUT_KEY" type="string"><description-docbook><para> The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para></description-docbook><description>The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</description></property><property name="parent" name_upper="PARENT" type="string" alias="dev"><description-docbook><para> If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</para></description-docbook><description>If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</description></property><property name="path-mtu-discovery" name_upper="PATH_MTU_DISCOVERY" type="boolean" default="TRUE"><description-docbook><para> Whether to enable Path MTU Discovery on this tunnel.</para></description-docbook><description>Whether to enable Path MTU Discovery on this tunnel.</description></property><property name="remote" name_upper="REMOTE" type="string" alias="remote"><description-docbook><para> The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</para></description-docbook><description>The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</description></property><property name="tos" name_upper="TOS" type="uint32" default="0"><description-docbook><para> The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</para></description-docbook><description>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</description></property><property name="ttl" name_upper="TTL" type="uint32" default="0"><description-docbook><para> The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</para></description-docbook><description>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</description></property></setting><setting name="macsec" description=" MACSec Settings" name_upper="MACSEC"><property name="encrypt" name_upper="ENCRYPT" type="boolean" default="TRUE" alias="encrypt"><description-docbook><para> Whether the transmitted traffic must be encrypted.</para></description-docbook><description>Whether the transmitted traffic must be encrypted.</description></property><property name="mka-cak" name_upper="MKA_CAK" type="string" alias="cak"><description-docbook><para> The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</para></description-docbook><description>The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</description></property><property name="mka-cak-flags" name_upper="MKA_CAK_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "mka-cak" property.</para></description-docbook><description>Flags indicating how to handle the "mka-cak" property.</description></property><property name="mka-ckn" name_upper="MKA_CKN" type="string" alias="ckn"><description-docbook><para> The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</para></description-docbook><description>The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</description></property><property name="mode" name_upper="MODE" type="int32" default="0" alias="mode"><description-docbook><para> Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</para></description-docbook><description>Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</description></property><property name="parent" name_upper="PARENT" type="string" alias="dev"><description-docbook><para> If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para></description-docbook><description>If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</description></property><property name="port" name_upper="PORT" type="int32" default="1" alias="port"><description-docbook><para> The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</para></description-docbook><description>The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</description></property><property name="send-sci" name_upper="SEND_SCI" type="boolean" default="TRUE"><description-docbook><para> Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</para></description-docbook><description>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</description></property><property name="validation" name_upper="VALIDATION" type="int32" default="2"><description-docbook><para> Specifies the validation mode for incoming frames.</para></description-docbook><description>Specifies the validation mode for incoming frames.</description></property></setting><setting name="macvlan" description=" MAC VLAN Settings" name_upper="MACVLAN"><property name="mode" name_upper="MODE" type="uint32" default="0" alias="mode"><description-docbook><para> The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</para></description-docbook><description>The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</description></property><property name="parent" name_upper="PARENT" type="string" alias="dev"><description-docbook><para> If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para></description-docbook><description>If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</description></property><property name="promiscuous" name_upper="PROMISCUOUS" type="boolean" default="TRUE"><description-docbook><para> Whether the interface should be put in promiscuous mode.</para></description-docbook><description>Whether the interface should be put in promiscuous mode.</description></property><property name="tap" name_upper="TAP" type="boolean" default="FALSE" alias="tap"><description-docbook><para> Whether the interface should be a MACVTAP.</para></description-docbook><description>Whether the interface should be a MACVTAP.</description></property></setting><setting name="match" description=" Match settings" name_upper="MATCH"><property name="driver" name_upper="DRIVER" type="array of string"><description-docbook><para> A list of driver names to match. Each element is a shell wildcard pattern.</para><para> See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</para></description-docbook><description>A list of driver names to match. Each element is a shell wildcard pattern. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\' are used for optional and mandatory matches and inverting the pattern.</description></property><property name="interface-name" name_upper="INTERFACE_NAME" type="array of string"><description-docbook><para> A list of interface names to match. Each element is a shell wildcard pattern.</para><para> An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".</para></description-docbook><description>A list of interface names to match. Each element is a shell wildcard pattern. An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\!a" is an mandatory match for literally "!a".</description></property><property name="kernel-command-line" name_upper="KERNEL_COMMAND_LINE" type="array of string"><description-docbook><para> A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported.</para><para> See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.</para></description-docbook><description>A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\' are used for optional and mandatory matches and inverting the match.</description></property><property name="path" name_upper="PATH" type="array of string"><description-docbook><para> A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier.</para><para> For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0".</para><para> The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev").</para><para> Each element of the list is a shell wildcard pattern.</para><para> See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</para></description-docbook><description>A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier. For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0". The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev"). Each element of the list is a shell wildcard pattern. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\' are used for optional and mandatory matches and inverting the pattern.</description></property></setting><setting name="802-11-olpc-mesh" description=" OLPC Wireless Mesh Settings" name_upper="OLPC_MESH" alias="olpc-mesh"><property name="channel" name_upper="CHANNEL" type="uint32" default="0" alias="channel"><description-docbook><para> Channel on which the mesh network to join is located.</para></description-docbook><description>Channel on which the mesh network to join is located.</description></property><property name="dhcp-anycast-address" name_upper="DHCP_ANYCAST_ADDRESS" type="byte array" alias="dhcp-anycast"><description-docbook><para> Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.</para><para> This is currently only implemented by dhclient DHCP plugin.</para></description-docbook><description>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. This is currently only implemented by dhclient DHCP plugin.</description></property><property name="ssid" name_upper="SSID" type="byte array" alias="ssid"><description-docbook><para> SSID of the mesh network to join.</para></description-docbook><description>SSID of the mesh network to join.</description></property></setting><setting name="ovs-bridge" description=" OvsBridge Link Settings" name_upper="OVS_BRIDGE"><property name="datapath-type" name_upper="DATAPATH_TYPE" type="string"><description-docbook><para> The data path type. One of "system", "netdev" or empty.</para></description-docbook><description>The data path type. One of "system", "netdev" or empty.</description></property><property name="fail-mode" name_upper="FAIL_MODE" type="string"><description-docbook><para> The bridge failure mode. One of "secure", "standalone" or empty.</para></description-docbook><description>The bridge failure mode. One of "secure", "standalone" or empty.</description></property><property name="mcast-snooping-enable" name_upper="MCAST_SNOOPING_ENABLE" type="boolean" default="FALSE"><description-docbook><para> Enable or disable multicast snooping.</para></description-docbook><description>Enable or disable multicast snooping.</description></property><property name="rstp-enable" name_upper="RSTP_ENABLE" type="boolean" default="FALSE"><description-docbook><para> Enable or disable RSTP.</para></description-docbook><description>Enable or disable RSTP.</description></property><property name="stp-enable" name_upper="STP_ENABLE" type="boolean" default="FALSE"><description-docbook><para> Enable or disable STP.</para></description-docbook><description>Enable or disable STP.</description></property></setting><setting name="ovs-dpdk" description=" OvsDpdk Link Settings" name_upper="OVS_DPDK"><property name="devargs" name_upper="DEVARGS" type="string"><description-docbook><para> Open vSwitch DPDK device arguments.</para></description-docbook><description>Open vSwitch DPDK device arguments.</description></property><property name="n-rxq" name_upper="N_RXQ" type="uint32" default="0"><description-docbook><para> Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.</para></description-docbook><description>Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.</description></property></setting><setting name="ovs-interface" description=" Open vSwitch Interface Settings" name_upper="OVS_INTERFACE"><property name="type" name_upper="TYPE" type="string"><description-docbook><para> The interface type. Either "internal", "system", "patch", "dpdk", or empty.</para></description-docbook><description>The interface type. Either "internal", "system", "patch", "dpdk", or empty.</description></property></setting><setting name="ovs-patch" description=" OvsPatch Link Settings" name_upper="OVS_PATCH"><property name="peer" name_upper="PEER" type="string"><description-docbook><para> Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.</para></description-docbook><description>Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.</description></property></setting><setting name="ovs-port" description=" OvsPort Link Settings" name_upper="OVS_PORT"><property name="bond-downdelay" name_upper="BOND_DOWNDELAY" type="uint32" default="0"><description-docbook><para> The time port must be inactive in order to be considered down.</para></description-docbook><description>The time port must be inactive in order to be considered down.</description></property><property name="bond-mode" name_upper="BOND_MODE" type="string"><description-docbook><para> Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</para></description-docbook><description>Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</description></property><property name="bond-updelay" name_upper="BOND_UPDELAY" type="uint32" default="0"><description-docbook><para> The time port must be active before it starts forwarding traffic.</para></description-docbook><description>The time port must be active before it starts forwarding traffic.</description></property><property name="lacp" name_upper="LACP" type="string"><description-docbook><para> LACP mode. One of "active", "off", or "passive".</para></description-docbook><description>LACP mode. One of "active", "off", or "passive".</description></property><property name="tag" name_upper="TAG" type="uint32" default="0"><description-docbook><para> The VLAN tag in the range 0-4095.</para></description-docbook><description>The VLAN tag in the range 0-4095.</description></property><property name="vlan-mode" name_upper="VLAN_MODE" type="string"><description-docbook><para> The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset.</para></description-docbook><description>The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset.</description></property></setting><setting name="ppp" description=" Point-to-Point Protocol Settings" name_upper="PPP"><property name="baud" name_upper="BAUD" type="uint32" default="0"><description-docbook><para> If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</para></description-docbook><description>If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</description></property><property name="crtscts" name_upper="CRTSCTS" type="boolean" default="FALSE"><description-docbook><para> If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</para></description-docbook><description>If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</description></property><property name="lcp-echo-failure" name_upper="LCP_ECHO_FAILURE" type="uint32" default="0"><description-docbook><para> If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.</para></description-docbook><description>If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.</description></property><property name="lcp-echo-interval" name_upper="LCP_ECHO_INTERVAL" type="uint32" default="0"><description-docbook><para> If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</para></description-docbook><description>If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</description></property><property name="mppe-stateful" name_upper="MPPE_STATEFUL" type="boolean" default="FALSE"><description-docbook><para> If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</para></description-docbook><description>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</description></property><property name="mru" name_upper="MRU" type="uint32" default="0"><description-docbook><para> If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</para></description-docbook><description>If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> If non-zero, instruct pppd to send packets no larger than the specified size.</para></description-docbook><description>If non-zero, instruct pppd to send packets no larger than the specified size.</description></property><property name="no-vj-comp" name_upper="NO_VJ_COMP" type="boolean" default="FALSE"><description-docbook><para> If TRUE, Van Jacobsen TCP header compression will not be requested.</para></description-docbook><description>If TRUE, Van Jacobsen TCP header compression will not be requested.</description></property><property name="noauth" name_upper="NOAUTH" type="boolean" default="TRUE"><description-docbook><para> If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</para></description-docbook><description>If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</description></property><property name="nobsdcomp" name_upper="NOBSDCOMP" type="boolean" default="FALSE"><description-docbook><para> If TRUE, BSD compression will not be requested.</para></description-docbook><description>If TRUE, BSD compression will not be requested.</description></property><property name="nodeflate" name_upper="NODEFLATE" type="boolean" default="FALSE"><description-docbook><para> If TRUE, "deflate" compression will not be requested.</para></description-docbook><description>If TRUE, "deflate" compression will not be requested.</description></property><property name="refuse-chap" name_upper="REFUSE_CHAP" type="boolean" default="FALSE"><description-docbook><para> If TRUE, the CHAP authentication method will not be used.</para></description-docbook><description>If TRUE, the CHAP authentication method will not be used.</description></property><property name="refuse-eap" name_upper="REFUSE_EAP" type="boolean" default="FALSE"><description-docbook><para> If TRUE, the EAP authentication method will not be used.</para></description-docbook><description>If TRUE, the EAP authentication method will not be used.</description></property><property name="refuse-mschap" name_upper="REFUSE_MSCHAP" type="boolean" default="FALSE"><description-docbook><para> If TRUE, the MSCHAP authentication method will not be used.</para></description-docbook><description>If TRUE, the MSCHAP authentication method will not be used.</description></property><property name="refuse-mschapv2" name_upper="REFUSE_MSCHAPV2" type="boolean" default="FALSE"><description-docbook><para> If TRUE, the MSCHAPv2 authentication method will not be used.</para></description-docbook><description>If TRUE, the MSCHAPv2 authentication method will not be used.</description></property><property name="refuse-pap" name_upper="REFUSE_PAP" type="boolean" default="FALSE"><description-docbook><para> If TRUE, the PAP authentication method will not be used.</para></description-docbook><description>If TRUE, the PAP authentication method will not be used.</description></property><property name="require-mppe" name_upper="REQUIRE_MPPE" type="boolean" default="FALSE"><description-docbook><para> If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</para></description-docbook><description>If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</description></property><property name="require-mppe-128" name_upper="REQUIRE_MPPE_128" type="boolean" default="FALSE"><description-docbook><para> If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</para></description-docbook><description>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</description></property></setting><setting name="pppoe" description=" PPP-over-Ethernet Settings" name_upper="PPPOE"><property name="parent" name_upper="PARENT" type="string" alias="parent"><description-docbook><para> If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.</para></description-docbook><description>If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.</description></property><property name="password" name_upper="PASSWORD" type="string" alias="password"><description-docbook><para> Password used to authenticate with the PPPoE service.</para></description-docbook><description>Password used to authenticate with the PPPoE service.</description></property><property name="password-flags" name_upper="PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "password" property.</para></description-docbook><description>Flags indicating how to handle the "password" property.</description></property><property name="service" name_upper="SERVICE" type="string" alias="service"><description-docbook><para> If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</para></description-docbook><description>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</description></property><property name="username" name_upper="USERNAME" type="string" alias="username"><description-docbook><para> Username used to authenticate with the PPPoE service.</para></description-docbook><description>Username used to authenticate with the PPPoE service.</description></property></setting><setting name="proxy" description=" WWW Proxy Settings" name_upper="PROXY"><property name="browser-only" name_upper="BROWSER_ONLY" type="boolean" default="FALSE" alias="browser-only"><description-docbook><para> Whether the proxy configuration is for browser only.</para></description-docbook><description>Whether the proxy configuration is for browser only.</description></property><property name="method" name_upper="METHOD" type="int32" default="0" alias="method"><description-docbook><para> Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</para></description-docbook><description>Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</description></property><property name="pac-script" name_upper="PAC_SCRIPT" type="string" alias="pac-script"><description-docbook><para> PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.</para></description-docbook><description>The PAC script. In the profile this must be an UTF-8 encoded javascript code that defines a FindProxyForURL() function. When setting the property in nmcli, a filename is accepted too. In that case, nmcli will read the content of the file and set the script. The prefixes "file://" and "js://" are supported to explicitly differentiate between the two.</description></property><property name="pac-url" name_upper="PAC_URL" type="string" alias="pac-url"><description-docbook><para> PAC URL for obtaining PAC file.</para></description-docbook><description>PAC URL for obtaining PAC file.</description></property></setting><setting name="serial" description=" Serial Link Settings" name_upper="SERIAL"><property name="baud" name_upper="BAUD" type="uint32" default="57600"><description-docbook><para> Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</para></description-docbook><description>Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</description></property><property name="bits" name_upper="BITS" type="uint32" default="8"><description-docbook><para> Byte-width of the serial communication. The 8 in "8n1" for example.</para></description-docbook><description>Byte-width of the serial communication. The 8 in "8n1" for example.</description></property><property name="parity" name_upper="PARITY" type="NMSettingSerialParity (byte)"><description-docbook><para> Parity setting of the serial port.</para></description-docbook><description>Parity setting of the serial port.</description></property><property name="send-delay" name_upper="SEND_DELAY" type="uint64" default="0"><description-docbook><para> Time to delay between each byte sent to the modem, in microseconds.</para></description-docbook><description>Time to delay between each byte sent to the modem, in microseconds.</description></property><property name="stopbits" name_upper="STOPBITS" type="uint32" default="1"><description-docbook><para> Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</para></description-docbook><description>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</description></property></setting><setting name="sriov" description=" SR-IOV settings" name_upper="SRIOV"><property name="autoprobe-drivers" name_upper="AUTOPROBE_DRIVERS" type="NMTernary (int32)"><description-docbook><para> Whether to autoprobe virtual functions by a compatible driver.</para><para> 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.</para><para> If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them.</para><para> 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).</para></description-docbook><description>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).</description></property><property name="total-vfs" name_upper="TOTAL_VFS" type="uint32" default="0"><description-docbook><para> The total number of virtual functions to create.</para><para> 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.</para></description-docbook><description>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.</description></property><property name="vfs" name_upper="VFS" type="array of vardict"><description-docbook><para> Array of virtual function descriptors.</para><para> Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF.</para><para> When represented as string a VF is in the form:</para><para> "INDEX [ATTR=VALUE[ ATTR=VALUE]...]".</para><para> for example:</para><para> "2 mac=00:11:22:33:44:55 spoof-check=true".</para><para> 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.</para><para> The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form</para><para> "ID[.PRIORITY[.PROTO]]".</para><para> PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.</para></description-docbook><description>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.</description></property></setting><setting name="tc" description=" Linux Traffic Control Settings" name_upper="TC_CONFIG"><property name="qdiscs" name_upper="QDISCS" type="GPtrArray(NMTCQdisc)"><description-docbook> -<para> -Array of TC queueing disciplines. qdisc is a basic block in the -Linux traffic control subsystem -</para> -<para> -Each qdisc can be specified by the following attributes: -</para> -<variablelist> -<varlistentry> -<term><varname>handle HANDLE</varname></term> -<listitem> -<para> -specifies the qdisc handle. A qdisc, which potentially can have children, gets -assigned a major number, called a 'handle', leaving the minor number namespace -available for classes. The handle is expressed as '10:'. It is customary to -explicitly assign a handle to qdiscs expected to have children. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>parent HANDLE</varname></term> -<listitem> -<para> -specifies the handle of the parent qdisc the current qdisc must be -attached to. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>root</varname></term> -<listitem> -<para> -specifies that the qdisc is attached to the root of device. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>KIND</varname></term> -<listitem> -<para> -this is the qdisc kind. NetworkManager currently supports the -following kinds: fq_codel, sfq, tbf. Each qdisc kind has a -different set of parameters, described below. There are also some -kinds like pfifo, pfifo_fast, prio supported by NetworkManager -but their parameters are not supported by NetworkManager. -</para> -</listitem> -</varlistentry> -</variablelist> -<para> -Parameters for 'fq_codel': -</para> -<variablelist> -<varlistentry> -<term><varname>limit U32</varname></term> -<listitem> -<para> -the hard limit on the real queue size. When this limit is -reached, incoming packets are dropped. Default is 10240 packets. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>memory_limit U32</varname></term> -<listitem> -<para> -sets a limit on the total number of bytes that can be queued in -this FQ-CoDel instance. The lower of the packet limit of the -limit parameter and the memory limit will be enforced. Default is -32 MB. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>flows U32</varname></term> -<listitem> -<para> -the number of flows into which the incoming packets are -classified. Due to the stochastic nature of hashing, multiple -flows may end up being hashed into the same slot. Newer flows -have priority over older ones. This parameter can be set only at -load time since memory has to be allocated for the hash table. -Default value is 1024. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>target U32</varname></term> -<listitem> -<para> -the acceptable minimum standing/persistent queue delay. This minimum -delay is identified by tracking the local minimum queue delay that packets -experience. The unit of measurement is microsecond(us). Default value is 5ms. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>interval U32</varname></term> -<listitem> -<para> -used to ensure that the measured minimum delay does not become too stale. -The minimum delay must be experienced in the last epoch of length .B -interval. It should be set on the order of the worst-case RTT -through the bottleneck to give endpoints sufficient time to -react. Default value is 100ms. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>quantum U32</varname></term> -<listitem> -<para> -the number of bytes used as 'deficit' in the fair queuing -algorithm. Default is set to 1514 bytes which corresponds to the -Ethernet MTU plus the hardware header length of 14 bytes. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>ecn BOOL</varname></term> -<listitem> -<para> -can be used to mark packets instead of dropping them. ecn is turned -on by default. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>ce_threshold U32</varname></term> -<listitem> -<para> -sets a threshold above which all packets are marked with ECN -Congestion Experienced. This is useful for DCTCP-style congestion -control algorithms that require marking at very shallow queueing -thresholds. -</para> -</listitem> -</varlistentry> -</variablelist> -<para> -Parameters for 'sfq': -</para> -<variablelist> -<varlistentry> -<term><varname>divisor U32</varname></term> -<listitem> -<para> -can be used to set a different hash table size, available -from kernel 2.6.39 onwards. The specified divisor must be -a power of two and cannot be larger than 65536. Default -value: 1024. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>limit U32</varname></term> -<listitem> -<para> -Upper limit of the SFQ. Can be used to reduce the default -length of 127 packets. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>depth U32</varname></term> -<listitem> -<para> -Limit of packets per flow. Default to -127 and can be lowered. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>perturb_period U32</varname></term> -<listitem> -<para> -Interval in seconds for queue algorithm perturbation. -Defaults to 0, which means that no perturbation occurs. Do -not set too low for each perturbation may cause some -packet reordering or losses. Advised value: 60 This value -has no effect when external flow classification is used. -Its better to increase divisor value to lower risk of hash -collisions. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>quantum U32</varname></term> -<listitem> -<para> -Amount of bytes a flow is allowed to dequeue during a -round of the round robin process. Defaults to the MTU of -the interface which is also the advised value and the -minimum value. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>flows U32</varname></term> -<listitem> -<para> -Default value is 127. -</para> -</listitem> -</varlistentry> -</variablelist> -<para> -Parameters for 'tbf': -</para> -<variablelist> -<varlistentry> -<term><varname>rate U64</varname></term> -<listitem> -<para> -Bandwidth or rate. These parameters accept a floating -point number, possibly followed by either a unit (both SI -and IEC units supported), or a float followed by a percent -character to specify the rate as a percentage of the -device's speed. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>burst U32</varname></term> -<listitem> -<para> -Also known as buffer or maxburst. Size of the bucket, in -bytes. This is the maximum amount of bytes that tokens can -be available for instantaneously. In general, larger -shaping rates require a larger buffer. For 10mbit/s on -Intel, you need at least 10kbyte buffer if you want to -reach your configured rate! -</para> -<para> -If your buffer is too small, packets may be dropped -because more tokens arrive per timer tick than fit in your -bucket. The minimum buffer size can be calculated by -dividing the rate by HZ. -</para> -<para> -Token usage calculations are performed using a table which -by default has a resolution of 8 packets. This resolution -can be changed by specifying the cell size with the burst. -For example, to specify a 6000 byte buffer with a 16 byte -cell size, set a burst of 6000/16. You will probably never -have to set this. Must be an integral power of 2. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>limit U32</varname></term> -<listitem> -<para> -Limit is the number of bytes that can be queued waiting -for tokens to become available. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>latency U32</varname></term> -<listitem> -<para> -specifies the maximum amount of time a packet can -sit in the TBF. The latency calculation takes into account -the size of the bucket, the rate and possibly the peakrate -(if set). The latency and limit are mutually exclusive. -</para> -</listitem> -</varlistentry> -</variablelist></description-docbook><description>Array of TC queueing disciplines. When the "tc" setting is present, qdiscs from this property are applied upon activation. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net.core.default_qdisc" sysctl. If the "tc" setting is not present, NetworkManager doesn't touch the qdiscs present on the interface.</description></property><property name="tfilters" name_upper="TFILTERS" type="GPtrArray(NMTCTfilter)"><description-docbook> -<para> -Array of TC traffic filters. Traffic control can manage the packet content during -classification by using filters. -</para> -<para> -Each tfilters can be specified by the following attributes: -</para> -<variablelist> -<varlistentry> -<term><varname>handle HANDLE</varname></term> -<listitem> -<para> -specifies the tfilters handle. A filter is used by a classful qdisc to determine in which class -a packet will be enqueued. It is important to notice that filters reside within qdiscs. Therefore, -see qdiscs handle for detailed information. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>parent HANDLE</varname></term> -<listitem> -<para> -specifies the handle of the parent qdisc the current qdisc must be -attached to. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>root</varname></term> -<listitem> -<para> -specifies that the qdisc is attached to the root of device. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>KIND</varname></term> -<listitem> -<para> -this is the tfilters kind. NetworkManager currently supports -following kinds: mirred, simple. Each filter kind has a -different set of actions, described below. There are also some -other kinds like matchall, basic, u32 supported by NetworkManager. -</para> -</listitem> -</varlistentry> -</variablelist> -<para> -Actions for 'mirred': -</para> -<variablelist> -<varlistentry> -<term><varname>egress bool</varname></term> -<listitem> -<para> -Define whether the packet should exit from the interface. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>ingress bool</varname></term> -<listitem> -<para> -Define whether the packet should come into the interface. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>mirror bool</varname></term> -<listitem> -<para> -Define whether the packet should be copied to the destination space. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>redirect bool</varname></term> -<listitem> -<para> -Define whether the packet should be moved to the destination space. -</para> -</listitem> -</varlistentry> -</variablelist> -<para> -Action for 'simple': -</para> -<variablelist> -<varlistentry> -<term><varname>sdata char[32]</varname></term> -<listitem> -<para> -The actual string to print. -</para> -</listitem> -</varlistentry> -</variablelist></description-docbook><description>Array of TC traffic filters. When the "tc" setting is present, filters from this property are applied upon activation. If the property is empty, NetworkManager removes all the filters. If the "tc" setting is not present, NetworkManager doesn't touch the filters present on the interface.</description></property></setting><setting name="team" description=" Teaming Settings" name_upper="TEAM"><property name="config" name_upper="CONFIG" type="string" alias="config"><description-docbook><para> The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</para></description-docbook><description>The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</description></property><property name="link-watchers" name_upper="LINK_WATCHERS" type="array of vardict"><description-docbook><para> Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</para></description-docbook><description>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</description></property><property name="mcast-rejoin-count" name_upper="MCAST_REJOIN_COUNT" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd mcast_rejoin.count.</para></description-docbook><description>Corresponds to the teamd mcast_rejoin.count.</description></property><property name="mcast-rejoin-interval" name_upper="MCAST_REJOIN_INTERVAL" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd mcast_rejoin.interval.</para></description-docbook><description>Corresponds to the teamd mcast_rejoin.interval.</description></property><property name="notify-peers-count" name_upper="NOTIFY_PEERS_COUNT" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd notify_peers.count.</para></description-docbook><description>Corresponds to the teamd notify_peers.count.</description></property><property name="notify-peers-interval" name_upper="NOTIFY_PEERS_INTERVAL" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd notify_peers.interval.</para></description-docbook><description>Corresponds to the teamd notify_peers.interval.</description></property><property name="runner" name_upper="RUNNER" type="string"><description-docbook><para> Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</para></description-docbook><description>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</description></property><property name="runner-active" name_upper="RUNNER_ACTIVE" type="boolean" default="TRUE"><description-docbook><para> Corresponds to the teamd runner.active.</para></description-docbook><description>Corresponds to the teamd runner.active.</description></property><property name="runner-agg-select-policy" name_upper="RUNNER_AGG_SELECT_POLICY" type="string"><description-docbook><para> Corresponds to the teamd runner.agg_select_policy.</para></description-docbook><description>Corresponds to the teamd runner.agg_select_policy.</description></property><property name="runner-fast-rate" name_upper="RUNNER_FAST_RATE" type="boolean" default="FALSE"><description-docbook><para> Corresponds to the teamd runner.fast_rate.</para></description-docbook><description>Corresponds to the teamd runner.fast_rate.</description></property><property name="runner-hwaddr-policy" name_upper="RUNNER_HWADDR_POLICY" type="string"><description-docbook><para> Corresponds to the teamd runner.hwaddr_policy.</para></description-docbook><description>Corresponds to the teamd runner.hwaddr_policy.</description></property><property name="runner-min-ports" name_upper="RUNNER_MIN_PORTS" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd runner.min_ports.</para></description-docbook><description>Corresponds to the teamd runner.min_ports.</description></property><property name="runner-sys-prio" name_upper="RUNNER_SYS_PRIO" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd runner.sys_prio.</para></description-docbook><description>Corresponds to the teamd runner.sys_prio.</description></property><property name="runner-tx-balancer" name_upper="RUNNER_TX_BALANCER" type="string"><description-docbook><para> Corresponds to the teamd runner.tx_balancer.name.</para></description-docbook><description>Corresponds to the teamd runner.tx_balancer.name.</description></property><property name="runner-tx-balancer-interval" name_upper="RUNNER_TX_BALANCER_INTERVAL" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd runner.tx_balancer.interval.</para></description-docbook><description>Corresponds to the teamd runner.tx_balancer.interval.</description></property><property name="runner-tx-hash" name_upper="RUNNER_TX_HASH" type="array of string"><description-docbook><para> Corresponds to the teamd runner.tx_hash.</para></description-docbook><description>Corresponds to the teamd runner.tx_hash.</description></property></setting><setting name="team-port" description=" Team Port Settings" name_upper="TEAM_PORT"><property name="config" name_upper="CONFIG" type="string" alias="config"><description-docbook><para> The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</para></description-docbook><description>The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</description></property><property name="lacp-key" name_upper="LACP_KEY" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd ports.PORTIFNAME.lacp_key.</para></description-docbook><description>Corresponds to the teamd ports.PORTIFNAME.lacp_key.</description></property><property name="lacp-prio" name_upper="LACP_PRIO" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</para></description-docbook><description>Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</description></property><property name="link-watchers" name_upper="LINK_WATCHERS" type="array of vardict"><description-docbook><para> Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</para></description-docbook><description>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</description></property><property name="prio" name_upper="PRIO" type="int32" default="0"><description-docbook><para> Corresponds to the teamd ports.PORTIFNAME.prio.</para></description-docbook><description>Corresponds to the teamd ports.PORTIFNAME.prio.</description></property><property name="queue-id" name_upper="QUEUE_ID" type="int32" default="-1"><description-docbook><para> Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</para></description-docbook><description>Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</description></property><property name="sticky" name_upper="STICKY" type="boolean" default="FALSE"><description-docbook><para> Corresponds to the teamd ports.PORTIFNAME.sticky.</para></description-docbook><description>Corresponds to the teamd ports.PORTIFNAME.sticky.</description></property></setting><setting name="tun" description=" Tunnel Settings" name_upper="TUN"><property name="group" name_upper="GROUP" type="string" alias="group"><description-docbook><para> The group ID which will own the device. If set to NULL everyone will be able to use the device.</para></description-docbook><description>The group ID which will own the device. If set to NULL everyone will be able to use the device.</description></property><property name="mode" name_upper="MODE" type="uint32" default="1" alias="mode"><description-docbook><para> The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.</para></description-docbook><description>The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.</description></property><property name="multi-queue" name_upper="MULTI_QUEUE" type="boolean" default="FALSE" alias="multi-queue"><description-docbook><para> If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</para></description-docbook><description>If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</description></property><property name="owner" name_upper="OWNER" type="string" alias="owner"><description-docbook><para> The user ID which will own the device. If set to NULL everyone will be able to use the device.</para></description-docbook><description>The user ID which will own the device. If set to NULL everyone will be able to use the device.</description></property><property name="pi" name_upper="PI" type="boolean" default="FALSE" alias="pi"><description-docbook><para> If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</para></description-docbook><description>If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</description></property><property name="vnet-hdr" name_upper="VNET_HDR" type="boolean" default="FALSE" alias="vnet-hdr"><description-docbook><para> If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</para></description-docbook><description>If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</description></property></setting><setting name="vlan" description=" VLAN Settings" name_upper="VLAN"><property name="egress-priority-map" name_upper="EGRESS_PRIORITY_MAP" type="array of string" alias="egress"><description-docbook><para> For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</para></description-docbook><description>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</description></property><property name="flags" name_upper="FLAGS" type="NMVlanFlags (uint32)" alias="flags"><description-docbook><para> One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol).</para><para> The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.</para></description-docbook><description>One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.</description></property><property name="id" name_upper="ID" type="uint32" default="0" alias="id"><description-docbook><para> The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.</para></description-docbook><description>The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.</description></property><property name="ingress-priority-map" name_upper="INGRESS_PRIORITY_MAP" type="array of string" alias="ingress"><description-docbook><para> For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</para></description-docbook><description>For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</description></property><property name="parent" name_upper="PARENT" type="string" alias="dev"><description-docbook><para> If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para></description-docbook><description>If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</description></property></setting><setting name="vpn" description=" VPN Settings" name_upper="VPN"><property name="data" name_upper="DATA" type="dict of string to string" default="{}"><description-docbook><para> Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</para></description-docbook><description>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</description></property><property name="persistent" name_upper="PERSISTENT" type="boolean" default="FALSE"><description-docbook><para> If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.</para></description-docbook><description>If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.</description></property><property name="secrets" name_upper="SECRETS" type="dict of string to string" default="{}"><description-docbook><para> Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</para></description-docbook><description>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</description></property><property name="service-type" name_upper="SERVICE_TYPE" type="string" alias="vpn-type"><description-docbook><para> D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</para></description-docbook><description>D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</description></property><property name="timeout" name_upper="TIMEOUT" type="uint32" default="0"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="user-name" name_upper="USER_NAME" type="string" alias="user"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property></setting><setting name="vrf" description=" VRF settings" name_upper="VRF"><property name="table" name_upper="TABLE" type="uint32" default="0" alias="table"><description-docbook><para> The routing table for this VRF.</para></description-docbook><description>The routing table for this VRF.</description></property></setting><setting name="vxlan" description=" VXLAN Settings" name_upper="VXLAN"><property name="ageing" name_upper="AGEING" type="uint32" default="300"><description-docbook><para> Specifies the lifetime in seconds of FDB entries learnt by the kernel.</para></description-docbook><description>Specifies the lifetime in seconds of FDB entries learnt by the kernel.</description></property><property name="destination-port" name_upper="DESTINATION_PORT" type="uint32" default="8472" alias="destination-port"><description-docbook><para> Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</para></description-docbook><description>Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</description></property><property name="id" name_upper="ID" type="uint32" default="0" alias="id"><description-docbook><para> Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.</para></description-docbook><description>Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.</description></property><property name="l2-miss" name_upper="L2_MISS" type="boolean" default="FALSE"><description-docbook><para> Specifies whether netlink LL ADDR miss notifications are generated.</para></description-docbook><description>Specifies whether netlink LL ADDR miss notifications are generated.</description></property><property name="l3-miss" name_upper="L3_MISS" type="boolean" default="FALSE"><description-docbook><para> Specifies whether netlink IP ADDR miss notifications are generated.</para></description-docbook><description>Specifies whether netlink IP ADDR miss notifications are generated.</description></property><property name="learning" name_upper="LEARNING" type="boolean" default="TRUE"><description-docbook><para> Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</para></description-docbook><description>Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</description></property><property name="limit" name_upper="LIMIT" type="uint32" default="0"><description-docbook><para> Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</para></description-docbook><description>Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</description></property><property name="local" name_upper="LOCAL" type="string" alias="local"><description-docbook><para> If given, specifies the source IP address to use in outgoing packets.</para></description-docbook><description>If given, specifies the source IP address to use in outgoing packets.</description></property><property name="parent" name_upper="PARENT" type="string" alias="dev"><description-docbook><para> If given, specifies the parent interface name or parent connection UUID.</para></description-docbook><description>If given, specifies the parent interface name or parent connection UUID.</description></property><property name="proxy" name_upper="PROXY" type="boolean" default="FALSE"><description-docbook><para> Specifies whether ARP proxy is turned on.</para></description-docbook><description>Specifies whether ARP proxy is turned on.</description></property><property name="remote" name_upper="REMOTE" type="string" alias="remote"><description-docbook><para> Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.</para></description-docbook><description>Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.</description></property><property name="rsc" name_upper="RSC" type="boolean" default="FALSE"><description-docbook><para> Specifies whether route short circuit is turned on.</para></description-docbook><description>Specifies whether route short circuit is turned on.</description></property><property name="source-port-max" name_upper="SOURCE_PORT_MAX" type="uint32" default="0" alias="source-port-max"><description-docbook><para> Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</para></description-docbook><description>Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</description></property><property name="source-port-min" name_upper="SOURCE_PORT_MIN" type="uint32" default="0" alias="source-port-min"><description-docbook><para> Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</para></description-docbook><description>Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</description></property><property name="tos" name_upper="TOS" type="uint32" default="0"><description-docbook><para> Specifies the TOS value to use in outgoing packets.</para></description-docbook><description>Specifies the TOS value to use in outgoing packets.</description></property><property name="ttl" name_upper="TTL" type="uint32" default="0"><description-docbook><para> Specifies the time-to-live value to use in outgoing packets.</para></description-docbook><description>Specifies the time-to-live value to use in outgoing packets.</description></property></setting><setting name="wifi-p2p" description=" Wi-Fi P2P Settings" name_upper="WIFI_P2P"><property name="peer" name_upper="PEER" type="string" alias="peer"><description-docbook><para> The P2P device that should be connected to. Currently, this is the only way to create or join a group.</para></description-docbook><description>The P2P device that should be connected to. Currently, this is the only way to create or join a group.</description></property><property name="wfd-ies" name_upper="WFD_IES" type="byte array"><description-docbook><para> The Wi-Fi Display (WFD) Information Elements (IEs) to set.</para><para> Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.</para></description-docbook><description>The Wi-Fi Display (WFD) Information Elements (IEs) to set. Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.</description></property><property name="wps-method" name_upper="WPS_METHOD" type="uint32" default="0"><description-docbook><para> Flags indicating which mode of WPS is to be used.</para><para> There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.</para></description-docbook><description>Flags indicating which mode of WPS is to be used. There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.</description></property></setting><setting name="wimax" description=" WiMax Settings" name_upper="WIMAX"><property name="mac-address" name_upper="MAC_ADDRESS" type="byte array" alias="mac"><description-docbook><para> 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</para></description-docbook><description>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</description></property><property name="network-name" name_upper="NETWORK_NAME" type="string" alias="nsp"><description-docbook><para> Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1</para></description-docbook><description>Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1</description></property></setting><setting name="802-3-ethernet" description=" Wired Ethernet Settings" name_upper="WIRED" alias="ethernet"><property name="accept-all-mac-addresses" name_upper="ACCEPT_ALL_MAC_ADDRESSES" type="NMTernary (int32)"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="auto-negotiate" name_upper="AUTO_NEGOTIATE" type="boolean" default="FALSE"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="cloned-mac-address" name_upper="CLONED_MAC_ADDRESS" type="byte array" alias="cloned-mac"><description-docbook><para> If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.</para><para> Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address if the device has one (otherwise this is treated as "preserve"). "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.</para><para> If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).</para><para> On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</para></description-docbook><description>If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing. Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address if the device has one (otherwise this is treated as "preserve"). "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key. If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value). On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</description></property><property name="duplex" name_upper="DUPLEX" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="generate-mac-address-mask" name_upper="GENERATE_MAC_ADDRESS_MASK" type="string"><description-docbook><para> 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.</para><para> 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.</para><para> 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.</para><para> 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.</para><para> 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.</para></description-docbook><description>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.</description></property><property name="mac-address" name_upper="MAC_ADDRESS" type="byte array" alias="mac"><description-docbook><para> 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).</para></description-docbook><description>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).</description></property><property name="mac-address-blacklist" name_upper="MAC_ADDRESS_BLACKLIST" type="array of string"><description-docbook><para> 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).</para></description-docbook><description>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).</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0" alias="mtu"><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</para></description-docbook><description>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</description></property><property name="port" name_upper="PORT" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="s390-nettype" name_upper="S390_NETTYPE" type="string"><description-docbook><para> s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</para></description-docbook><description>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</description></property><property name="s390-options" name_upper="S390_OPTIONS" type="dict of string to string" default="{}"><description-docbook><para> 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]).</para><para> Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.</para></description-docbook><description>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.</description></property><property name="s390-subchannels" name_upper="S390_SUBCHANNELS" type="array of string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="speed" name_upper="SPEED" type="uint32" default="0"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="wake-on-lan" name_upper="WAKE_ON_LAN" type="uint32" default="1"><description-docbook><para> 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).</para></description-docbook><description>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).</description></property><property name="wake-on-lan-password" name_upper="WAKE_ON_LAN_PASSWORD" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property></setting><setting name="wireguard" description=" WireGuard Settings" name_upper="WIREGUARD"><property name="fwmark" name_upper="FWMARK" type="uint32" default="0"><description-docbook><para> 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.</para><para> Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.</para></description-docbook><description>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.</description></property><property name="ip4-auto-default-route" name_upper="IP4_AUTO_DEFAULT_ROUTE" type="NMTernary (int32)"><description-docbook><para> 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".</para><para> 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.</para><para> 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. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.</para></description-docbook><description>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. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.</description></property><property name="ip6-auto-default-route" name_upper="IP6_AUTO_DEFAULT_ROUTE" type="NMTernary (int32)"><description-docbook><para> Like ip4-auto-default-route, but for the IPv6 default route.</para></description-docbook><description>Like ip4-auto-default-route, but for the IPv6 default route.</description></property><property name="listen-port" name_upper="LISTEN_PORT" type="uint32" default="0"><description-docbook><para> The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</para></description-docbook><description>The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0"><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para><para> 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.</para></description-docbook><description>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.</description></property><property name="peer-routes" name_upper="PEER_ROUTES" type="boolean" default="TRUE"><description-docbook><para> 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.</para><para> 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.</para></description-docbook><description>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.</description></property><property name="private-key" name_upper="PRIVATE_KEY" type="string"><description-docbook><para> The 256 bit private-key in base64 encoding.</para></description-docbook><description>The 256 bit private-key in base64 encoding.</description></property><property name="private-key-flags" name_upper="PRIVATE_KEY_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "private-key" property.</para></description-docbook><description>Flags indicating how to handle the "private-key" property.</description></property></setting><setting name="802-11-wireless" description=" Wi-Fi Settings" name_upper="WIRELESS" alias="wifi"><property name="ap-isolation" name_upper="AP_ISOLATION" type="NMTernary (int32)"><description-docbook><para> Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode.</para><para> If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.</para><para> If set to NM_TERNARY_FALSE (0), devices can talk to each other.</para><para> 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_FALSE (0).</para></description-docbook><description>Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode. If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. If set to NM_TERNARY_FALSE (0), devices can talk to each other. 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_FALSE (0).</description></property><property name="band" name_upper="BAND" type="string"><description-docbook><para> 802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</para></description-docbook><description>802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</description></property><property name="bssid" name_upper="BSSID" type="byte array"><description-docbook><para> If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.</para><para> Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.</para></description-docbook><description>If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future. Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.</description></property><property name="channel" name_upper="CHANNEL" type="uint32" default="0"><description-docbook><para> Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.</para></description-docbook><description>Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.</description></property><property name="cloned-mac-address" name_upper="CLONED_MAC_ADDRESS" type="byte array" alias="cloned-mac"><description-docbook><para> If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.</para><para> Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.</para><para> If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).</para><para> On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</para></description-docbook><description>If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing. Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key. If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value). On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</description></property><property name="generate-mac-address-mask" name_upper="GENERATE_MAC_ADDRESS_MASK" type="string"><description-docbook><para> 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.</para><para> 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.</para><para> 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.</para><para> 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.</para><para> 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.</para></description-docbook><description>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.</description></property><property name="hidden" name_upper="HIDDEN" type="boolean" default="FALSE"><description-docbook><para> If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.</para><para> In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.</para><para> In AP mode, the created network does not broadcast its SSID.</para><para> Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</para></description-docbook><description>If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode. In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. In AP mode, the created network does not broadcast its SSID. Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</description></property><property name="mac-address" name_upper="MAC_ADDRESS" type="byte array" alias="mac"><description-docbook><para> If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</para></description-docbook><description>If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</description></property><property name="mac-address-blacklist" name_upper="MAC_ADDRESS_BLACKLIST" type="array of string"><description-docbook><para> A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</para></description-docbook><description>A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</description></property><property name="mac-address-randomization" name_upper="MAC_ADDRESS_RANDOMIZATION" type="uint32" default="0"><description-docbook><para> One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'. Deprecated: 1</para></description-docbook><description>One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'. Deprecated: 1</description></property><property name="mode" name_upper="MODE" type="string" alias="mode"><description-docbook><para> Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</para></description-docbook><description>Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</description></property><property name="mtu" name_upper="MTU" type="uint32" default="0" alias="mtu"><description-docbook><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</para></description-docbook><description>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</description></property><property name="powersave" name_upper="POWERSAVE" type="uint32" default="0"><description-docbook><para> One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</para></description-docbook><description>One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</description></property><property name="rate" name_upper="RATE" type="uint32" default="0"><description-docbook><para> If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</para></description-docbook><description>If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</description></property><property name="seen-bssids" name_upper="SEEN_BSSIDS" type="array of string"><description-docbook><para> A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</para></description-docbook><description>A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</description></property><property name="ssid" name_upper="SSID" type="byte array" alias="ssid"><description-docbook><para> SSID of the Wi-Fi network. Must be specified.</para></description-docbook><description>SSID of the Wi-Fi network. Must be specified.</description></property><property name="tx-power" name_upper="TX_POWER" type="uint32" default="0"><description-docbook><para> If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</para></description-docbook><description>If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</description></property><property name="wake-on-wlan" name_upper="WAKE_ON_WLAN" type="uint32" default="1"><description-docbook><para> The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</para></description-docbook><description>The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</description></property></setting><setting name="802-11-wireless-security" description=" Wi-Fi Security Settings" name_upper="WIRELESS_SECURITY" alias="wifi-sec"><property name="auth-alg" name_upper="AUTH_ALG" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="fils" name_upper="FILS" type="int32" default="0"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="group" name_upper="GROUP" type="array of string"><description-docbook><para> 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".</para></description-docbook><description>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".</description></property><property name="key-mgmt" name_upper="KEY_MGMT" type="string"><description-docbook><para> 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).</para><para> This property must be set for any Wi-Fi connection that uses security.</para></description-docbook><description>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.</description></property><property name="leap-password" name_upper="LEAP_PASSWORD" type="string"><description-docbook><para> The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</para></description-docbook><description>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</description></property><property name="leap-password-flags" name_upper="LEAP_PASSWORD_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "leap-password" property.</para></description-docbook><description>Flags indicating how to handle the "leap-password" property.</description></property><property name="leap-username" name_upper="LEAP_USERNAME" type="string"><description-docbook><para> The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</para></description-docbook><description>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</description></property><property name="pairwise" name_upper="PAIRWISE" type="array of string"><description-docbook><para> 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".</para></description-docbook><description>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".</description></property><property name="pmf" name_upper="PMF" type="int32" default="0"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="proto" name_upper="PROTO" type="array of string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="psk" name_upper="PSK" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="psk-flags" name_upper="PSK_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "psk" property.</para></description-docbook><description>Flags indicating how to handle the "psk" property.</description></property><property name="wep-key-flags" name_upper="WEP_KEY_FLAGS" type="NMSettingSecretFlags (uint32)"><description-docbook><para> Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</para></description-docbook><description>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</description></property><property name="wep-key-type" name_upper="WEP_KEY_TYPE" type="NMWepKeyType (uint32)"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="wep-key0" name_upper="WEP_KEY0" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="wep-key1" name_upper="WEP_KEY1" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="wep-key2" name_upper="WEP_KEY2" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="wep-key3" name_upper="WEP_KEY3" type="string"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="wep-tx-keyidx" name_upper="WEP_TX_KEYIDX" type="uint32" default="0"><description-docbook><para> 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.</para></description-docbook><description>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.</description></property><property name="wps-method" name_upper="WPS_METHOD" type="uint32" default="0"><description-docbook><para> Flags indicating which mode of WPS is to be used if any.</para><para> 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.</para><para> WPS can be disabled by setting this property to a value of 1.</para></description-docbook><description>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.</description></property></setting><setting name="wpan" description=" IEEE 802.15.4 (WPAN) MAC Settings" name_upper="WPAN"><property name="channel" name_upper="CHANNEL" type="int32" default="-1" alias="channel"><description-docbook><para> IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</para></description-docbook><description>IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</description></property><property name="mac-address" name_upper="MAC_ADDRESS" type="string" alias="mac"><description-docbook><para> If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.</para></description-docbook><description>If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.</description></property><property name="page" name_upper="PAGE" type="int32" default="-1" alias="page"><description-docbook><para> IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</para></description-docbook><description>IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</description></property><property name="pan-id" name_upper="PAN_ID" type="uint32" default="65535" alias="pan-id"><description-docbook><para> IEEE 802.15.4 Personal Area Network (PAN) identifier.</para></description-docbook><description>IEEE 802.15.4 Personal Area Network (PAN) identifier.</description></property><property name="short-address" name_upper="SHORT_ADDRESS" type="uint32" default="65535" alias="short-addr"><description-docbook><para> Short IEEE 802.15.4 address to be used within a restricted environment.</para></description-docbook><description>Short IEEE 802.15.4 address to be used within a restricted environment.</description></property></setting><setting name="bond-port" description=" Bond Port Settings" name_upper="BOND_PORT"><property name="queue-id" name_upper="QUEUE_ID" type="uint32" default="0" alias="queue-id"><description-docbook><para> The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.</para></description-docbook><description>The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.</description></property></setting><setting name="hostname" description=" Hostname settings" name_upper="HOSTNAME"><property name="from-dhcp" name_upper="FROM_DHCP" type="NMTernary (int32)"><description-docbook><para> Whether the system hostname can be determined from DHCP on this connection.</para><para> 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).</para></description-docbook><description>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).</description></property><property name="from-dns-lookup" name_upper="FROM_DNS_LOOKUP" type="NMTernary (int32)"><description-docbook><para> Whether the system hostname can be determined from reverse DNS lookup of addresses on this device.</para><para> 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).</para></description-docbook><description>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).</description></property><property name="only-from-default" name_upper="ONLY_FROM_DEFAULT" type="NMTernary (int32)"><description-docbook><para> 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).</para><para> If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route.</para><para> 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).</para></description-docbook><description>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).</description></property><property name="priority" name_upper="PRIORITY" type="int32" default="0"><description-docbook><para> 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.</para><para> 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.</para><para> 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.</para></description-docbook><description>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.</description></property></setting><setting name="veth" description=" Veth Settings" name_upper="VETH"><property name="peer" name_upper="PEER" type="string" alias="peer"><description-docbook><para> This property specifies the peer interface name of the veth. This property is mandatory.</para></description-docbook><description>This property specifies the peer interface name of the veth. This property is mandatory.</description></property></setting></nm-setting-docs> \ No newline at end of file diff --git a/man/nm-settings-ifcfg-rh.5 b/man/nm-settings-ifcfg-rh.5 index c1812b2c..e96e1e3f 100644 --- a/man/nm-settings-ifcfg-rh.5 +++ b/man/nm-settings-ifcfg-rh.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-ifcfg-rh .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: Configuration -.\" Source: NetworkManager 1.40.12 +.\" Source: NetworkManager 1.42.4 .\" Language: English .\" -.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.40\&.12" "Configuration" +.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.42\&.4" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -369,7 +369,477 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&2.\ \&802\-1x setting +.B Table\ \&2.\ \&802\-11\-wireless setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Ifcfg\-rh Variable +T}:T{ +Default +T}:T{ +Description +T} +.T& +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l. +T{ +ssid +T}:T{ +ESSID +T}:T{ +\ \& +T}:T{ +SSID of Wi\-Fi network\&.\fB + +Example: \fRESSID="Quick Net" +T} +T{ +mode +T}:T{ +MODE +T}:T{ +\ \& +T}:T{ +Wi\-Fi network mode\&.\fB + +Allowed values: \fRAd\-Hoc, Managed (Auto) [case insensitive] +T} +T{ +band +T}:T{ +BAND\fI(+)\fR +T}:T{ +\ \& +T}:T{ +BAND alone is honored, but CHANNEL overrides BAND since it implies a band\&.\fB + +Example: \fRBAND=bg\fB + +Allowed values: \fRa, bg +T} +T{ +channel +T}:T{ +CHANNEL +T}:T{ +\ \& +T}:T{ +Channel used for the Wi\-Fi communication\&. Channels greater than 14 mean "a" band, otherwise the band is "bg"\&.\fB + +Example: \fRCHANNEL=6 +T} +T{ +bssid +T}:T{ +BSSID\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Restricts association only to a single AP\&.\fB + +Example: \fRBSSID=00:1E:BD:64:83:21 +T} +T{ +rate +T}:T{ +(none) +T}:T{ +\ \& +T}:T{ +This property is not handled by ifcfg\-rh plugin\&. +T} +T{ +tx\-power +T}:T{ +(none) +T}:T{ +\ \& +T}:T{ +This property is not handled by ifcfg\-rh plugin\&. +T} +T{ +mac\-address +T}:T{ +HWADDR +T}:T{ +\ \& +T}:T{ +Hardware address of the device in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:14:5A:05)\&. Note that for initscripts this is the current MAC address of the device as found during ifup\&. For NetworkManager this is the permanent MAC address\&. Or in case no permanent MAC address exists, the MAC address initially configured on the device\&. +T} +T{ +cloned\-mac\-address +T}:T{ +MACADDR +T}:T{ +\ \& +T}:T{ +Cloned (spoofed) MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:14:5A:99)\&. +T} +T{ +generate\-mac\-address\-mask +T}:T{ +GENERATE_MAC_ADDRESS_MASK\fI(+)\fR +T}:T{ +\ \& +T}:T{ +the MAC address mask for generating randomized and stable cloned\-mac\-address\&. +T} +T{ +mac\-address\-blacklist +T}:T{ +HWADDR_BLACKLIST\fI(+)\fR +T}:T{ +\ \& +T}:T{ +It denies usage of the connection for any device whose address is listed\&. +T} +T{ +seen\-bssids +T}:T{ +(none) +T}:T{ +\ \& +T}:T{ +This property is not handled by ifcfg\-rh plugin\&. +T} +T{ +mtu +T}:T{ +MTU +T}:T{ +\ \& +T}:T{ +MTU of the wireless interface\&. +T} +T{ +hidden +T}:T{ +SSID_HIDDEN\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Whether the network hides the SSID\&. +T} +T{ +powersave +T}:T{ +POWERSAVE\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Enables or disables Wi\-Fi power saving\&.\fB + +Example: \fRPOWERSAVE=enable\fB + +Allowed values: \fRdefault, ignore, enable, disable +T} +T{ +mac\-address\-randomization +T}:T{ +MAC_ADDRESS_RANDOMIZATION\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Enables or disables Wi\-Fi MAC address randomization\&.\fB + +Example: \fRMAC_ADDRESS_RANDOMIZATION=always\fB + +Allowed values: \fRdefault, never, always +T} +T{ +security +T}:T{ +(none) +T}:T{ +\ \& +T}:T{ +This property is deprecated and not handled by ifcfg\-rh\-plugin\&. +T} +T{ +ap\-isolation +T}:T{ +AP_ISOLATION\fI(+)\fR +T}:T{ +missing variable means global default +T}:T{ +Whether AP isolation is enabled\fB + +Allowed values: \fR"yes", "no" +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&3.\ \&802\-11\-wireless\-security setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Ifcfg\-rh Variable +T}:T{ +Default +T}:T{ +Description +T} +.T& +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l. +T{ +key\-mgmt +T}:T{ +KEY_MGMT\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Key management method\&.\fB + +Allowed values: \fRnone, ieee8021x, owe, wpa\-psk, sae, wpa\-eap, wpa\-eap\-suite\-b\-192 +T} +T{ +wep\-tx\-keyidx +T}:T{ +DEFAULTKEY +T}:T{ +1 +T}:T{ +Index of active WEP key\&. Note that in ifcfg format the index starts counting at 1, while NetworkManager API otherwise is zero based\&.\fB + +Allowed values: \fR1, 2, 3, 4 +T} +T{ +auth\-alg +T}:T{ +SECURITYMODE\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Authentication algorithm for WEP\&.\fB + +Allowed values: \fRrestricted, open, leap +T} +T{ +proto +T}:T{ +WPA_ALLOW_WPA\fI(+)\fR, WPA_ALLOW_WPA2\fI(+)\fR +T}:T{ +no +T}:T{ +Allowed WPA protocols, WPA and WPA2 (RSN)\&.\fB + +Allowed values: \fRyes, no +T} +T{ +pairwise +T}:T{ +CIPHER_PAIRWISE\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Restrict pairwise encryption algorithms, specified as a space separated list\&.\fB + +Allowed values: \fRCCMP, TKIP +T} +T{ +group +T}:T{ +CIPHER_GROUP\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Restrict group/broadcast encryption algorithms, specified as a space separated list\&.\fB + +Allowed values: \fRCCMP, TKIP, WEP40, WEP104 +T} +T{ +pmf +T}:T{ +PMF\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Enables or disables PMF (802\&.11w)\fB + +Example: \fRPMF=required\fB + +Allowed values: \fRdefault, disable, optional, required +T} +T{ +leap\-username +T}:T{ +IEEE_8021X_IDENTITY\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Login name for LEAP\&. +T} +T{ +wep\-key0 +T}:T{ +KEY1, KEY_PASSPHRASE1\fI(+)\fR +T}:T{ +\ \& +T}:T{ +The first WEP key (used in most networks)\&. See also DEFAULTKEY for key index\&. +T} +T{ +wep\-key1 +T}:T{ +KEY2, KEY_PASSPHRASE2\fI(+)\fR +T}:T{ +\ \& +T}:T{ +WEP key with index 1\&. See also DEFAULTKEY for key index\&. +T} +T{ +wep\-key2 +T}:T{ +KEY3, KEY_PASSPHRASE3\fI(+)\fR +T}:T{ +\ \& +T}:T{ +WEP key with index 2\&. See also DEFAULTKEY for key index\&. +T} +T{ +wep\-key3 +T}:T{ +KEY4, KEY_PASSPHRASE4\fI(+)\fR +T}:T{ +\ \& +T}:T{ +WEP key with index 3\&. See also DEFAULTKEY for key index\&. +T} +T{ +wep\-key\-flags +T}:T{ +WEP_KEY_FLAGS\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Password flags for KEY<i>, KEY_PASSPHRASE<i> password\&. (see the section called \(lqSecret flags\(rq for _FLAGS values) +T} +T{ +psk +T}:T{ +WPA_PSK +T}:T{ +\ \& +T}:T{ +Pre\-Shared\-Key for WPA networks\&. +T} +T{ +psk\-flags +T}:T{ +WPA_PSK_FLAGS\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Password flags for WPA_PSK_FLAGS\&. (see the section called \(lqSecret flags\(rq for _FLAGS values)\fB + +Example: \fRWPA_PSK_FLAGS=user +T} +T{ +leap\-password +T}:T{ +IEEE_8021X_PASSWORD\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Password for LEAP\&. It can also go to "key\-" lookaside file, or it can be owned by a secret agent\&. +T} +T{ +leap\-password\-flags +T}:T{ +IEEE_8021X_PASSWORD_FLAGS\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Password flags for IEEE_8021X_PASSWORD_FLAGS\&. (see the section called \(lqSecret flags\(rq for _FLAGS values) +T} +T{ +wep\-key\-type +T}:T{ +KEY<i> or KEY_PASSPHRASE<i>\fI(+)\fR; KEY_TYPE\fI(+)\fR +T}:T{ +\ \& +T}:T{ +KEY is used for "key" type (10 or 26 hexadecimal characters, or 5 or 13 character string prefixed with "s:")\&. KEY_PASSPHRASE is used for WEP passphrases\&. KEY_TYPE specifies the key type and can be either \*(Aqkey\*(Aq or \*(Aqpassphrase\*(Aq\&. KEY_TYPE is redundant and can be omitted\&.\fB + +Example: \fRKEY1=s:ahoj, KEY1=0a1c45bc02, KEY_PASSPHRASE1=mysupersecretkey +T} +T{ +wps\-method +T}:T{ +WPS_METHOD +T}:T{ +\ \& +T}:T{ +Used to control the WPS methods to be used Valid values are "default", "auto", "disabled", "pin" and "pbc"\&. If omitted, whatver the AP announces is used\&.\fB + +Example: \fRWPS_METHOD=disabled, WPS_METHOD="pin pbc" +T} +T{ +fils +T}:T{ +FILS\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Enables or disables FILS (802\&.11ai)\fB + +Example: \fRFILS=required\fB + +Allowed values: \fRdefault, disable, optional, required +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&4.\ \&802\-1x setting .TS allbox tab(:); lB lB lB lB. @@ -814,7 +1284,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&3.\ \&bond\-port setting +.B Table\ \&5.\ \&802\-3\-ethernet setting .TS allbox tab(:); lB lB lB lB. @@ -828,17 +1298,165 @@ T}:T{ Description T} .T& +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l l l l l. T{ -queue\-id +port T}:T{ -BONDING_OPTS: queue\-id= +(none) T}:T{ -0 +\ \& T}:T{ -Queue ID\&.\fB +The property is not saved by the plugin\&. +T} +T{ +speed +T}:T{ +ETHTOOL_OPTS +T}:T{ +\ \& +T}:T{ +Fixed speed for the ethernet link\&. It is added as "speed" parameter in the ETHTOOL_OPTS variable\&. +T} +T{ +duplex +T}:T{ +ETHTOOL_OPTS +T}:T{ +\ \& +T}:T{ +Fixed duplex mode for the ethernet link\&. It is added as "duplex" parameter in the ETHOOL_OPTS variable\&. +T} +T{ +auto\-negotiate +T}:T{ +ETHTOOL_OPTS +T}:T{ +\ \& +T}:T{ +Whether link speed and duplex autonegotiation is enabled\&. It is not saved only if disabled and no values are provided for the "speed" and "duplex" parameters (skips link configuration)\&. +T} +T{ +mac\-address +T}:T{ +HWADDR +T}:T{ +\ \& +T}:T{ +Hardware address of the device in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:14:5A:05)\&. Note that for initscripts this is the current MAC address of the device as found during ifup\&. For NetworkManager this is the permanent MAC address\&. Or in case no permanent MAC address exists, the MAC address initially configured on the device\&. +T} +T{ +cloned\-mac\-address +T}:T{ +MACADDR +T}:T{ +\ \& +T}:T{ +Cloned (spoofed) MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:14:5A:99)\&. +T} +T{ +generate\-mac\-address\-mask +T}:T{ +GENERATE_MAC_ADDRESS_MASK\fI(+)\fR +T}:T{ +\ \& +T}:T{ +the MAC address mask for generating randomized and stable cloned\-mac\-address\&. +T} +T{ +mac\-address\-blacklist +T}:T{ +HWADDR_BLACKLIST\fI(+)\fR +T}:T{ +\ \& +T}:T{ +It denies usage of the connection for any device whose address is listed\&.\fB -Allowed values: \fR0 \- 65535 +Example: \fRHWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55" +T} +T{ +mtu +T}:T{ +MTU +T}:T{ +\ \& +T}:T{ +MTU of the interface\&. +T} +T{ +s390\-subchannels +T}:T{ +SUBCHANNELS +T}:T{ +\ \& +T}:T{ +Subchannels for IBM S390 hosts\&.\fB + +Example: \fRSUBCHANNELS=0\&.0\&.b00a,0\&.0\&.b00b,0\&.0\&.b00c +T} +T{ +s390\-nettype +T}:T{ +NETTYPE +T}:T{ +\ \& +T}:T{ +Network type of the S390 host\&.\fB + +Example: \fRNETTYPE=qeth\fB + +Allowed values: \fR"qeth", "lcs" or "ctc" +T} +T{ +s390\-options +T}:T{ +OPTIONS and PORTNAME, CTCPROTO, +T}:T{ +\ \& +T}:T{ +S390 device options\&. All options go to OPTIONS, except for "portname" and "ctcprot" that have their own variables\&. +T} +T{ +wake\-on\-lan +T}:T{ +ETHTOOL_OPTS, ETHTOOL_WAKE_ON_LAN +T}:T{ +\ \& +T}:T{ +Wake on Lan mode for ethernet\&. The setting "ignore" is expressed with "ETHTOOL_WAKE_ON_LAN=ignore"\&. Otherwise, the "ETHTOOL_OPTS" variable is set with the value "wol" and several of the characters "p|u|m|b|a|g|s|f|d" as explained in the ethtool manual page\&. +T} +T{ +wake\-on\-lan\-password +T}:T{ +ETHTOOL_OPTS +T}:T{ +\ \& +T}:T{ +Password for secure\-on based Wake\-on\-Lan\&. It is added as "sopass" parameter in the ETHTOOL_OPTS variable\&.\fB + +Example: \fRETHTOOL_OPTS="wol gs sopass 00:11:22:33:44:55" +T} +T{ +accept\-all\-mac\-addresses +T}:T{ +ACCEPT_ALL_MAC_ADDRESSES +T}:T{ +\ \& +T}:T{ +Enforce the interface to accept all the packets\&. T} .TE .sp 1 @@ -847,7 +1465,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&4.\ \&bond setting +.B Table\ \&6.\ \&bond setting .TS allbox tab(:); lB lB lB lB. @@ -880,7 +1498,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&5.\ \&bridge\-port setting +.B Table\ \&7.\ \&bond\-port setting .TS allbox tab(:); lB lB lB lB. @@ -894,51 +1512,17 @@ T}:T{ Description T} .T& -l l l l -l l l l -l l l l l l l l. T{ -priority -T}:T{ -BRIDGING_OPTS: priority= -T}:T{ -32 -T}:T{ -STP priority\&.\fB - -Allowed values: \fR0 \- 63 -T} -T{ -path\-cost -T}:T{ -BRIDGING_OPTS: path_cost= -T}:T{ -100 -T}:T{ -STP cost\&.\fB - -Allowed values: \fR1 \- 65535 -T} -T{ -hairpin\-mode -T}:T{ -BRIDGING_OPTS: hairpin_mode= -T}:T{ -yes -T}:T{ -Hairpin mode of the bridge port\&. -T} -T{ -vlans +queue\-id T}:T{ -BRIDGE_PORT_VLANS +BONDING_OPTS: queue\-id= T}:T{ -\ \& +0 T}:T{ -List of VLANs on the bridge port\fB +Queue ID\&.\fB -Example: \fRBRIDGE_PORT_VLANS="1 pvid untagged,20,300\-400 untagged" +Allowed values: \fR0 \- 65535 T} .TE .sp 1 @@ -947,7 +1531,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&6.\ \&bridge setting +.B Table\ \&8.\ \&bridge setting .TS allbox tab(:); lB lB lB lB. @@ -1278,7 +1862,74 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&7.\ \&connection setting +.B Table\ \&9.\ \&bridge\-port setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Ifcfg\-rh Variable +T}:T{ +Default +T}:T{ +Description +T} +.T& +l l l l +l l l l +l l l l +l l l l. +T{ +priority +T}:T{ +BRIDGING_OPTS: priority= +T}:T{ +32 +T}:T{ +STP priority\&.\fB + +Allowed values: \fR0 \- 63 +T} +T{ +path\-cost +T}:T{ +BRIDGING_OPTS: path_cost= +T}:T{ +100 +T}:T{ +STP cost\&.\fB + +Allowed values: \fR1 \- 65535 +T} +T{ +hairpin\-mode +T}:T{ +BRIDGING_OPTS: hairpin_mode= +T}:T{ +yes +T}:T{ +Hairpin mode of the bridge port\&. +T} +T{ +vlans +T}:T{ +BRIDGE_PORT_VLANS +T}:T{ +\ \& +T}:T{ +List of VLANs on the bridge port\fB + +Example: \fRBRIDGE_PORT_VLANS="1 pvid untagged,20,300\-400 untagged" +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&10.\ \&connection setting .TS allbox tab(:); lB lB lB lB. @@ -1611,7 +2262,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&8.\ \&dcb setting +.B Table\ \&11.\ \&dcb setting .TS allbox tab(:); lB lB lB lB. @@ -1806,7 +2457,7 @@ All DCB related configuration is a NetworkManager extension\&. DCB=yes must be u .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&9.\ \ðtool setting +.B Table\ \&12.\ \ðtool setting .TS allbox tab(:); lB lB lB lB. @@ -1828,7 +2479,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&10.\ \&hostname setting +.B Table\ \&13.\ \&hostname setting .TS allbox tab(:); lB lB lB lB. @@ -1869,7 +2520,7 @@ whether the system hostname can be determined from DHCP\fB Example: \fRHOSTNAME_FROM_DHCP=0,1 T} T{ -from\-dhcp +from\-dns\-lookup T}:T{ HOSTNAME_FROM_DNS_LOOKUP\fI(+)\fR T}:T{ @@ -1897,7 +2548,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&11.\ \&infiniband setting +.B Table\ \&14.\ \&infiniband setting .TS allbox tab(:); lB lB lB lB. @@ -1974,7 +2625,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&12.\ \&ipv4 setting +.B Table\ \&15.\ \&ipv4 setting .TS allbox tab(:); lB lB lB lB. @@ -2009,6 +2660,9 @@ l l l l l l l l l l l l l l l l +l l l l +l l l l +l l l l l l l l. T{ method @@ -2167,6 +2821,24 @@ The priority for DNS servers of this connection\&. Lower values have higher prio Example: \fRIPV4_DNS_PRIORITY=20 T} T{ +auto\-route\-ext\-gw +T}:T{ +IPV4_AUTO_ROUTE_EXT_GW\fI(+)\fR +T}:T{ +yes +T}:T{ +VPN connections will default to add the route automatically unless this setting is set to %FALSE\&. For other connection types, adding such an automatic route is currently not supported and setting this to %TRUE has no effect\&. +T} +T{ +replace\-local\-rule +T}:T{ +IPV4_REPLACE_LOCAL_RULE\fI(+)\fR +T}:T{ +no +T}:T{ +Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to %TRUE\&. +T} +T{ dhcp\-client\-id T}:T{ DHCP_CLIENT_ID\fI(+)\fR @@ -2200,6 +2872,17 @@ A timeout after which the DHCP transaction fails in case of no response\&.\fB Example: \fRIPV4_DHCP_TIMEOUT=10 T} T{ +dhcp\-hostname\-flags +T}:T{ +DHCP_HOSTNAME_FLAGS +T}:T{ +\ \& +T}:T{ +flags for the DHCP hostname and FQDN properties\fB + +Example: \fRDHCP_HOSTNAME_FLAGS=5 +T} +T{ dhcp\-fqdn T}:T{ DHCP_FQDN @@ -2239,7 +2922,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&13.\ \&ipv6 setting +.B Table\ \&16.\ \&ipv6 setting .TS allbox tab(:); lB lB lB lB. @@ -2274,6 +2957,8 @@ l l l l l l l l l l l l l l l l +l l l l +l l l l l l l l. T{ method @@ -2441,6 +3126,24 @@ List of DNS options to be added to /etc/resolv\&.conf\fB Example: \fRIPV6_RES_OPTIONS=ndots:2 timeout:3 T} T{ +auto\-route\-ext\-gw +T}:T{ +IPV6_AUTO_ROUTE_EXT_GW\fI(+)\fR +T}:T{ +yes +T}:T{ +VPN connections will default to add the route automatically unless this setting is set to %FALSE\&. For other connection types, adding such an automatic route is currently not supported and setting this to %TRUE has no effect\&. +T} +T{ +replace\-local\-rule +T}:T{ +IPV6_REPLACE_LOCAL_RULE\fI(+)\fR +T}:T{ +no +T}:T{ +Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to %TRUE\&. +T} +T{ ip6\-privacy T}:T{ IPV6_PRIVACY, IPV6_PRIVACY_PREFER_PUBLIC_IP\fI(+)\fR @@ -2478,7 +3181,7 @@ The IPv6 tokenized interface identifier token\fB Example: \fRIPV6_TOKEN=::53 T} T{ -dhcp\-timeout +ra\-timeout T}:T{ IPV6_RA_TIMEOUT\fI(+)\fR T}:T{ @@ -2506,7 +3209,38 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&14.\ \&match setting +.B Table\ \&17.\ \&loopback setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Ifcfg\-rh Variable +T}:T{ +Default +T}:T{ +Description +T} +.T& +l l l l. +T{ +mtu +T}:T{ +MTU +T}:T{ +\ \& +T}:T{ +MTU of the interface\&. +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&18.\ \&match setting .TS allbox tab(:); lB lB lB lB. @@ -2539,7 +3273,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&15.\ \&ovs\-bridge setting +.B Table\ \&19.\ \&ovs\-bridge setting .TS allbox tab(:); lB lB lB lB. @@ -2561,7 +3295,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&16.\ \&ovs\-dpdk setting +.B Table\ \&20.\ \&ovs\-dpdk setting .TS allbox tab(:); lB lB lB lB. @@ -2583,7 +3317,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&17.\ \&ovs\-external\-ids setting +.B Table\ \&21.\ \&ovs\-external\-ids setting .TS allbox tab(:); lB lB lB lB. @@ -2605,7 +3339,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&18.\ \&ovs\-interface setting +.B Table\ \&22.\ \&ovs\-interface setting .TS allbox tab(:); lB lB lB lB. @@ -2627,7 +3361,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&19.\ \&ovs\-patch setting +.B Table\ \&23.\ \&ovs\-other\-config setting .TS allbox tab(:); lB lB lB lB. @@ -2649,7 +3383,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&20.\ \&ovs\-port setting +.B Table\ \&24.\ \&ovs\-patch setting .TS allbox tab(:); lB lB lB lB. @@ -2671,7 +3405,29 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&21.\ \&proxy setting +.B Table\ \&25.\ \&ovs\-port setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Ifcfg\-rh Variable +T}:T{ +Default +T}:T{ +Description +T} +.T& +. +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&26.\ \&proxy setting .TS allbox tab(:); lB lB lB lB. @@ -2738,7 +3494,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&22.\ \&sriov setting +.B Table\ \&27.\ \&sriov setting .TS allbox tab(:); lB lB lB lB. @@ -2795,7 +3551,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&23.\ \&tc setting +.B Table\ \&28.\ \&tc setting .TS allbox tab(:); lB lB lB lB. @@ -2823,7 +3579,7 @@ Queueing disciplines to set on the interface\&. When no QDISC1, QDISC2, \&.\&.\& Example: \fRQDISC1=ingress, QDISC2="root handle 1234: fq_codel" T} T{ -qdiscs +tfilters T}:T{ FILTER1\fI(+)\fR, FILTER2\fI(+)\fR, \&.\&.\&., TC_COMMIT\fI(+)\fR T}:T{ @@ -2840,7 +3596,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&24.\ \&team\-port setting +.B Table\ \&29.\ \&team setting .TS allbox tab(:); lB lB lB lB. @@ -2858,11 +3614,11 @@ l l l l. T{ config T}:T{ -TEAM_PORT_CONFIG +TEAM_CONFIG T}:T{ \ \& T}:T{ -Team port configuration in JSON\&. See man teamd\&.conf for details\&. +Team configuration in JSON\&. See man teamd\&.conf for details\&. T} .TE .sp 1 @@ -2871,7 +3627,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&25.\ \&team setting +.B Table\ \&30.\ \&team\-port setting .TS allbox tab(:); lB lB lB lB. @@ -2889,11 +3645,11 @@ l l l l. T{ config T}:T{ -TEAM_CONFIG +TEAM_PORT_CONFIG T}:T{ \ \& T}:T{ -Team configuration in JSON\&. See man teamd\&.conf for details\&. +Team port configuration in JSON\&. See man teamd\&.conf for details\&. T} .TE .sp 1 @@ -2902,7 +3658,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&26.\ \&user setting +.B Table\ \&31.\ \&user setting .TS allbox tab(:); lB lB lB lB. @@ -2935,7 +3691,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&27.\ \&veth setting +.B Table\ \&32.\ \&veth setting .TS allbox tab(:); lB lB lB lB. @@ -2957,7 +3713,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&28.\ \&vlan setting +.B Table\ \&33.\ \&vlan setting .TS allbox tab(:); lB lB lB lB. @@ -2976,6 +3732,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ parent @@ -3007,6 +3764,17 @@ VLAN flags\&.\fB Allowed values: \fR"yes or "no" for GVRP and MVRP; "LOOSE_BINDING" and "NO_REORDER_HDR" for VLAN_FLAGS T} T{ +protocol +T}:T{ +VLAN_PROTOCOL +T}:T{ +\ \& +T}:T{ +VLAN protocol\&.\fB + +Example: \fRVLAN_PROTOCOL="802\&.1ad" +T} +T{ ingress\-priority\-map T}:T{ VLAN_INGRESS_PRIORITY_MAP @@ -3046,7 +3814,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&29.\ \&vrf setting +.B Table\ \&34.\ \&vrf setting .TS allbox tab(:); lB lB lB lB. @@ -3068,7 +3836,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&30.\ \&wifi\-p2p setting +.B Table\ \&35.\ \&wifi\-p2p setting .TS allbox tab(:); lB lB lB lB. @@ -3090,188 +3858,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&31.\ \&802\-3\-ethernet setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -port -T}:T{ -(none) -T}:T{ -\ \& -T}:T{ -The property is not saved by the plugin\&. -T} -T{ -speed -T}:T{ -ETHTOOL_OPTS -T}:T{ -\ \& -T}:T{ -Fixed speed for the ethernet link\&. It is added as "speed" parameter in the ETHTOOL_OPTS variable\&. -T} -T{ -duplex -T}:T{ -ETHTOOL_OPTS -T}:T{ -\ \& -T}:T{ -Fixed duplex mode for the ethernet link\&. It is added as "duplex" parameter in the ETHOOL_OPTS variable\&. -T} -T{ -auto\-negotiate -T}:T{ -ETHTOOL_OPTS -T}:T{ -\ \& -T}:T{ -Whether link speed and duplex autonegotiation is enabled\&. It is not saved only if disabled and no values are provided for the "speed" and "duplex" parameters (skips link configuration)\&. -T} -T{ -mac\-address -T}:T{ -HWADDR -T}:T{ -\ \& -T}:T{ -Hardware address of the device in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:14:5A:05)\&. Note that for initscripts this is the current MAC address of the device as found during ifup\&. For NetworkManager this is the permanent MAC address\&. Or in case no permanent MAC address exists, the MAC address initially configured on the device\&. -T} -T{ -cloned\-mac\-address -T}:T{ -MACADDR -T}:T{ -\ \& -T}:T{ -Cloned (spoofed) MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:14:5A:99)\&. -T} -T{ -generate\-mac\-address\-mask -T}:T{ -GENERATE_MAC_ADDRESS_MASK\fI(+)\fR -T}:T{ -\ \& -T}:T{ -the MAC address mask for generating randomized and stable cloned\-mac\-address\&. -T} -T{ -mac\-address\-blacklist -T}:T{ -HWADDR_BLACKLIST\fI(+)\fR -T}:T{ -\ \& -T}:T{ -It denies usage of the connection for any device whose address is listed\&.\fB - -Example: \fRHWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55" -T} -T{ -mtu -T}:T{ -MTU -T}:T{ -\ \& -T}:T{ -MTU of the interface\&. -T} -T{ -s390\-subchannels -T}:T{ -SUBCHANNELS -T}:T{ -\ \& -T}:T{ -Subchannels for IBM S390 hosts\&.\fB - -Example: \fRSUBCHANNELS=0\&.0\&.b00a,0\&.0\&.b00b,0\&.0\&.b00c -T} -T{ -s390\-nettype -T}:T{ -NETTYPE -T}:T{ -\ \& -T}:T{ -Network type of the S390 host\&.\fB - -Example: \fRNETTYPE=qeth\fB - -Allowed values: \fR"qeth", "lcs" or "ctc" -T} -T{ -s390\-options -T}:T{ -OPTIONS and PORTNAME, CTCPROTO, -T}:T{ -\ \& -T}:T{ -S390 device options\&. All options go to OPTIONS, except for "portname" and "ctcprot" that have their own variables\&. -T} -T{ -wake\-on\-lan -T}:T{ -ETHTOOL_OPTS, ETHTOOL_WAKE_ON_LAN -T}:T{ -\ \& -T}:T{ -Wake on Lan mode for ethernet\&. The setting "ignore" is expressed with "ETHTOOL_WAKE_ON_LAN=ignore"\&. Otherwise, the "ETHTOOL_OPTS" variable is set with the value "wol" and several of the characters "p|u|m|b|a|g|s|f|d" as explained in the ethtool manual page\&. -T} -T{ -wake\-on\-lan\-password -T}:T{ -ETHTOOL_OPTS -T}:T{ -\ \& -T}:T{ -Password for secure\-on based Wake\-on\-Lan\&. It is added as "sopass" parameter in the ETHTOOL_OPTS variable\&.\fB - -Example: \fRETHTOOL_OPTS="wol gs sopass 00:11:22:33:44:55" -T} -T{ -accept\-all\-mac\-addresses -T}:T{ -ACCEPT_ALL_MAC_ADDRESSES -T}:T{ -\ \& -T}:T{ -Enforce the interface to accept all the packets\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&32.\ \&wireguard setting +.B Table\ \&36.\ \&wireguard setting .TS allbox tab(:); lB lB lB lB. @@ -3293,477 +3880,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&33.\ \&802\-11\-wireless\-security setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -key\-mgmt -T}:T{ -KEY_MGMT\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Key management method\&.\fB - -Allowed values: \fRnone, ieee8021x, owe, wpa\-psk, sae, wpa\-eap, wpa\-eap\-suite\-b\-192 -T} -T{ -wep\-tx\-keyidx -T}:T{ -DEFAULTKEY -T}:T{ -1 -T}:T{ -Index of active WEP key\&. Note that in ifcfg format the index starts counting at 1, while NetworkManager API otherwise is zero based\&.\fB - -Allowed values: \fR1, 2, 3, 4 -T} -T{ -auth\-alg -T}:T{ -SECURITYMODE\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Authentication algorithm for WEP\&.\fB - -Allowed values: \fRrestricted, open, leap -T} -T{ -proto -T}:T{ -WPA_ALLOW_WPA\fI(+)\fR, WPA_ALLOW_WPA2\fI(+)\fR -T}:T{ -no -T}:T{ -Allowed WPA protocols, WPA and WPA2 (RSN)\&.\fB - -Allowed values: \fRyes, no -T} -T{ -pairwise -T}:T{ -CIPHER_PAIRWISE\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Restrict pairwise encryption algorithms, specified as a space separated list\&.\fB - -Allowed values: \fRCCMP, TKIP -T} -T{ -group -T}:T{ -CIPHER_GROUP\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Restrict group/broadcast encryption algorithms, specified as a space separated list\&.\fB - -Allowed values: \fRCCMP, TKIP, WEP40, WEP104 -T} -T{ -pmf -T}:T{ -PMF\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Enables or disables PMF (802\&.11w)\fB - -Example: \fRPMF=required\fB - -Allowed values: \fRdefault, disable, optional, required -T} -T{ -leap\-username -T}:T{ -IEEE_8021X_IDENTITY\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Login name for LEAP\&. -T} -T{ -wep\-key0 -T}:T{ -KEY1, KEY_PASSPHRASE1\fI(+)\fR -T}:T{ -\ \& -T}:T{ -The first WEP key (used in most networks)\&. See also DEFAULTKEY for key index\&. -T} -T{ -wep\-key1 -T}:T{ -KEY2, KEY_PASSPHRASE2\fI(+)\fR -T}:T{ -\ \& -T}:T{ -WEP key with index 1\&. See also DEFAULTKEY for key index\&. -T} -T{ -wep\-key2 -T}:T{ -KEY3, KEY_PASSPHRASE3\fI(+)\fR -T}:T{ -\ \& -T}:T{ -WEP key with index 2\&. See also DEFAULTKEY for key index\&. -T} -T{ -wep\-key3 -T}:T{ -KEY4, KEY_PASSPHRASE4\fI(+)\fR -T}:T{ -\ \& -T}:T{ -WEP key with index 3\&. See also DEFAULTKEY for key index\&. -T} -T{ -wep\-key\-flags -T}:T{ -WEP_KEY_FLAGS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Password flags for KEY<i>, KEY_PASSPHRASE<i> password\&. (see the section called \(lqSecret flags\(rq for _FLAGS values) -T} -T{ -psk -T}:T{ -WPA_PSK -T}:T{ -\ \& -T}:T{ -Pre\-Shared\-Key for WPA networks\&. -T} -T{ -psk\-flags -T}:T{ -WPA_PSK_FLAGS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Password flags for WPA_PSK_FLAGS\&. (see the section called \(lqSecret flags\(rq for _FLAGS values)\fB - -Example: \fRWPA_PSK_FLAGS=user -T} -T{ -leap\-password -T}:T{ -IEEE_8021X_PASSWORD\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Password for LEAP\&. It can also go to "key\-" lookaside file, or it can be owned by a secret agent\&. -T} -T{ -leap\-password\-flags -T}:T{ -IEEE_8021X_PASSWORD_FLAGS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Password flags for IEEE_8021X_PASSWORD_FLAGS\&. (see the section called \(lqSecret flags\(rq for _FLAGS values) -T} -T{ -wep\-key\-type -T}:T{ -KEY<i> or KEY_PASSPHRASE<i>\fI(+)\fR; KEY_TYPE\fI(+)\fR -T}:T{ -\ \& -T}:T{ -KEY is used for "key" type (10 or 26 hexadecimal characters, or 5 or 13 character string prefixed with "s:")\&. KEY_PASSPHRASE is used for WEP passphrases\&. KEY_TYPE specifies the key type and can be either \*(Aqkey\*(Aq or \*(Aqpassphrase\*(Aq\&. KEY_TYPE is redundant and can be omitted\&.\fB - -Example: \fRKEY1=s:ahoj, KEY1=0a1c45bc02, KEY_PASSPHRASE1=mysupersecretkey -T} -T{ -wps\-method -T}:T{ -WPS_METHOD -T}:T{ -\ \& -T}:T{ -Used to control the WPS methods to be used Valid values are "default", "auto", "disabled", "pin" and "pbc"\&. If omitted, whatver the AP announces is used\&.\fB - -Example: \fRWPS_METHOD=disabled, WPS_METHOD="pin pbc" -T} -T{ -fils -T}:T{ -FILS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Enables or disables FILS (802\&.11ai)\fB - -Example: \fRFILS=required\fB - -Allowed values: \fRdefault, disable, optional, required -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&34.\ \&802\-11\-wireless setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -ssid -T}:T{ -ESSID -T}:T{ -\ \& -T}:T{ -SSID of Wi\-Fi network\&.\fB - -Example: \fRESSID="Quick Net" -T} -T{ -mode -T}:T{ -MODE -T}:T{ -\ \& -T}:T{ -Wi\-Fi network mode\&.\fB - -Allowed values: \fRAd\-Hoc, Managed (Auto) [case insensitive] -T} -T{ -band -T}:T{ -BAND\fI(+)\fR -T}:T{ -\ \& -T}:T{ -BAND alone is honored, but CHANNEL overrides BAND since it implies a band\&.\fB - -Example: \fRBAND=bg\fB - -Allowed values: \fRa, bg -T} -T{ -channel -T}:T{ -CHANNEL -T}:T{ -\ \& -T}:T{ -Channel used for the Wi\-Fi communication\&. Channels greater than 14 mean "a" band, otherwise the band is "bg"\&.\fB - -Example: \fRCHANNEL=6 -T} -T{ -bssid -T}:T{ -BSSID\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Restricts association only to a single AP\&.\fB - -Example: \fRBSSID=00:1E:BD:64:83:21 -T} -T{ -rate -T}:T{ -(none) -T}:T{ -\ \& -T}:T{ -This property is not handled by ifcfg\-rh plugin\&. -T} -T{ -tx\-power -T}:T{ -(none) -T}:T{ -\ \& -T}:T{ -This property is not handled by ifcfg\-rh plugin\&. -T} -T{ -mac\-address -T}:T{ -HWADDR -T}:T{ -\ \& -T}:T{ -Hardware address of the device in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:14:5A:05)\&. Note that for initscripts this is the current MAC address of the device as found during ifup\&. For NetworkManager this is the permanent MAC address\&. Or in case no permanent MAC address exists, the MAC address initially configured on the device\&. -T} -T{ -cloned\-mac\-address -T}:T{ -MACADDR -T}:T{ -\ \& -T}:T{ -Cloned (spoofed) MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:14:5A:99)\&. -T} -T{ -generate\-mac\-address\-mask -T}:T{ -GENERATE_MAC_ADDRESS_MASK\fI(+)\fR -T}:T{ -\ \& -T}:T{ -the MAC address mask for generating randomized and stable cloned\-mac\-address\&. -T} -T{ -mac\-address\-blacklist -T}:T{ -HWADDR_BLACKLIST\fI(+)\fR -T}:T{ -\ \& -T}:T{ -It denies usage of the connection for any device whose address is listed\&. -T} -T{ -seen\-bssids -T}:T{ -(none) -T}:T{ -\ \& -T}:T{ -This property is not handled by ifcfg\-rh plugin\&. -T} -T{ -mtu -T}:T{ -MTU -T}:T{ -\ \& -T}:T{ -MTU of the wireless interface\&. -T} -T{ -hidden -T}:T{ -SSID_HIDDEN\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Whether the network hides the SSID\&. -T} -T{ -powersave -T}:T{ -POWERSAVE\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Enables or disables Wi\-Fi power saving\&.\fB - -Example: \fRPOWERSAVE=enable\fB - -Allowed values: \fRdefault, ignore, enable, disable -T} -T{ -mac\-address\-randomization -T}:T{ -MAC_ADDRESS_RANDOMIZATION\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Enables or disables Wi\-Fi MAC address randomization\&.\fB - -Example: \fRMAC_ADDRESS_RANDOMIZATION=always\fB - -Allowed values: \fRdefault, never, always -T} -T{ -security -T}:T{ -(none) -T}:T{ -\ \& -T}:T{ -This property is deprecated and not handled by ifcfg\-rh\-plugin\&. -T} -T{ -ap\-isolation -T}:T{ -AP_ISOLATION\fI(+)\fR -T}:T{ -missing variable means global default -T}:T{ -Whether AP isolation is enabled\fB - -Allowed values: \fR"yes", "no" -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&35.\ \&wpan setting +.B Table\ \&37.\ \&wpan setting .TS allbox tab(:); lB lB lB lB. diff --git a/man/nm-settings-ifcfg-rh.xml b/man/nm-settings-ifcfg-rh.xml index cb030194..37a46ab3 100644 --- a/man/nm-settings-ifcfg-rh.xml +++ b/man/nm-settings-ifcfg-rh.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-ifcfg-rh"><refentryinfo><title>nm-settings-ifcfg-rh</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-ifcfg-rh</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.40.12</refmiscinfo></refmeta><refnamediv><refname>nm-settings-ifcfg-rh</refname><refpurpose>Description of <emphasis>ifcfg-rh</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> +<refentry id="nm-settings-ifcfg-rh"><refentryinfo><title>nm-settings-ifcfg-rh</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-ifcfg-rh</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.42.4</refmiscinfo></refmeta><refnamediv><refname>nm-settings-ifcfg-rh</refname><refpurpose>Description of <emphasis>ifcfg-rh</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on the concept of connection profiles that contain network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing @@ -172,7 +172,55 @@ DEVICETYPE=TeamPort differences in NetworkManager and initscripts are documented in the tables below. </para></refsect1><refsect1 id="details"><title>Details</title><para><emphasis>ifcfg-rh</emphasis> plugin variables marked with <emphasis>(+)</emphasis> are NetworkManager specific extensions not understood by traditional initscripts. - </para><table><title>6lowpan setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>802-1x setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">eap</entry><entry align="left">IEEE_8021X_EAP_METHODS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">EAP method for 802.1X authentication.<emphasis role="bold"> + </para><table><title>6lowpan setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>802-11-wireless setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">ssid</entry><entry align="left">ESSID</entry><entry align="left"/><entry align="left">SSID of Wi-Fi network.<emphasis role="bold"> + +Example: </emphasis>ESSID="Quick Net"</entry></row><row><entry align="left">mode</entry><entry align="left">MODE</entry><entry align="left"/><entry align="left">Wi-Fi network mode.<emphasis role="bold"> + +Allowed values: </emphasis>Ad-Hoc, Managed (Auto) [case insensitive]</entry></row><row><entry align="left">band</entry><entry align="left">BAND<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">BAND alone is honored, but CHANNEL overrides BAND since it implies a band.<emphasis role="bold"> + +Example: </emphasis>BAND=bg<emphasis role="bold"> + +Allowed values: </emphasis>a, bg</entry></row><row><entry align="left">channel</entry><entry align="left">CHANNEL</entry><entry align="left"/><entry align="left">Channel used for the Wi-Fi communication. Channels greater than 14 mean "a" band, otherwise the band is "bg".<emphasis role="bold"> + +Example: </emphasis>CHANNEL=6</entry></row><row><entry align="left">bssid</entry><entry align="left">BSSID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Restricts association only to a single AP.<emphasis role="bold"> + +Example: </emphasis>BSSID=00:1E:BD:64:83:21</entry></row><row><entry align="left">rate</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">tx-power</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device.</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left">MACADDR</entry><entry align="left"/><entry align="left">Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).</entry></row><row><entry align="left">generate-mac-address-mask</entry><entry align="left">GENERATE_MAC_ADDRESS_MASK<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">the MAC address mask for generating randomized and stable cloned-mac-address.</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left">HWADDR_BLACKLIST<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">It denies usage of the connection for any device whose address is listed.</entry></row><row><entry align="left">seen-bssids</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">mtu</entry><entry align="left">MTU</entry><entry align="left"/><entry align="left">MTU of the wireless interface.</entry></row><row><entry align="left">hidden</entry><entry align="left">SSID_HIDDEN<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Whether the network hides the SSID.</entry></row><row><entry align="left">powersave</entry><entry align="left">POWERSAVE<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Enables or disables Wi-Fi power saving.<emphasis role="bold"> + +Example: </emphasis>POWERSAVE=enable<emphasis role="bold"> + +Allowed values: </emphasis>default, ignore, enable, disable</entry></row><row><entry align="left">mac-address-randomization</entry><entry align="left">MAC_ADDRESS_RANDOMIZATION<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Enables or disables Wi-Fi MAC address randomization.<emphasis role="bold"> + +Example: </emphasis>MAC_ADDRESS_RANDOMIZATION=always<emphasis role="bold"> + +Allowed values: </emphasis>default, never, always</entry></row><row><entry align="left">security</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is deprecated and not handled by ifcfg-rh-plugin.</entry></row><row><entry align="left">ap-isolation</entry><entry align="left">AP_ISOLATION<emphasis>(+)</emphasis></entry><entry align="left">missing variable means global default</entry><entry align="left">Whether AP isolation is enabled<emphasis role="bold"> + +Allowed values: </emphasis>"yes", "no"</entry></row></tbody></tgroup></table><table><title>802-11-wireless-security setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">key-mgmt</entry><entry align="left">KEY_MGMT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Key management method.<emphasis role="bold"> + +Allowed values: </emphasis>none, ieee8021x, owe, wpa-psk, sae, wpa-eap, wpa-eap-suite-b-192</entry></row><row><entry align="left">wep-tx-keyidx</entry><entry align="left">DEFAULTKEY</entry><entry align="left">1</entry><entry align="left">Index of active WEP key. Note that in ifcfg format the index starts counting at 1, while NetworkManager API otherwise is zero based.<emphasis role="bold"> + +Allowed values: </emphasis>1, 2, 3, 4</entry></row><row><entry align="left">auth-alg</entry><entry align="left">SECURITYMODE<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Authentication algorithm for WEP.<emphasis role="bold"> + +Allowed values: </emphasis>restricted, open, leap</entry></row><row><entry align="left">proto</entry><entry align="left">WPA_ALLOW_WPA<emphasis>(+)</emphasis>, WPA_ALLOW_WPA2<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Allowed WPA protocols, WPA and WPA2 (RSN).<emphasis role="bold"> + +Allowed values: </emphasis>yes, no</entry></row><row><entry align="left">pairwise</entry><entry align="left">CIPHER_PAIRWISE<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Restrict pairwise encryption algorithms, specified as a space separated list.<emphasis role="bold"> + +Allowed values: </emphasis>CCMP, TKIP</entry></row><row><entry align="left">group</entry><entry align="left">CIPHER_GROUP<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Restrict group/broadcast encryption algorithms, specified as a space separated list.<emphasis role="bold"> + +Allowed values: </emphasis>CCMP, TKIP, WEP40, WEP104</entry></row><row><entry align="left">pmf</entry><entry align="left">PMF<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Enables or disables PMF (802.11w)<emphasis role="bold"> + +Example: </emphasis>PMF=required<emphasis role="bold"> + +Allowed values: </emphasis>default, disable, optional, required</entry></row><row><entry align="left">leap-username</entry><entry align="left">IEEE_8021X_IDENTITY<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Login name for LEAP.</entry></row><row><entry align="left">wep-key0</entry><entry align="left">KEY1, KEY_PASSPHRASE1<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">The first WEP key (used in most networks). See also DEFAULTKEY for key index.</entry></row><row><entry align="left">wep-key1</entry><entry align="left">KEY2, KEY_PASSPHRASE2<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">WEP key with index 1. See also DEFAULTKEY for key index.</entry></row><row><entry align="left">wep-key2</entry><entry align="left">KEY3, KEY_PASSPHRASE3<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">WEP key with index 2. See also DEFAULTKEY for key index.</entry></row><row><entry align="left">wep-key3</entry><entry align="left">KEY4, KEY_PASSPHRASE4<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">WEP key with index 3. See also DEFAULTKEY for key index.</entry></row><row><entry align="left">wep-key-flags</entry><entry align="left">WEP_KEY_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for KEY<i>, KEY_PASSPHRASE<i> password. (see <xref linkend="secrets-flags"/> for _FLAGS values)</entry></row><row><entry align="left">psk</entry><entry align="left">WPA_PSK</entry><entry align="left"/><entry align="left">Pre-Shared-Key for WPA networks.</entry></row><row><entry align="left">psk-flags</entry><entry align="left">WPA_PSK_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for WPA_PSK_FLAGS. (see <xref linkend="secrets-flags"/> for _FLAGS values)<emphasis role="bold"> + +Example: </emphasis>WPA_PSK_FLAGS=user</entry></row><row><entry align="left">leap-password</entry><entry align="left">IEEE_8021X_PASSWORD<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password for LEAP. It can also go to "key-" lookaside file, or it can be owned by a secret agent.</entry></row><row><entry align="left">leap-password-flags</entry><entry align="left">IEEE_8021X_PASSWORD_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for IEEE_8021X_PASSWORD_FLAGS. (see <xref linkend="secrets-flags"/> for _FLAGS values)</entry></row><row><entry align="left">wep-key-type</entry><entry align="left">KEY<i> or KEY_PASSPHRASE<i><emphasis>(+)</emphasis>; KEY_TYPE<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">KEY is used for "key" type (10 or 26 hexadecimal characters, or 5 or 13 character string prefixed with "s:"). KEY_PASSPHRASE is used for WEP passphrases. KEY_TYPE specifies the key type and can be either 'key' or 'passphrase'. KEY_TYPE is redundant and can be omitted.<emphasis role="bold"> + +Example: </emphasis>KEY1=s:ahoj, KEY1=0a1c45bc02, KEY_PASSPHRASE1=mysupersecretkey</entry></row><row><entry align="left">wps-method</entry><entry align="left">WPS_METHOD</entry><entry align="left"/><entry align="left">Used to control the WPS methods to be used Valid values are "default", "auto", "disabled", "pin" and "pbc". If omitted, whatver the AP announces is used.<emphasis role="bold"> + +Example: </emphasis>WPS_METHOD=disabled, WPS_METHOD="pin pbc"</entry></row><row><entry align="left">fils</entry><entry align="left">FILS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Enables or disables FILS (802.11ai)<emphasis role="bold"> + +Example: </emphasis>FILS=required<emphasis role="bold"> + +Allowed values: </emphasis>default, disable, optional, required</entry></row></tbody></tgroup></table><table><title>802-1x setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">eap</entry><entry align="left">IEEE_8021X_EAP_METHODS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">EAP method for 802.1X authentication.<emphasis role="bold"> Example: </emphasis>IEEE_8021X_EAP_METHODS=PEAP<emphasis role="bold"> @@ -216,17 +264,21 @@ Example: </emphasis>IEEE_8021X_INNER_CLIENT_CERT=/home/joe/mycert.crt</entry></r Example: </emphasis>IEEE_8021X_PASSWORD_RAW=041c8320083aa4bf</entry></row><row><entry align="left">password-raw-flags</entry><entry align="left">IEEE_8021X_PASSWORD_RAW_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">The secret flags for password-raw.</entry></row><row><entry align="left">private-key</entry><entry align="left">IEEE_8021X_PRIVATE_KEY<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Private key for EAP-TLS.<emphasis role="bold"> -Example: </emphasis>IEEE_8021X_PRIVATE_KEY=/home/joe/mykey.p12</entry></row><row><entry align="left">private-key-password</entry><entry align="left">IEEE_8021X_PRIVATE_KEY_PASSWORD<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password for IEEE_8021X_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.</entry></row><row><entry align="left">private-key-password-flags</entry><entry align="left">IEEE_8021X_PRIVATE_KEY_PASSWORD_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for IEEE_8021X_PRIVATE_KEY_PASSWORD password. (see <xref linkend="secrets-flags"/> for _FLAGS values)</entry></row><row><entry align="left">phase2-private-key</entry><entry align="left">IEEE_8021X_INNER_PRIVATE_KEY<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Private key for inner authentication method for EAP-TLS.</entry></row><row><entry align="left">phase2-private-key-password</entry><entry align="left">IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password for IEEE_8021X_INNER_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.</entry></row><row><entry align="left">phase2-private-key-password-flags</entry><entry align="left">IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD password. (see <xref linkend="secrets-flags"/> for _FLAGS values)</entry></row><row><entry align="left">pin</entry><entry align="left">IEEE_8021X_PIN<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">The pin secret used for EAP authentication methods.</entry></row><row><entry align="left">pin-flags</entry><entry align="left">IEEE_8021X_PIN_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">The secret flags for the pin property.</entry></row><row><entry align="left">system-ca-certs</entry><entry align="left">IEEE_8021X_SYSTEM_CA_CERTS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">a boolean value.</entry></row><row><entry align="left">auth-timeout</entry><entry align="left">IEEE_8021X_AUTH_TIMEOUT<emphasis>(+)</emphasis></entry><entry align="left">0</entry><entry align="left">Timeout in seconds for the 802.1X authentication. Zero means the global default or 25.</entry></row><row><entry align="left">optional</entry><entry align="left">IEEE_8021X_OPTIONAL<emphasis>(+)</emphasis> default=no</entry><entry align="left"/><entry align="left">whether the 802.1X authentication is optional</entry></row></tbody></tgroup></table><table><title>bond-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">queue-id</entry><entry align="left">BONDING_OPTS: queue-id=</entry><entry align="left">0</entry><entry align="left">Queue ID.<emphasis role="bold"> +Example: </emphasis>IEEE_8021X_PRIVATE_KEY=/home/joe/mykey.p12</entry></row><row><entry align="left">private-key-password</entry><entry align="left">IEEE_8021X_PRIVATE_KEY_PASSWORD<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password for IEEE_8021X_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.</entry></row><row><entry align="left">private-key-password-flags</entry><entry align="left">IEEE_8021X_PRIVATE_KEY_PASSWORD_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for IEEE_8021X_PRIVATE_KEY_PASSWORD password. (see <xref linkend="secrets-flags"/> for _FLAGS values)</entry></row><row><entry align="left">phase2-private-key</entry><entry align="left">IEEE_8021X_INNER_PRIVATE_KEY<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Private key for inner authentication method for EAP-TLS.</entry></row><row><entry align="left">phase2-private-key-password</entry><entry align="left">IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password for IEEE_8021X_INNER_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.</entry></row><row><entry align="left">phase2-private-key-password-flags</entry><entry align="left">IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD password. (see <xref linkend="secrets-flags"/> for _FLAGS values)</entry></row><row><entry align="left">pin</entry><entry align="left">IEEE_8021X_PIN<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">The pin secret used for EAP authentication methods.</entry></row><row><entry align="left">pin-flags</entry><entry align="left">IEEE_8021X_PIN_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">The secret flags for the pin property.</entry></row><row><entry align="left">system-ca-certs</entry><entry align="left">IEEE_8021X_SYSTEM_CA_CERTS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">a boolean value.</entry></row><row><entry align="left">auth-timeout</entry><entry align="left">IEEE_8021X_AUTH_TIMEOUT<emphasis>(+)</emphasis></entry><entry align="left">0</entry><entry align="left">Timeout in seconds for the 802.1X authentication. Zero means the global default or 25.</entry></row><row><entry align="left">optional</entry><entry align="left">IEEE_8021X_OPTIONAL<emphasis>(+)</emphasis> default=no</entry><entry align="left"/><entry align="left">whether the 802.1X authentication is optional</entry></row></tbody></tgroup></table><table><title>802-3-ethernet setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">port</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not saved by the plugin.</entry></row><row><entry align="left">speed</entry><entry align="left">ETHTOOL_OPTS</entry><entry align="left"/><entry align="left">Fixed speed for the ethernet link. It is added as "speed" parameter in the ETHTOOL_OPTS variable.</entry></row><row><entry align="left">duplex</entry><entry align="left">ETHTOOL_OPTS</entry><entry align="left"/><entry align="left">Fixed duplex mode for the ethernet link. It is added as "duplex" parameter in the ETHOOL_OPTS variable.</entry></row><row><entry align="left">auto-negotiate</entry><entry align="left">ETHTOOL_OPTS</entry><entry align="left"/><entry align="left">Whether link speed and duplex autonegotiation is enabled. It is not saved only if disabled and no values are provided for the "speed" and "duplex" parameters (skips link configuration).</entry></row><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device.</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left">MACADDR</entry><entry align="left"/><entry align="left">Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).</entry></row><row><entry align="left">generate-mac-address-mask</entry><entry align="left">GENERATE_MAC_ADDRESS_MASK<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">the MAC address mask for generating randomized and stable cloned-mac-address.</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left">HWADDR_BLACKLIST<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">It denies usage of the connection for any device whose address is listed.<emphasis role="bold"> -Allowed values: </emphasis>0 - 65535</entry></row></tbody></tgroup></table><table><title>bond setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">options</entry><entry align="left">BONDING_OPTS</entry><entry align="left"/><entry align="left">Bonding options.<emphasis role="bold"> +Example: </emphasis>HWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55"</entry></row><row><entry align="left">mtu</entry><entry align="left">MTU</entry><entry align="left"/><entry align="left">MTU of the interface.</entry></row><row><entry align="left">s390-subchannels</entry><entry align="left">SUBCHANNELS</entry><entry align="left"/><entry align="left">Subchannels for IBM S390 hosts.<emphasis role="bold"> -Example: </emphasis>BONDING_OPTS="miimon=100 mode=broadcast"</entry></row></tbody></tgroup></table><table><title>bridge-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">priority</entry><entry align="left">BRIDGING_OPTS: priority=</entry><entry align="left">32</entry><entry align="left">STP priority.<emphasis role="bold"> +Example: </emphasis>SUBCHANNELS=0.0.b00a,0.0.b00b,0.0.b00c</entry></row><row><entry align="left">s390-nettype</entry><entry align="left">NETTYPE</entry><entry align="left"/><entry align="left">Network type of the S390 host.<emphasis role="bold"> -Allowed values: </emphasis>0 - 63</entry></row><row><entry align="left">path-cost</entry><entry align="left">BRIDGING_OPTS: path_cost=</entry><entry align="left">100</entry><entry align="left">STP cost.<emphasis role="bold"> +Example: </emphasis>NETTYPE=qeth<emphasis role="bold"> -Allowed values: </emphasis>1 - 65535</entry></row><row><entry align="left">hairpin-mode</entry><entry align="left">BRIDGING_OPTS: hairpin_mode=</entry><entry align="left">yes</entry><entry align="left">Hairpin mode of the bridge port.</entry></row><row><entry align="left">vlans</entry><entry align="left">BRIDGE_PORT_VLANS</entry><entry align="left"/><entry align="left">List of VLANs on the bridge port<emphasis role="bold"> +Allowed values: </emphasis>"qeth", "lcs" or "ctc"</entry></row><row><entry align="left">s390-options</entry><entry align="left">OPTIONS and PORTNAME, CTCPROTO,</entry><entry align="left"/><entry align="left">S390 device options. All options go to OPTIONS, except for "portname" and "ctcprot" that have their own variables.</entry></row><row><entry align="left">wake-on-lan</entry><entry align="left">ETHTOOL_OPTS, ETHTOOL_WAKE_ON_LAN</entry><entry align="left"/><entry align="left">Wake on Lan mode for ethernet. The setting "ignore" is expressed with "ETHTOOL_WAKE_ON_LAN=ignore". Otherwise, the "ETHTOOL_OPTS" variable is set with the value "wol" and several of the characters "p|u|m|b|a|g|s|f|d" as explained in the ethtool manual page.</entry></row><row><entry align="left">wake-on-lan-password</entry><entry align="left">ETHTOOL_OPTS</entry><entry align="left"/><entry align="left">Password for secure-on based Wake-on-Lan. It is added as "sopass" parameter in the ETHTOOL_OPTS variable.<emphasis role="bold"> + +Example: </emphasis>ETHTOOL_OPTS="wol gs sopass 00:11:22:33:44:55"</entry></row><row><entry align="left">accept-all-mac-addresses</entry><entry align="left">ACCEPT_ALL_MAC_ADDRESSES</entry><entry align="left"/><entry align="left">Enforce the interface to accept all the packets.</entry></row></tbody></tgroup></table><table><title>bond setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">options</entry><entry align="left">BONDING_OPTS</entry><entry align="left"/><entry align="left">Bonding options.<emphasis role="bold"> -Example: </emphasis>BRIDGE_PORT_VLANS="1 pvid untagged,20,300-400 untagged"</entry></row></tbody></tgroup></table><table><title>bridge setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">mac-address</entry><entry align="left">BRIDGE_MACADDR<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">MAC address of the bridge. Note that this requires a recent kernel support, originally introduced in 3.15 upstream kernel) BRIDGE_MACADDR for bridges is an NM extension.</entry></row><row><entry align="left">stp</entry><entry align="left">STP</entry><entry align="left">no</entry><entry align="left">Span tree protocol participation.</entry></row><row><entry align="left">priority</entry><entry align="left">BRIDGING_OPTS: priority=</entry><entry align="left">32768</entry><entry align="left">STP priority.<emphasis role="bold"> +Example: </emphasis>BONDING_OPTS="miimon=100 mode=broadcast"</entry></row></tbody></tgroup></table><table><title>bond-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">queue-id</entry><entry align="left">BONDING_OPTS: queue-id=</entry><entry align="left">0</entry><entry align="left">Queue ID.<emphasis role="bold"> + +Allowed values: </emphasis>0 - 65535</entry></row></tbody></tgroup></table><table><title>bridge setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">mac-address</entry><entry align="left">BRIDGE_MACADDR<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">MAC address of the bridge. Note that this requires a recent kernel support, originally introduced in 3.15 upstream kernel) BRIDGE_MACADDR for bridges is an NM extension.</entry></row><row><entry align="left">stp</entry><entry align="left">STP</entry><entry align="left">no</entry><entry align="left">Span tree protocol participation.</entry></row><row><entry align="left">priority</entry><entry align="left">BRIDGING_OPTS: priority=</entry><entry align="left">32768</entry><entry align="left">STP priority.<emphasis role="bold"> Allowed values: </emphasis>0 - 32768</entry></row><row><entry align="left">forward-delay</entry><entry align="left">DELAY</entry><entry align="left">15</entry><entry align="left">STP forwarding delay.<emphasis role="bold"> @@ -276,7 +328,13 @@ Example: </emphasis>BRIDGING_OPTS="multicast_query_response_interval=2000"</entr Example: </emphasis>BRIDGING_OPTS="multicast_startup_query_count=4"</entry></row><row><entry align="left">multicast-startup-query-interval</entry><entry align="left">BRIDGING_OPTS: multicast_startup_query_interval=</entry><entry align="left">3125</entry><entry align="left"><emphasis role="bold"> -Example: </emphasis>BRIDGING_OPTS="multicast_startup_query_interval=4000"</entry></row></tbody></tgroup></table><table><title>connection setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">id</entry><entry align="left">NAME<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">User friendly name for the connection profile.</entry></row><row><entry align="left">uuid</entry><entry align="left">UUID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">UUID for the connection profile. When missing, NetworkManager creates the UUID itself (by hashing the filename).</entry></row><row><entry align="left">stable-id</entry><entry align="left">STABLE_ID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Token to generate stable IDs.</entry></row><row><entry align="left">interface-name</entry><entry align="left">DEVICE</entry><entry align="left"/><entry align="left">Interface name of the device this profile is bound to. The variable can be left out when the profile should apply for more devices. Note that DEVICE can be required for some connection types.</entry></row><row><entry align="left">type</entry><entry align="left">TYPE (DEVICETYPE, DEVICE)</entry><entry align="left"/><entry align="left">Base type of the connection. DEVICETYPE is used for teaming connections.<emphasis role="bold"> +Example: </emphasis>BRIDGING_OPTS="multicast_startup_query_interval=4000"</entry></row></tbody></tgroup></table><table><title>bridge-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">priority</entry><entry align="left">BRIDGING_OPTS: priority=</entry><entry align="left">32</entry><entry align="left">STP priority.<emphasis role="bold"> + +Allowed values: </emphasis>0 - 63</entry></row><row><entry align="left">path-cost</entry><entry align="left">BRIDGING_OPTS: path_cost=</entry><entry align="left">100</entry><entry align="left">STP cost.<emphasis role="bold"> + +Allowed values: </emphasis>1 - 65535</entry></row><row><entry align="left">hairpin-mode</entry><entry align="left">BRIDGING_OPTS: hairpin_mode=</entry><entry align="left">yes</entry><entry align="left">Hairpin mode of the bridge port.</entry></row><row><entry align="left">vlans</entry><entry align="left">BRIDGE_PORT_VLANS</entry><entry align="left"/><entry align="left">List of VLANs on the bridge port<emphasis role="bold"> + +Example: </emphasis>BRIDGE_PORT_VLANS="1 pvid untagged,20,300-400 untagged"</entry></row></tbody></tgroup></table><table><title>connection setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">id</entry><entry align="left">NAME<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">User friendly name for the connection profile.</entry></row><row><entry align="left">uuid</entry><entry align="left">UUID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">UUID for the connection profile. When missing, NetworkManager creates the UUID itself (by hashing the filename).</entry></row><row><entry align="left">stable-id</entry><entry align="left">STABLE_ID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Token to generate stable IDs.</entry></row><row><entry align="left">interface-name</entry><entry align="left">DEVICE</entry><entry align="left"/><entry align="left">Interface name of the device this profile is bound to. The variable can be left out when the profile should apply for more devices. Note that DEVICE can be required for some connection types.</entry></row><row><entry align="left">type</entry><entry align="left">TYPE (DEVICETYPE, DEVICE)</entry><entry align="left"/><entry align="left">Base type of the connection. DEVICETYPE is used for teaming connections.<emphasis role="bold"> Example: </emphasis>TYPE=Ethernet; TYPE=Bond; TYPE=Bridge; DEVICETYPE=TeamPort<emphasis role="bold"> @@ -357,7 +415,7 @@ Example: </emphasis>DCB_PG_UP2TC=01623701</entry></row></tbody></tgroup></table> Example: </emphasis>HOSTNAME_PRIORITY=50</entry></row><row><entry align="left">from-dhcp</entry><entry align="left">HOSTNAME_FROM_DHCP<emphasis>(+)</emphasis></entry><entry align="left">missing variable means global default or 1</entry><entry align="left">whether the system hostname can be determined from DHCP<emphasis role="bold"> -Example: </emphasis>HOSTNAME_FROM_DHCP=0,1</entry></row><row><entry align="left">from-dhcp</entry><entry align="left">HOSTNAME_FROM_DNS_LOOKUP<emphasis>(+)</emphasis></entry><entry align="left">missing variable means global default or 1</entry><entry align="left">whether the system hostname can be determined from reverse DNS lookup<emphasis role="bold"> +Example: </emphasis>HOSTNAME_FROM_DHCP=0,1</entry></row><row><entry align="left">from-dns-lookup</entry><entry align="left">HOSTNAME_FROM_DNS_LOOKUP<emphasis>(+)</emphasis></entry><entry align="left">missing variable means global default or 1</entry><entry align="left">whether the system hostname can be determined from reverse DNS lookup<emphasis role="bold"> Example: </emphasis>HOSTNAME_FROM_DNS_LOOKUP=0,1</entry></row><row><entry align="left">only-best-device</entry><entry align="left">HOSTNAME_ONLY_FROM_DEFAULT<emphasis>(+)</emphasis></entry><entry align="left">missing variable means global default or 1</entry><entry align="left">whether the hostname can be determined only from devices with the default route<emphasis role="bold"> @@ -379,13 +437,15 @@ Example: </emphasis>GATEWAY=10.5.5.1</entry></row><row><entry align="left">route Example: </emphasis>RES_OPTIONS=ndots:2 timeout:3</entry></row><row><entry align="left">dns-priority</entry><entry align="left">IPV4_DNS_PRIORITY<emphasis>(+)</emphasis></entry><entry align="left">0</entry><entry align="left">The priority for DNS servers of this connection. Lower values have higher priority. If zero, the default value will be used (50 for VPNs, 100 for other connections). A negative value prevents DNS from other connections with greater values to be used.<emphasis role="bold"> -Example: </emphasis>IPV4_DNS_PRIORITY=20</entry></row><row><entry align="left">dhcp-client-id</entry><entry align="left">DHCP_CLIENT_ID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A string sent to the DHCP server to identify the local machine. A binary value can be specified using hex notation ('aa:bb:cc').<emphasis role="bold"> +Example: </emphasis>IPV4_DNS_PRIORITY=20</entry></row><row><entry align="left">auto-route-ext-gw</entry><entry align="left">IPV4_AUTO_ROUTE_EXT_GW<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">VPN connections will default to add the route automatically unless this setting is set to %FALSE. For other connection types, adding such an automatic route is currently not supported and setting this to %TRUE has no effect.</entry></row><row><entry align="left">replace-local-rule</entry><entry align="left">IPV4_REPLACE_LOCAL_RULE<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to %TRUE.</entry></row><row><entry align="left">dhcp-client-id</entry><entry align="left">DHCP_CLIENT_ID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A string sent to the DHCP server to identify the local machine. A binary value can be specified using hex notation ('aa:bb:cc').<emphasis role="bold"> Example: </emphasis>DHCP_CLIENT_ID=ax-srv-1; DHCP_CLIENT_ID=01:44:44:44:44:44:44</entry></row><row><entry align="left">dad-timeout</entry><entry align="left">ACD_TIMEOUT<emphasis>(+)</emphasis>, ARPING_WAIT</entry><entry align="left">missing variable means global default (config override or zero)</entry><entry align="left">Timeout (in milliseconds for ACD_TIMEOUT or in seconds for ARPING_WAIT) for address conflict detection before configuring IPv4 addresses. 0 turns off the ACD completely, -1 means default value.<emphasis role="bold"> Example: </emphasis>ACD_TIMEOUT=2000 or ARPING_WAIT=2</entry></row><row><entry align="left">dhcp-timeout</entry><entry align="left">IPV4_DHCP_TIMEOUT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A timeout after which the DHCP transaction fails in case of no response.<emphasis role="bold"> -Example: </emphasis>IPV4_DHCP_TIMEOUT=10</entry></row><row><entry align="left">dhcp-fqdn</entry><entry align="left">DHCP_FQDN</entry><entry align="left"/><entry align="left">FQDN to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used.<emphasis role="bold"> +Example: </emphasis>IPV4_DHCP_TIMEOUT=10</entry></row><row><entry align="left">dhcp-hostname-flags</entry><entry align="left">DHCP_HOSTNAME_FLAGS</entry><entry align="left"/><entry align="left">flags for the DHCP hostname and FQDN properties<emphasis role="bold"> + +Example: </emphasis>DHCP_HOSTNAME_FLAGS=5</entry></row><row><entry align="left">dhcp-fqdn</entry><entry align="left">DHCP_FQDN</entry><entry align="left"/><entry align="left">FQDN to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used.<emphasis role="bold"> Example: </emphasis>DHCP_FQDN=foo.bar.com</entry></row><row><entry align="left">dhcp-vendor-class-identifier</entry><entry align="left">DHCP_VENDOR_CLASS_IDENTIFIER<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">The Vendor Class Identifier DHCP option (60).<emphasis role="bold"> @@ -403,7 +463,7 @@ Example: </emphasis>DHCPV6_HOSTNAME_FLAGS=5</entry></row><row><entry align="left Example: </emphasis>IPV6_DNS_PRIORITY=20</entry></row><row><entry align="left">dns-options</entry><entry align="left">IPV6_RES_OPTIONS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">List of DNS options to be added to /etc/resolv.conf<emphasis role="bold"> -Example: </emphasis>IPV6_RES_OPTIONS=ndots:2 timeout:3</entry></row><row><entry align="left">ip6-privacy</entry><entry align="left">IPV6_PRIVACY, IPV6_PRIVACY_PREFER_PUBLIC_IP<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Configure IPv6 Privacy Extensions for SLAAC (RFC4941).<emphasis role="bold"> +Example: </emphasis>IPV6_RES_OPTIONS=ndots:2 timeout:3</entry></row><row><entry align="left">auto-route-ext-gw</entry><entry align="left">IPV6_AUTO_ROUTE_EXT_GW<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">VPN connections will default to add the route automatically unless this setting is set to %FALSE. For other connection types, adding such an automatic route is currently not supported and setting this to %TRUE has no effect.</entry></row><row><entry align="left">replace-local-rule</entry><entry align="left">IPV6_REPLACE_LOCAL_RULE<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to %TRUE.</entry></row><row><entry align="left">ip6-privacy</entry><entry align="left">IPV6_PRIVACY, IPV6_PRIVACY_PREFER_PUBLIC_IP<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Configure IPv6 Privacy Extensions for SLAAC (RFC4941).<emphasis role="bold"> Example: </emphasis>IPV6_PRIVACY=rfc3041 IPV6_PRIVACY_PREFER_PUBLIC_IP=yes<emphasis role="bold"> @@ -413,13 +473,13 @@ Example: </emphasis>IPV6_ADDR_GEN_MODE=stable-privacy<emphasis role="bold"> Allowed values: </emphasis>IPV6_ADDR_GEN_MODE: default, default-or-eui64, eui64, stable-privacy</entry></row><row><entry align="left">token</entry><entry align="left">IPV6_TOKEN</entry><entry align="left"/><entry align="left">The IPv6 tokenized interface identifier token<emphasis role="bold"> -Example: </emphasis>IPV6_TOKEN=::53</entry></row><row><entry align="left">dhcp-timeout</entry><entry align="left">IPV6_RA_TIMEOUT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A timeout for waiting Router Advertisements in seconds.<emphasis role="bold"> +Example: </emphasis>IPV6_TOKEN=::53</entry></row><row><entry align="left">ra-timeout</entry><entry align="left">IPV6_RA_TIMEOUT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A timeout for waiting Router Advertisements in seconds.<emphasis role="bold"> Example: </emphasis>IPV6_RA_TIMEOUT=10</entry></row><row><entry align="left">dhcp-duid</entry><entry align="left">DHCPV6_DUID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A string sent to the DHCPv6 server to identify the local machine. Apart from the special values "lease", "stable-llt", "stable-ll", "stable-uuid", "llt" and "ll" a binary value in hex format is expected. An hex string where each octet is separated by a colon is also accepted.<emphasis role="bold"> -Example: </emphasis>DHCPV6_DUID=LL; DHCPV6_DUID=0301deadbeef0001; DHCPV6_DUID=03:01:de:ad:be:ef:00:01</entry></row></tbody></tgroup></table><table><title>match setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">path</entry><entry align="left">MATCH_PATH</entry><entry align="left"/><entry align="left">space-separated list of paths to match against the udev property ID_PATHS of devices<emphasis role="bold"> +Example: </emphasis>DHCPV6_DUID=LL; DHCPV6_DUID=0301deadbeef0001; DHCPV6_DUID=03:01:de:ad:be:ef:00:01</entry></row></tbody></tgroup></table><table><title>loopback setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">mtu</entry><entry align="left">MTU</entry><entry align="left"/><entry align="left">MTU of the interface.</entry></row></tbody></tgroup></table><table><title>match setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">path</entry><entry align="left">MATCH_PATH</entry><entry align="left"/><entry align="left">space-separated list of paths to match against the udev property ID_PATHS of devices<emphasis role="bold"> -Example: </emphasis>MATCH_PATH="pci-0000:01:00.0 pci-0000:0c:00.0"</entry></row></tbody></tgroup></table><table><title>ovs-bridge setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-dpdk setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-external-ids setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-interface setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-patch setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>proxy setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">method</entry><entry align="left">PROXY_METHOD<emphasis>(+)</emphasis></entry><entry align="left">none</entry><entry align="left">Method for proxy configuration. For "auto", WPAD is used for proxy configuration, or set the PAC file via PAC_URL or PAC_SCRIPT.<emphasis role="bold"> +Example: </emphasis>MATCH_PATH="pci-0000:01:00.0 pci-0000:0c:00.0"</entry></row></tbody></tgroup></table><table><title>ovs-bridge setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-dpdk setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-external-ids setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-interface setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-other-config setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-patch setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>proxy setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">method</entry><entry align="left">PROXY_METHOD<emphasis>(+)</emphasis></entry><entry align="left">none</entry><entry align="left">Method for proxy configuration. For "auto", WPAD is used for proxy configuration, or set the PAC file via PAC_URL or PAC_SCRIPT.<emphasis role="bold"> Allowed values: </emphasis>none, auto</entry></row><row><entry align="left">browser-only</entry><entry align="left">BROWSER_ONLY<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Whether the proxy configuration is for browser only.</entry></row><row><entry align="left">pac-url</entry><entry align="left">PAC_URL<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">URL for PAC file.<emphasis role="bold"> @@ -433,77 +493,21 @@ Example: </emphasis>SRIOV_VF10="mac=00:11:22:33:44:55", ...</entry></row><row><e Example: </emphasis>SRIOV_AUTOPROBE_DRIVERS=0,1</entry></row></tbody></tgroup></table><table><title>tc setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">qdiscs</entry><entry align="left">QDISC1<emphasis>(+)</emphasis>, QDISC2<emphasis>(+)</emphasis>, ..., TC_COMMIT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Queueing disciplines to set on the interface. When no QDISC1, QDISC2, ..., FILTER1, FILTER2, ... keys are present, NetworkManager doesn't touch qdiscs and filters present on the interface, unless TC_COMMIT is set to 'yes'.<emphasis role="bold"> -Example: </emphasis>QDISC1=ingress, QDISC2="root handle 1234: fq_codel"</entry></row><row><entry align="left">qdiscs</entry><entry align="left">FILTER1<emphasis>(+)</emphasis>, FILTER2<emphasis>(+)</emphasis>, ..., TC_COMMIT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Traffic filters to set on the interface. When no QDISC1, QDISC2, ..., FILTER1, FILTER2, ... keys are present, NetworkManager doesn't touch qdiscs and filters present on the interface, unless TC_COMMIT is set to 'yes'.<emphasis role="bold"> +Example: </emphasis>QDISC1=ingress, QDISC2="root handle 1234: fq_codel"</entry></row><row><entry align="left">tfilters</entry><entry align="left">FILTER1<emphasis>(+)</emphasis>, FILTER2<emphasis>(+)</emphasis>, ..., TC_COMMIT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Traffic filters to set on the interface. When no QDISC1, QDISC2, ..., FILTER1, FILTER2, ... keys are present, NetworkManager doesn't touch qdiscs and filters present on the interface, unless TC_COMMIT is set to 'yes'.<emphasis role="bold"> -Example: </emphasis>FILTER1="parent ffff: matchall action simple sdata Input", ...</entry></row></tbody></tgroup></table><table><title>team-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">config</entry><entry align="left">TEAM_PORT_CONFIG</entry><entry align="left"/><entry align="left">Team port configuration in JSON. See man teamd.conf for details.</entry></row></tbody></tgroup></table><table><title>team setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">config</entry><entry align="left">TEAM_CONFIG</entry><entry align="left"/><entry align="left">Team configuration in JSON. See man teamd.conf for details.</entry></row></tbody></tgroup></table><table><title>user setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">data</entry><entry align="left">NM_USER_*</entry><entry align="left"/><entry align="left">each key/value pair is stored as a separate variable with name composed by concatenating NM_USER_ with the encoded key. The key is encoded by substituting lowercase letters with uppercase and prepending uppercase letters with an underscore. A dot is encoded as a double underscore. Remaining characters are encoded as underscore followed by a 3 digit octal representation of the character.<emphasis role="bold"> +Example: </emphasis>FILTER1="parent ffff: matchall action simple sdata Input", ...</entry></row></tbody></tgroup></table><table><title>team setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">config</entry><entry align="left">TEAM_CONFIG</entry><entry align="left"/><entry align="left">Team configuration in JSON. See man teamd.conf for details.</entry></row></tbody></tgroup></table><table><title>team-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">config</entry><entry align="left">TEAM_PORT_CONFIG</entry><entry align="left"/><entry align="left">Team port configuration in JSON. See man teamd.conf for details.</entry></row></tbody></tgroup></table><table><title>user setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">data</entry><entry align="left">NM_USER_*</entry><entry align="left"/><entry align="left">each key/value pair is stored as a separate variable with name composed by concatenating NM_USER_ with the encoded key. The key is encoded by substituting lowercase letters with uppercase and prepending uppercase letters with an underscore. A dot is encoded as a double underscore. Remaining characters are encoded as underscore followed by a 3 digit octal representation of the character.<emphasis role="bold"> Example: </emphasis>NM_USER_FOO__BAR=something</entry></row></tbody></tgroup></table><table><title>veth setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>vlan setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">parent</entry><entry align="left">DEVICE or PHYSDEV</entry><entry align="left"/><entry align="left">Parent interface of the VLAN.</entry></row><row><entry align="left">id</entry><entry align="left">VLAN_ID, DEVICE.</entry><entry align="left"/><entry align="left">VLAN identifier. If VLAN_ID is not set, it is attempted to be detected from the suffix of DEVICE=. Note that older versions of NetworkManager had a bug where they would prefer the detected ID from the DEVICE over VLAN_ID.</entry></row><row><entry align="left">flags</entry><entry align="left">GVRP, MVRP, VLAN_FLAGS</entry><entry align="left"/><entry align="left">VLAN flags.<emphasis role="bold"> -Allowed values: </emphasis>"yes or "no" for GVRP and MVRP; "LOOSE_BINDING" and "NO_REORDER_HDR" for VLAN_FLAGS</entry></row><row><entry align="left">ingress-priority-map</entry><entry align="left">VLAN_INGRESS_PRIORITY_MAP</entry><entry align="left"/><entry align="left">Ingress priority mapping.<emphasis role="bold"> +Allowed values: </emphasis>"yes or "no" for GVRP and MVRP; "LOOSE_BINDING" and "NO_REORDER_HDR" for VLAN_FLAGS</entry></row><row><entry align="left">protocol</entry><entry align="left">VLAN_PROTOCOL</entry><entry align="left"/><entry align="left">VLAN protocol.<emphasis role="bold"> + +Example: </emphasis>VLAN_PROTOCOL="802.1ad"</entry></row><row><entry align="left">ingress-priority-map</entry><entry align="left">VLAN_INGRESS_PRIORITY_MAP</entry><entry align="left"/><entry align="left">Ingress priority mapping.<emphasis role="bold"> Example: </emphasis>VLAN_INGRESS_PRIORITY_MAP=4:2,3:5</entry></row><row><entry align="left">egress-priority-map</entry><entry align="left">VLAN_EGRESS_PRIORITY_MAP</entry><entry align="left"/><entry align="left">Egress priority mapping.<emphasis role="bold"> Example: </emphasis>VLAN_EGRESS_PRIORITY_MAP=5:4,4:1,3:7</entry></row><row><entry align="left">interface-name</entry><entry align="left">PHYSDEV and VLAN_ID, or DEVICE</entry><entry align="left"/><entry align="left">VLAN interface name. If all variables are set, parent device from PHYSDEV takes precedence over DEVICE, but VLAN id from DEVICE takes precedence over VLAN_ID.<emphasis role="bold"> -Example: </emphasis>PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12</entry></row></tbody></tgroup></table><table><title>vrf setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>wifi-p2p setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>802-3-ethernet setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">port</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not saved by the plugin.</entry></row><row><entry align="left">speed</entry><entry align="left">ETHTOOL_OPTS</entry><entry align="left"/><entry align="left">Fixed speed for the ethernet link. It is added as "speed" parameter in the ETHTOOL_OPTS variable.</entry></row><row><entry align="left">duplex</entry><entry align="left">ETHTOOL_OPTS</entry><entry align="left"/><entry align="left">Fixed duplex mode for the ethernet link. It is added as "duplex" parameter in the ETHOOL_OPTS variable.</entry></row><row><entry align="left">auto-negotiate</entry><entry align="left">ETHTOOL_OPTS</entry><entry align="left"/><entry align="left">Whether link speed and duplex autonegotiation is enabled. It is not saved only if disabled and no values are provided for the "speed" and "duplex" parameters (skips link configuration).</entry></row><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device.</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left">MACADDR</entry><entry align="left"/><entry align="left">Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).</entry></row><row><entry align="left">generate-mac-address-mask</entry><entry align="left">GENERATE_MAC_ADDRESS_MASK<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">the MAC address mask for generating randomized and stable cloned-mac-address.</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left">HWADDR_BLACKLIST<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">It denies usage of the connection for any device whose address is listed.<emphasis role="bold"> - -Example: </emphasis>HWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55"</entry></row><row><entry align="left">mtu</entry><entry align="left">MTU</entry><entry align="left"/><entry align="left">MTU of the interface.</entry></row><row><entry align="left">s390-subchannels</entry><entry align="left">SUBCHANNELS</entry><entry align="left"/><entry align="left">Subchannels for IBM S390 hosts.<emphasis role="bold"> - -Example: </emphasis>SUBCHANNELS=0.0.b00a,0.0.b00b,0.0.b00c</entry></row><row><entry align="left">s390-nettype</entry><entry align="left">NETTYPE</entry><entry align="left"/><entry align="left">Network type of the S390 host.<emphasis role="bold"> - -Example: </emphasis>NETTYPE=qeth<emphasis role="bold"> - -Allowed values: </emphasis>"qeth", "lcs" or "ctc"</entry></row><row><entry align="left">s390-options</entry><entry align="left">OPTIONS and PORTNAME, CTCPROTO,</entry><entry align="left"/><entry align="left">S390 device options. All options go to OPTIONS, except for "portname" and "ctcprot" that have their own variables.</entry></row><row><entry align="left">wake-on-lan</entry><entry align="left">ETHTOOL_OPTS, ETHTOOL_WAKE_ON_LAN</entry><entry align="left"/><entry align="left">Wake on Lan mode for ethernet. The setting "ignore" is expressed with "ETHTOOL_WAKE_ON_LAN=ignore". Otherwise, the "ETHTOOL_OPTS" variable is set with the value "wol" and several of the characters "p|u|m|b|a|g|s|f|d" as explained in the ethtool manual page.</entry></row><row><entry align="left">wake-on-lan-password</entry><entry align="left">ETHTOOL_OPTS</entry><entry align="left"/><entry align="left">Password for secure-on based Wake-on-Lan. It is added as "sopass" parameter in the ETHTOOL_OPTS variable.<emphasis role="bold"> - -Example: </emphasis>ETHTOOL_OPTS="wol gs sopass 00:11:22:33:44:55"</entry></row><row><entry align="left">accept-all-mac-addresses</entry><entry align="left">ACCEPT_ALL_MAC_ADDRESSES</entry><entry align="left"/><entry align="left">Enforce the interface to accept all the packets.</entry></row></tbody></tgroup></table><table><title>wireguard setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>802-11-wireless-security setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">key-mgmt</entry><entry align="left">KEY_MGMT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Key management method.<emphasis role="bold"> - -Allowed values: </emphasis>none, ieee8021x, owe, wpa-psk, sae, wpa-eap, wpa-eap-suite-b-192</entry></row><row><entry align="left">wep-tx-keyidx</entry><entry align="left">DEFAULTKEY</entry><entry align="left">1</entry><entry align="left">Index of active WEP key. Note that in ifcfg format the index starts counting at 1, while NetworkManager API otherwise is zero based.<emphasis role="bold"> - -Allowed values: </emphasis>1, 2, 3, 4</entry></row><row><entry align="left">auth-alg</entry><entry align="left">SECURITYMODE<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Authentication algorithm for WEP.<emphasis role="bold"> - -Allowed values: </emphasis>restricted, open, leap</entry></row><row><entry align="left">proto</entry><entry align="left">WPA_ALLOW_WPA<emphasis>(+)</emphasis>, WPA_ALLOW_WPA2<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Allowed WPA protocols, WPA and WPA2 (RSN).<emphasis role="bold"> - -Allowed values: </emphasis>yes, no</entry></row><row><entry align="left">pairwise</entry><entry align="left">CIPHER_PAIRWISE<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Restrict pairwise encryption algorithms, specified as a space separated list.<emphasis role="bold"> - -Allowed values: </emphasis>CCMP, TKIP</entry></row><row><entry align="left">group</entry><entry align="left">CIPHER_GROUP<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Restrict group/broadcast encryption algorithms, specified as a space separated list.<emphasis role="bold"> - -Allowed values: </emphasis>CCMP, TKIP, WEP40, WEP104</entry></row><row><entry align="left">pmf</entry><entry align="left">PMF<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Enables or disables PMF (802.11w)<emphasis role="bold"> - -Example: </emphasis>PMF=required<emphasis role="bold"> - -Allowed values: </emphasis>default, disable, optional, required</entry></row><row><entry align="left">leap-username</entry><entry align="left">IEEE_8021X_IDENTITY<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Login name for LEAP.</entry></row><row><entry align="left">wep-key0</entry><entry align="left">KEY1, KEY_PASSPHRASE1<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">The first WEP key (used in most networks). See also DEFAULTKEY for key index.</entry></row><row><entry align="left">wep-key1</entry><entry align="left">KEY2, KEY_PASSPHRASE2<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">WEP key with index 1. See also DEFAULTKEY for key index.</entry></row><row><entry align="left">wep-key2</entry><entry align="left">KEY3, KEY_PASSPHRASE3<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">WEP key with index 2. See also DEFAULTKEY for key index.</entry></row><row><entry align="left">wep-key3</entry><entry align="left">KEY4, KEY_PASSPHRASE4<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">WEP key with index 3. See also DEFAULTKEY for key index.</entry></row><row><entry align="left">wep-key-flags</entry><entry align="left">WEP_KEY_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for KEY<i>, KEY_PASSPHRASE<i> password. (see <xref linkend="secrets-flags"/> for _FLAGS values)</entry></row><row><entry align="left">psk</entry><entry align="left">WPA_PSK</entry><entry align="left"/><entry align="left">Pre-Shared-Key for WPA networks.</entry></row><row><entry align="left">psk-flags</entry><entry align="left">WPA_PSK_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for WPA_PSK_FLAGS. (see <xref linkend="secrets-flags"/> for _FLAGS values)<emphasis role="bold"> - -Example: </emphasis>WPA_PSK_FLAGS=user</entry></row><row><entry align="left">leap-password</entry><entry align="left">IEEE_8021X_PASSWORD<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password for LEAP. It can also go to "key-" lookaside file, or it can be owned by a secret agent.</entry></row><row><entry align="left">leap-password-flags</entry><entry align="left">IEEE_8021X_PASSWORD_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for IEEE_8021X_PASSWORD_FLAGS. (see <xref linkend="secrets-flags"/> for _FLAGS values)</entry></row><row><entry align="left">wep-key-type</entry><entry align="left">KEY<i> or KEY_PASSPHRASE<i><emphasis>(+)</emphasis>; KEY_TYPE<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">KEY is used for "key" type (10 or 26 hexadecimal characters, or 5 or 13 character string prefixed with "s:"). KEY_PASSPHRASE is used for WEP passphrases. KEY_TYPE specifies the key type and can be either 'key' or 'passphrase'. KEY_TYPE is redundant and can be omitted.<emphasis role="bold"> - -Example: </emphasis>KEY1=s:ahoj, KEY1=0a1c45bc02, KEY_PASSPHRASE1=mysupersecretkey</entry></row><row><entry align="left">wps-method</entry><entry align="left">WPS_METHOD</entry><entry align="left"/><entry align="left">Used to control the WPS methods to be used Valid values are "default", "auto", "disabled", "pin" and "pbc". If omitted, whatver the AP announces is used.<emphasis role="bold"> - -Example: </emphasis>WPS_METHOD=disabled, WPS_METHOD="pin pbc"</entry></row><row><entry align="left">fils</entry><entry align="left">FILS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Enables or disables FILS (802.11ai)<emphasis role="bold"> - -Example: </emphasis>FILS=required<emphasis role="bold"> - -Allowed values: </emphasis>default, disable, optional, required</entry></row></tbody></tgroup></table><table><title>802-11-wireless setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">ssid</entry><entry align="left">ESSID</entry><entry align="left"/><entry align="left">SSID of Wi-Fi network.<emphasis role="bold"> - -Example: </emphasis>ESSID="Quick Net"</entry></row><row><entry align="left">mode</entry><entry align="left">MODE</entry><entry align="left"/><entry align="left">Wi-Fi network mode.<emphasis role="bold"> - -Allowed values: </emphasis>Ad-Hoc, Managed (Auto) [case insensitive]</entry></row><row><entry align="left">band</entry><entry align="left">BAND<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">BAND alone is honored, but CHANNEL overrides BAND since it implies a band.<emphasis role="bold"> - -Example: </emphasis>BAND=bg<emphasis role="bold"> - -Allowed values: </emphasis>a, bg</entry></row><row><entry align="left">channel</entry><entry align="left">CHANNEL</entry><entry align="left"/><entry align="left">Channel used for the Wi-Fi communication. Channels greater than 14 mean "a" band, otherwise the band is "bg".<emphasis role="bold"> - -Example: </emphasis>CHANNEL=6</entry></row><row><entry align="left">bssid</entry><entry align="left">BSSID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Restricts association only to a single AP.<emphasis role="bold"> - -Example: </emphasis>BSSID=00:1E:BD:64:83:21</entry></row><row><entry align="left">rate</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">tx-power</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device.</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left">MACADDR</entry><entry align="left"/><entry align="left">Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).</entry></row><row><entry align="left">generate-mac-address-mask</entry><entry align="left">GENERATE_MAC_ADDRESS_MASK<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">the MAC address mask for generating randomized and stable cloned-mac-address.</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left">HWADDR_BLACKLIST<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">It denies usage of the connection for any device whose address is listed.</entry></row><row><entry align="left">seen-bssids</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">mtu</entry><entry align="left">MTU</entry><entry align="left"/><entry align="left">MTU of the wireless interface.</entry></row><row><entry align="left">hidden</entry><entry align="left">SSID_HIDDEN<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Whether the network hides the SSID.</entry></row><row><entry align="left">powersave</entry><entry align="left">POWERSAVE<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Enables or disables Wi-Fi power saving.<emphasis role="bold"> - -Example: </emphasis>POWERSAVE=enable<emphasis role="bold"> - -Allowed values: </emphasis>default, ignore, enable, disable</entry></row><row><entry align="left">mac-address-randomization</entry><entry align="left">MAC_ADDRESS_RANDOMIZATION<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Enables or disables Wi-Fi MAC address randomization.<emphasis role="bold"> - -Example: </emphasis>MAC_ADDRESS_RANDOMIZATION=always<emphasis role="bold"> - -Allowed values: </emphasis>default, never, always</entry></row><row><entry align="left">security</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is deprecated and not handled by ifcfg-rh-plugin.</entry></row><row><entry align="left">ap-isolation</entry><entry align="left">AP_ISOLATION<emphasis>(+)</emphasis></entry><entry align="left">missing variable means global default</entry><entry align="left">Whether AP isolation is enabled<emphasis role="bold"> - -Allowed values: </emphasis>"yes", "no"</entry></row></tbody></tgroup></table><table><title>wpan setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><para>The following settings are not supported by <emphasis>ifcfg-rh</emphasis> plugin:</para><para>802-11-olpc-mesh, adsl, bluetooth, cdma, dummy, generic, gsm, ip-tunnel, macsec, macvlan, ppp, pppoe, serial, tun, vpn, vxlan, wimax</para><refsect2 id="secrets-flags"><title>Secret flags</title><para> +Example: </emphasis>PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12</entry></row></tbody></tgroup></table><table><title>vrf setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>wifi-p2p setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>wireguard setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>wpan setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><para>The following settings are not supported by <emphasis>ifcfg-rh</emphasis> plugin:</para><para>802-11-olpc-mesh, adsl, bluetooth, cdma, dummy, generic, gsm, ip-tunnel, macsec, macvlan, ppp, pppoe, serial, tun, vpn, vxlan, wimax</para><refsect2 id="secrets-flags"><title>Secret flags</title><para> Each secret property in a NetworkManager setting has an associated <emphasis>flags</emphasis> property that describes how to handle that secret. In the <emphasis>ifcfg-rh</emphasis> plugin variables for secret flags have a diff --git a/man/nm-settings-keyfile.5 b/man/nm-settings-keyfile.5 index d7a1b082..fc30ddb8 100644 --- a/man/nm-settings-keyfile.5 +++ b/man/nm-settings-keyfile.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-keyfile .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: Configuration -.\" Source: NetworkManager 1.40.12 +.\" Source: NetworkManager 1.42.4 .\" Language: English .\" -.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.40\&.12" "Configuration" +.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.42\&.4" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -230,7 +230,7 @@ introduces aliases that can be used instead of the names\&. .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&1.\ \&bridge setting (section) +.B Table\ \&1.\ \&802\-11\-wireless setting (section) .TS allbox tab(:); lB lB lB lB. @@ -244,12 +244,130 @@ T}:T{ Description T} .T& +l l l l +l l l l +l l l l +l l l l. +T{ +ssid +T}:T{ +\ \& +T}:T{ +string (or decimal\-byte list \- obsolete) +T}:T{ +SSID of Wi\-Fi network\&.\fB + +Example: \fRssid=Quick Net +T} +T{ +mac\-address +T}:T{ +\ \& +T}:T{ +usual hex\-digits\-and\-colons notation +T}:T{ +MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;162)\&. +T} +T{ +cloned\-mac\-address +T}:T{ +\ \& +T}:T{ +usual hex\-digits\-and\-colons notation +T}:T{ +Cloned MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;178)\&. +T} +T{ +mac\-address\-blacklist +T}:T{ +\ \& +T}:T{ +list of MACs (separated with semicolons) +T}:T{ +MAC address blacklist\&.\fB + +Example: \fRmac\-address\-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78 +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&2.\ \&802\-3\-ethernet setting (section) +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Keyfile Variable +T}:T{ +Format +T}:T{ +Description +T} +.T& +l l l l +l l l l l l l l. T{ mac\-address T}:T{ +\ \& +T}:T{ +usual hex\-digits\-and\-colons notation +T}:T{ +MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;162) +T} +T{ +cloned\-mac\-address +T}:T{ +\ \& +T}:T{ +usual hex\-digits\-and\-colons notation +T}:T{ +Cloned MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;178)\&. +T} +T{ +mac\-address\-blacklist +T}:T{ +\ \& +T}:T{ +list of MACs (separated with semicolons) +T}:T{ +MAC address blacklist\&.\fB + +Example: \fRmac\-address\-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78 +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&3.\ \&bridge setting (section) +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Keyfile Variable +T}:T{ +Format +T}:T{ +Description +T} +.T& +l l l l. +T{ mac\-address T}:T{ +\ \& +T}:T{ usual hex\-digits\-and\-colons notation T}:T{ MAC address in traditional hex\-digits\-and\-colons notation, or semicolon separated list of 6 decimal bytes (obsolete)\fB @@ -263,7 +381,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&2.\ \&infiniband setting (section) +.B Table\ \&4.\ \&infiniband setting (section) .TS allbox tab(:); lB lB lB lB. @@ -281,7 +399,7 @@ l l l l. T{ mac\-address T}:T{ -mac\-address +\ \& T}:T{ usual hex\-digits\-and\-colons notation T}:T{ @@ -296,7 +414,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&3.\ \&ipv4 setting (section) +.B Table\ \&5.\ \&ipv4 setting (section) .TS allbox tab(:); lB lB lB lB. @@ -317,7 +435,7 @@ l l l l. T{ dns T}:T{ -dns +\ \& T}:T{ list of DNS IP addresses T}:T{ @@ -365,7 +483,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&4.\ \&ipv6 setting (section) +.B Table\ \&6.\ \&ipv6 setting (section) .TS allbox tab(:); lB lB lB lB. @@ -386,7 +504,7 @@ l l l l. T{ dns T}:T{ -dns +\ \& T}:T{ list of DNS IP addresses T}:T{ @@ -434,7 +552,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&5.\ \&serial setting (section) +.B Table\ \&7.\ \&serial setting (section) .TS allbox tab(:); lB lB lB lB. @@ -452,7 +570,7 @@ l l l l. T{ parity T}:T{ -parity +\ \& T}:T{ \*(Aqe\*(Aq, \*(Aqo\*(Aq, or \*(Aqn\*(Aq T}:T{ @@ -467,7 +585,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&6.\ \&vpn setting (section) +.B Table\ \&8.\ \&vpn setting (section) .TS allbox tab(:); lB lB lB lB. @@ -512,7 +630,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&7.\ \&wifi\-p2p setting (section) +.B Table\ \&9.\ \&wifi\-p2p setting (section) .TS allbox tab(:); lB lB lB lB. @@ -530,130 +648,12 @@ l l l l. T{ peer T}:T{ -peer -T}:T{ -usual hex\-digits\-and\-colons notation -T}:T{ -MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;162)\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&8.\ \&802\-3\-ethernet setting (section) -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Keyfile Variable -T}:T{ -Format -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l. -T{ -mac\-address -T}:T{ -mac\-address -T}:T{ -usual hex\-digits\-and\-colons notation -T}:T{ -MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;162) -T} -T{ -cloned\-mac\-address -T}:T{ -cloned\-mac\-address -T}:T{ -usual hex\-digits\-and\-colons notation -T}:T{ -Cloned MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;178)\&. -T} -T{ -mac\-address\-blacklist -T}:T{ -mac\-address\-blacklist -T}:T{ -list of MACs (separated with semicolons) -T}:T{ -MAC address blacklist\&.\fB - -Example: \fRmac\-address\-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78 -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&9.\ \&802\-11\-wireless setting (section) -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Keyfile Variable -T}:T{ -Format -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -ssid -T}:T{ -ssid -T}:T{ -string (or decimal\-byte list \- obsolete) -T}:T{ -SSID of Wi\-Fi network\&.\fB - -Example: \fRssid=Quick Net -T} -T{ -mac\-address -T}:T{ -mac\-address +\ \& T}:T{ usual hex\-digits\-and\-colons notation T}:T{ MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;162)\&. T} -T{ -cloned\-mac\-address -T}:T{ -cloned\-mac\-address -T}:T{ -usual hex\-digits\-and\-colons notation -T}:T{ -Cloned MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;178)\&. -T} -T{ -mac\-address\-blacklist -T}:T{ -mac\-address\-blacklist -T}:T{ -list of MACs (separated with semicolons) -T}:T{ -MAC address blacklist\&.\fB - -Example: \fRmac\-address\-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78 -T} .TE .sp 1 .sp @@ -679,7 +679,7 @@ l l l l. T{ mac\-address T}:T{ -mac\-address +\ \& T}:T{ usual hex\-digits\-and\-colons notation T}:T{ diff --git a/man/nm-settings-keyfile.xml b/man/nm-settings-keyfile.xml index 0523a8bc..07e45da2 100644 --- a/man/nm-settings-keyfile.xml +++ b/man/nm-settings-keyfile.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-keyfile"><refentryinfo><title>nm-settings-keyfile</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-keyfile</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.40.12</refmiscinfo></refmeta><refnamediv><refname>nm-settings-keyfile</refname><refpurpose>Description of <emphasis>keyfile</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> +<refentry id="nm-settings-keyfile"><refentryinfo><title>nm-settings-keyfile</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-keyfile</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.42.4</refmiscinfo></refmeta><refnamediv><refname>nm-settings-keyfile</refname><refpurpose>Description of <emphasis>keyfile</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on the concept of connection profiles that contain network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing @@ -134,14 +134,17 @@ id=4 </para><formalpara><title>Name aliases</title><para> Some of the NetworkManager setting names are somewhat hard to type or remember. Therefore <emphasis>keyfile</emphasis> introduces aliases that can be used instead of the names. - <simplelist type="horiz" columns="1"><member><emphasis>setting name keyfile alias</emphasis></member><member>802-3-ethernet = ethernet</member><member>802-11-wireless = wifi</member><member>802-11-wireless-security = wifi-security</member></simplelist></para></formalpara><table><title>bridge setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> -<row><entry align="left">mac-address</entry><entry align="left">mac-address</entry><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">MAC address in traditional hex-digits-and-colons notation, or semicolon separated list of 6 decimal bytes (obsolete)<emphasis role="bold"> + <simplelist type="horiz" columns="1"><member><emphasis>setting name keyfile alias</emphasis></member><member>802-3-ethernet = ethernet</member><member>802-11-wireless = wifi</member><member>802-11-wireless-security = wifi-security</member></simplelist></para></formalpara><table><title>802-11-wireless setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">ssid</entry><entry align="left"/><entry align="left">string (or decimal-byte list - obsolete)</entry><entry align="left">SSID of Wi-Fi network.<emphasis role="bold"> -Example: </emphasis>mac-address=00:22:68:12:79:A2 mac-address=0;34;104;18;121;162;</entry></row></tbody></tgroup></table><table><title>infiniband setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> -<row><entry align="left">mac-address</entry><entry align="left">mac-address</entry><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">MAC address in traditional hex-digits-and-colons notation, or or semicolon separated list of 20 decimal bytes (obsolete)<emphasis role="bold"> +Example: </emphasis>ssid=Quick Net</entry></row><row><entry align="left">mac-address</entry><entry align="left"/><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162).</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left"/><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">Cloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left"/><entry align="left">list of MACs (separated with semicolons)</entry><entry align="left">MAC address blacklist.<emphasis role="bold"> -Example: </emphasis>mac-address= 80:00:00:6d:fe:80:00:00:00:00:00:00:00:02:55:00:70:33:cf:01</entry></row></tbody></tgroup></table><table><title>ipv4 setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> -<row><entry align="left">dns</entry><entry align="left">dns</entry><entry align="left">list of DNS IP addresses</entry><entry align="left">List of DNS servers.<emphasis role="bold"> +Example: </emphasis>mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78</entry></row></tbody></tgroup></table><table><title>802-3-ethernet setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">mac-address</entry><entry align="left"/><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162)</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left"/><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">Cloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left"/><entry align="left">list of MACs (separated with semicolons)</entry><entry align="left">MAC address blacklist.<emphasis role="bold"> + +Example: </emphasis>mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78</entry></row></tbody></tgroup></table><table><title>bridge setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">mac-address</entry><entry align="left"/><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">MAC address in traditional hex-digits-and-colons notation, or semicolon separated list of 6 decimal bytes (obsolete)<emphasis role="bold"> + +Example: </emphasis>mac-address=00:22:68:12:79:A2 mac-address=0;34;104;18;121;162;</entry></row></tbody></tgroup></table><table><title>infiniband setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">mac-address</entry><entry align="left"/><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">MAC address in traditional hex-digits-and-colons notation, or or semicolon separated list of 20 decimal bytes (obsolete)<emphasis role="bold"> + +Example: </emphasis>mac-address= 80:00:00:6d:fe:80:00:00:00:00:00:00:00:02:55:00:70:33:cf:01</entry></row></tbody></tgroup></table><table><title>ipv4 setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">dns</entry><entry align="left"/><entry align="left">list of DNS IP addresses</entry><entry align="left">List of DNS servers.<emphasis role="bold"> Example: </emphasis>dns=1.2.3.4;8.8.8.8;8.8.4.4;</entry></row><row><entry align="left">addresses</entry><entry align="left">address1, address2, ...</entry><entry align="left">address/plen</entry><entry align="left">List of static IP addresses.<emphasis role="bold"> @@ -149,8 +152,7 @@ Example: </emphasis>address1=192.168.100.100/24 address2=10.1.1.5/24</entry></ro Example: </emphasis>gateway=192.168.100.1</entry></row><row><entry align="left">routes</entry><entry align="left">route1, route2, ...</entry><entry align="left">route/plen[,gateway,metric]</entry><entry align="left">List of IP routes.<emphasis role="bold"> -Example: </emphasis>route1=8.8.8.0/24,10.1.1.1,77 route2=7.7.0.0/16</entry></row></tbody></tgroup></table><table><title>ipv6 setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> -<row><entry align="left">dns</entry><entry align="left">dns</entry><entry align="left">list of DNS IP addresses</entry><entry align="left">List of DNS servers.<emphasis role="bold"> +Example: </emphasis>route1=8.8.8.0/24,10.1.1.1,77 route2=7.7.0.0/16</entry></row></tbody></tgroup></table><table><title>ipv6 setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">dns</entry><entry align="left"/><entry align="left">list of DNS IP addresses</entry><entry align="left">List of DNS servers.<emphasis role="bold"> Example: </emphasis>dns=2001:4860:4860::8888;2001:4860:4860::8844;</entry></row><row><entry align="left">addresses</entry><entry align="left">address1, address2, ...</entry><entry align="left">address/plen</entry><entry align="left">List of static IP addresses.<emphasis role="bold"> @@ -158,25 +160,13 @@ Example: </emphasis>address1=abbe::cafe/96 address2=2001::1234</entry></row><row Example: </emphasis>gateway=abbe::1</entry></row><row><entry align="left">routes</entry><entry align="left">route1, route2, ...</entry><entry align="left">route/plen[,gateway,metric]</entry><entry align="left">List of IP routes.<emphasis role="bold"> -Example: </emphasis>route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403</entry></row></tbody></tgroup></table><table><title>serial setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> -<row><entry align="left">parity</entry><entry align="left">parity</entry><entry align="left">'e', 'o', or 'n'</entry><entry align="left">The connection parity; even, odd, or none. Note that older versions of NetworkManager stored this as an integer: 69 ('E') for even, 111 ('o') for odd, or 110 ('n') for none.<emphasis role="bold"> +Example: </emphasis>route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403</entry></row></tbody></tgroup></table><table><title>serial setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">parity</entry><entry align="left"/><entry align="left">'e', 'o', or 'n'</entry><entry align="left">The connection parity; even, odd, or none. Note that older versions of NetworkManager stored this as an integer: 69 ('E') for even, 111 ('o') for odd, or 110 ('n') for none.<emphasis role="bold"> -Example: </emphasis>parity=n</entry></row></tbody></tgroup></table><table><title>vpn setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> -<row><entry align="left">data</entry><entry align="left">separate variables named after keys of the dictionary</entry><entry align="left"/><entry align="left">The keys of the data dictionary are used as variable names directly under [vpn] section.<emphasis role="bold"> +Example: </emphasis>parity=n</entry></row></tbody></tgroup></table><table><title>vpn setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">data</entry><entry align="left">separate variables named after keys of the dictionary</entry><entry align="left"/><entry align="left">The keys of the data dictionary are used as variable names directly under [vpn] section.<emphasis role="bold"> Example: </emphasis>remote=ovpn.corp.com cipher=AES-256-CBC username=joe</entry></row><row><entry align="left">secrets</entry><entry align="left">separate variables named after keys of the dictionary</entry><entry align="left"/><entry align="left">The keys of the secrets dictionary are used as variable names directly under [vpn-secrets] section.<emphasis role="bold"> -Example: </emphasis>password=Popocatepetl</entry></row></tbody></tgroup></table><table><title>wifi-p2p setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> -<row><entry align="left">peer</entry><entry align="left">peer</entry><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162).</entry></row></tbody></tgroup></table><table><title>802-3-ethernet setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> -<row><entry align="left">mac-address</entry><entry align="left">mac-address</entry><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162)</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left">cloned-mac-address</entry><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">Cloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left">mac-address-blacklist</entry><entry align="left">list of MACs (separated with semicolons)</entry><entry align="left">MAC address blacklist.<emphasis role="bold"> - -Example: </emphasis>mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78</entry></row></tbody></tgroup></table><table><title>802-11-wireless setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> -<row><entry align="left">ssid</entry><entry align="left">ssid</entry><entry align="left">string (or decimal-byte list - obsolete)</entry><entry align="left">SSID of Wi-Fi network.<emphasis role="bold"> - -Example: </emphasis>ssid=Quick Net</entry></row><row><entry align="left">mac-address</entry><entry align="left">mac-address</entry><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162).</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left">cloned-mac-address</entry><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">Cloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left">mac-address-blacklist</entry><entry align="left">list of MACs (separated with semicolons)</entry><entry align="left">MAC address blacklist.<emphasis role="bold"> - -Example: </emphasis>mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78</entry></row></tbody></tgroup></table><table><title>wpan setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> -<row><entry align="left">mac-address</entry><entry align="left">mac-address</entry><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">MAC address in hex-digits-and-colons notation (e.g. 76:d8:9b:87:66:60:84:ee).</entry></row></tbody></tgroup></table><refsect2 id="secrets-flags"><title>Secret flags</title><para> +Example: </emphasis>password=Popocatepetl</entry></row></tbody></tgroup></table><table><title>wifi-p2p setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">peer</entry><entry align="left"/><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162).</entry></row></tbody></tgroup></table><table><title>wpan setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">mac-address</entry><entry align="left"/><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">MAC address in hex-digits-and-colons notation (e.g. 76:d8:9b:87:66:60:84:ee).</entry></row></tbody></tgroup></table><refsect2 id="secrets-flags"><title>Secret flags</title><para> Each secret property in a NetworkManager setting has an associated <emphasis>flags</emphasis> property that describes how to handle that secret. In the <emphasis>keyfile</emphasis> plugin, the value of <emphasis>-flags</emphasis> variable is a decimal number (0 - 7) defined as a sum diff --git a/man/nm-settings-nmcli.5 b/man/nm-settings-nmcli.5 index 6fb8f1d1..c14b6a52 100644 --- a/man/nm-settings-nmcli.5 +++ b/man/nm-settings-nmcli.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-nmcli .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: Configuration -.\" Source: NetworkManager 1.40.12 +.\" Source: NetworkManager 1.42.4 .\" Language: English .\" -.TH "NM\-SETTINGS\-NMCLI" "5" "" "NetworkManager 1\&.40\&.12" "Configuration" +.TH "NM\-SETTINGS\-NMCLI" "5" "" "NetworkManager 1\&.42\&.4" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -314,7 +314,7 @@ A universally unique identifier for the connection, for example generated with l .sp The UUID must be in the format "2815492f\-7e56\-435e\-b2e9\-246bd7cdc664" (ie, contains only hexadecimal characters and "\-")\&. .sp -Format: string +Format: a valid RFC4122 universally unique identifier (UUID)\&. .RE .PP \fBwait\-activation\-delay\fR @@ -513,7 +513,7 @@ Format: NMSettingSecretFlags (uint32) .PP \fBphase1\-auth\-flags\fR .RS 4 -Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options\&. The individual TLS versions can be explicitly disabled\&. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it\&. The TLS options map to tls_disable_tlsv1_x settings\&. See the wpa_supplicant documentation for more details\&. +Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options\&. The individual TLS versions can be explicitly disabled\&. TLS time checks can be also disabled\&. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it\&. The TLS options map to tls_disable_tlsv1_x and tls_disable_time_checks settings\&. See the wpa_supplicant documentation for more details\&. .sp Format: uint32 .RE @@ -656,7 +656,9 @@ Format: NMSettingSecretFlags (uint32) .PP \fBphase2\-subject\-match\fR .RS 4 -Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2\-domain\-suffix\-match\&. +Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and should not be used\&. +.sp +This property is deprecated since version 1\&.2\&. Use "phase2\-domain\-suffix\-match" instead\&. .sp Format: string .RE @@ -702,7 +704,9 @@ Format: NMSettingSecretFlags (uint32) .PP \fBsubject\-match\fR .RS 4 -Substring to be matched against the subject of the certificate presented by the authentication server\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain\-suffix\-match\&. +Substring to be matched against the subject of the certificate presented by the authentication server\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and should not be used\&. +.sp +This property is deprecated since version 1\&.2\&. Use "phase2\-domain\-suffix\-match" instead\&. .sp Format: string .RE @@ -867,7 +871,9 @@ Alias: mac .sp If specified, the MAC address of bridge\&. When creating a new bridge, this MAC address will be set\&. .sp -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 +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\&. +.sp +This property is deprecated since version 1\&.12\&. Use the "cloned\-mac\-address" property instead\&. .sp Format: byte array .RE @@ -1642,7 +1648,9 @@ Format: string .PP \fBnumber\fR .RS 4 -Legacy setting that used to help establishing PPP data sessions for GSM\-based modems\&. Deprecated: 1 +Legacy setting that used to help establishing PPP data sessions for GSM\-based modems\&. +.sp +This property is deprecated since version 1\&.16\&. User\-provided values for this setting are no longer used\&. .sp Format: string .RE @@ -1764,6 +1772,15 @@ Array of IP addresses\&. Format: a comma separated list of addresses .RE .PP +\fBauto\-route\-ext\-gw\fR +.RS 4 +VPN connections will default to add the route automatically unless this setting is set to FALSE\&. +.sp +For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect\&. +.sp +Format: NMTernary (int32) +.RE +.PP \fBdad\-timeout\fR .RS 4 Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network\&. If an address conflict is detected, the activation will fail\&. A zero value means that no duplicate address detection is performed, \-1 means the default value (either configuration ipvx\&.dad\-timeout override or zero)\&. A value greater than zero is a timeout in milliseconds\&. @@ -1817,7 +1834,13 @@ Format: uint32 .PP \fBdhcp\-iaid\fR .RS 4 -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The property is a 32\-bit decimal value or a special value among "mac", "perm\-mac", "ifname" and "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address\&. +A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. +.sp +For DHCPv4, the IAID is only used with "ipv4\&.dhcp\-client\-id" values "duid" and "ipv6\-duid" to generate the client\-id\&. +.sp +For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin\&. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address\&. +.sp +The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device\&. .sp Format: string .RE @@ -1860,6 +1883,8 @@ Format: string .RS 4 Array of IP addresses of DNS servers\&. .sp +For DoT (DNS over TLS), the SNI server name can be specified by appending "#example\&.com" to the IP address of the DNS server\&. This currently only has effect when using systemd\-resolved\&. +.sp Format: array of uint32 .RE .PP @@ -1975,6 +2000,13 @@ If TRUE, this connection will never be the default connection for this IP type, Format: boolean .RE .PP +\fBreplace\-local\-rule\fR +.RS 4 +Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. +.sp +Format: NMTernary (int32) +.RE +.PP \fBrequired\-timeout\fR .RS 4 The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds\&. @@ -2155,7 +2187,7 @@ Various attributes are supported: .IP \(bu 2.3 .\} "onlink" -\- a boolean value\&. +\- a boolean value\&. The onlink flag is ignored for IPv4 routes without a gateway\&. That also means, with a positive "weight" the route cannot merge with ECMP routes which are onlink and have a gateway\&. .RE .sp .RS 4 @@ -2243,7 +2275,7 @@ Various attributes are supported: unicast, local, blackhole, -unavailable, +unreachable, prohibit, throw\&. The default is unicast\&. @@ -2257,6 +2289,20 @@ unicast\&. .sp -1 .IP \(bu 2.3 .\} +"weight" +\- an unsigned 32 bit integer ranging from 0 to 256\&. A non\-zero weight indicates that the IPv4 route is an ECMP IPv4 route\&. NetworkManager will automatically merge compatible ECMP routes into multi\-hop routes\&. Setting to zero or omitting the attribute configures single hop routes that won\*(Aqt get merged\&. If the route finds no merge partner, it is configured as single hop route\&. +.sp +Note that in NetworkManager, currently all nexthops of a ECMP route must share the same "onlink" flag in order to be mergable\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} "window" \- an unsigned 32 bit integer\&. .RE @@ -2309,6 +2355,15 @@ Array of IP addresses\&. Format: a comma separated list of addresses .RE .PP +\fBauto\-route\-ext\-gw\fR +.RS 4 +VPN connections will default to add the route automatically unless this setting is set to FALSE\&. +.sp +For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect\&. +.sp +Format: NMTernary (int32) +.RE +.PP \fBdhcp\-duid\fR .RS 4 A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315)\&. The DUID is carried in the Client Identifier option\&. If the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option\&. @@ -2344,7 +2399,13 @@ Format: uint32 .PP \fBdhcp\-iaid\fR .RS 4 -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The property is a 32\-bit decimal value or a special value among "mac", "perm\-mac", "ifname" and "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address\&. +A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. +.sp +For DHCPv4, the IAID is only used with "ipv4\&.dhcp\-client\-id" values "duid" and "ipv6\-duid" to generate the client\-id\&. +.sp +For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin\&. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address\&. +.sp +The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device\&. .sp Format: string .RE @@ -2369,6 +2430,8 @@ Format: int32 .RS 4 Array of IP addresses of DNS servers\&. .sp +For DoT (DNS over TLS), the SNI server name can be specified by appending "#example\&.com" to the IP address of the DNS server\&. This currently only has effect when using systemd\-resolved\&. +.sp Format: array of byte array .RE .PP @@ -2504,6 +2567,13 @@ Set to 2147483647 (MAXINT32) for infinity\&. Format: int32 .RE .PP +\fBreplace\-local\-rule\fR +.RS 4 +Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. +.sp +Format: NMTernary (int32) +.RE +.PP \fBrequired\-timeout\fR .RS 4 The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds\&. @@ -2760,7 +2830,7 @@ Various attributes are supported: unicast, local, blackhole, -unavailable, +unreachable, prohibit, throw\&. The default is unicast\&. @@ -2828,6 +2898,13 @@ The flow label to assign to tunnel packets\&. This property applies only to IPv6 Format: uint32 .RE .PP +\fBfwmark\fR +.RS 4 +The fwmark value to assign to tunnel packets\&. This property can be set to a non zero value only on VTI and VTI6 tunnels\&. +.sp +Format: uint32 +.RE +.PP \fBinput\-key\fR .RS 4 The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE)\&. If empty, no key is used\&. @@ -3166,12 +3243,33 @@ Open vSwitch DPDK number of rx queues\&. Defaults to zero which means to leave t .sp Format: uint32 .RE +.PP +\fBn\-rxq\-desc\fR +.RS 4 +The rx queue size (number of rx descriptors) for DPDK ports\&. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors\&. +.sp +Format: uint32 +.RE +.PP +\fBn\-txq\-desc\fR +.RS 4 +The tx queue size (number of tx descriptors) for DPDK ports\&. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors\&. +.sp +Format: uint32 +.RE .SS "ovs\-interface setting" .PP Open vSwitch Interface Settings\&. .PP Properties: .PP +\fBofport\-request\fR +.RS 4 +Open vSwitch openflow port number\&. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs\&. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network\&. OpenFlow switches connect logically to each other via their OpenFlow ports\&. +.sp +Format: uint32 +.RE +.PP \fBtype\fR .RS 4 The interface type\&. Either "internal", "system", "patch", "dpdk", or empty\&. @@ -3231,9 +3329,18 @@ The VLAN tag in the range 0\-4095\&. Format: uint32 .RE .PP +\fBtrunks\fR +.RS 4 +A list of VLAN ranges that this port trunks\&. +.sp +The property is valid only for ports with mode "trunk", "native\-tagged", or "native\-untagged port"\&. If it is empty, the port trunks all VLANs\&. +.sp +Format: array of vardict +.RE +.PP \fBvlan\-mode\fR .RS 4 -The VLAN mode\&. One of "access", "native\-tagged", "native\-untagged", "trunk" or unset\&. +The VLAN mode\&. One of "access", "native\-tagged", "native\-untagged", "trunk", "dot1q\-tunnel" or unset\&. .sp Format: string .RE @@ -4027,6 +4134,15 @@ If given, specifies the parent interface name or parent connection UUID from whi .sp Format: string .RE +.PP +\fBprotocol\fR +.RS 4 +Specifies the VLAN protocol to use for encapsulation\&. +.sp +Supported values are: \*(Aq802\&.1Q\*(Aq, \*(Aq802\&.1ad\*(Aq\&. If not specified the default value is \*(Aq802\&.1Q\*(Aq\&. +.sp +Format: string +.RE .SS "vpn setting" .PP VPN Settings\&. @@ -4265,7 +4381,9 @@ Properties: .RS 4 Alias: mac .sp -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 +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)\&. +.sp +This property is deprecated since version 1\&.2\&. WiMAX is no longer supported\&. .sp Format: byte array .RE @@ -4274,7 +4392,9 @@ Format: byte array .RS 4 Alias: nsp .sp -Network Service Provider (NSP) name of the WiMAX network this connection should use\&. Deprecated: 1 +Network Service Provider (NSP) name of the WiMAX network this connection should use\&. +.sp +This property is deprecated since version 1\&.2\&. WiMAX is no longer supported\&. .sp Format: string .RE @@ -4588,7 +4708,9 @@ Format: array of string .PP \fBmac\-address\-randomization\fR .RS 4 -One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address)\&. This property is deprecated for \*(Aqcloned\-mac\-address\*(Aq\&. Deprecated: 1 +One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address)\&. +.sp +This property is deprecated since version 1\&.4\&. Use the "cloned\-mac\-address" property instead\&. .sp Format: uint32 .RE @@ -4916,6 +5038,20 @@ Negative values have the special effect of excluding other connections with a gr .sp Format: int32 .RE +.SS "loopback setting" +.PP +Loopback Link Settings\&. +.PP +Properties: +.PP +\fBmtu\fR +.RS 4 +Alias: mtu +.sp +If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. +.sp +Format: uint32 +.RE .SS "veth setting" .PP Veth Settings\&. diff --git a/man/nm-settings-nmcli.xml b/man/nm-settings-nmcli.xml index 794ee278..6154468e 100644 --- a/man/nm-settings-nmcli.xml +++ b/man/nm-settings-nmcli.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-nmcli"><refentryinfo><title>nm-settings-nmcli</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.40.12</refmiscinfo></refmeta><refnamediv><refname>nm-settings-nmcli</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles for nmcli</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> +<refentry id="nm-settings-nmcli"><refentryinfo><title>nm-settings-nmcli</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.42.4</refmiscinfo></refmeta><refnamediv><refname>nm-settings-nmcli</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles for nmcli</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on a concept of connection profiles, sometimes referred to as connections only. These connection profiles contain a network configuration. When NetworkManager activates a connection profile on a network device the configuration will @@ -31,324 +31,349 @@ also shows aliases that can be used unqualified instead of the full name. For example <literal>connection.interface-name</literal> and <literal>ifname</literal> refer to the same property. - </para><refsect2><title>connection setting</title><para> General Connection Profile Settings.</para><para> + </para><refsect2><title>connection setting</title><para>General Connection Profile Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.connection.auth-retries">auth-retries</option></term><listitem><para> 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.</para><para> Currently, this only applies to 802-1x authentication.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.connection.auth-retries">auth-retries</option></term><listitem><para>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.</para><para>Currently, this only applies to 802-1x authentication.</para><para> Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect">autoconnect</option></term><listitem><para> - Alias: autoconnect</para><para> 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.</para><para> 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.</para><para> Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.</para><para> If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined.</para><para> Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-priority">autoconnect-priority</option></term><listitem><para> 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.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-retries">autoconnect-retries</option></term><listitem><para> 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.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-slaves">autoconnect-slaves</option></term><listitem><para> 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.</para><para> - Format: NMSettingConnectionAutoconnectSlaves (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.dns-over-tls">dns-over-tls</option></term><listitem><para> Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic.</para><para> 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.</para><para> This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.gateway-ping-timeout">gateway-ping-timeout</option></term><listitem><para> If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</para><para> + Alias: autoconnect</para><para>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.</para><para>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.</para><para>Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.</para><para>If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined.</para><para>Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-priority">autoconnect-priority</option></term><listitem><para>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.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-retries">autoconnect-retries</option></term><listitem><para>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.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-slaves">autoconnect-slaves</option></term><listitem><para>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.</para><para> + Format: NMSettingConnectionAutoconnectSlaves (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.dns-over-tls">dns-over-tls</option></term><listitem><para>Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic.</para><para>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.</para><para>This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.gateway-ping-timeout">gateway-ping-timeout</option></term><listitem><para>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.id">id</option></term><listitem><para> - Alias: con-name</para><para> A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</para><para> + Alias: con-name</para><para>A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.interface-name">interface-name</option></term><listitem><para> - Alias: ifname</para><para> 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).</para><para> For software devices this specifies the name of the created device.</para><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.lldp">lldp</option></term><listitem><para> Whether LLDP is enabled for the connection.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.llmnr">llmnr</option></term><listitem><para> 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.</para><para> 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").</para><para> This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para><para> + Alias: ifname</para><para>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).</para><para>For software devices this specifies the name of the created device.</para><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.lldp">lldp</option></term><listitem><para>Whether LLDP is enabled for the connection.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.llmnr">llmnr</option></term><listitem><para>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.</para><para>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").</para><para>This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para><para> Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.master">master</option></term><listitem><para> - Alias: master</para><para> Interface name of the master device or UUID of the master connection.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.mdns">mdns</option></term><listitem><para> Whether mDNS is enabled for the connection.</para><para> 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").</para><para> This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.metered">metered</option></term><listitem><para> Whether the connection is metered.</para><para> When updating this property on a currently activated connection, the change takes effect immediately.</para><para> - Format: NMMetered (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.mptcp-flags">mptcp-flags</option></term><listitem><para> Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints.</para><para> If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.</para><para> The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags.</para><para> Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless.</para><para> Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that.</para><para> When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.</para><para> If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl.</para><para> NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.</para><para> Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.mud-url">mud-url</option></term><listitem><para> 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://".</para><para> The special value "none" is allowed to indicate that no MUD URL is used.</para><para> If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.multi-connect">multi-connect</option></term><listitem><para> Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.permissions">permissions</option></term><listitem><para> 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".</para><para> 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.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.read-only">read-only</option></term><listitem><para> 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.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.secondaries">secondaries</option></term><listitem><para> List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</para><para> + Alias: master</para><para>Interface name of the master device or UUID of the master connection.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.mdns">mdns</option></term><listitem><para>Whether mDNS is enabled for the connection.</para><para>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").</para><para>This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.metered">metered</option></term><listitem><para>Whether the connection is metered.</para><para>When updating this property on a currently activated connection, the change takes effect immediately.</para><para> + Format: NMMetered (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.mptcp-flags">mptcp-flags</option></term><listitem><para>Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints.</para><para>If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.</para><para>The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags.</para><para>Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless.</para><para>Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that.</para><para>When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.</para><para>If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl.</para><para>NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.</para><para>Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.mud-url">mud-url</option></term><listitem><para>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://".</para><para>The special value "none" is allowed to indicate that no MUD URL is used.</para><para>If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.multi-connect">multi-connect</option></term><listitem><para>Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.permissions">permissions</option></term><listitem><para>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".</para><para>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.</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.read-only">read-only</option></term><listitem><para>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.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.secondaries">secondaries</option></term><listitem><para>List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</para><para> Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.slave-type">slave-type</option></term><listitem><para> - Alias: slave-type</para><para> Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.stable-id">stable-id</option></term><listitem><para> 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.</para><para> 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].</para><para> 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. See NetworkManager(8) manual about the secret-key and the host identity.</para><para> 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.</para><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.timestamp">timestamp</option></term><listitem><para> The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated.</para><para> 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).</para><para> + Alias: slave-type</para><para>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.stable-id">stable-id</option></term><listitem><para>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.</para><para>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].</para><para>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. See NetworkManager(8) manual about the secret-key and the host identity.</para><para>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.</para><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.timestamp">timestamp</option></term><listitem><para>The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated.</para><para>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).</para><para> Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.type">type</option></term><listitem><para> - Alias: type</para><para> 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).</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.uuid">uuid</option></term><listitem><para> 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.</para><para> The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.wait-activation-delay">wait-activation-delay</option></term><listitem><para> Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event.</para><para> The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.wait-device-timeout">wait-device-timeout</option></term><listitem><para> 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.</para><para> The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.zone">zone</option></term><listitem><para> 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.</para><para> When updating this property on a currently activated connection, the change takes effect immediately.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>6lowpan setting</title><para> 6LoWPAN Settings.</para><para> + Alias: type</para><para>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).</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.uuid">uuid</option></term><listitem><para>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.</para><para>The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").</para><para> + Format: a valid RFC4122 universally unique identifier (UUID).</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.wait-activation-delay">wait-activation-delay</option></term><listitem><para>Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event.</para><para>The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.wait-device-timeout">wait-device-timeout</option></term><listitem><para>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.</para><para>The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.zone">zone</option></term><listitem><para>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.</para><para>When updating this property on a currently activated connection, the change takes effect immediately.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>6lowpan setting</title><para>6LoWPAN Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.6lowpan.parent">parent</option></term><listitem><para> - Alias: dev</para><para> If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-1x setting</title><para> IEEE 802.1x Authentication Settings.</para><para> + Alias: dev</para><para>If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-1x setting</title><para>IEEE 802.1x Authentication Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.altsubject-matches">altsubject-matches</option></term><listitem><para> List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.anonymous-identity">anonymous-identity</option></term><listitem><para> Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.auth-timeout">auth-timeout</option></term><listitem><para> A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-cert">ca-cert</option></term><listitem><para> Contains the CA certificate if used by the EAP method specified in the "eap" property.</para><para> Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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.</para><para> Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-cert-password">ca-cert-password</option></term><listitem><para> The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-cert-password-flags">ca-cert-password-flags</option></term><listitem><para> Flags indicating how to handle the "ca-cert-password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-path">ca-path</option></term><listitem><para> UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property.</para><para> If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.client-cert">client-cert</option></term><listitem><para> Contains the client certificate if used by the EAP method specified in the "eap" property.</para><para> 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.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.client-cert-password">client-cert-password</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.client-cert-password-flags">client-cert-password-flags</option></term><listitem><para> Flags indicating how to handle the "client-cert-password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.domain-match">domain-match</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.domain-suffix-match">domain-suffix-match</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.eap">eap</option></term><listitem><para> 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.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.identity">identity</option></term><listitem><para> Identity string for EAP authentication methods. Often the user's user or login name.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.optional">optional</option></term><listitem><para> 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.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.pac-file">pac-file</option></term><listitem><para> UTF-8 encoded file path containing PAC for EAP-FAST.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password">password</option></term><listitem><para> UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password-flags">password-flags</option></term><listitem><para> Flags indicating how to handle the "password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password-raw">password-raw</option></term><listitem><para> Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password-raw-flags">password-raw-flags</option></term><listitem><para> Flags indicating how to handle the "password-raw" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-auth-flags">phase1-auth-flags</option></term><listitem><para> Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x settings. See the wpa_supplicant documentation for more details.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-fast-provisioning">phase1-fast-provisioning</option></term><listitem><para> Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-peaplabel">phase1-peaplabel</option></term><listitem><para> Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-peapver">phase1-peapver</option></term><listitem><para> Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-altsubject-matches">phase2-altsubject-matches</option></term><listitem><para> List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-auth">phase2-auth</option></term><listitem><para> Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-autheap">phase2-autheap</option></term><listitem><para> Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-cert">phase2-ca-cert</option></term><listitem><para> Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</para><para> Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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.</para><para> Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-cert-password">phase2-ca-cert-password</option></term><listitem><para> The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-cert-password-flags">phase2-ca-cert-password-flags</option></term><listitem><para> Flags indicating how to handle the "phase2-ca-cert-password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-path">phase2-ca-path</option></term><listitem><para> UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property.</para><para> If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-client-cert">phase2-client-cert</option></term><listitem><para> Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</para><para> 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.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-client-cert-password">phase2-client-cert-password</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-client-cert-password-flags">phase2-client-cert-password-flags</option></term><listitem><para> Flags indicating how to handle the "phase2-client-cert-password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-domain-match">phase2-domain-match</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-domain-suffix-match">phase2-domain-suffix-match</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-private-key">phase2-private-key</option></term><listitem><para> Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls".</para><para> 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.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-private-key-password">phase2-private-key-password</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-private-key-password-flags">phase2-private-key-password-flags</option></term><listitem><para> Flags indicating how to handle the "phase2-private-key-password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-subject-match">phase2-subject-match</option></term><listitem><para> Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.pin">pin</option></term><listitem><para> PIN used for EAP authentication methods.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.pin-flags">pin-flags</option></term><listitem><para> Flags indicating how to handle the "pin" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.private-key">private-key</option></term><listitem><para> Contains the private key when the "eap" property is set to "tls".</para><para> 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 "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 "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</para><para> WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.private-key-password">private-key-password</option></term><listitem><para> The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.private-key-password-flags">private-key-password-flags</option></term><listitem><para> Flags indicating how to handle the "private-key-password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.subject-match">subject-match</option></term><listitem><para> Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.system-ca-certs">system-ca-certs</option></term><listitem><para> When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).</para><para> - Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>adsl setting</title><para> ADSL Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.altsubject-matches">altsubject-matches</option></term><listitem><para>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.anonymous-identity">anonymous-identity</option></term><listitem><para>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.auth-timeout">auth-timeout</option></term><listitem><para>A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-cert">ca-cert</option></term><listitem><para>Contains the CA certificate if used by the EAP method specified in the "eap" property.</para><para>Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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.</para><para>Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</para><para> + Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-cert-password">ca-cert-password</option></term><listitem><para>The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-cert-password-flags">ca-cert-password-flags</option></term><listitem><para>Flags indicating how to handle the "ca-cert-password" property.</para><para> + Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-path">ca-path</option></term><listitem><para>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property.</para><para>If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.client-cert">client-cert</option></term><listitem><para>Contains the client certificate if used by the EAP method specified in the "eap" property.</para><para>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.</para><para> + Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.client-cert-password">client-cert-password</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.client-cert-password-flags">client-cert-password-flags</option></term><listitem><para>Flags indicating how to handle the "client-cert-password" property.</para><para> + Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.domain-match">domain-match</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.domain-suffix-match">domain-suffix-match</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.eap">eap</option></term><listitem><para>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.</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.identity">identity</option></term><listitem><para>Identity string for EAP authentication methods. Often the user's user or login name.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.optional">optional</option></term><listitem><para>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.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.pac-file">pac-file</option></term><listitem><para>UTF-8 encoded file path containing PAC for EAP-FAST.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password">password</option></term><listitem><para>UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password-flags">password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> + Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password-raw">password-raw</option></term><listitem><para>Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</para><para> + Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password-raw-flags">password-raw-flags</option></term><listitem><para>Flags indicating how to handle the "password-raw" property.</para><para> + Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-auth-flags">phase1-auth-flags</option></term><listitem><para>Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. TLS time checks can be also disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x and tls_disable_time_checks settings. See the wpa_supplicant documentation for more details.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-fast-provisioning">phase1-fast-provisioning</option></term><listitem><para>Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-peaplabel">phase1-peaplabel</option></term><listitem><para>Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-peapver">phase1-peapver</option></term><listitem><para>Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-altsubject-matches">phase2-altsubject-matches</option></term><listitem><para>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-auth">phase2-auth</option></term><listitem><para>Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-autheap">phase2-autheap</option></term><listitem><para>Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-cert">phase2-ca-cert</option></term><listitem><para>Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</para><para>Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme 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.</para><para>Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</para><para> + Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-cert-password">phase2-ca-cert-password</option></term><listitem><para>The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-cert-password-flags">phase2-ca-cert-password-flags</option></term><listitem><para>Flags indicating how to handle the "phase2-ca-cert-password" property.</para><para> + Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-path">phase2-ca-path</option></term><listitem><para>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property.</para><para>If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-client-cert">phase2-client-cert</option></term><listitem><para>Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</para><para>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.</para><para> + Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-client-cert-password">phase2-client-cert-password</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-client-cert-password-flags">phase2-client-cert-password-flags</option></term><listitem><para>Flags indicating how to handle the "phase2-client-cert-password" property.</para><para> + Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-domain-match">phase2-domain-match</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-domain-suffix-match">phase2-domain-suffix-match</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-private-key">phase2-private-key</option></term><listitem><para>Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls".</para><para>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.</para><para> + Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-private-key-password">phase2-private-key-password</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-private-key-password-flags">phase2-private-key-password-flags</option></term><listitem><para>Flags indicating how to handle the "phase2-private-key-password" property.</para><para> + Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-subject-match">phase2-subject-match</option></term><listitem><para>Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.</para><para> + This property is deprecated since version 1.2. + Use "phase2-domain-suffix-match" instead.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.pin">pin</option></term><listitem><para>PIN used for EAP authentication methods.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.pin-flags">pin-flags</option></term><listitem><para>Flags indicating how to handle the "pin" property.</para><para> + Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.private-key">private-key</option></term><listitem><para>Contains the private key when the "eap" property is set to "tls".</para><para>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 "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 "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</para><para>WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.</para><para> + Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.private-key-password">private-key-password</option></term><listitem><para>The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.private-key-password-flags">private-key-password-flags</option></term><listitem><para>Flags indicating how to handle the "private-key-password" property.</para><para> + Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.subject-match">subject-match</option></term><listitem><para>Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.</para><para> + This property is deprecated since version 1.2. + Use "phase2-domain-suffix-match" instead.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.system-ca-certs">system-ca-certs</option></term><listitem><para>When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).</para><para> + Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>adsl setting</title><para>ADSL Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.adsl.encapsulation">encapsulation</option></term><listitem><para> - Alias: encapsulation</para><para> Encapsulation of ADSL connection. Can be "vcmux" or "llc".</para><para> + Alias: encapsulation</para><para>Encapsulation of ADSL connection. Can be "vcmux" or "llc".</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.password">password</option></term><listitem><para> - Alias: password</para><para> Password used to authenticate with the ADSL service.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.password-flags">password-flags</option></term><listitem><para> Flags indicating how to handle the "password" property.</para><para> + Alias: password</para><para>Password used to authenticate with the ADSL service.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.password-flags">password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.protocol">protocol</option></term><listitem><para> - Alias: protocol</para><para> ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</para><para> + Alias: protocol</para><para>ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.username">username</option></term><listitem><para> - Alias: username</para><para> Username used to authenticate with the ADSL service.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.vci">vci</option></term><listitem><para> VCI of ADSL connection</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.vpi">vpi</option></term><listitem><para> VPI of ADSL connection</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bluetooth setting</title><para> Bluetooth Settings.</para><para> + Alias: username</para><para>Username used to authenticate with the ADSL service.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.vci">vci</option></term><listitem><para>VCI of ADSL connection</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.vpi">vpi</option></term><listitem><para>VPI of ADSL connection</para><para> + Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bluetooth setting</title><para>Bluetooth Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bluetooth.bdaddr">bdaddr</option></term><listitem><para> - Alias: addr</para><para> The Bluetooth address of the device.</para><para> + Alias: addr</para><para>The Bluetooth address of the device.</para><para> Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bluetooth.type">type</option></term><listitem><para> - Alias: bt-type</para><para> Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bond setting</title><para> Bonding Settings.</para><para> + Alias: bt-type</para><para>Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bond setting</title><para>Bonding Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bond.options">options</option></term><listitem><para> Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</para><para> - Format: dict of string to string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bridge setting</title><para> Bridging Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bond.options">options</option></term><listitem><para>Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</para><para> + Format: dict of string to string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bridge setting</title><para>Bridging Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bridge.ageing-time">ageing-time</option></term><listitem><para> - Alias: ageing-time</para><para> The Ethernet MAC address aging time, in seconds.</para><para> + Alias: ageing-time</para><para>The Ethernet MAC address aging time, in seconds.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.forward-delay">forward-delay</option></term><listitem><para> - Alias: forward-delay</para><para> The Spanning Tree Protocol (STP) forwarding delay, in seconds.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.group-address">group-address</option></term><listitem><para> If specified, The MAC address of the multicast group this bridge uses for STP.</para><para> 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.</para><para> + Alias: forward-delay</para><para>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.group-address">group-address</option></term><listitem><para>If specified, The MAC address of the multicast group this bridge uses for STP.</para><para>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.</para><para> Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.group-forward-mask">group-forward-mask</option></term><listitem><para> - Alias: group-forward-mask</para><para> 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.</para><para> + Alias: group-forward-mask</para><para>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.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.hello-time">hello-time</option></term><listitem><para> - Alias: hello-time</para><para> The Spanning Tree Protocol (STP) hello time, in seconds.</para><para> + Alias: hello-time</para><para>The Spanning Tree Protocol (STP) hello time, in seconds.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.mac-address">mac-address</option></term><listitem><para> - Alias: mac</para><para> If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set.</para><para> 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</para><para> + Alias: mac</para><para>If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set.</para><para>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.</para><para> + This property is deprecated since version 1.12. + Use the "cloned-mac-address" property instead.</para><para> Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.max-age">max-age</option></term><listitem><para> - Alias: max-age</para><para> The Spanning Tree Protocol (STP) maximum message age, in seconds.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-hash-max">multicast-hash-max</option></term><listitem><para> Set maximum size of multicast hash table (value must be a power of 2).</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-last-member-count">multicast-last-member-count</option></term><listitem><para> Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-last-member-interval">multicast-last-member-interval</option></term><listitem><para> Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-membership-interval">multicast-membership-interval</option></term><listitem><para> Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-querier">multicast-querier</option></term><listitem><para> Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-querier-interval">multicast-querier-interval</option></term><listitem><para> If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-interval">multicast-query-interval</option></term><listitem><para> Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-response-interval">multicast-query-response-interval</option></term><listitem><para> Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-use-ifaddr">multicast-query-use-ifaddr</option></term><listitem><para> 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.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-router">multicast-router</option></term><listitem><para> Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work.</para><para> Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).</para><para> + Alias: max-age</para><para>The Spanning Tree Protocol (STP) maximum message age, in seconds.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-hash-max">multicast-hash-max</option></term><listitem><para>Set maximum size of multicast hash table (value must be a power of 2).</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-last-member-count">multicast-last-member-count</option></term><listitem><para>Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-last-member-interval">multicast-last-member-interval</option></term><listitem><para>Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.</para><para> + Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-membership-interval">multicast-membership-interval</option></term><listitem><para>Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.</para><para> + Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-querier">multicast-querier</option></term><listitem><para>Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-querier-interval">multicast-querier-interval</option></term><listitem><para>If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.</para><para> + Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-interval">multicast-query-interval</option></term><listitem><para>Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</para><para> + Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-response-interval">multicast-query-response-interval</option></term><listitem><para>Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</para><para> + Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-use-ifaddr">multicast-query-use-ifaddr</option></term><listitem><para>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.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-router">multicast-router</option></term><listitem><para>Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work.</para><para>Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-snooping">multicast-snooping</option></term><listitem><para> - Alias: multicast-snooping</para><para> 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.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-startup-query-count">multicast-startup-query-count</option></term><listitem><para> Set the number of IGMP queries to send during startup phase.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-startup-query-interval">multicast-startup-query-interval</option></term><listitem><para> Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</para><para> + Alias: multicast-snooping</para><para>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.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-startup-query-count">multicast-startup-query-count</option></term><listitem><para>Set the number of IGMP queries to send during startup phase.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-startup-query-interval">multicast-startup-query-interval</option></term><listitem><para>Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</para><para> Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.priority">priority</option></term><listitem><para> - Alias: priority</para><para> Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</para><para> + Alias: priority</para><para>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.stp">stp</option></term><listitem><para> - Alias: stp</para><para> Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-default-pvid">vlan-default-pvid</option></term><listitem><para> The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-filtering">vlan-filtering</option></term><listitem><para> Control whether VLAN filtering is enabled on the bridge.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-protocol">vlan-protocol</option></term><listitem><para> If specified, the protocol used for VLAN filtering.</para><para> Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-stats-enabled">vlan-stats-enabled</option></term><listitem><para> Controls whether per-VLAN stats accounting is enabled.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlans">vlans</option></term><listitem><para> 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.</para><para> In nmcli the VLAN list can be specified with the following syntax:</para><para> $vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</para><para> where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</para><para> - Format: array of vardict</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bridge-port setting</title><para> Bridge Port Settings.</para><para> + Alias: stp</para><para>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-default-pvid">vlan-default-pvid</option></term><listitem><para>The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-filtering">vlan-filtering</option></term><listitem><para>Control whether VLAN filtering is enabled on the bridge.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-protocol">vlan-protocol</option></term><listitem><para>If specified, the protocol used for VLAN filtering.</para><para>Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-stats-enabled">vlan-stats-enabled</option></term><listitem><para>Controls whether per-VLAN stats accounting is enabled.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlans">vlans</option></term><listitem><para>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.</para><para>In nmcli the VLAN list can be specified with the following syntax:</para><para>$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</para><para>where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</para><para> + Format: array of vardict</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bridge-port setting</title><para>Bridge Port Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bridge-port.hairpin-mode">hairpin-mode</option></term><listitem><para> - Alias: hairpin</para><para> Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.</para><para> + Alias: hairpin</para><para>Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.</para><para> Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge-port.path-cost">path-cost</option></term><listitem><para> - Alias: path-cost</para><para> The Spanning Tree Protocol (STP) port cost for destinations via this port.</para><para> + Alias: path-cost</para><para>The Spanning Tree Protocol (STP) port cost for destinations via this port.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge-port.priority">priority</option></term><listitem><para> - Alias: priority</para><para> The Spanning Tree Protocol (STP) priority of this bridge port.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge-port.vlans">vlans</option></term><listitem><para> Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property.</para><para> In nmcli the VLAN list can be specified with the following syntax:</para><para> $vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</para><para> where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</para><para> - Format: array of vardict</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>cdma setting</title><para> CDMA-based Mobile Broadband Settings.</para><para> + Alias: priority</para><para>The Spanning Tree Protocol (STP) priority of this bridge port.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge-port.vlans">vlans</option></term><listitem><para>Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property.</para><para>In nmcli the VLAN list can be specified with the following syntax:</para><para>$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</para><para>where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</para><para> + Format: array of vardict</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>cdma setting</title><para>CDMA-based Mobile Broadband Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.cdma.mtu">mtu</option></term><listitem><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.number">number</option></term><listitem><para> 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.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.cdma.mtu">mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.number">number</option></term><listitem><para>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.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.password">password</option></term><listitem><para> - Alias: password</para><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.password-flags">password-flags</option></term><listitem><para> Flags indicating how to handle the "password" property.</para><para> + Alias: password</para><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.password-flags">password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.username">username</option></term><listitem><para> - Alias: user</para><para> 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.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>dcb setting</title><para> Data Center Bridging Settings.</para><para> + Alias: user</para><para>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.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>dcb setting</title><para>Data Center Bridging Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-flags">app-fcoe-flags</option></term><listitem><para> 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).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-mode">app-fcoe-mode</option></term><listitem><para> The FCoE controller mode; either "fabric" or "vn2vn".</para><para> Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-priority">app-fcoe-priority</option></term><listitem><para> 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.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fip-flags">app-fip-flags</option></term><listitem><para> 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).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fip-priority">app-fip-priority</option></term><listitem><para> 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.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-iscsi-flags">app-iscsi-flags</option></term><listitem><para> 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).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-iscsi-priority">app-iscsi-priority</option></term><listitem><para> 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.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-bandwidth">priority-bandwidth</option></term><listitem><para> 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.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-flow-control">priority-flow-control</option></term><listitem><para> 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.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-flow-control-flags">priority-flow-control-flags</option></term><listitem><para> 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).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-bandwidth">priority-group-bandwidth</option></term><listitem><para> 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.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-flags">priority-group-flags</option></term><listitem><para> 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).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-id">priority-group-id</option></term><listitem><para> 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.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-strict-bandwidth">priority-strict-bandwidth</option></term><listitem><para> 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.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-traffic-class">priority-traffic-class</option></term><listitem><para> 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.</para><para> - Format: array of uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ethtool setting</title><para> Ethtool Ethernet Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-flags">app-fcoe-flags</option></term><listitem><para>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).</para><para> + Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-mode">app-fcoe-mode</option></term><listitem><para>The FCoE controller mode; either "fabric" or "vn2vn".</para><para>Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-priority">app-fcoe-priority</option></term><listitem><para>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.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fip-flags">app-fip-flags</option></term><listitem><para>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).</para><para> + Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fip-priority">app-fip-priority</option></term><listitem><para>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.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-iscsi-flags">app-iscsi-flags</option></term><listitem><para>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).</para><para> + Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-iscsi-priority">app-iscsi-priority</option></term><listitem><para>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.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-bandwidth">priority-bandwidth</option></term><listitem><para>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.</para><para> + Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-flow-control">priority-flow-control</option></term><listitem><para>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.</para><para> + Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-flow-control-flags">priority-flow-control-flags</option></term><listitem><para>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).</para><para> + Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-bandwidth">priority-group-bandwidth</option></term><listitem><para>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.</para><para> + Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-flags">priority-group-flags</option></term><listitem><para>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).</para><para> + Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-id">priority-group-id</option></term><listitem><para>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.</para><para> + Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-strict-bandwidth">priority-strict-bandwidth</option></term><listitem><para>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.</para><para> + Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-traffic-class">priority-traffic-class</option></term><listitem><para>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.</para><para> + Format: array of uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ethtool setting</title><para>Ethtool Ethernet Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-adaptive-rx">coalesce-adaptive-rx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-adaptive-tx">coalesce-adaptive-tx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-high">coalesce-pkt-rate-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-low">coalesce-pkt-rate-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames">coalesce-rx-frames</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-high">coalesce-rx-frames-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-irq">coalesce-rx-frames-irq</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-low">coalesce-rx-frames-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs">coalesce-rx-usecs</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-high">coalesce-rx-usecs-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-irq">coalesce-rx-usecs-irq</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-low">coalesce-rx-usecs-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-sample-interval">coalesce-sample-interval</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-stats-block-usecs">coalesce-stats-block-usecs</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames">coalesce-tx-frames</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-high">coalesce-tx-frames-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-irq">coalesce-tx-frames-irq</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-low">coalesce-tx-frames-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs">coalesce-tx-usecs</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-high">coalesce-tx-usecs-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-irq">coalesce-tx-usecs-irq</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-low">coalesce-tx-usecs-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-esp-hw-offload">feature-esp-hw-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-esp-tx-csum-hw-offload">feature-esp-tx-csum-hw-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-fcoe-mtu">feature-fcoe-mtu</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-gro">feature-gro</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-gso">feature-gso</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-highdma">feature-highdma</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-hw-tc-offload">feature-hw-tc-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-l2-fwd-offload">feature-l2-fwd-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-loopback">feature-loopback</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-lro">feature-lro</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-macsec-hw-offload">feature-macsec-hw-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-ntuple">feature-ntuple</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx">feature-rx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-all">feature-rx-all</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-fcs">feature-rx-fcs</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-gro-hw">feature-rx-gro-hw</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-gro-list">feature-rx-gro-list</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-udp-gro-forwarding">feature-rx-udp-gro-forwarding</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-udp_tunnel-port-offload">feature-rx-udp_tunnel-port-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-filter">feature-rx-vlan-filter</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-filter">feature-rx-vlan-stag-filter</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-hw-parse">feature-rx-vlan-stag-hw-parse</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rxhash">feature-rxhash</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rxvlan">feature-rxvlan</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-sg">feature-sg</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-record">feature-tls-hw-record</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-rx-offload">feature-tls-hw-rx-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-tx-offload">feature-tls-hw-tx-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tso">feature-tso</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx">feature-tx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-fcoe-crc">feature-tx-checksum-fcoe-crc</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ip-generic">feature-tx-checksum-ip-generic</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv4">feature-tx-checksum-ipv4</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv6">feature-tx-checksum-ipv6</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-sctp">feature-tx-checksum-sctp</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-esp-segmentation">feature-tx-esp-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-fcoe-segmentation">feature-tx-fcoe-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gre-csum-segmentation">feature-tx-gre-csum-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gre-segmentation">feature-tx-gre-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-list">feature-tx-gso-list</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-partial">feature-tx-gso-partial</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-robust">feature-tx-gso-robust</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-ipxip4-segmentation">feature-tx-ipxip4-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-ipxip6-segmentation">feature-tx-ipxip6-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-nocache-copy">feature-tx-nocache-copy</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather">feature-tx-scatter-gather</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather-fraglist">feature-tx-scatter-gather-fraglist</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-sctp-segmentation">feature-tx-sctp-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-ecn-segmentation">feature-tx-tcp-ecn-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-mangleid-segmentation">feature-tx-tcp-mangleid-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-segmentation">feature-tx-tcp-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp6-segmentation">feature-tx-tcp6-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tunnel-remcsum-segmentation">feature-tx-tunnel-remcsum-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp-segmentation">feature-tx-udp-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-csum-segmentation">feature-tx-udp_tnl-csum-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-segmentation">feature-tx-udp_tnl-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-vlan-stag-hw-insert">feature-tx-vlan-stag-hw-insert</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-txvlan">feature-txvlan</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-autoneg">pause-autoneg</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-rx">pause-rx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-tx">pause-tx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx">ring-rx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx-jumbo">ring-rx-jumbo</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx-mini">ring-rx-mini</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-tx">ring-tx</option></term><listitem><para/></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>gsm setting</title><para> GSM-based Mobile Broadband Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-adaptive-rx">coalesce-adaptive-rx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-adaptive-tx">coalesce-adaptive-tx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-high">coalesce-pkt-rate-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-low">coalesce-pkt-rate-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames">coalesce-rx-frames</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-high">coalesce-rx-frames-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-irq">coalesce-rx-frames-irq</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-low">coalesce-rx-frames-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs">coalesce-rx-usecs</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-high">coalesce-rx-usecs-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-irq">coalesce-rx-usecs-irq</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-low">coalesce-rx-usecs-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-sample-interval">coalesce-sample-interval</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-stats-block-usecs">coalesce-stats-block-usecs</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames">coalesce-tx-frames</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-high">coalesce-tx-frames-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-irq">coalesce-tx-frames-irq</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-low">coalesce-tx-frames-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs">coalesce-tx-usecs</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-high">coalesce-tx-usecs-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-irq">coalesce-tx-usecs-irq</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-low">coalesce-tx-usecs-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-esp-hw-offload">feature-esp-hw-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-esp-tx-csum-hw-offload">feature-esp-tx-csum-hw-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-fcoe-mtu">feature-fcoe-mtu</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-gro">feature-gro</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-gso">feature-gso</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-highdma">feature-highdma</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-hw-tc-offload">feature-hw-tc-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-l2-fwd-offload">feature-l2-fwd-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-loopback">feature-loopback</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-lro">feature-lro</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-macsec-hw-offload">feature-macsec-hw-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-ntuple">feature-ntuple</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx">feature-rx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-all">feature-rx-all</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-fcs">feature-rx-fcs</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-gro-hw">feature-rx-gro-hw</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-gro-list">feature-rx-gro-list</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-udp-gro-forwarding">feature-rx-udp-gro-forwarding</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-udp_tunnel-port-offload">feature-rx-udp_tunnel-port-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-filter">feature-rx-vlan-filter</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-filter">feature-rx-vlan-stag-filter</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-hw-parse">feature-rx-vlan-stag-hw-parse</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rxhash">feature-rxhash</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rxvlan">feature-rxvlan</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-sg">feature-sg</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-record">feature-tls-hw-record</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-rx-offload">feature-tls-hw-rx-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-tx-offload">feature-tls-hw-tx-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tso">feature-tso</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx">feature-tx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-fcoe-crc">feature-tx-checksum-fcoe-crc</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ip-generic">feature-tx-checksum-ip-generic</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv4">feature-tx-checksum-ipv4</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv6">feature-tx-checksum-ipv6</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-sctp">feature-tx-checksum-sctp</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-esp-segmentation">feature-tx-esp-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-fcoe-segmentation">feature-tx-fcoe-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gre-csum-segmentation">feature-tx-gre-csum-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gre-segmentation">feature-tx-gre-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-list">feature-tx-gso-list</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-partial">feature-tx-gso-partial</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-robust">feature-tx-gso-robust</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-ipxip4-segmentation">feature-tx-ipxip4-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-ipxip6-segmentation">feature-tx-ipxip6-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-nocache-copy">feature-tx-nocache-copy</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather">feature-tx-scatter-gather</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather-fraglist">feature-tx-scatter-gather-fraglist</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-sctp-segmentation">feature-tx-sctp-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-ecn-segmentation">feature-tx-tcp-ecn-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-mangleid-segmentation">feature-tx-tcp-mangleid-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-segmentation">feature-tx-tcp-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp6-segmentation">feature-tx-tcp6-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tunnel-remcsum-segmentation">feature-tx-tunnel-remcsum-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp-segmentation">feature-tx-udp-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-csum-segmentation">feature-tx-udp_tnl-csum-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-segmentation">feature-tx-udp_tnl-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-vlan-stag-hw-insert">feature-tx-vlan-stag-hw-insert</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-txvlan">feature-txvlan</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-autoneg">pause-autoneg</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-rx">pause-rx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-tx">pause-tx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx">ring-rx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx-jumbo">ring-rx-jumbo</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx-mini">ring-rx-mini</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-tx">ring-tx</option></term><listitem><para/></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>gsm setting</title><para>GSM-based Mobile Broadband Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.gsm.apn">apn</option></term><listitem><para> - Alias: apn</para><para> The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.auto-config">auto-config</option></term><listitem><para> When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.device-id">device-id</option></term><listitem><para> The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.home-only">home-only</option></term><listitem><para> When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.mtu">mtu</option></term><listitem><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.network-id">network-id</option></term><listitem><para> The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.number">number</option></term><listitem><para> Legacy setting that used to help establishing PPP data sessions for GSM-based modems. Deprecated: 1</para><para> + Alias: apn</para><para>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.auto-config">auto-config</option></term><listitem><para>When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.device-id">device-id</option></term><listitem><para>The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.home-only">home-only</option></term><listitem><para>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.mtu">mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.network-id">network-id</option></term><listitem><para>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.number">number</option></term><listitem><para>Legacy setting that used to help establishing PPP data sessions for GSM-based modems.</para><para> + This property is deprecated since version 1.16. + User-provided values for this setting are no longer used.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.password">password</option></term><listitem><para> - Alias: password</para><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.password-flags">password-flags</option></term><listitem><para> Flags indicating how to handle the "password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.pin">pin</option></term><listitem><para> If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.pin-flags">pin-flags</option></term><listitem><para> Flags indicating how to handle the "pin" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.sim-id">sim-id</option></term><listitem><para> The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.sim-operator-id">sim-operator-id</option></term><listitem><para> A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.</para><para> + Alias: password</para><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.password-flags">password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> + Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.pin">pin</option></term><listitem><para>If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.pin-flags">pin-flags</option></term><listitem><para>Flags indicating how to handle the "pin" property.</para><para> + Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.sim-id">sim-id</option></term><listitem><para>The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.sim-operator-id">sim-operator-id</option></term><listitem><para>A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.username">username</option></term><listitem><para> - Alias: user</para><para> 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.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>infiniband setting</title><para> Infiniband Settings.</para><para> + Alias: user</para><para>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.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>infiniband setting</title><para>Infiniband Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.infiniband.mac-address">mac-address</option></term><listitem><para> - Alias: mac</para><para> If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</para><para> + Alias: mac</para><para>If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</para><para> Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.infiniband.mtu">mtu</option></term><listitem><para> - Alias: mtu</para><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para><para> + Alias: mtu</para><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.infiniband.p-key">p-key</option></term><listitem><para> - Alias: p-key</para><para> The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.</para><para> + Alias: p-key</para><para>The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.</para><para> Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.infiniband.parent">parent</option></term><listitem><para> - Alias: parent</para><para> The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".</para><para> + Alias: parent</para><para>The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.infiniband.transport-mode">transport-mode</option></term><listitem><para> - Alias: transport-mode</para><para> The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ipv4 setting</title><para> IPv4 Settings.</para><para> + Alias: transport-mode</para><para>The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ipv4 setting</title><para>IPv4 Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.addresses">addresses</option></term><listitem><para> - Alias: ip4</para><para> Array of IP addresses.</para><para> - Format: a comma separated list of addresses</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dad-timeout">dad-timeout</option></term><listitem><para> Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds.</para><para> The property is currently implemented only for IPv4.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-client-id">dhcp-client-id</option></term><listitem><para> A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0.</para><para> The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links.</para><para> The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset.</para><para> The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id.</para><para> The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key.</para><para> If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-fqdn">dhcp-fqdn</option></term><listitem><para> If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-hostname">dhcp-hostname</option></term><listitem><para> If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-hostname-flags">dhcp-hostname-flags</option></term><listitem><para> Flags for the DHCP hostname and FQDN.</para><para> Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.</para><para> When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-iaid">dhcp-iaid</option></term><listitem><para> A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-reject-servers">dhcp-reject-servers</option></term><listitem><para> Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers.</para><para> For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24").</para><para> This property is currently not implemented for DHCPv6.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-send-hostname">dhcp-send-hostname</option></term><listitem><para> If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-timeout">dhcp-timeout</option></term><listitem><para> 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).</para><para> Set to 2147483647 (MAXINT32) for infinity.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-vendor-class-identifier">dhcp-vendor-class-identifier</option></term><listitem><para> The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns">dns</option></term><listitem><para> Array of IP addresses of DNS servers.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-options">dns-options</option></term><listitem><para> Array of DNS options as described in man 5 resolv.conf.</para><para> 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.</para><para> The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc".</para><para> The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.</para><para> When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-priority">dns-priority</option></term><listitem><para> DNS servers priority.</para><para> The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</para><para> Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.</para><para> 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.</para><para> 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.</para><para> 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.</para><para> 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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</para><para> When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-search">dns-search</option></term><listitem><para> List 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.</para><para> When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</para><para> When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</para><para> + Alias: ip4</para><para>Array of IP addresses.</para><para> + Format: a comma separated list of addresses</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.auto-route-ext-gw">auto-route-ext-gw</option></term><listitem><para>VPN connections will default to add the route automatically unless this setting is set to FALSE.</para><para>For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</para><para> + Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dad-timeout">dad-timeout</option></term><listitem><para>Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds.</para><para>The property is currently implemented only for IPv4.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-client-id">dhcp-client-id</option></term><listitem><para>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0.</para><para>The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links.</para><para>The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset.</para><para>The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id.</para><para>The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key.</para><para>If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-fqdn">dhcp-fqdn</option></term><listitem><para>If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-hostname">dhcp-hostname</option></term><listitem><para>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-hostname-flags">dhcp-hostname-flags</option></term><listitem><para>Flags for the DHCP hostname and FQDN.</para><para>Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.</para><para>When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-iaid">dhcp-iaid</option></term><listitem><para>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname".</para><para>For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.</para><para>For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address.</para><para>The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-reject-servers">dhcp-reject-servers</option></term><listitem><para>Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers.</para><para>For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24").</para><para>This property is currently not implemented for DHCPv6.</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-send-hostname">dhcp-send-hostname</option></term><listitem><para>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-timeout">dhcp-timeout</option></term><listitem><para>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).</para><para>Set to 2147483647 (MAXINT32) for infinity.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-vendor-class-identifier">dhcp-vendor-class-identifier</option></term><listitem><para>The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns">dns</option></term><listitem><para>Array of IP addresses of DNS servers.</para><para>For DoT (DNS over TLS), the SNI server name can be specified by appending "#example.com" to the IP address of the DNS server. This currently only has effect when using systemd-resolved.</para><para> + Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-options">dns-options</option></term><listitem><para>Array of DNS options as described in man 5 resolv.conf.</para><para>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.</para><para>The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc".</para><para>The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.</para><para>When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-priority">dns-priority</option></term><listitem><para>DNS servers priority.</para><para>The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</para><para>Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.</para><para>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.</para><para>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.</para><para>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.</para><para>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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</para><para>When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-search">dns-search</option></term><listitem><para>List 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.</para><para>When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</para><para>When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</para><para> Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.gateway">gateway</option></term><listitem><para> - Alias: gw4</para><para> The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</para><para> Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</para><para> Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.ignore-auto-dns">ignore-auto-dns</option></term><listitem><para> When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.ignore-auto-routes">ignore-auto-routes</option></term><listitem><para> When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.link-local">link-local</option></term><listitem><para> Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server.</para><para> When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.may-fail">may-fail</option></term><listitem><para> If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.method">method</option></term><listitem><para> IP configuration method.</para><para> NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.</para><para> In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.</para><para> For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.</para><para> For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.never-default">never-default</option></term><listitem><para> If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.required-timeout">required-timeout</option></term><listitem><para> The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</para><para> This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.</para><para> Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</para><para> A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.route-metric">route-metric</option></term><listitem><para> The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</para><para> - Format: int64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.route-table">route-table</option></term><listitem><para> Enable policy routing (source routing) and set the routing table used when adding routes.</para><para> This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para> If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para> Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para><para> + Alias: gw4</para><para>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</para><para>Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</para><para>Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.ignore-auto-dns">ignore-auto-dns</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.ignore-auto-routes">ignore-auto-routes</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.link-local">link-local</option></term><listitem><para>Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server.</para><para>When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.may-fail">may-fail</option></term><listitem><para>If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.method">method</option></term><listitem><para>IP configuration method.</para><para>NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.</para><para>In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.</para><para>For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.</para><para>For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.never-default">never-default</option></term><listitem><para>If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.replace-local-rule">replace-local-rule</option></term><listitem><para>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</para><para> + Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.required-timeout">required-timeout</option></term><listitem><para>The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</para><para>This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.</para><para>Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</para><para>A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.route-metric">route-metric</option></term><listitem><para>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</para><para> + Format: int64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.route-table">route-table</option></term><listitem><para>Enable policy routing (source routing) and set the routing table used when adding routes.</para><para>This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para>If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para>Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.routes">routes</option></term><listitem><para> -A list of IPv4 destination addresses, prefix length, optional IPv4 -next hop addresses, optional route metric, optional attribute. The valid syntax is: -"ip[/prefix] [next-hop] [metric] [attribute=val]...[,ip[/prefix]...]". -For example "192.0.2.0/24 10.1.1.1 77, 198.51.100.0/24". + A list of IPv4 destination addresses, prefix length, optional IPv4 + next hop addresses, optional route metric, optional attribute. The valid syntax is: + "ip[/prefix] [next-hop] [metric] [attribute=val]...[,ip[/prefix]...]". + For example "192.0.2.0/24 10.1.1.1 77, 198.51.100.0/24". </para><para> -Various attributes are supported: -<itemizedlist> -<listitem> -<para><literal>"advmss"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"cwnd"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"initcwnd"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"initrwnd"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"lock-advmss"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-cwnd"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-initcwnd"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-initrwnd"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-mtu"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-window"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"mtu"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"onlink"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"quickack"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"rto_min"</literal> - an unsigned 32 bit integer. -The value is in milliseconds.</para> -</listitem> -<listitem> -<para><literal>"scope"</literal> - an unsigned 8 bit integer. IPv4 only.</para> -</listitem> -<listitem> -<para><literal>"src"</literal> - an IPv4 address.</para> -</listitem> -<listitem> -<para><literal>"table"</literal> - an unsigned 32 bit integer. The default depends on ipv4.route-table.</para> -</listitem> -<listitem> -<para><literal>"tos"</literal> - an unsigned 8 bit integer. IPv4 only.</para> -</listitem> -<listitem> -<para><literal>"type"</literal> - one of <literal>unicast</literal>, <literal>local</literal>, <literal>blackhole</literal>, -<literal>unavailable</literal>, <literal>prohibit</literal>, <literal>throw</literal>. -The default is <literal>unicast</literal>.</para> -</listitem> -<listitem> -<para><literal>"window"</literal> - an unsigned 32 bit integer.</para> -</listitem> -</itemizedlist> + Various attributes are supported: + <itemizedlist> + <listitem> + <para><literal>"advmss"</literal> - an unsigned 32 bit integer.</para> + </listitem> + <listitem> + <para><literal>"cwnd"</literal> - an unsigned 32 bit integer.</para> + </listitem> + <listitem> + <para><literal>"initcwnd"</literal> - an unsigned 32 bit integer.</para> + </listitem> + <listitem> + <para><literal>"initrwnd"</literal> - an unsigned 32 bit integer.</para> + </listitem> + <listitem> + <para><literal>"lock-advmss"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"lock-cwnd"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"lock-initcwnd"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"lock-initrwnd"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"lock-mtu"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"lock-window"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"mtu"</literal> - an unsigned 32 bit integer.</para> + </listitem> + <listitem> + <para><literal>"onlink"</literal> - a boolean value. The onlink flag + is ignored for IPv4 routes without a gateway. That also means, + with a positive "weight" the route cannot merge with ECMP routes + which are onlink and have a gateway. + </para> + </listitem> + <listitem> + <para><literal>"quickack"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"rto_min"</literal> - an unsigned 32 bit integer. + The value is in milliseconds.</para> + </listitem> + <listitem> + <para><literal>"scope"</literal> - an unsigned 8 bit integer. IPv4 only.</para> + </listitem> + <listitem> + <para><literal>"src"</literal> - an IPv4 address.</para> + </listitem> + <listitem> + <para><literal>"table"</literal> - an unsigned 32 bit integer. The default depends on ipv4.route-table.</para> + </listitem> + <listitem> + <para><literal>"tos"</literal> - an unsigned 8 bit integer. IPv4 only.</para> + </listitem> + <listitem> + <para><literal>"type"</literal> - one of <literal>unicast</literal>, <literal>local</literal>, <literal>blackhole</literal>, + <literal>unreachable</literal>, <literal>prohibit</literal>, <literal>throw</literal>. + The default is <literal>unicast</literal>.</para> + </listitem> + <listitem> + <para><literal>"weight"</literal> - an unsigned 32 bit integer + ranging from 0 to 256. A non-zero weight indicates that the IPv4 + route is an ECMP IPv4 route. NetworkManager will automatically + merge compatible ECMP routes into multi-hop routes. Setting to + zero or omitting the attribute configures single hop routes that + won't get merged. If the route finds no merge partner, it is + configured as single hop route.</para> <para>Note that in + NetworkManager, currently all nexthops of a ECMP route must share + the same "onlink" flag in order to be mergable.</para> + </listitem> + <listitem> + <para><literal>"window"</literal> - an unsigned 32 bit integer.</para> + </listitem> + </itemizedlist> </para><para> For details see also `man ip-route`. </para><para> @@ -360,102 +385,104 @@ fixed priority. </para><para> Example: <literal>priority 5 from 192.167.4.0/24 table 45</literal> </para><para> - Format: a comma separated list of routing rules</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ipv6 setting</title><para> IPv6 Settings.</para><para> + Format: a comma separated list of routing rules</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ipv6 setting</title><para>IPv6 Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.addr-gen-mode">addr-gen-mode</option></term><listitem><para> Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3).</para><para> If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced.</para><para> The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced.</para><para> The special values "default" and "default-or-eui64" will fallback to the global connection default in as documented in NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively.</para><para> For libnm, the property defaults to "default" since 1.40. Previously it defaulted to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions.</para><para> Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.addr-gen-mode">addr-gen-mode</option></term><listitem><para>Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3).</para><para>If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced.</para><para>The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced.</para><para>The special values "default" and "default-or-eui64" will fallback to the global connection default in as documented in NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively.</para><para>For libnm, the property defaults to "default" since 1.40. Previously it defaulted to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions.</para><para>Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</para><para> Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.addresses">addresses</option></term><listitem><para> - Alias: ip6</para><para> Array of IP addresses.</para><para> - Format: a comma separated list of addresses</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-duid">dhcp-duid</option></term><listitem><para> A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option.</para><para> The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id.</para><para> The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk.</para><para> The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt").</para><para> When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-hostname">dhcp-hostname</option></term><listitem><para> If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-hostname-flags">dhcp-hostname-flags</option></term><listitem><para> Flags for the DHCP hostname and FQDN.</para><para> Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.</para><para> When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-iaid">dhcp-iaid</option></term><listitem><para> A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-send-hostname">dhcp-send-hostname</option></term><listitem><para> If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-timeout">dhcp-timeout</option></term><listitem><para> 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).</para><para> Set to 2147483647 (MAXINT32) for infinity.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns">dns</option></term><listitem><para> Array of IP addresses of DNS servers.</para><para> - Format: array of byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-options">dns-options</option></term><listitem><para> Array of DNS options as described in man 5 resolv.conf.</para><para> 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.</para><para> The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc".</para><para> The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.</para><para> When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-priority">dns-priority</option></term><listitem><para> DNS servers priority.</para><para> The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</para><para> Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.</para><para> 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.</para><para> 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.</para><para> 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.</para><para> 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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</para><para> When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-search">dns-search</option></term><listitem><para> List 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.</para><para> When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</para><para> When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</para><para> + Alias: ip6</para><para>Array of IP addresses.</para><para> + Format: a comma separated list of addresses</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.auto-route-ext-gw">auto-route-ext-gw</option></term><listitem><para>VPN connections will default to add the route automatically unless this setting is set to FALSE.</para><para>For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</para><para> + Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-duid">dhcp-duid</option></term><listitem><para>A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option.</para><para>The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id.</para><para>The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk.</para><para>The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt").</para><para>When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-hostname">dhcp-hostname</option></term><listitem><para>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-hostname-flags">dhcp-hostname-flags</option></term><listitem><para>Flags for the DHCP hostname and FQDN.</para><para>Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.</para><para>When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-iaid">dhcp-iaid</option></term><listitem><para>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname".</para><para>For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.</para><para>For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address.</para><para>The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-send-hostname">dhcp-send-hostname</option></term><listitem><para>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-timeout">dhcp-timeout</option></term><listitem><para>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).</para><para>Set to 2147483647 (MAXINT32) for infinity.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns">dns</option></term><listitem><para>Array of IP addresses of DNS servers.</para><para>For DoT (DNS over TLS), the SNI server name can be specified by appending "#example.com" to the IP address of the DNS server. This currently only has effect when using systemd-resolved.</para><para> + Format: array of byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-options">dns-options</option></term><listitem><para>Array of DNS options as described in man 5 resolv.conf.</para><para>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.</para><para>The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc".</para><para>The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.</para><para>When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-priority">dns-priority</option></term><listitem><para>DNS servers priority.</para><para>The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</para><para>Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.</para><para>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.</para><para>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.</para><para>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.</para><para>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. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</para><para>When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. 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 best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-search">dns-search</option></term><listitem><para>List 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.</para><para>When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</para><para>When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</para><para> Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.gateway">gateway</option></term><listitem><para> - Alias: gw6</para><para> The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</para><para> Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</para><para> Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ignore-auto-dns">ignore-auto-dns</option></term><listitem><para> When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ignore-auto-routes">ignore-auto-routes</option></term><listitem><para> When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ip6-privacy">ip6-privacy</option></term><listitem><para> Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).</para><para> Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy".</para><para> If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr".</para><para> Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.</para><para> - Format: NMSettingIP6ConfigPrivacy (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.may-fail">may-fail</option></term><listitem><para> If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.method">method</option></term><listitem><para> IP configuration method.</para><para> NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.</para><para> In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.</para><para> For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.</para><para> For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.mtu">mtu</option></term><listitem><para> Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.never-default">never-default</option></term><listitem><para> If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ra-timeout">ra-timeout</option></term><listitem><para> A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device.</para><para> Set to 2147483647 (MAXINT32) for infinity.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.required-timeout">required-timeout</option></term><listitem><para> The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</para><para> This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.</para><para> Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</para><para> A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.route-metric">route-metric</option></term><listitem><para> The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</para><para> - Format: int64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.route-table">route-table</option></term><listitem><para> Enable policy routing (source routing) and set the routing table used when adding routes.</para><para> This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para> If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para> Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para><para> + Alias: gw6</para><para>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</para><para>Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</para><para>Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ignore-auto-dns">ignore-auto-dns</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ignore-auto-routes">ignore-auto-routes</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ip6-privacy">ip6-privacy</option></term><listitem><para>Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).</para><para>Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy".</para><para>If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr".</para><para>Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.</para><para> + Format: NMSettingIP6ConfigPrivacy (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.may-fail">may-fail</option></term><listitem><para>If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.method">method</option></term><listitem><para>IP configuration method.</para><para>NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.</para><para>In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.</para><para>For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.</para><para>For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.mtu">mtu</option></term><listitem><para>Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.never-default">never-default</option></term><listitem><para>If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ra-timeout">ra-timeout</option></term><listitem><para>A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device.</para><para>Set to 2147483647 (MAXINT32) for infinity.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.replace-local-rule">replace-local-rule</option></term><listitem><para>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</para><para> + Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.required-timeout">required-timeout</option></term><listitem><para>The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</para><para>This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.</para><para>Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</para><para>A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.route-metric">route-metric</option></term><listitem><para>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</para><para> + Format: int64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.route-table">route-table</option></term><listitem><para>Enable policy routing (source routing) and set the routing table used when adding routes.</para><para>This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para>If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para>Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.routes">routes</option></term><listitem><para> -A list of IPv6 destination addresses, prefix length, optional IPv6 -next hop addresses, optional route metric, optional attribute. The valid syntax is: -"ip[/prefix] [next-hop] [metric] [attribute=val]...[,ip[/prefix]...]". + A list of IPv6 destination addresses, prefix length, optional IPv6 + next hop addresses, optional route metric, optional attribute. The valid syntax is: + "ip[/prefix] [next-hop] [metric] [attribute=val]...[,ip[/prefix]...]". </para><para> -Various attributes are supported: -<itemizedlist> -<listitem> -<para><literal>"advmss"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"cwnd"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"from"</literal> - an IPv6 address with optional prefix. IPv6 only.</para> -</listitem> -<listitem> -<para><literal>"initcwnd"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"initrwnd"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"lock-advmss"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-cwnd"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-initcwnd"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-initrwnd"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-mtu"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"lock-window"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"mtu"</literal> - an unsigned 32 bit integer.</para> -</listitem> -<listitem> -<para><literal>"onlink"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"quickack"</literal> - a boolean value.</para> -</listitem> -<listitem> -<para><literal>"rto_min"</literal> - an unsigned 32 bit integer. -The value is in milliseconds.</para> -</listitem> -<listitem> -<para><literal>"src"</literal> - an IPv6 address.</para> -</listitem> -<listitem> -<para><literal>"table"</literal> - an unsigned 32 bit integer. The default depends on ipv6.route-table.</para> -</listitem> -<listitem> -<para><literal>"type"</literal> - one of <literal>unicast</literal>, <literal>local</literal>, <literal>blackhole</literal>, -<literal>unavailable</literal>, <literal>prohibit</literal>, <literal>throw</literal>. -The default is <literal>unicast</literal>.</para> -</listitem> -<listitem> -<para><literal>"window"</literal> - an unsigned 32 bit integer.</para> -</listitem> -</itemizedlist> + Various attributes are supported: + <itemizedlist> + <listitem> + <para><literal>"advmss"</literal> - an unsigned 32 bit integer.</para> + </listitem> + <listitem> + <para><literal>"cwnd"</literal> - an unsigned 32 bit integer.</para> + </listitem> + <listitem> + <para><literal>"from"</literal> - an IPv6 address with optional prefix. IPv6 only.</para> + </listitem> + <listitem> + <para><literal>"initcwnd"</literal> - an unsigned 32 bit integer.</para> + </listitem> + <listitem> + <para><literal>"initrwnd"</literal> - an unsigned 32 bit integer.</para> + </listitem> + <listitem> + <para><literal>"lock-advmss"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"lock-cwnd"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"lock-initcwnd"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"lock-initrwnd"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"lock-mtu"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"lock-window"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"mtu"</literal> - an unsigned 32 bit integer.</para> + </listitem> + <listitem> + <para><literal>"onlink"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"quickack"</literal> - a boolean value.</para> + </listitem> + <listitem> + <para><literal>"rto_min"</literal> - an unsigned 32 bit integer. + The value is in milliseconds.</para> + </listitem> + <listitem> + <para><literal>"src"</literal> - an IPv6 address.</para> + </listitem> + <listitem> + <para><literal>"table"</literal> - an unsigned 32 bit integer. The default depends on ipv6.route-table.</para> + </listitem> + <listitem> + <para><literal>"type"</literal> - one of <literal>unicast</literal>, <literal>local</literal>, <literal>blackhole</literal>, + <literal>unreachable</literal>, <literal>prohibit</literal>, <literal>throw</literal>. + The default is <literal>unicast</literal>.</para> + </listitem> + <listitem> + <para><literal>"window"</literal> - an unsigned 32 bit integer.</para> + </listitem> + </itemizedlist> </para><para> For details see also `man ip-route`. </para><para> @@ -467,712 +494,728 @@ fixed priority. </para><para> Example: <literal>priority 5 from 1:2:3::5/128 table 45</literal> </para><para> - Format: a comma separated list of routing rules</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.token">token</option></term><listitem><para> Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ip-tunnel setting</title><para> IP Tunneling Settings.</para><para> + Format: a comma separated list of routing rules</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.token">token</option></term><listitem><para>Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ip-tunnel setting</title><para>IP Tunneling Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.encapsulation-limit">encapsulation-limit</option></term><listitem><para> How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.flags">flags</option></term><listitem><para> Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.flow-label">flow-label</option></term><listitem><para> The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.input-key">input-key</option></term><listitem><para> The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.encapsulation-limit">encapsulation-limit</option></term><listitem><para>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.flags">flags</option></term><listitem><para>Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.flow-label">flow-label</option></term><listitem><para>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.fwmark">fwmark</option></term><listitem><para>The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.input-key">input-key</option></term><listitem><para>The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.local">local</option></term><listitem><para> - Alias: local</para><para> The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</para><para> + Alias: local</para><para>The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.mode">mode</option></term><listitem><para> - Alias: mode</para><para> The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.mtu">mtu</option></term><listitem><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.output-key">output-key</option></term><listitem><para> The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para><para> + Alias: mode</para><para>The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.mtu">mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.output-key">output-key</option></term><listitem><para>The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.parent">parent</option></term><listitem><para> - Alias: dev</para><para> If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.path-mtu-discovery">path-mtu-discovery</option></term><listitem><para> Whether to enable Path MTU Discovery on this tunnel.</para><para> + Alias: dev</para><para>If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.path-mtu-discovery">path-mtu-discovery</option></term><listitem><para>Whether to enable Path MTU Discovery on this tunnel.</para><para> Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.remote">remote</option></term><listitem><para> - Alias: remote</para><para> The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.tos">tos</option></term><listitem><para> The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.ttl">ttl</option></term><listitem><para> The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>macsec setting</title><para> MACSec Settings.</para><para> + Alias: remote</para><para>The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.tos">tos</option></term><listitem><para>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.ttl">ttl</option></term><listitem><para>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</para><para> + Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>macsec setting</title><para>MACSec Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.macsec.encrypt">encrypt</option></term><listitem><para> - Alias: encrypt</para><para> Whether the transmitted traffic must be encrypted.</para><para> + Alias: encrypt</para><para>Whether the transmitted traffic must be encrypted.</para><para> Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.mka-cak">mka-cak</option></term><listitem><para> - Alias: cak</para><para> The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.mka-cak-flags">mka-cak-flags</option></term><listitem><para> Flags indicating how to handle the "mka-cak" property.</para><para> + Alias: cak</para><para>The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.mka-cak-flags">mka-cak-flags</option></term><listitem><para>Flags indicating how to handle the "mka-cak" property.</para><para> Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.mka-ckn">mka-ckn</option></term><listitem><para> - Alias: ckn</para><para> The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</para><para> + Alias: ckn</para><para>The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.mode">mode</option></term><listitem><para> - Alias: mode</para><para> Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</para><para> + Alias: mode</para><para>Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</para><para> Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.parent">parent</option></term><listitem><para> - Alias: dev</para><para> If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para><para> + Alias: dev</para><para>If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.port">port</option></term><listitem><para> - Alias: port</para><para> The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.send-sci">send-sci</option></term><listitem><para> Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.validation">validation</option></term><listitem><para> Specifies the validation mode for incoming frames.</para><para> - Format: int32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>macvlan setting</title><para> MAC VLAN Settings.</para><para> + Alias: port</para><para>The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.send-sci">send-sci</option></term><listitem><para>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.validation">validation</option></term><listitem><para>Specifies the validation mode for incoming frames.</para><para> + Format: int32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>macvlan setting</title><para>MAC VLAN Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.macvlan.mode">mode</option></term><listitem><para> - Alias: mode</para><para> The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</para><para> + Alias: mode</para><para>The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macvlan.parent">parent</option></term><listitem><para> - Alias: dev</para><para> If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macvlan.promiscuous">promiscuous</option></term><listitem><para> Whether the interface should be put in promiscuous mode.</para><para> + Alias: dev</para><para>If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macvlan.promiscuous">promiscuous</option></term><listitem><para>Whether the interface should be put in promiscuous mode.</para><para> Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macvlan.tap">tap</option></term><listitem><para> - Alias: tap</para><para> Whether the interface should be a MACVTAP.</para><para> - Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>match setting</title><para> Match settings.</para><para> + Alias: tap</para><para>Whether the interface should be a MACVTAP.</para><para> + Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>match setting</title><para>Match settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.match.driver">driver</option></term><listitem><para> A list of driver names to match. Each element is a shell wildcard pattern.</para><para> See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.interface-name">interface-name</option></term><listitem><para> A list of interface names to match. Each element is a shell wildcard pattern.</para><para> An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.kernel-command-line">kernel-command-line</option></term><listitem><para> A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported.</para><para> See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.path">path</option></term><listitem><para> A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier.</para><para> For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0".</para><para> The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev").</para><para> Each element of the list is a shell wildcard pattern.</para><para> See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.match.driver">driver</option></term><listitem><para>A list of driver names to match. Each element is a shell wildcard pattern.</para><para>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.interface-name">interface-name</option></term><listitem><para>A list of interface names to match. Each element is a shell wildcard pattern.</para><para>An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.kernel-command-line">kernel-command-line</option></term><listitem><para>A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported.</para><para>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.path">path</option></term><listitem><para>A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier.</para><para>For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0".</para><para>The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev").</para><para>Each element of the list is a shell wildcard pattern.</para><para>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</para><para> Format: array of string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-11-olpc-mesh setting</title><para> - Alias: olpc-mesh</para><para> OLPC Wireless Mesh Settings.</para><para> + Alias: olpc-mesh</para><para>OLPC Wireless Mesh Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-11-olpc-mesh.channel">channel</option></term><listitem><para> - Alias: channel</para><para> Channel on which the mesh network to join is located.</para><para> + Alias: channel</para><para>Channel on which the mesh network to join is located.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-olpc-mesh.dhcp-anycast-address">dhcp-anycast-address</option></term><listitem><para> - Alias: dhcp-anycast</para><para> Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.</para><para> This is currently only implemented by dhclient DHCP plugin.</para><para> + Alias: dhcp-anycast</para><para>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.</para><para>This is currently only implemented by dhclient DHCP plugin.</para><para> Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-olpc-mesh.ssid">ssid</option></term><listitem><para> - Alias: ssid</para><para> SSID of the mesh network to join.</para><para> - Format: byte array</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-bridge setting</title><para> OvsBridge Link Settings.</para><para> + Alias: ssid</para><para>SSID of the mesh network to join.</para><para> + Format: byte array</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-bridge setting</title><para>OvsBridge Link Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.datapath-type">datapath-type</option></term><listitem><para> The data path type. One of "system", "netdev" or empty.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.fail-mode">fail-mode</option></term><listitem><para> The bridge failure mode. One of "secure", "standalone" or empty.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.mcast-snooping-enable">mcast-snooping-enable</option></term><listitem><para> Enable or disable multicast snooping.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.rstp-enable">rstp-enable</option></term><listitem><para> Enable or disable RSTP.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.stp-enable">stp-enable</option></term><listitem><para> Enable or disable STP.</para><para> - Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-dpdk setting</title><para> OvsDpdk Link Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.datapath-type">datapath-type</option></term><listitem><para>The data path type. One of "system", "netdev" or empty.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.fail-mode">fail-mode</option></term><listitem><para>The bridge failure mode. One of "secure", "standalone" or empty.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.mcast-snooping-enable">mcast-snooping-enable</option></term><listitem><para>Enable or disable multicast snooping.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.rstp-enable">rstp-enable</option></term><listitem><para>Enable or disable RSTP.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.stp-enable">stp-enable</option></term><listitem><para>Enable or disable STP.</para><para> + Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-dpdk setting</title><para>OvsDpdk Link Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.devargs">devargs</option></term><listitem><para> Open vSwitch DPDK device arguments.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.n-rxq">n-rxq</option></term><listitem><para> Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-interface setting</title><para> Open vSwitch Interface Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.devargs">devargs</option></term><listitem><para>Open vSwitch DPDK device arguments.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.n-rxq">n-rxq</option></term><listitem><para>Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.n-rxq-desc">n-rxq-desc</option></term><listitem><para>The rx queue size (number of rx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.n-txq-desc">n-txq-desc</option></term><listitem><para>The tx queue size (number of tx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.</para><para> + Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-interface setting</title><para>Open vSwitch Interface Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-interface.type">type</option></term><listitem><para> The interface type. Either "internal", "system", "patch", "dpdk", or empty.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-patch setting</title><para> OvsPatch Link Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-interface.ofport-request">ofport-request</option></term><listitem><para>Open vSwitch openflow port number. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network. OpenFlow switches connect logically to each other via their OpenFlow ports.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-interface.type">type</option></term><listitem><para>The interface type. Either "internal", "system", "patch", "dpdk", or empty.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-patch setting</title><para>OvsPatch Link Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-patch.peer">peer</option></term><listitem><para> Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-port setting</title><para> OvsPort Link Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-patch.peer">peer</option></term><listitem><para>Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-port setting</title><para>OvsPort Link Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.bond-downdelay">bond-downdelay</option></term><listitem><para> The time port must be inactive in order to be considered down.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.bond-mode">bond-mode</option></term><listitem><para> Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.bond-updelay">bond-updelay</option></term><listitem><para> The time port must be active before it starts forwarding traffic.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.lacp">lacp</option></term><listitem><para> LACP mode. One of "active", "off", or "passive".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.tag">tag</option></term><listitem><para> The VLAN tag in the range 0-4095.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.vlan-mode">vlan-mode</option></term><listitem><para> The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ppp setting</title><para> Point-to-Point Protocol Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.bond-downdelay">bond-downdelay</option></term><listitem><para>The time port must be inactive in order to be considered down.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.bond-mode">bond-mode</option></term><listitem><para>Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.bond-updelay">bond-updelay</option></term><listitem><para>The time port must be active before it starts forwarding traffic.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.lacp">lacp</option></term><listitem><para>LACP mode. One of "active", "off", or "passive".</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.tag">tag</option></term><listitem><para>The VLAN tag in the range 0-4095.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.trunks">trunks</option></term><listitem><para>A list of VLAN ranges that this port trunks.</para><para>The property is valid only for ports with mode "trunk", "native-tagged", or "native-untagged port". If it is empty, the port trunks all VLANs.</para><para> + Format: array of vardict</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.vlan-mode">vlan-mode</option></term><listitem><para>The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ppp setting</title><para>Point-to-Point Protocol Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ppp.baud">baud</option></term><listitem><para> If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.crtscts">crtscts</option></term><listitem><para> If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.lcp-echo-failure">lcp-echo-failure</option></term><listitem><para> If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.lcp-echo-interval">lcp-echo-interval</option></term><listitem><para> If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mppe-stateful">mppe-stateful</option></term><listitem><para> If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mru">mru</option></term><listitem><para> If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mtu">mtu</option></term><listitem><para> If non-zero, instruct pppd to send packets no larger than the specified size.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.no-vj-comp">no-vj-comp</option></term><listitem><para> If TRUE, Van Jacobsen TCP header compression will not be requested.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.noauth">noauth</option></term><listitem><para> If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.nobsdcomp">nobsdcomp</option></term><listitem><para> If TRUE, BSD compression will not be requested.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.nodeflate">nodeflate</option></term><listitem><para> If TRUE, "deflate" compression will not be requested.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-chap">refuse-chap</option></term><listitem><para> If TRUE, the CHAP authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-eap">refuse-eap</option></term><listitem><para> If TRUE, the EAP authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-mschap">refuse-mschap</option></term><listitem><para> If TRUE, the MSCHAP authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-mschapv2">refuse-mschapv2</option></term><listitem><para> If TRUE, the MSCHAPv2 authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-pap">refuse-pap</option></term><listitem><para> If TRUE, the PAP authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.require-mppe">require-mppe</option></term><listitem><para> If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.require-mppe-128">require-mppe-128</option></term><listitem><para> If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</para><para> - Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>pppoe setting</title><para> PPP-over-Ethernet Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ppp.baud">baud</option></term><listitem><para>If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.crtscts">crtscts</option></term><listitem><para>If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.lcp-echo-failure">lcp-echo-failure</option></term><listitem><para>If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.lcp-echo-interval">lcp-echo-interval</option></term><listitem><para>If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mppe-stateful">mppe-stateful</option></term><listitem><para>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mru">mru</option></term><listitem><para>If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mtu">mtu</option></term><listitem><para>If non-zero, instruct pppd to send packets no larger than the specified size.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.no-vj-comp">no-vj-comp</option></term><listitem><para>If TRUE, Van Jacobsen TCP header compression will not be requested.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.noauth">noauth</option></term><listitem><para>If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.nobsdcomp">nobsdcomp</option></term><listitem><para>If TRUE, BSD compression will not be requested.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.nodeflate">nodeflate</option></term><listitem><para>If TRUE, "deflate" compression will not be requested.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-chap">refuse-chap</option></term><listitem><para>If TRUE, the CHAP authentication method will not be used.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-eap">refuse-eap</option></term><listitem><para>If TRUE, the EAP authentication method will not be used.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-mschap">refuse-mschap</option></term><listitem><para>If TRUE, the MSCHAP authentication method will not be used.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-mschapv2">refuse-mschapv2</option></term><listitem><para>If TRUE, the MSCHAPv2 authentication method will not be used.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-pap">refuse-pap</option></term><listitem><para>If TRUE, the PAP authentication method will not be used.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.require-mppe">require-mppe</option></term><listitem><para>If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.require-mppe-128">require-mppe-128</option></term><listitem><para>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</para><para> + Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>pppoe setting</title><para>PPP-over-Ethernet Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.parent">parent</option></term><listitem><para> - Alias: parent</para><para> If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.</para><para> + Alias: parent</para><para>If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.password">password</option></term><listitem><para> - Alias: password</para><para> Password used to authenticate with the PPPoE service.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.password-flags">password-flags</option></term><listitem><para> Flags indicating how to handle the "password" property.</para><para> + Alias: password</para><para>Password used to authenticate with the PPPoE service.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.password-flags">password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.service">service</option></term><listitem><para> - Alias: service</para><para> If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</para><para> + Alias: service</para><para>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.username">username</option></term><listitem><para> - Alias: username</para><para> Username used to authenticate with the PPPoE service.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>proxy setting</title><para> WWW Proxy Settings.</para><para> + Alias: username</para><para>Username used to authenticate with the PPPoE service.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>proxy setting</title><para>WWW Proxy Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.proxy.browser-only">browser-only</option></term><listitem><para> - Alias: browser-only</para><para> Whether the proxy configuration is for browser only.</para><para> + Alias: browser-only</para><para>Whether the proxy configuration is for browser only.</para><para> Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.proxy.method">method</option></term><listitem><para> - Alias: method</para><para> Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</para><para> + Alias: method</para><para>Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</para><para> Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.proxy.pac-script">pac-script</option></term><listitem><para> - Alias: pac-script</para><para> PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.</para><para> + Alias: pac-script</para><para>PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.proxy.pac-url">pac-url</option></term><listitem><para> - Alias: pac-url</para><para> PAC URL for obtaining PAC file.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>serial setting</title><para> Serial Link Settings.</para><para> + Alias: pac-url</para><para>PAC URL for obtaining PAC file.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>serial setting</title><para>Serial Link Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.serial.baud">baud</option></term><listitem><para> Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.bits">bits</option></term><listitem><para> Byte-width of the serial communication. The 8 in "8n1" for example.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.parity">parity</option></term><listitem><para> Parity setting of the serial port.</para><para> - Format: NMSettingSerialParity (byte)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.send-delay">send-delay</option></term><listitem><para> Time to delay between each byte sent to the modem, in microseconds.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.stopbits">stopbits</option></term><listitem><para> Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>sriov setting</title><para> SR-IOV settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.serial.baud">baud</option></term><listitem><para>Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.bits">bits</option></term><listitem><para>Byte-width of the serial communication. The 8 in "8n1" for example.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.parity">parity</option></term><listitem><para>Parity setting of the serial port.</para><para> + Format: NMSettingSerialParity (byte)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.send-delay">send-delay</option></term><listitem><para>Time to delay between each byte sent to the modem, in microseconds.</para><para> + Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.stopbits">stopbits</option></term><listitem><para>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</para><para> + Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>sriov setting</title><para>SR-IOV settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.sriov.autoprobe-drivers">autoprobe-drivers</option></term><listitem><para> Whether to autoprobe virtual functions by a compatible driver.</para><para> 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.</para><para> If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them.</para><para> 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).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.total-vfs">total-vfs</option></term><listitem><para> The total number of virtual functions to create.</para><para> 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.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.vfs">vfs</option></term><listitem><para> Array of virtual function descriptors.</para><para> Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF.</para><para> When represented as string a VF is in the form:</para><para> "INDEX [ATTR=VALUE[ ATTR=VALUE]...]".</para><para> for example:</para><para> "2 mac=00:11:22:33:44:55 spoof-check=true".</para><para> 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.</para><para> The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form</para><para> "ID[.PRIORITY[.PROTO]]".</para><para> PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.</para><para> - Format: array of vardict</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>tc setting</title><para> Linux Traffic Control Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.sriov.autoprobe-drivers">autoprobe-drivers</option></term><listitem><para>Whether to autoprobe virtual functions by a compatible driver.</para><para>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.</para><para>If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them.</para><para>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).</para><para> + Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.total-vfs">total-vfs</option></term><listitem><para>The total number of virtual functions to create.</para><para>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.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.vfs">vfs</option></term><listitem><para>Array of virtual function descriptors.</para><para>Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF.</para><para>When represented as string a VF is in the form:</para><para>"INDEX [ATTR=VALUE[ ATTR=VALUE]...]".</para><para>for example:</para><para>"2 mac=00:11:22:33:44:55 spoof-check=true".</para><para>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.</para><para>The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form</para><para>"ID[.PRIORITY[.PROTO]]".</para><para>PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.</para><para> + Format: array of vardict</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>tc setting</title><para>Linux Traffic Control Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.tc.qdiscs">qdiscs</option></term><listitem><para> Array of TC queueing disciplines. qdisc is a basic block in the Linux traffic control subsystem </para><para> -Each qdisc can be specified by the following attributes: + Each qdisc can be specified by the following attributes: </para><variablelist> -<varlistentry> -<term><varname>handle HANDLE</varname></term> -<listitem> -<para> -specifies the qdisc handle. A qdisc, which potentially can have children, gets -assigned a major number, called a 'handle', leaving the minor number namespace -available for classes. The handle is expressed as '10:'. It is customary to -explicitly assign a handle to qdiscs expected to have children. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>parent HANDLE</varname></term> -<listitem> -<para> -specifies the handle of the parent qdisc the current qdisc must be -attached to. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>root</varname></term> -<listitem> -<para> -specifies that the qdisc is attached to the root of device. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>KIND</varname></term> -<listitem> -<para> -this is the qdisc kind. NetworkManager currently supports the -following kinds: fq_codel, sfq, tbf. Each qdisc kind has a -different set of parameters, described below. There are also some -kinds like pfifo, pfifo_fast, prio supported by NetworkManager -but their parameters are not supported by NetworkManager. -</para> -</listitem> + <varlistentry> + <term><varname>handle HANDLE</varname></term> + <listitem> + <para> + specifies the qdisc handle. A qdisc, which potentially can have children, gets + assigned a major number, called a 'handle', leaving the minor number namespace + available for classes. The handle is expressed as '10:'. It is customary to + explicitly assign a handle to qdiscs expected to have children. + </para> + </listitem> </varlistentry> + <varlistentry> + <term><varname>parent HANDLE</varname></term> + <listitem> + <para> + specifies the handle of the parent qdisc the current qdisc must be + attached to. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>root</varname></term> + <listitem> + <para> + specifies that the qdisc is attached to the root of device. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>KIND</varname></term> + <listitem> + <para> + this is the qdisc kind. NetworkManager currently supports the + following kinds: fq_codel, sfq, tbf. Each qdisc kind has a + different set of parameters, described below. There are also some + kinds like pfifo, pfifo_fast, prio supported by NetworkManager + but their parameters are not supported by NetworkManager. + </para> + </listitem> + </varlistentry> </variablelist><para> -Parameters for 'fq_codel': + Parameters for 'fq_codel': </para><variablelist> -<varlistentry> -<term><varname>limit U32</varname></term> -<listitem> -<para> -the hard limit on the real queue size. When this limit is -reached, incoming packets are dropped. Default is 10240 packets. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>memory_limit U32</varname></term> -<listitem> -<para> -sets a limit on the total number of bytes that can be queued in -this FQ-CoDel instance. The lower of the packet limit of the -limit parameter and the memory limit will be enforced. Default is -32 MB. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>flows U32</varname></term> -<listitem> -<para> -the number of flows into which the incoming packets are -classified. Due to the stochastic nature of hashing, multiple -flows may end up being hashed into the same slot. Newer flows -have priority over older ones. This parameter can be set only at -load time since memory has to be allocated for the hash table. -Default value is 1024. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>target U32</varname></term> -<listitem> -<para> -the acceptable minimum standing/persistent queue delay. This minimum -delay is identified by tracking the local minimum queue delay that packets -experience. The unit of measurement is microsecond(us). Default value is 5ms. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>interval U32</varname></term> -<listitem> -<para> -used to ensure that the measured minimum delay does not become too stale. -The minimum delay must be experienced in the last epoch of length .B -interval. It should be set on the order of the worst-case RTT -through the bottleneck to give endpoints sufficient time to -react. Default value is 100ms. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>quantum U32</varname></term> -<listitem> -<para> -the number of bytes used as 'deficit' in the fair queuing -algorithm. Default is set to 1514 bytes which corresponds to the -Ethernet MTU plus the hardware header length of 14 bytes. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>ecn BOOL</varname></term> -<listitem> -<para> -can be used to mark packets instead of dropping them. ecn is turned -on by default. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>ce_threshold U32</varname></term> -<listitem> -<para> -sets a threshold above which all packets are marked with ECN -Congestion Experienced. This is useful for DCTCP-style congestion -control algorithms that require marking at very shallow queueing -thresholds. -</para> -</listitem> + <varlistentry> + <term><varname>limit U32</varname></term> + <listitem> + <para> + the hard limit on the real queue size. When this limit is + reached, incoming packets are dropped. Default is 10240 packets. + </para> + </listitem> </varlistentry> + <varlistentry> + <term><varname>memory_limit U32</varname></term> + <listitem> + <para> + sets a limit on the total number of bytes that can be queued in + this FQ-CoDel instance. The lower of the packet limit of the + limit parameter and the memory limit will be enforced. Default is + 32 MB. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>flows U32</varname></term> + <listitem> + <para> + the number of flows into which the incoming packets are + classified. Due to the stochastic nature of hashing, multiple + flows may end up being hashed into the same slot. Newer flows + have priority over older ones. This parameter can be set only at + load time since memory has to be allocated for the hash table. + Default value is 1024. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>target U32</varname></term> + <listitem> + <para> + the acceptable minimum standing/persistent queue delay. This minimum + delay is identified by tracking the local minimum queue delay that packets + experience. The unit of measurement is microsecond(us). Default value is 5ms. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>interval U32</varname></term> + <listitem> + <para> + used to ensure that the measured minimum delay does not become too stale. + The minimum delay must be experienced in the last epoch of length .B + interval. It should be set on the order of the worst-case RTT + through the bottleneck to give endpoints sufficient time to + react. Default value is 100ms. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>quantum U32</varname></term> + <listitem> + <para> + the number of bytes used as 'deficit' in the fair queuing + algorithm. Default is set to 1514 bytes which corresponds to the + Ethernet MTU plus the hardware header length of 14 bytes. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>ecn BOOL</varname></term> + <listitem> + <para> + can be used to mark packets instead of dropping them. ecn is turned + on by default. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>ce_threshold U32</varname></term> + <listitem> + <para> + sets a threshold above which all packets are marked with ECN + Congestion Experienced. This is useful for DCTCP-style congestion + control algorithms that require marking at very shallow queueing + thresholds. + </para> + </listitem> + </varlistentry> </variablelist><para> -Parameters for 'sfq': + Parameters for 'sfq': </para><variablelist> -<varlistentry> -<term><varname>divisor U32</varname></term> -<listitem> -<para> -can be used to set a different hash table size, available -from kernel 2.6.39 onwards. The specified divisor must be -a power of two and cannot be larger than 65536. Default -value: 1024. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>limit U32</varname></term> -<listitem> -<para> -Upper limit of the SFQ. Can be used to reduce the default -length of 127 packets. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>depth U32</varname></term> -<listitem> -<para> -Limit of packets per flow. Default to -127 and can be lowered. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>perturb_period U32</varname></term> -<listitem> -<para> -Interval in seconds for queue algorithm perturbation. -Defaults to 0, which means that no perturbation occurs. Do -not set too low for each perturbation may cause some -packet reordering or losses. Advised value: 60 This value -has no effect when external flow classification is used. -Its better to increase divisor value to lower risk of hash -collisions. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>quantum U32</varname></term> -<listitem> -<para> -Amount of bytes a flow is allowed to dequeue during a -round of the round robin process. Defaults to the MTU of -the interface which is also the advised value and the -minimum value. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>flows U32</varname></term> -<listitem> -<para> -Default value is 127. -</para> -</listitem> + <varlistentry> + <term><varname>divisor U32</varname></term> + <listitem> + <para> + can be used to set a different hash table size, available + from kernel 2.6.39 onwards. The specified divisor must be + a power of two and cannot be larger than 65536. + Default value: 1024. + </para> + </listitem> </varlistentry> + <varlistentry> + <term><varname>limit U32</varname></term> + <listitem> + <para> + Upper limit of the SFQ. Can be used to reduce the default + length of 127 packets. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>depth U32</varname></term> + <listitem> + <para> + Limit of packets per flow. Default to + 127 and can be lowered. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>perturb_period U32</varname></term> + <listitem> + <para> + Interval in seconds for queue algorithm perturbation. + Defaults to 0, which means that no perturbation occurs. Do + not set too low for each perturbation may cause some + packet reordering or losses. Advised value: 60 This value + has no effect when external flow classification is used. + Its better to increase divisor value to lower risk of hash + collisions. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>quantum U32</varname></term> + <listitem> + <para> + Amount of bytes a flow is allowed to dequeue during a + round of the round robin process. Defaults to the MTU of + the interface which is also the advised value and the + minimum value. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>flows U32</varname></term> + <listitem> + <para> + Default value is 127. + </para> + </listitem> + </varlistentry> </variablelist><para> -Parameters for 'tbf': + Parameters for 'tbf': </para><variablelist> -<varlistentry> -<term><varname>rate U64</varname></term> -<listitem> -<para> -Bandwidth or rate. These parameters accept a floating -point number, possibly followed by either a unit (both SI -and IEC units supported), or a float followed by a percent -character to specify the rate as a percentage of the -device's speed. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>burst U32</varname></term> -<listitem> -<para> -Also known as buffer or maxburst. Size of the bucket, in -bytes. This is the maximum amount of bytes that tokens can -be available for instantaneously. In general, larger -shaping rates require a larger buffer. For 10mbit/s on -Intel, you need at least 10kbyte buffer if you want to -reach your configured rate! -</para> -<para> -If your buffer is too small, packets may be dropped -because more tokens arrive per timer tick than fit in your -bucket. The minimum buffer size can be calculated by -dividing the rate by HZ. -</para> -<para> -Token usage calculations are performed using a table which -by default has a resolution of 8 packets. This resolution -can be changed by specifying the cell size with the burst. -For example, to specify a 6000 byte buffer with a 16 byte -cell size, set a burst of 6000/16. You will probably never -have to set this. Must be an integral power of 2. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>limit U32</varname></term> -<listitem> -<para> -Limit is the number of bytes that can be queued waiting -for tokens to become available. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>latency U32</varname></term> -<listitem> -<para> -specifies the maximum amount of time a packet can -sit in the TBF. The latency calculation takes into account -the size of the bucket, the rate and possibly the peakrate -(if set). The latency and limit are mutually exclusive. -</para> -</listitem> + <varlistentry> + <term><varname>rate U64</varname></term> + <listitem> + <para> + Bandwidth or rate. These parameters accept a floating + point number, possibly followed by either a unit (both SI + and IEC units supported), or a float followed by a percent + character to specify the rate as a percentage of the + device's speed. + </para> + </listitem> </varlistentry> + <varlistentry> + <term><varname>burst U32</varname></term> + <listitem> + <para> + Also known as buffer or maxburst. Size of the bucket, in + bytes. This is the maximum amount of bytes that tokens can + be available for instantaneously. In general, larger + shaping rates require a larger buffer. For 10mbit/s on + Intel, you need at least 10kbyte buffer if you want to + reach your configured rate! + </para> + <para> + If your buffer is too small, packets may be dropped + because more tokens arrive per timer tick than fit in your + bucket. The minimum buffer size can be calculated by + dividing the rate by HZ. + </para> + <para> + Token usage calculations are performed using a table which + by default has a resolution of 8 packets. This resolution + can be changed by specifying the cell size with the burst. + For example, to specify a 6000 byte buffer with a 16 byte + cell size, set a burst of 6000/16. You will probably never + have to set this. Must be an integral power of 2. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>limit U32</varname></term> + <listitem> + <para> + Limit is the number of bytes that can be queued waiting + for tokens to become available. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>latency U32</varname></term> + <listitem> + <para> + specifies the maximum amount of time a packet can + sit in the TBF. The latency calculation takes into account + the size of the bucket, the rate and possibly the peakrate + (if set). The latency and limit are mutually exclusive. + </para> + </listitem> + </varlistentry> </variablelist><para> Format: GPtrArray(NMTCQdisc)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tc.tfilters">tfilters</option></term><listitem><para> -Array of TC traffic filters. Traffic control can manage the packet content during -classification by using filters. + Array of TC traffic filters. Traffic control can manage the packet content during + classification by using filters. </para><para> -Each tfilters can be specified by the following attributes: + Each tfilters can be specified by the following attributes: </para><variablelist> -<varlistentry> -<term><varname>handle HANDLE</varname></term> -<listitem> -<para> -specifies the tfilters handle. A filter is used by a classful qdisc to determine in which class -a packet will be enqueued. It is important to notice that filters reside within qdiscs. Therefore, -see qdiscs handle for detailed information. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>parent HANDLE</varname></term> -<listitem> -<para> -specifies the handle of the parent qdisc the current qdisc must be -attached to. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>root</varname></term> -<listitem> -<para> -specifies that the qdisc is attached to the root of device. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>KIND</varname></term> -<listitem> -<para> -this is the tfilters kind. NetworkManager currently supports -following kinds: mirred, simple. Each filter kind has a -different set of actions, described below. There are also some -other kinds like matchall, basic, u32 supported by NetworkManager. -</para> -</listitem> + <varlistentry> + <term><varname>handle HANDLE</varname></term> + <listitem> + <para> + specifies the tfilters handle. A filter is used by a classful qdisc to determine in which class + a packet will be enqueued. It is important to notice that filters reside within qdiscs. Therefore, + see qdiscs handle for detailed information. + </para> + </listitem> </varlistentry> + <varlistentry> + <term><varname>parent HANDLE</varname></term> + <listitem> + <para> + specifies the handle of the parent qdisc the current qdisc must be + attached to. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>root</varname></term> + <listitem> + <para> + specifies that the qdisc is attached to the root of device. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>KIND</varname></term> + <listitem> + <para> + this is the tfilters kind. NetworkManager currently supports + following kinds: mirred, simple. Each filter kind has a + different set of actions, described below. There are also some + other kinds like matchall, basic, u32 supported by NetworkManager. + </para> + </listitem> + </varlistentry> </variablelist><para> -Actions for 'mirred': + Actions for 'mirred': </para><variablelist> -<varlistentry> -<term><varname>egress bool</varname></term> -<listitem> -<para> -Define whether the packet should exit from the interface. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>ingress bool</varname></term> -<listitem> -<para> -Define whether the packet should come into the interface. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>mirror bool</varname></term> -<listitem> -<para> -Define whether the packet should be copied to the destination space. -</para> -</listitem> -</varlistentry> -<varlistentry> -<term><varname>redirect bool</varname></term> -<listitem> -<para> -Define whether the packet should be moved to the destination space. -</para> -</listitem> + <varlistentry> + <term><varname>egress bool</varname></term> + <listitem> + <para> + Define whether the packet should exit from the interface. + </para> + </listitem> </varlistentry> + <varlistentry> + <term><varname>ingress bool</varname></term> + <listitem> + <para> + Define whether the packet should come into the interface. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>mirror bool</varname></term> + <listitem> + <para> + Define whether the packet should be copied to the destination space. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>redirect bool</varname></term> + <listitem> + <para> + Define whether the packet should be moved to the destination space. + </para> + </listitem> + </varlistentry> </variablelist><para> -Action for 'simple': + Action for 'simple': </para><variablelist> -<varlistentry> -<term><varname>sdata char[32]</varname></term> -<listitem> -<para> -The actual string to print. -</para> -</listitem> + <varlistentry> + <term><varname>sdata char[32]</varname></term> + <listitem> + <para> + The actual string to print. + </para> + </listitem> </varlistentry> </variablelist><para> - Format: GPtrArray(NMTCTfilter)</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>team setting</title><para> Teaming Settings.</para><para> + Format: GPtrArray(NMTCTfilter)</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>team setting</title><para>Teaming Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.team.config">config</option></term><listitem><para> - Alias: config</para><para> The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.link-watchers">link-watchers</option></term><listitem><para> Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</para><para> - Format: array of vardict</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.mcast-rejoin-count">mcast-rejoin-count</option></term><listitem><para> Corresponds to the teamd mcast_rejoin.count.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.mcast-rejoin-interval">mcast-rejoin-interval</option></term><listitem><para> Corresponds to the teamd mcast_rejoin.interval.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.notify-peers-count">notify-peers-count</option></term><listitem><para> Corresponds to the teamd notify_peers.count.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.notify-peers-interval">notify-peers-interval</option></term><listitem><para> Corresponds to the teamd notify_peers.interval.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner">runner</option></term><listitem><para> Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-active">runner-active</option></term><listitem><para> Corresponds to the teamd runner.active.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-agg-select-policy">runner-agg-select-policy</option></term><listitem><para> Corresponds to the teamd runner.agg_select_policy.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-fast-rate">runner-fast-rate</option></term><listitem><para> Corresponds to the teamd runner.fast_rate.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-hwaddr-policy">runner-hwaddr-policy</option></term><listitem><para> Corresponds to the teamd runner.hwaddr_policy.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-min-ports">runner-min-ports</option></term><listitem><para> Corresponds to the teamd runner.min_ports.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-sys-prio">runner-sys-prio</option></term><listitem><para> Corresponds to the teamd runner.sys_prio.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-balancer">runner-tx-balancer</option></term><listitem><para> Corresponds to the teamd runner.tx_balancer.name.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-balancer-interval">runner-tx-balancer-interval</option></term><listitem><para> Corresponds to the teamd runner.tx_balancer.interval.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-hash">runner-tx-hash</option></term><listitem><para> Corresponds to the teamd runner.tx_hash.</para><para> - Format: array of string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>team-port setting</title><para> Team Port Settings.</para><para> + Alias: config</para><para>The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.link-watchers">link-watchers</option></term><listitem><para>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</para><para> + Format: array of vardict</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.mcast-rejoin-count">mcast-rejoin-count</option></term><listitem><para>Corresponds to the teamd mcast_rejoin.count.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.mcast-rejoin-interval">mcast-rejoin-interval</option></term><listitem><para>Corresponds to the teamd mcast_rejoin.interval.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.notify-peers-count">notify-peers-count</option></term><listitem><para>Corresponds to the teamd notify_peers.count.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.notify-peers-interval">notify-peers-interval</option></term><listitem><para>Corresponds to the teamd notify_peers.interval.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner">runner</option></term><listitem><para>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-active">runner-active</option></term><listitem><para>Corresponds to the teamd runner.active.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-agg-select-policy">runner-agg-select-policy</option></term><listitem><para>Corresponds to the teamd runner.agg_select_policy.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-fast-rate">runner-fast-rate</option></term><listitem><para>Corresponds to the teamd runner.fast_rate.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-hwaddr-policy">runner-hwaddr-policy</option></term><listitem><para>Corresponds to the teamd runner.hwaddr_policy.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-min-ports">runner-min-ports</option></term><listitem><para>Corresponds to the teamd runner.min_ports.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-sys-prio">runner-sys-prio</option></term><listitem><para>Corresponds to the teamd runner.sys_prio.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-balancer">runner-tx-balancer</option></term><listitem><para>Corresponds to the teamd runner.tx_balancer.name.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-balancer-interval">runner-tx-balancer-interval</option></term><listitem><para>Corresponds to the teamd runner.tx_balancer.interval.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-hash">runner-tx-hash</option></term><listitem><para>Corresponds to the teamd runner.tx_hash.</para><para> + Format: array of string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>team-port setting</title><para>Team Port Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.team-port.config">config</option></term><listitem><para> - Alias: config</para><para> The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.lacp-key">lacp-key</option></term><listitem><para> Corresponds to the teamd ports.PORTIFNAME.lacp_key.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.lacp-prio">lacp-prio</option></term><listitem><para> Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.link-watchers">link-watchers</option></term><listitem><para> Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</para><para> - Format: array of vardict</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.prio">prio</option></term><listitem><para> Corresponds to the teamd ports.PORTIFNAME.prio.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.queue-id">queue-id</option></term><listitem><para> Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.sticky">sticky</option></term><listitem><para> Corresponds to the teamd ports.PORTIFNAME.sticky.</para><para> - Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>tun setting</title><para> Tunnel Settings.</para><para> + Alias: config</para><para>The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.lacp-key">lacp-key</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.lacp_key.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.lacp-prio">lacp-prio</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.link-watchers">link-watchers</option></term><listitem><para>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</para><para> + Format: array of vardict</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.prio">prio</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.prio.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.queue-id">queue-id</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.sticky">sticky</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.sticky.</para><para> + Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>tun setting</title><para>Tunnel Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.tun.group">group</option></term><listitem><para> - Alias: group</para><para> The group ID which will own the device. If set to NULL everyone will be able to use the device.</para><para> + Alias: group</para><para>The group ID which will own the device. If set to NULL everyone will be able to use the device.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tun.mode">mode</option></term><listitem><para> - Alias: mode</para><para> The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.</para><para> + Alias: mode</para><para>The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tun.multi-queue">multi-queue</option></term><listitem><para> - Alias: multi-queue</para><para> If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</para><para> + Alias: multi-queue</para><para>If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</para><para> Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tun.owner">owner</option></term><listitem><para> - Alias: owner</para><para> The user ID which will own the device. If set to NULL everyone will be able to use the device.</para><para> + Alias: owner</para><para>The user ID which will own the device. If set to NULL everyone will be able to use the device.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tun.pi">pi</option></term><listitem><para> - Alias: pi</para><para> If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</para><para> + Alias: pi</para><para>If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</para><para> Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tun.vnet-hdr">vnet-hdr</option></term><listitem><para> - Alias: vnet-hdr</para><para> If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</para><para> - Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vlan setting</title><para> VLAN Settings.</para><para> + Alias: vnet-hdr</para><para>If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</para><para> + Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vlan setting</title><para>VLAN Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.vlan.egress-priority-map">egress-priority-map</option></term><listitem><para> - Alias: egress</para><para> For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</para><para> + Alias: egress</para><para>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</para><para> Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.flags">flags</option></term><listitem><para> - Alias: flags</para><para> One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol).</para><para> The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.</para><para> + Alias: flags</para><para>One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol).</para><para>The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.</para><para> Format: NMVlanFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.id">id</option></term><listitem><para> - Alias: id</para><para> The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.</para><para> + Alias: id</para><para>The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.ingress-priority-map">ingress-priority-map</option></term><listitem><para> - Alias: ingress</para><para> For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</para><para> + Alias: ingress</para><para>For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</para><para> Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.parent">parent</option></term><listitem><para> - Alias: dev</para><para> If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vpn setting</title><para> VPN Settings.</para><para> + Alias: dev</para><para>If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.protocol">protocol</option></term><listitem><para>Specifies the VLAN protocol to use for encapsulation.</para><para>Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vpn setting</title><para>VPN Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.vpn.data">data</option></term><listitem><para> Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</para><para> - Format: dict of string to string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.persistent">persistent</option></term><listitem><para> If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.secrets">secrets</option></term><listitem><para> Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.vpn.data">data</option></term><listitem><para>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</para><para> + Format: dict of string to string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.persistent">persistent</option></term><listitem><para>If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.secrets">secrets</option></term><listitem><para>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</para><para> Format: dict of string to string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.service-type">service-type</option></term><listitem><para> - Alias: vpn-type</para><para> D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.timeout">timeout</option></term><listitem><para> 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.</para><para> + Alias: vpn-type</para><para>D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.timeout">timeout</option></term><listitem><para>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.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.user-name">user-name</option></term><listitem><para> - Alias: user</para><para> 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.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vrf setting</title><para> VRF settings.</para><para> + Alias: user</para><para>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.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vrf setting</title><para>VRF settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.vrf.table">table</option></term><listitem><para> - Alias: table</para><para> The routing table for this VRF.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vxlan setting</title><para> VXLAN Settings.</para><para> + Alias: table</para><para>The routing table for this VRF.</para><para> + Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vxlan setting</title><para>VXLAN Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.ageing">ageing</option></term><listitem><para> Specifies the lifetime in seconds of FDB entries learnt by the kernel.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.ageing">ageing</option></term><listitem><para>Specifies the lifetime in seconds of FDB entries learnt by the kernel.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.destination-port">destination-port</option></term><listitem><para> - Alias: destination-port</para><para> Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</para><para> + Alias: destination-port</para><para>Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.id">id</option></term><listitem><para> - Alias: id</para><para> Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.l2-miss">l2-miss</option></term><listitem><para> Specifies whether netlink LL ADDR miss notifications are generated.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.l3-miss">l3-miss</option></term><listitem><para> Specifies whether netlink IP ADDR miss notifications are generated.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.learning">learning</option></term><listitem><para> Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.limit">limit</option></term><listitem><para> Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</para><para> + Alias: id</para><para>Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.l2-miss">l2-miss</option></term><listitem><para>Specifies whether netlink LL ADDR miss notifications are generated.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.l3-miss">l3-miss</option></term><listitem><para>Specifies whether netlink IP ADDR miss notifications are generated.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.learning">learning</option></term><listitem><para>Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.limit">limit</option></term><listitem><para>Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.local">local</option></term><listitem><para> - Alias: local</para><para> If given, specifies the source IP address to use in outgoing packets.</para><para> + Alias: local</para><para>If given, specifies the source IP address to use in outgoing packets.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.parent">parent</option></term><listitem><para> - Alias: dev</para><para> If given, specifies the parent interface name or parent connection UUID.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.proxy">proxy</option></term><listitem><para> Specifies whether ARP proxy is turned on.</para><para> + Alias: dev</para><para>If given, specifies the parent interface name or parent connection UUID.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.proxy">proxy</option></term><listitem><para>Specifies whether ARP proxy is turned on.</para><para> Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.remote">remote</option></term><listitem><para> - Alias: remote</para><para> Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.rsc">rsc</option></term><listitem><para> Specifies whether route short circuit is turned on.</para><para> + Alias: remote</para><para>Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.rsc">rsc</option></term><listitem><para>Specifies whether route short circuit is turned on.</para><para> Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.source-port-max">source-port-max</option></term><listitem><para> - Alias: source-port-max</para><para> Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</para><para> + Alias: source-port-max</para><para>Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.source-port-min">source-port-min</option></term><listitem><para> - Alias: source-port-min</para><para> Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.tos">tos</option></term><listitem><para> Specifies the TOS value to use in outgoing packets.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.ttl">ttl</option></term><listitem><para> Specifies the time-to-live value to use in outgoing packets.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wifi-p2p setting</title><para> Wi-Fi P2P Settings.</para><para> + Alias: source-port-min</para><para>Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.tos">tos</option></term><listitem><para>Specifies the TOS value to use in outgoing packets.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.ttl">ttl</option></term><listitem><para>Specifies the time-to-live value to use in outgoing packets.</para><para> + Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wifi-p2p setting</title><para>Wi-Fi P2P Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.wifi-p2p.peer">peer</option></term><listitem><para> - Alias: peer</para><para> The P2P device that should be connected to. Currently, this is the only way to create or join a group.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wifi-p2p.wfd-ies">wfd-ies</option></term><listitem><para> The Wi-Fi Display (WFD) Information Elements (IEs) to set.</para><para> Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wifi-p2p.wps-method">wps-method</option></term><listitem><para> Flags indicating which mode of WPS is to be used.</para><para> There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wimax setting</title><para> WiMax Settings.</para><para> + Alias: peer</para><para>The P2P device that should be connected to. Currently, this is the only way to create or join a group.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wifi-p2p.wfd-ies">wfd-ies</option></term><listitem><para>The Wi-Fi Display (WFD) Information Elements (IEs) to set.</para><para>Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.</para><para> + Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wifi-p2p.wps-method">wps-method</option></term><listitem><para>Flags indicating which mode of WPS is to be used.</para><para>There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.</para><para> + Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wimax setting</title><para>WiMax Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.wimax.mac-address">mac-address</option></term><listitem><para> - Alias: mac</para><para> 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</para><para> + Alias: mac</para><para>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).</para><para> + This property is deprecated since version 1.2. + WiMAX is no longer supported.</para><para> Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wimax.network-name">network-name</option></term><listitem><para> - Alias: nsp</para><para> Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1</para><para> + Alias: nsp</para><para>Network Service Provider (NSP) name of the WiMAX network this connection should use.</para><para> + This property is deprecated since version 1.2. + WiMAX is no longer supported.</para><para> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-3-ethernet setting</title><para> - Alias: ethernet</para><para> Wired Ethernet Settings.</para><para> + Alias: ethernet</para><para>Wired Ethernet Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.accept-all-mac-addresses">accept-all-mac-addresses</option></term><listitem><para> 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.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.auto-negotiate">auto-negotiate</option></term><listitem><para> 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.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.accept-all-mac-addresses">accept-all-mac-addresses</option></term><listitem><para>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.</para><para> + Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.auto-negotiate">auto-negotiate</option></term><listitem><para>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.</para><para> Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.cloned-mac-address">cloned-mac-address</option></term><listitem><para> - Alias: cloned-mac</para><para> If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.</para><para> Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address if the device has one (otherwise this is treated as "preserve"). "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.</para><para> If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).</para><para> On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.duplex">duplex</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.generate-mac-address-mask">generate-mac-address-mask</option></term><listitem><para> 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.</para><para> 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.</para><para> 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.</para><para> 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.</para><para> 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.</para><para> + Alias: cloned-mac</para><para>If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.</para><para>Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address if the device has one (otherwise this is treated as "preserve"). "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.</para><para>If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).</para><para>On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</para><para> + Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.duplex">duplex</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.generate-mac-address-mask">generate-mac-address-mask</option></term><listitem><para>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.</para><para>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.</para><para>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.</para><para>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.</para><para>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.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.mac-address">mac-address</option></term><listitem><para> - Alias: mac</para><para> 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).</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.mac-address-blacklist">mac-address-blacklist</option></term><listitem><para> 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).</para><para> + Alias: mac</para><para>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).</para><para> + Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.mac-address-blacklist">mac-address-blacklist</option></term><listitem><para>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).</para><para> Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.mtu">mtu</option></term><listitem><para> - Alias: mtu</para><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.port">port</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-nettype">s390-nettype</option></term><listitem><para> s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-options">s390-options</option></term><listitem><para> 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]).</para><para> Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.</para><para> - Format: dict of string to string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-subchannels">s390-subchannels</option></term><listitem><para> 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.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.speed">speed</option></term><listitem><para> 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.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan">wake-on-lan</option></term><listitem><para> 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).</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan-password">wake-on-lan-password</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wireguard setting</title><para> WireGuard Settings.</para><para> + Alias: mtu</para><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.port">port</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-nettype">s390-nettype</option></term><listitem><para>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-options">s390-options</option></term><listitem><para>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]).</para><para>Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.</para><para> + Format: dict of string to string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-subchannels">s390-subchannels</option></term><listitem><para>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.</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.speed">speed</option></term><listitem><para>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.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan">wake-on-lan</option></term><listitem><para>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).</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan-password">wake-on-lan-password</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wireguard setting</title><para>WireGuard Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.fwmark">fwmark</option></term><listitem><para> 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.</para><para> Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.ip4-auto-default-route">ip4-auto-default-route</option></term><listitem><para> 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".</para><para> 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.</para><para> 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. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.ip6-auto-default-route">ip6-auto-default-route</option></term><listitem><para> Like ip4-auto-default-route, but for the IPv6 default route.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.listen-port">listen-port</option></term><listitem><para> The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.mtu">mtu</option></term><listitem><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para><para> 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.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.peer-routes">peer-routes</option></term><listitem><para> 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.</para><para> 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.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.private-key">private-key</option></term><listitem><para> The 256 bit private-key in base64 encoding.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.private-key-flags">private-key-flags</option></term><listitem><para> Flags indicating how to handle the "private-key" property.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.fwmark">fwmark</option></term><listitem><para>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.</para><para>Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.ip4-auto-default-route">ip4-auto-default-route</option></term><listitem><para>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".</para><para>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.</para><para>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. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.</para><para> + Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.ip6-auto-default-route">ip6-auto-default-route</option></term><listitem><para>Like ip4-auto-default-route, but for the IPv6 default route.</para><para> + Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.listen-port">listen-port</option></term><listitem><para>The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.mtu">mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para><para>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.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.peer-routes">peer-routes</option></term><listitem><para>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.</para><para>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.</para><para> + Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.private-key">private-key</option></term><listitem><para>The 256 bit private-key in base64 encoding.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.private-key-flags">private-key-flags</option></term><listitem><para>Flags indicating how to handle the "private-key" property.</para><para> Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-11-wireless setting</title><para> - Alias: wifi</para><para> Wi-Fi Settings.</para><para> + Alias: wifi</para><para>Wi-Fi Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.ap-isolation">ap-isolation</option></term><listitem><para> Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode.</para><para> If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.</para><para> If set to NM_TERNARY_FALSE (0), devices can talk to each other.</para><para> 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_FALSE (0).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.band">band</option></term><listitem><para> 802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.bssid">bssid</option></term><listitem><para> If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.</para><para> Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.channel">channel</option></term><listitem><para> Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.ap-isolation">ap-isolation</option></term><listitem><para>Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode.</para><para>If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.</para><para>If set to NM_TERNARY_FALSE (0), devices can talk to each other.</para><para>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_FALSE (0).</para><para> + Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.band">band</option></term><listitem><para>802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.bssid">bssid</option></term><listitem><para>If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.</para><para>Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.</para><para> + Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.channel">channel</option></term><listitem><para>Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.cloned-mac-address">cloned-mac-address</option></term><listitem><para> - Alias: cloned-mac</para><para> If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.</para><para> Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.</para><para> If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).</para><para> On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.generate-mac-address-mask">generate-mac-address-mask</option></term><listitem><para> 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.</para><para> 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.</para><para> 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.</para><para> 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.</para><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.hidden">hidden</option></term><listitem><para> If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.</para><para> In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.</para><para> In AP mode, the created network does not broadcast its SSID.</para><para> Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</para><para> + Alias: cloned-mac</para><para>If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.</para><para>Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.</para><para>If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).</para><para>On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</para><para> + Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.generate-mac-address-mask">generate-mac-address-mask</option></term><listitem><para>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.</para><para>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.</para><para>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.</para><para>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.</para><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.hidden">hidden</option></term><listitem><para>If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.</para><para>In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.</para><para>In AP mode, the created network does not broadcast its SSID.</para><para>Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</para><para> Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mac-address">mac-address</option></term><listitem><para> - Alias: mac</para><para> If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mac-address-blacklist">mac-address-blacklist</option></term><listitem><para> A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mac-address-randomization">mac-address-randomization</option></term><listitem><para> One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'. Deprecated: 1</para><para> + Alias: mac</para><para>If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</para><para> + Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mac-address-blacklist">mac-address-blacklist</option></term><listitem><para>A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mac-address-randomization">mac-address-randomization</option></term><listitem><para>One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address).</para><para> + This property is deprecated since version 1.4. + Use the "cloned-mac-address" property instead.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mode">mode</option></term><listitem><para> - Alias: mode</para><para> Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</para><para> + Alias: mode</para><para>Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mtu">mtu</option></term><listitem><para> - Alias: mtu</para><para> If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.powersave">powersave</option></term><listitem><para> One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.rate">rate</option></term><listitem><para> If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.seen-bssids">seen-bssids</option></term><listitem><para> A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</para><para> + Alias: mtu</para><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.powersave">powersave</option></term><listitem><para>One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.rate">rate</option></term><listitem><para>If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.seen-bssids">seen-bssids</option></term><listitem><para>A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</para><para> Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.ssid">ssid</option></term><listitem><para> - Alias: ssid</para><para> SSID of the Wi-Fi network. Must be specified.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.tx-power">tx-power</option></term><listitem><para> If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.wake-on-wlan">wake-on-wlan</option></term><listitem><para> The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</para><para> + Alias: ssid</para><para>SSID of the Wi-Fi network. Must be specified.</para><para> + Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.tx-power">tx-power</option></term><listitem><para>If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.wake-on-wlan">wake-on-wlan</option></term><listitem><para>The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</para><para> Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-11-wireless-security setting</title><para> - Alias: wifi-sec</para><para> Wi-Fi Security Settings.</para><para> + Alias: wifi-sec</para><para>Wi-Fi Security Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.auth-alg">auth-alg</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.fils">fils</option></term><listitem><para> 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.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.group">group</option></term><listitem><para> 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".</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.key-mgmt">key-mgmt</option></term><listitem><para> 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).</para><para> This property must be set for any Wi-Fi connection that uses security.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.leap-password">leap-password</option></term><listitem><para> The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.leap-password-flags">leap-password-flags</option></term><listitem><para> Flags indicating how to handle the "leap-password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.leap-username">leap-username</option></term><listitem><para> The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.pairwise">pairwise</option></term><listitem><para> 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".</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.pmf">pmf</option></term><listitem><para> 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.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.proto">proto</option></term><listitem><para> 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.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.psk">psk</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.psk-flags">psk-flags</option></term><listitem><para> Flags indicating how to handle the "psk" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key-flags">wep-key-flags</option></term><listitem><para> Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key-type">wep-key-type</option></term><listitem><para> 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.</para><para> - Format: NMWepKeyType (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key0">wep-key0</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key1">wep-key1</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key2">wep-key2</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key3">wep-key3</option></term><listitem><para> 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.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-tx-keyidx">wep-tx-keyidx</option></term><listitem><para> 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.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wps-method">wps-method</option></term><listitem><para> Flags indicating which mode of WPS is to be used if any.</para><para> 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.</para><para> WPS can be disabled by setting this property to a value of 1.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wpan setting</title><para> IEEE 802.15.4 (WPAN) MAC Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.auth-alg">auth-alg</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.fils">fils</option></term><listitem><para>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.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.group">group</option></term><listitem><para>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".</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.key-mgmt">key-mgmt</option></term><listitem><para>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).</para><para>This property must be set for any Wi-Fi connection that uses security.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.leap-password">leap-password</option></term><listitem><para>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.leap-password-flags">leap-password-flags</option></term><listitem><para>Flags indicating how to handle the "leap-password" property.</para><para> + Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.leap-username">leap-username</option></term><listitem><para>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.pairwise">pairwise</option></term><listitem><para>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".</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.pmf">pmf</option></term><listitem><para>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.</para><para> + Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.proto">proto</option></term><listitem><para>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.</para><para> + Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.psk">psk</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.psk-flags">psk-flags</option></term><listitem><para>Flags indicating how to handle the "psk" property.</para><para> + Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key-flags">wep-key-flags</option></term><listitem><para>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</para><para> + Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key-type">wep-key-type</option></term><listitem><para>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.</para><para> + Format: NMWepKeyType (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key0">wep-key0</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key1">wep-key1</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key2">wep-key2</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key3">wep-key3</option></term><listitem><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-tx-keyidx">wep-tx-keyidx</option></term><listitem><para>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.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wps-method">wps-method</option></term><listitem><para>Flags indicating which mode of WPS is to be used if any.</para><para>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.</para><para>WPS can be disabled by setting this property to a value of 1.</para><para> + Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wpan setting</title><para>IEEE 802.15.4 (WPAN) MAC Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.wpan.channel">channel</option></term><listitem><para> - Alias: channel</para><para> IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</para><para> + Alias: channel</para><para>IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</para><para> Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wpan.mac-address">mac-address</option></term><listitem><para> - Alias: mac</para><para> If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.</para><para> + Alias: mac</para><para>If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wpan.page">page</option></term><listitem><para> - Alias: page</para><para> IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</para><para> + Alias: page</para><para>IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</para><para> Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wpan.pan-id">pan-id</option></term><listitem><para> - Alias: pan-id</para><para> IEEE 802.15.4 Personal Area Network (PAN) identifier.</para><para> + Alias: pan-id</para><para>IEEE 802.15.4 Personal Area Network (PAN) identifier.</para><para> Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wpan.short-address">short-address</option></term><listitem><para> - Alias: short-addr</para><para> Short IEEE 802.15.4 address to be used within a restricted environment.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bond-port setting</title><para> Bond Port Settings.</para><para> + Alias: short-addr</para><para>Short IEEE 802.15.4 address to be used within a restricted environment.</para><para> + Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bond-port setting</title><para>Bond Port Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bond-port.queue-id">queue-id</option></term><listitem><para> - Alias: queue-id</para><para> The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>hostname setting</title><para> Hostname settings.</para><para> + Alias: queue-id</para><para>The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.</para><para> + Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>hostname setting</title><para>Hostname settings.</para><para> + Properties: + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.hostname.from-dhcp">from-dhcp</option></term><listitem><para>Whether the system hostname can be determined from DHCP on this connection.</para><para>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).</para><para> + Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.from-dns-lookup">from-dns-lookup</option></term><listitem><para>Whether the system hostname can be determined from reverse DNS lookup of addresses on this device.</para><para>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).</para><para> + Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.only-from-default">only-from-default</option></term><listitem><para>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).</para><para>If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route.</para><para>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).</para><para> + Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.priority">priority</option></term><listitem><para>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.</para><para>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.</para><para>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.</para><para> + Format: int32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>loopback setting</title><para>Loopback Link Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.hostname.from-dhcp">from-dhcp</option></term><listitem><para> Whether the system hostname can be determined from DHCP on this connection.</para><para> 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).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.from-dns-lookup">from-dns-lookup</option></term><listitem><para> Whether the system hostname can be determined from reverse DNS lookup of addresses on this device.</para><para> 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).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.only-from-default">only-from-default</option></term><listitem><para> 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).</para><para> If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route.</para><para> 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).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.priority">priority</option></term><listitem><para> 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.</para><para> 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.</para><para> 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.</para><para> - Format: int32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>veth setting</title><para> Veth Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.loopback.mtu">mtu</option></term><listitem><para> + Alias: mtu</para><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</para><para> + Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>veth setting</title><para>Veth Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.veth.peer">peer</option></term><listitem><para> - Alias: peer</para><para> This property specifies the peer interface name of the veth. This property is mandatory.</para><para> + Alias: peer</para><para>This property specifies the peer interface name of the veth. This property is mandatory.</para><para> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2 id="secrets-flags"><title>Secret flag types:</title><para> Each password or secret property in a setting has an associated <emphasis>flags</emphasis> property that describes how to handle that secret. The <emphasis>flags</emphasis> property is a bitfield diff --git a/man/nm-settings-nmcli.xsl b/man/nm-settings-nmcli.xsl index 5a6b8ba1..d7b770d6 100644 --- a/man/nm-settings-nmcli.xsl +++ b/man/nm-settings-nmcli.xsl @@ -163,6 +163,12 @@ </para> </xsl:otherwise> </xsl:choose> + <xsl:if test="deprecated"> + <para> + This property is deprecated since version <xsl:value-of select="deprecated/@since"/>. + <xsl:value-of select="deprecated"/> + </para> + </xsl:if> <xsl:if test="@type"> <para> Format: <xsl:value-of select="@type"/> diff --git a/man/nmcli-examples.7 b/man/nmcli-examples.7 index eb114348..055716bd 100644 --- a/man/nmcli-examples.7 +++ b/man/nmcli-examples.7 @@ -2,12 +2,12 @@ .\" Title: nmcli-examples .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: Examples -.\" Source: NetworkManager 1.40.12 +.\" Source: NetworkManager 1.42.4 .\" Language: English .\" -.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.40\&.12" "Examples" +.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.42\&.4" "Examples" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nmcli.1 b/man/nmcli.1 index c9f40627..374593ce 100644 --- a/man/nmcli.1 +++ b/man/nmcli.1 @@ -2,12 +2,12 @@ .\" Title: nmcli .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.40.12 +.\" Source: NetworkManager 1.42.4 .\" Language: English .\" -.TH "NMCLI" "1" "" "NetworkManager 1\&.40\&.12" "General Commands Manual" +.TH "NMCLI" "1" "" "NetworkManager 1\&.42\&.4" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -1822,6 +1822,47 @@ Determines the locale to be used for internationalized messages\&. .RS 4 Provides a default value for the internationalization variables that are unset or null\&. .RE +.PP +\fBNO_COLOR\fR +.RS 4 +Default to not producing colored and paged output\&. The +\fB\-\-colors\fR +option, if used, takes precedence\&. +.RE +.PP +\fBPAGER\fR +.RS 4 +Filter to pipe the output through if it doesn\*(Aqt fit on a screen\&. Can be a file name of an executable or a shell command\&. Empty string to disable the functionality\&. +.sp +Note that the pager command is expected to handle wide characters and ANSI escape sequences for changing colors (unless they\*(Aqre disabled)\&. +\fBnmcli\fR +sets up the environment variables +\fBLESS\fR +and +\fBLESSCHARSET\fR +appropriately for the +\fBless\fR(1) +pager, other pagers may or may not need extra configuration\&. +.sp +If unspecified, +\fBpager\fR(1), +\fBless\fR(1) +and +\fBmore\fR(1) +will be tried (in that order)\&. +.RE +.PP +\fBTERM\fR +.RS 4 +Terminal type\&. If +dumb, +\fBnmcli\fR +will not use a pager or produce ANSI escape sequences for coloring\&. +.sp +Terminal types other than +dumb +are assumed to support ASCII escape sequences for setting the output color\&. +.RE .SH "INTERNATIONALIZATION NOTES" .PP Be aware that diff --git a/man/nmcli.xml b/man/nmcli.xml index 768087ea..1caafd31 100644 --- a/man/nmcli.xml +++ b/man/nmcli.xml @@ -2253,8 +2253,47 @@ unset or null.</para> </listitem> </varlistentry> - </variablelist> + <varlistentry> + <term><envar>NO_COLOR</envar></term> + <listitem> + <para>Default to not producing colored and paged output. The + <option>--colors</option> option, if used, takes precedence.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><envar>PAGER</envar></term> + <listitem> + <para>Filter to pipe the output through if it doesn't fit on a screen. + Can be a file name of an executable or a shell command. Empty string to + disable the functionality.</para> + + <para>Note that the pager command is expected to handle wide characters + and ANSI escape sequences for changing colors (unless they're disabled). + <command>nmcli</command> sets up the environment variables + <envar>LESS</envar> and <envar>LESSCHARSET</envar> appropriately for the + <citerefentry><refentrytitle>less</refentrytitle><manvolnum>1</manvolnum></citerefentry> + pager, other pagers may or may not need extra configuration.</para> + + <para>If unspecified, + <citerefentry><refentrytitle>pager</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>less</refentrytitle><manvolnum>1</manvolnum></citerefentry> + and <citerefentry><refentrytitle>more</refentrytitle><manvolnum>1</manvolnum></citerefentry> + will be tried (in that order).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><envar>TERM</envar></term> + <listitem> + <para>Terminal type. If <literal>dumb</literal>, <command>nmcli</command> + will not use a pager or produce ANSI escape sequences for coloring.</para> + <para>Terminal types other than <literal>dumb</literal> are assumed to + support ASCII escape sequences for setting the output color.</para> + </listitem> + </varlistentry> + </variablelist> </refsect1> <refsect1 id='internationalization_notes'><title>Internationalization notes</title> diff --git a/man/nmtui.1 b/man/nmtui.1 index 972fb184..ebf235f6 100644 --- a/man/nmtui.1 +++ b/man/nmtui.1 @@ -2,12 +2,12 @@ .\" Title: nmtui .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 01/26/2023 +.\" Date: 03/09/2023 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.40.12 +.\" Source: NetworkManager 1.42.4 .\" Language: English .\" -.TH "NMTUI" "1" "" "NetworkManager 1\&.40\&.12" "General Commands Manual" +.TH "NMTUI" "1" "" "NetworkManager 1\&.42\&.4" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- |