diff options
| author | Michael Biebl <biebl@debian.org> | 2023-08-09 21:55:35 +0200 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2023-08-09 21:55:35 +0200 |
| commit | 05e4a733f2141995181a551854d5df929f084adf (patch) | |
| tree | 83bb937740a6667525ba0df046748ecaa829c269 /docs/api | |
| parent | 14b0f3a9dc9ea90d60a3b057350fd4d637dc021a (diff) | |
New upstream version 1.44.0 upstream/1.44.0
Diffstat (limited to 'docs/api')
76 files changed, 2658 insertions, 1604 deletions
diff --git a/docs/api/Makefile.in b/docs/api/Makefile.in index d7a09949..a5f236f5 100644 --- a/docs/api/Makefile.in +++ b/docs/api/Makefile.in @@ -286,6 +286,7 @@ MM_GLIB_LIBS = @MM_GLIB_LIBS@ MOBILE_BROADBAND_PROVIDER_INFO_CFLAGS = @MOBILE_BROADBAND_PROVIDER_INFO_CFLAGS@ MOBILE_BROADBAND_PROVIDER_INFO_LIBS = @MOBILE_BROADBAND_PROVIDER_INFO_LIBS@ MOC = @MOC@ +MODPROBE_PATH = @MODPROBE_PATH@ MSGFMT = @MSGFMT@ MSGMERGE = @MSGMERGE@ MSGMERGE_FOR_MSGFMT_OPTION = @MSGMERGE_FOR_MSGFMT_OPTION@ @@ -298,6 +299,7 @@ NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT = @NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT@ NM_CONFIG_DEFAULT_LOGGING_BACKEND_TEXT = @NM_CONFIG_DEFAULT_LOGGING_BACKEND_TEXT@ NM_CONFIG_DEFAULT_MAIN_AUTH_POLKIT_TEXT = @NM_CONFIG_DEFAULT_MAIN_AUTH_POLKIT_TEXT@ NM_CONFIG_DEFAULT_MAIN_DHCP = @NM_CONFIG_DEFAULT_MAIN_DHCP@ +NM_CONFIG_DEFAULT_MAIN_MIGRATE_IFCFG_RH_TEXT = @NM_CONFIG_DEFAULT_MAIN_MIGRATE_IFCFG_RH_TEXT@ NM_CONFIG_DEFAULT_MAIN_RC_MANAGER = @NM_CONFIG_DEFAULT_MAIN_RC_MANAGER@ NM_CONFIG_DEFAULT_WIFI_BACKEND_TEXT = @NM_CONFIG_DEFAULT_WIFI_BACKEND_TEXT@ NM_DIST_VERSION = @NM_DIST_VERSION@ diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml index d824fbad..1ec5d9a8 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Connection.Active.xml @@ -274,8 +274,8 @@ Master readable o <para> The path to the controller device if the connection is a port. </para><para> -This property is deprecated in favor of the 'Controller' -property since 1.44 and 1.42.2. +DEPRECATED. This property is deprecated in favor of the 'Controller' +property since 1.44. </para> </refsect2> </refsect1> diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml index bdd3c2a4..7f01357e 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Settings.Connection.xml @@ -237,6 +237,10 @@ The <constant>args</constant> argument accepts the following keys: <listitem><para>The settings plugin the connection will be migrated to such as "keyfile" or "ifcfg-rh".</para> <para role="since">Since 1.38</para></listitem> +<term><literal>version-id</literal>:</term> +<listitem><para>If specified, the update request is rejected if the +profile's version-id does not match. This can be used to catch concurrent +modifications. Zero means no version check.</para><para role="since">Since 1.44</para></listitem> </varlistentry> </variablelist> </para><para> diff --git a/docs/api/dbus-org.freedesktop.NetworkManager.Settings.xml b/docs/api/dbus-org.freedesktop.NetworkManager.Settings.xml index b501ea69..74ad0259 100644 --- a/docs/api/dbus-org.freedesktop.NetworkManager.Settings.xml +++ b/docs/api/dbus-org.freedesktop.NetworkManager.Settings.xml @@ -40,6 +40,7 @@ <link linkend="gdbus-property-org-freedesktop-NetworkManager-Settings.Connections">Connections</link> readable ao <link linkend="gdbus-property-org-freedesktop-NetworkManager-Settings.Hostname">Hostname</link> readable s <link linkend="gdbus-property-org-freedesktop-NetworkManager-Settings.CanModify">CanModify</link> readable b +<link linkend="gdbus-property-org-freedesktop-NetworkManager-Settings.VersionId">VersionId</link> readable t </synopsis> </refsect1> <refsect1 role="desc" id="gdbus-interface-org-freedesktop-NetworkManager-Settings"> @@ -400,6 +401,19 @@ CanModify readable b If true, adding and modifying connections is supported. </para> </refsect2> +<refsect2 role="property" id="gdbus-property-org-freedesktop-NetworkManager-Settings.VersionId"> + <title>The "VersionId" property</title> + <indexterm zone="gdbus-property-org-freedesktop-NetworkManager-Settings.VersionId"><primary sortas=".Settings:VersionId">org.freedesktop.NetworkManager.Settings:VersionId</primary></indexterm> +<programlisting> +VersionId readable t +</programlisting> +<para> +The version of the settings. This is incremented whenever the profile +changes and can be used to detect concurrent modifications. +</para><para> +Since: 1.44 +</para> +</refsect2> </refsect1> </refentry> diff --git a/docs/api/html/NetworkManager.conf.html b/docs/api/html/NetworkManager.conf.html index b4134352..abd47cea 100644 --- a/docs/api/html/NetworkManager.conf.html +++ b/docs/api/html/NetworkManager.conf.html @@ -344,7 +344,7 @@ no-auto-default=* setting below), the name server there will be localhost only. NetworkManager also writes a file <code class="filename">/run/NetworkManager/no-stub-resolv.conf</code> that contains the original name servers pushed to the DNS plugin.</p> -<p>When using <code class="literal">dnsmasq</code> and <code class="literal">systemd-resolved</code> +<p>When using <code class="literal">dnsmasq</code> and <code class="literal">systemd-resolved</code>, per-connection added dns servers will always be queried using the device the connection has been activated on.</p> </td> @@ -407,16 +407,15 @@ no-auto-default=* <tr> <td><p><span class="term"><code class="varname">systemd-resolved</code></span></p></td> <td> -<p>Send the connection DNS configuration to +<p>Additionally, send the connection DNS configuration to <code class="literal">systemd-resolved</code>. Defaults to "<code class="literal">true</code>". </p> -<p>Note that this setting is complementary to the - <code class="varname">dns</code> setting. You can keep this enabled while using - <code class="varname">dns</code> set to another DNS plugin alongside - <code class="literal">systemd-resolved</code>, or <code class="varname">dns</code> set to - <code class="literal">systemd-resolved</code> to configure the system resolver to use - <code class="literal">systemd-resolved</code>.</p> -<p>If systemd-resolved is enabled, the connectivity check resolves the +<p>Note that this setting has no effect if the main <code class="varname">dns</code> + plugin is already <code class="literal">systemd-resolved</code>. It is complementary to the + <code class="varname">dns</code> setting to configure systemd-resolved alongside the + main plugin.</p> +<p>If systemd-resolved is enabled, either via this setting or the main + DNS plugin, the connectivity check resolves the hostname per-device.</p> </td> </tr> @@ -504,6 +503,15 @@ no-auto-default=* </p> </td> </tr> +<tr> +<td><p><span class="term"><code class="varname">migrate-ifcfg-rh</code></span></p></td> +<td><p>Whether NetworkManager tries to automatically convert + any connection profile stored in ifcfg-rh format to the keyfile format. + Support for ifcfg-rh is deprecated and will be eventually removed. If + enabled, the migration is performed at every startup of the daemon. + The default value is <code class="literal">false</code>. + </p></td> +</tr> </tbody> </table></div> </div> @@ -535,6 +543,19 @@ no-auto-default=* </p></td> </tr> <tr> +<td><p><span class="term"><code class="varname">rename</code></span></p></td> +<td><p> + NetworkManager automatically chooses a filename when storing + a new profile to disk. That name depends on the profile's name + (connection.id). When updating a profile's name, the file is + not renamed to not break scripts that rely on the filename + for the profile. + By setting this option to "true", NetworkManager renames + the keyfile on update of the profile, to follow the profile's + name. This defaults to "false". + </p></td> +</tr> +<tr> <td><p><span class="term"><code class="varname">unmanaged-devices</code></span></p></td> <td> <p>Set devices that should be ignored by NetworkManager. @@ -1647,9 +1668,9 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16 <tr> <td><p><span class="term"><code class="varname">ifcfg-rh</code></span></p></td> <td><p> - This plugin is used on the Fedora and Red Hat Enterprise - Linux distributions to read and write configuration from - the standard + This plugin is now deprecated; it can be used on the + Fedora and Red Hat Enterprise Linux distributions to read + and write configuration from the standard <code class="filename">/etc/sysconfig/network-scripts/ifcfg-*</code> files. It currently supports reading Ethernet, Wi-Fi, InfiniBand, VLAN, Bond, Bridge, and Team connections. diff --git a/docs/api/html/NetworkManager.devhelp2 b/docs/api/html/NetworkManager.devhelp2 index 33b73bdf..850eb5c0 100644 --- a/docs/api/html/NetworkManager.devhelp2 +++ b/docs/api/html/NetworkManager.devhelp2 @@ -70,6 +70,7 @@ <sub name="" link="settings-wpan.html"/> <sub name="" link="settings-bond-port.html"/> <sub name="" link="settings-hostname.html"/> + <sub name="" link="settings-link.html"/> <sub name="" link="settings-loopback.html"/> <sub name="" link="settings-ovs-external-ids.html"/> <sub name="" link="settings-ovs-other-config.html"/> @@ -241,6 +242,7 @@ <keyword type="property" name="The "Connections" property" link="gdbus-org.freedesktop.NetworkManager.Settings.html#gdbus-property-org-freedesktop-NetworkManager-Settings.Connections"/> <keyword type="property" name="The "Hostname" property" link="gdbus-org.freedesktop.NetworkManager.Settings.html#gdbus-property-org-freedesktop-NetworkManager-Settings.Hostname"/> <keyword type="property" name="The "CanModify" property" link="gdbus-org.freedesktop.NetworkManager.Settings.html#gdbus-property-org-freedesktop-NetworkManager-Settings.CanModify"/> + <keyword type="property" name="The "VersionId" property" link="gdbus-org.freedesktop.NetworkManager.Settings.html#gdbus-property-org-freedesktop-NetworkManager-Settings.VersionId"/> <keyword type="method" name="The Update() method" link="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Update"/> <keyword type="method" name="The UpdateUnsaved() method" link="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.UpdateUnsaved"/> <keyword type="method" name="The Delete() method" link="gdbus-org.freedesktop.NetworkManager.Settings.Connection.html#gdbus-method-org-freedesktop-NetworkManager-Settings-Connection.Delete"/> diff --git a/docs/api/html/ch01.html b/docs/api/html/ch01.html index 4a43e068..a6dee91a 100644 --- a/docs/api/html/ch01.html +++ b/docs/api/html/ch01.html @@ -174,6 +174,9 @@ <span class="refentrytitle"><a href="settings-hostname.html">hostname</a></span><span class="refpurpose"> — Hostname settings</span> </dt> <dt> +<span class="refentrytitle"><a href="settings-link.html">link</a></span><span class="refpurpose"> — Link settings</span> +</dt> +<dt> <span class="refentrytitle"><a href="settings-loopback.html">loopback</a></span><span class="refpurpose"> — Loopback Link Settings</span> </dt> <dt> diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html index afd8aea2..8dcd4289 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Connection.Active.html @@ -309,8 +309,8 @@ Master readable o The path to the controller device if the connection is a port. </p> <p> -This property is deprecated in favor of the 'Controller' -property since 1.44 and 1.42.2. +DEPRECATED. This property is deprecated in favor of the 'Controller' +property since 1.44. </p> </div> </div> diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html index d0b2322f..fd20e593 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.Connection.html @@ -297,11 +297,15 @@ The <code class="constant">args</code> argument accepts the following keys: <col> </colgroup> <tbody><tr> -<td><p><span class="term"><code class="literal">plugin</code>:</span></p></td> +<td><p><span class="term"><code class="literal">plugin</code>:, </span><span class="term"><code class="literal">version-id</code>:</span></p></td> <td> <p>The settings plugin the connection will be migrated to such as "keyfile" or "ifcfg-rh".</p> <p class="since">Since 1.38</p> +<p>If specified, the update request is rejected if the +profile's version-id does not match. This can be used to catch concurrent +modifications. Zero means no version check.</p> +<p class="since">Since 1.44</p> </td> </tr></tbody> </table></div> diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html index 7efdc770..4facbb7f 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.Settings.html @@ -68,6 +68,7 @@ <a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.html#gdbus-property-org-freedesktop-NetworkManager-Settings.Connections" title='The "Connections" property'>Connections</a> readable ao <a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.html#gdbus-property-org-freedesktop-NetworkManager-Settings.Hostname" title='The "Hostname" property'>Hostname</a> readable s <a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.html#gdbus-property-org-freedesktop-NetworkManager-Settings.CanModify" title='The "CanModify" property'>CanModify</a> readable b +<a class="link" href="gdbus-org.freedesktop.NetworkManager.Settings.html#gdbus-property-org-freedesktop-NetworkManager-Settings.VersionId" title='The "VersionId" property'>VersionId</a> readable t </pre> </div> <div class="refsect1"> @@ -498,6 +499,20 @@ CanModify readable b If true, adding and modifying connections is supported. </p> </div> +<hr> +<div class="refsect2"> +<a name="gdbus-property-org-freedesktop-NetworkManager-Settings.VersionId"></a><h3>The "VersionId" property</h3> +<pre class="programlisting"> +VersionId readable t +</pre> +<p> +The version of the settings. This is incremented whenever the profile +changes and can be used to detect concurrent modifications. +</p> +<p> +Since: 1.44 +</p> +</div> </div> </div> <div class="footer"> diff --git a/docs/api/html/index.html b/docs/api/html/index.html index 56e3108b..7f6ebb52 100644 --- a/docs/api/html/index.html +++ b/docs/api/html/index.html @@ -16,7 +16,7 @@ <div> <div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">NetworkManager Reference Manual</p></th></tr></table></div> <div><p class="releaseinfo"> - for NetworkManager 1.42.8 + for NetworkManager 1.44.0 The latest version of this documentation can be found on-line at <a class="ulink" href="https://networkmanager.dev/docs/api/latest/" target="_top">https://networkmanager.dev/docs/api/latest/</a>. @@ -270,6 +270,9 @@ <span class="refentrytitle"><a href="settings-hostname.html">hostname</a></span><span class="refpurpose"> — Hostname settings</span> </dt> <dt> +<span class="refentrytitle"><a href="settings-link.html">link</a></span><span class="refpurpose"> — Link settings</span> +</dt> +<dt> <span class="refentrytitle"><a href="settings-loopback.html">loopback</a></span><span class="refpurpose"> — Loopback Link Settings</span> </dt> <dt> diff --git a/docs/api/html/ix01.html b/docs/api/html/ix01.html index 0a54382c..e7c79395 100644 --- a/docs/api/html/ix01.html +++ b/docs/api/html/ix01.html @@ -506,6 +506,8 @@ </dt> <dt id="ientry-id-1.4.6.2.9.3.2">org.freedesktop.NetworkManager.Settings:Hostname, <a class="indexterm" href="gdbus-org.freedesktop.NetworkManager.Settings.html#gdbus-property-org-freedesktop-NetworkManager-Settings.Hostname">The "Hostname" property</a> </dt> +<dt id="ientry-id-1.4.6.2.9.5.2">org.freedesktop.NetworkManager.Settings:VersionId, <a class="indexterm" href="gdbus-org.freedesktop.NetworkManager.Settings.html#gdbus-property-org-freedesktop-NetworkManager-Settings.VersionId">The "VersionId" property</a> +</dt> </dl> </div> <div class="indexdiv"> @@ -750,6 +752,8 @@ </dt> <dt id="ientry-id-1.3.3.17.2.2.1.1.2.9.1.1.1">dhcp-iaid, <a class="indexterm" href="settings-ipv4.html">ipv4</a>, <a class="indexterm" href="settings-ipv6.html">ipv6</a> </dt> +<dt id="ientry-id-1.3.3.18.2.2.1.1.2.10.1.1.1">dhcp-pd-hint, <a class="indexterm" href="settings-ipv6.html">ipv6</a> +</dt> <dt id="ientry-id-1.3.3.17.2.2.1.1.2.10.1.1.1">dhcp-reject-servers, <a class="indexterm" href="settings-ipv4.html">ipv4</a>, <a class="indexterm" href="settings-ipv6.html">ipv6</a> </dt> <dt id="ientry-id-1.3.3.17.2.2.1.1.2.11.1.1.1">dhcp-send-hostname, <a class="indexterm" href="settings-ipv4.html">ipv4</a>, <a class="indexterm" href="settings-ipv6.html">ipv6</a> @@ -833,12 +837,18 @@ </dt> <dt id="ientry-id-1.3.3.45.2.2.1.1.2.6.1.1.1">generate-mac-address-mask, <a class="indexterm" href="settings-802-3-ethernet.html">802-3-ethernet</a>, <a class="indexterm" href="settings-802-11-wireless.html">802-11-wireless</a> </dt> +<dt id="ientry-id-1.3.3.52.2.2.1.1.2.1.1.1.1">gro-max-size, <a class="indexterm" href="settings-link.html">link</a> +</dt> <dt id="ientry-id-1.3.3.37.2.2.1.1.2.1.1.1.1">group, <a class="indexterm" href="settings-tun.html">tun</a>, <a class="indexterm" href="settings-802-11-wireless-security.html">802-11-wireless-security</a> </dt> <dt id="ientry-id-1.3.3.8.2.2.1.1.2.3.1.1.1">group-address, <a class="indexterm" href="settings-bridge.html">bridge</a> </dt> <dt id="ientry-id-1.3.3.8.2.2.1.1.2.4.1.1.1">group-forward-mask, <a class="indexterm" href="settings-bridge.html">bridge</a> </dt> +<dt id="ientry-id-1.3.3.52.2.2.1.1.2.2.1.1.1">gso-max-segments, <a class="indexterm" href="settings-link.html">link</a> +</dt> +<dt id="ientry-id-1.3.3.52.2.2.1.1.2.3.1.1.1">gso-max-size, <a class="indexterm" href="settings-link.html">link</a> +</dt> </dl> </div> <div class="indexdiv"> @@ -867,6 +877,10 @@ </dt> <dt id="ientry-id-1.3.3.39.2.2.1.1.2.4.1.1.1">ingress-priority-map, <a class="indexterm" href="settings-vlan.html">vlan</a> </dt> +<dt id="ientry-id-1.3.3.15.2.2.1.1.2.5.1.1.1">initial-eps-bearer-apn, <a class="indexterm" href="settings-gsm.html">gsm</a> +</dt> +<dt id="ientry-id-1.3.3.15.2.2.1.1.2.6.1.1.1">initial-eps-bearer-configure, <a class="indexterm" href="settings-gsm.html">gsm</a> +</dt> <dt id="ientry-id-1.3.3.19.2.2.1.1.2.5.1.1.1">input-key, <a class="indexterm" href="settings-ip-tunnel.html">ip-tunnel</a> </dt> <dt id="ientry-id-1.3.3.2.2.2.1.1.2.9.1.1.1">interface-name, <a class="indexterm" href="settings-connection.html">connection</a>, <a class="indexterm" href="settings-bond.html">bond</a>, <a class="indexterm" href="settings-bridge.html">bridge</a>, <a class="indexterm" href="settings-match.html">match</a>, <a class="indexterm" href="settings-team.html">team</a>, <a class="indexterm" href="settings-vlan.html">vlan</a> @@ -875,7 +889,7 @@ </dt> <dt id="ientry-id-1.3.3.46.2.2.1.1.2.3.1.1.1">ip6-auto-default-route, <a class="indexterm" href="settings-wireguard.html">wireguard</a> </dt> -<dt id="ientry-id-1.3.3.18.2.2.1.1.2.21.1.1.1">ip6-privacy, <a class="indexterm" href="settings-ipv6.html">ipv6</a> +<dt id="ientry-id-1.3.3.18.2.2.1.1.2.22.1.1.1">ip6-privacy, <a class="indexterm" href="settings-ipv6.html">ipv6</a> </dt> </dl> </div> @@ -1115,7 +1129,7 @@ </dt> <dt id="ientry-id-1.3.3.25.2.2.1.1.2.4.1.1.1">n-txq-desc, <a class="indexterm" href="settings-ovs-dpdk.html">ovs-dpdk</a> </dt> -<dt id="ientry-id-1.3.3.15.2.2.1.1.2.6.1.1.1">network-id, <a class="indexterm" href="settings-gsm.html">gsm</a> +<dt id="ientry-id-1.3.3.15.2.2.1.1.2.8.1.1.1">network-id, <a class="indexterm" href="settings-gsm.html">gsm</a> </dt> <dt id="ientry-id-1.3.3.44.2.2.1.1.2.2.1.1.1">network-name, <a class="indexterm" href="settings-wimax.html">wimax</a> </dt> @@ -1397,7 +1411,7 @@ <div class="indexdiv"> <h3>R</h3> <dl> -<dt id="ientry-id-1.3.3.18.2.2.1.1.2.26.1.1.1">ra-timeout, <a class="indexterm" href="settings-ipv6.html">ipv6</a> +<dt id="ientry-id-1.3.3.18.2.2.1.1.2.27.1.1.1">ra-timeout, <a class="indexterm" href="settings-ipv6.html">ipv6</a> </dt> <dt id="ientry-id-1.3.3.47.2.2.1.1.2.15.1.1.1">rate, <a class="indexterm" href="settings-802-11-wireless.html">802-11-wireless</a> </dt> @@ -1486,9 +1500,9 @@ </dt> <dt id="ientry-id-1.3.3.49.2.2.1.1.2.5.1.1.1">short-address, <a class="indexterm" href="settings-wpan.html">wpan</a> </dt> -<dt id="ientry-id-1.3.3.15.2.2.1.1.2.12.1.1.1">sim-id, <a class="indexterm" href="settings-gsm.html">gsm</a> +<dt id="ientry-id-1.3.3.15.2.2.1.1.2.14.1.1.1">sim-id, <a class="indexterm" href="settings-gsm.html">gsm</a> </dt> -<dt id="ientry-id-1.3.3.15.2.2.1.1.2.13.1.1.1">sim-operator-id, <a class="indexterm" href="settings-gsm.html">gsm</a> +<dt id="ientry-id-1.3.3.15.2.2.1.1.2.15.1.1.1">sim-operator-id, <a class="indexterm" href="settings-gsm.html">gsm</a> </dt> <dt id="ientry-id-1.3.3.2.2.2.1.1.2.21.1.1.1">slave-type, <a class="indexterm" href="settings-connection.html">connection</a> </dt> @@ -1531,7 +1545,7 @@ </dt> <dt id="ientry-id-1.3.3.2.2.2.1.1.2.23.1.1.1">timestamp, <a class="indexterm" href="settings-connection.html">connection</a> </dt> -<dt id="ientry-id-1.3.3.18.2.2.1.1.2.34.1.1.1">token, <a class="indexterm" href="settings-ipv6.html">ipv6</a> +<dt id="ientry-id-1.3.3.18.2.2.1.1.2.35.1.1.1">token, <a class="indexterm" href="settings-ipv6.html">ipv6</a> </dt> <dt id="ientry-id-1.3.3.19.2.2.1.1.2.13.1.1.1">tos, <a class="indexterm" href="settings-ip-tunnel.html">ip-tunnel</a>, <a class="indexterm" href="settings-vxlan.html">vxlan</a> </dt> @@ -1545,6 +1559,8 @@ </dt> <dt id="ientry-id-1.3.3.47.2.2.1.1.2.19.1.1.1">tx-power, <a class="indexterm" href="settings-802-11-wireless.html">802-11-wireless</a> </dt> +<dt id="ientry-id-1.3.3.52.2.2.1.1.2.4.1.1.1">tx-queue-length, <a class="indexterm" href="settings-link.html">link</a> +</dt> <dt id="ientry-id-1.3.3.2.2.2.1.1.2.24.1.1.1">type, <a class="indexterm" href="settings-connection.html">connection</a>, <a class="indexterm" href="settings-bluetooth.html">bluetooth</a>, <a class="indexterm" href="settings-ovs-interface.html">ovs-interface</a> </dt> </dl> diff --git a/docs/api/html/nm-cloud-setup.html b/docs/api/html/nm-cloud-setup.html index 360519fa..794c1375 100644 --- a/docs/api/html/nm-cloud-setup.html +++ b/docs/api/html/nm-cloud-setup.html @@ -137,7 +137,9 @@ <li class="listitem"><p><code class="literal">NM_CLOUD_SETUP_LOG</code>: control the logging verbosity. Set it to one of <code class="literal">TRACE</code>, <code class="literal">DEBUG</code>, <code class="literal">INFO</code>, <code class="literal">WARN</code>, <code class="literal">ERR</code> or <code class="literal">OFF</code>. The program - will print message on stdout and the default level is <code class="literal">WARN</code>.</p></li> + will print message on stdout and the default level is <code class="literal">WARN</code>. When + run as systemd service, the log will be collected by journald can can be seen with + <span class="command"><strong>journalctl</strong></span>.</p></li> <li class="listitem"><p><code class="literal">NM_CLOUD_SETUP_AZURE</code>: boolean, whether Microsoft Azure support is enabled. Defaults to <code class="literal">no</code>.</p></li> <li class="listitem"><p><code class="literal">NM_CLOUD_SETUP_EC2</code>: boolean, whether Amazon EC2 (AWS) support is enabled. Defaults @@ -149,6 +151,15 @@ </ul></div> </div> <div class="refsect1"> +<a name="debugging"></a><h2>Debugging</h2> +<p>Enable debug logging by setting <code class="literal">NM_CLOUD_SETUP_LOG</code> environment variable to <code class="literal">TRACE</code>.</p> +<p>In the common case where nm-cloud-setup is running as systemd service, this can be done via <span class="command"><strong>systemctl edit nm-cloud-setup.service</strong></span> + and add <code class="literal">Environment=NM_CLOUD_SETUP_LOG=TRACE</code> to the <code class="literal">[Service]</code> section. Afterwards, the log can + be found in syslog via <code class="literal">journalctl</code>. You may also want to enable debug logging in NetworkManager as descibed + in the DEBUGGING section in <a class="link" href="NetworkManager.html" title="NetworkManager"><span class="citerefentry"><span class="refentrytitle">NetworkManager</span>(5)</span></a> + manual. When sharing logs, it's best to share complete logs and not preemptively filter for NetworkManager or nm-cloud-setup logs.</p> +</div> +<div class="refsect1"> <a name="deploy"></a><h2>Example Setup for Configuring and Predeploying nm-cloud-setup</h2> <p>As detailed before, nm-cloud-setup needs to be explicitly enabled. As it runs as a systemd service and timer, that basically means to enable and configure @@ -182,7 +193,7 @@ ln -s /etc/systemd/system/timers.target.wants/nm-cloud-setup.timer /usr/lib/syst <div class="refsect1"> <a name="providers"></a><h2>Supported Cloud Providers</h2> <div class="refsect2"> -<a name="id-1.2.15.9.2"></a><h3>Amazon EC2 (AWS)</h3> +<a name="id-1.2.15.10.2"></a><h3>Amazon EC2 (AWS)</h3> <p>For AWS, the tools tries to fetch configuration from <code class="literal">http://169.254.169.254/</code>. Currently, it only configures IPv4 and does nothing about IPv6. It will do the following.</p> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> @@ -239,7 +250,7 @@ ln -s /etc/systemd/system/timers.target.wants/nm-cloud-setup.timer /usr/lib/syst </div> <hr> <div class="refsect2"> -<a name="id-1.2.15.9.3"></a><h3>Google Cloud Platform (GCP)</h3> +<a name="id-1.2.15.10.3"></a><h3>Google Cloud Platform (GCP)</h3> <p> For GCP, the meta data is fetched from URIs starting with <code class="literal">http://metadata.google.internal/computeMetadata/v1/</code> with a HTTP header <code class="literal">"Metadata-Flavor: Google"</code>. @@ -267,7 +278,7 @@ ln -s /etc/systemd/system/timers.target.wants/nm-cloud-setup.timer /usr/lib/syst </div> <hr> <div class="refsect2"> -<a name="id-1.2.15.9.4"></a><h3>Microsoft Azure</h3> +<a name="id-1.2.15.10.4"></a><h3>Microsoft Azure</h3> <p> For Azure, the meta data is fetched from URIs starting with <code class="literal">http://169.254.169.254/metadata/instance</code> with a URL parameter <code class="literal">"?format=text&api-version=2017-04-02"</code> and a HTTP header <code class="literal">"Metadata:true"</code>. @@ -299,7 +310,7 @@ ln -s /etc/systemd/system/timers.target.wants/nm-cloud-setup.timer /usr/lib/syst </div> <hr> <div class="refsect2"> -<a name="id-1.2.15.9.5"></a><h3>Alibaba Cloud (Aliyun)</h3> +<a name="id-1.2.15.10.5"></a><h3>Alibaba Cloud (Aliyun)</h3> <p>For Aliyun, the tools tries to fetch configuration from <code class="literal">http://100.100.100.200/</code>. Currently, it only configures IPv4 and does nothing about IPv6. It will do the following.</p> <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> @@ -327,7 +338,7 @@ ln -s /etc/systemd/system/timers.target.wants/nm-cloud-setup.timer /usr/lib/syst </div> </div> <div class="refsect1"> -<a name="id-1.2.15.10"></a><h2>See Also</h2> +<a name="id-1.2.15.11"></a><h2>See Also</h2> <p> <a class="link" href="NetworkManager.html" title="NetworkManager"><span class="citerefentry"><span class="refentrytitle">NetworkManager</span>(8)</span></a> <a class="link" href="nmcli.html" title="nmcli"><span class="citerefentry"><span class="refentrytitle">nmcli</span>(1)</span></a> diff --git a/docs/api/html/nm-dbus-types.html b/docs/api/html/nm-dbus-types.html index 5d7db24a..287647e3 100644 --- a/docs/api/html/nm-dbus-types.html +++ b/docs/api/html/nm-dbus-types.html @@ -1763,7 +1763,7 @@ <p></p> </td> <td class="enum_member_description"> -<p>modem has 5GNR data capability (Since: 1.36)</p> +<p>modem has 5GNR data capability. Since: 1.36.</p> <p></p> </td> <td class="auto-generated"> </td> @@ -3997,7 +3997,7 @@ <div class="refsect2"> <a name="NMCheckpointCreateFlags"></a><h3>enum NMCheckpointCreateFlags</h3> <p>The flags for CheckpointCreate call</p> -<p>Since: 1.12 (public since 1.4, g-ir since 1.12)</p> +<p>Since: 1.12: Public since 1.4, g-ir since 1.12.</p> <p></p> <div class="refsect3"> <a name="id-1.4.17.2.25.4"></a><h4>Values</h4> diff --git a/docs/api/html/nm-settings-dbus.html b/docs/api/html/nm-settings-dbus.html index 778860e6..ee13ceaf 100644 --- a/docs/api/html/nm-settings-dbus.html +++ b/docs/api/html/nm-settings-dbus.html @@ -291,7 +291,9 @@ At this time only the "user" [type] is allowed. Any other values are ignored an <a name="nm-settings-dbus.property.connection.read-only"></a>read-only</td> <td align="left">boolean</td> <td align="left">FALSE</td> -<td>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.</td> +<td>This property is deprecated and has no meaning. + +This property is deprecated since version 1.44.This property is deprecated and has no meaning.</td> </tr> <tr> <td align="left"> @@ -314,13 +316,13 @@ At this time only the "user" [type] is allowed. Any other values are ignored an <td align="left"> </td> <td>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 to derive the DHCP client identifier with ipv4.dhcp-client-id=stable, the DHCPv6 DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid] and the DHCP IAID with ipv4.iaid=stable and ipv6.iaid=stable. 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 activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. The "${CONNECTION}" uses the profile's connection.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" 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.</td> +If the value is unset, a global connection default is consulted. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile.</td> </tr> <tr> <td align="left"> @@ -1499,6 +1501,20 @@ Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was reject </tr> <tr> <td align="left"> +<a name="nm-settings-dbus.property.gsm.initial-eps-bearer-apn"></a>initial-eps-bearer-apn</td> +<td align="left">string</td> +<td align="left"> </td> +<td>For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network. Setting this parameter implies initial-eps-bearer-configure to be TRUE.</td> +</tr> +<tr> +<td align="left"> +<a name="nm-settings-dbus.property.gsm.initial-eps-bearer-configure"></a>initial-eps-bearer-configure</td> +<td align="left">boolean</td> +<td align="left">FALSE</td> +<td>For LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection. It is inferred TRUE if initial-eps-bearer-apn is set.</td> +</tr> +<tr> +<td align="left"> <a name="nm-settings-dbus.property.gsm.mtu"></a>mtu</td> <td align="left">uint32</td> <td align="left">0</td> @@ -1730,7 +1746,7 @@ When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), <a name="nm-settings-dbus.property.ipv4.dhcp-iaid"></a>dhcp-iaid</td> <td align="left">string</td> <td align="left"> </td> -<td>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". +<td>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 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. @@ -1984,15 +2000,17 @@ Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-b <a name="nm-settings-dbus.property.ipv6.addr-gen-mode"></a>addr-gen-mode</td> <td align="left">int32</td> <td align="left">3</td> -<td>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). +<td>Configure the method for creating the IPv6 interface identifier of addresses for RFC4862 IPv6 Stateless Address Autoconfiguration and IPv6 Link Local. + +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. +If the property is set to "eui64", the addresses will be generated using the interface token derived from the hardware address. This makes the host part of the address constant, making it possible to track the host's presence when it changes networks. The address changes when the interface hardware is replaced. If a duplicate address is detected, there is no fallback to generate another address. When configured, the "ipv6.token" is used instead of the MAC address to generate addresses for stateless autoconfiguration. -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. +If the property is set to "stable-privacy", the interface identifier is generated as specified by RFC7217. This works by hashing a host specific key (see NetworkManager(8) manual), the interface name, the connection's "connection.stable-id" property and the address prefix. This improves privacy by making it harder to use the address to track the host's presence as every prefix and network has a different identifier. Also, the address is 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 as documented in the 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. +For libnm, the property defaults to "default" since 1.40. Previously it used to default 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.</td> </tr> @@ -2067,7 +2085,7 @@ When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), <a name="nm-settings-dbus.property.ipv6.dhcp-iaid"></a>dhcp-iaid</td> <td align="left">string</td> <td align="left"> </td> -<td>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". +<td>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 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. @@ -2077,6 +2095,13 @@ The actually used DHCPv6 IAID for a currently activated interface is exposed in </tr> <tr> <td align="left"> +<a name="nm-settings-dbus.property.ipv6.dhcp-pd-hint"></a>dhcp-pd-hint</td> +<td align="left">string</td> +<td align="left"> </td> +<td>A IPv6 address followed by a slash and a prefix length. If set, the value is sent to the DHCPv6 server as hint indicating the prefix delegation (IA_PD) we want to receive. To only hint a prefix length without prefix, set the address part to the zero address (for example "::/60").</td> +</tr> +<tr> +<td align="left"> <a name="nm-settings-dbus.property.ipv6.dhcp-reject-servers"></a>dhcp-reject-servers</td> <td align="left">array of string</td> <td align="left"> </td> @@ -2313,7 +2338,9 @@ Array of IPv6 route structures. Each IPv6 route structure is composed of an IPv <a name="nm-settings-dbus.property.ipv6.token"></a>token</td> <td align="left">string</td> <td align="left"> </td> -<td>Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</td> +<td>Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode. + +When set, the token is used as IPv6 interface identifier instead of the hardware address. This only applies to addresses from stateless autoconfiguration, not to IPv6 link local addresses.</td> </tr> </tbody> </table></div> @@ -4396,21 +4423,25 @@ This property is deprecated since version 1.4.Use the "cloned-mac-address" prope <a name="nm-settings-dbus.property.802-11-wireless.rate"></a>rate</td> <td align="left">uint32</td> <td align="left">0</td> -<td>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.</td> +<td>This property is not implemented and has no effect. + +This property is deprecated since version 1.44.This property is not implemented and has no effect.</td> </tr> <tr> <td align="left"> <a name="nm-settings-dbus.property.802-11-wireless.security"></a>security</td> <td align="left"> </td> <td align="left"> </td> -<td>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.</td> +<td>This property is deprecated and has no effect. For backwards compatibility, it can be set to "802-11-wireless-security" if the profile has a wireless security setting.</td> </tr> <tr> <td align="left"> <a name="nm-settings-dbus.property.802-11-wireless.seen-bssids"></a>seen-bssids</td> <td align="left">array of string</td> <td align="left"> </td> -<td>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.</td> +<td>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. + +This is not a regular property that the user would configure. Instead, NetworkManager automatically sets the seen BSSIDs and tracks them internally in "/var/lib/NetworkManager/seen-bssids" file.</td> </tr> <tr> <td align="left"> @@ -4424,7 +4455,9 @@ This property is deprecated since version 1.4.Use the "cloned-mac-address" prope <a name="nm-settings-dbus.property.802-11-wireless.tx-power"></a>tx-power</td> <td align="left">uint32</td> <td align="left">0</td> -<td>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.</td> +<td>This property is not implemented and has no effect. + +This property is deprecated since version 1.44.This property is not implemented and has no effect.</td> </tr> <tr> <td align="left"> @@ -4757,7 +4790,56 @@ Negative values have the special effect of excluding other connections with a gr </div> <hr> <div class="refsect2"> -<a name="id-1.2.9.4.53"></a><h3>loopback setting</h3> +<a name="id-1.2.9.4.53"></a><h3>link setting</h3> +<p>Link settings.</p> +<div class="informaltable"><table class="informaltable" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td align="left"> +<a name="nm-settings-dbus.property.link.gro-max-size"></a>gro-max-size</td> +<td align="left">int64</td> +<td align="left">-1</td> +<td>The maximum size of a packet built by the Generic Receive Offload stack for this device. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</td> +</tr> +<tr> +<td align="left"> +<a name="nm-settings-dbus.property.link.gso-max-segments"></a>gso-max-segments</td> +<td align="left">int64</td> +<td align="left">-1</td> +<td>The maximum segments of a Generic Segment Offload packet the device should accept. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</td> +</tr> +<tr> +<td align="left"> +<a name="nm-settings-dbus.property.link.gso-max-size"></a>gso-max-size</td> +<td align="left">int64</td> +<td align="left">-1</td> +<td>The maximum size of a Generic Segment Offload packet the device should accept. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</td> +</tr> +<tr> +<td align="left"> +<a name="nm-settings-dbus.property.link.tx-queue-length"></a>tx-queue-length</td> +<td align="left">int64</td> +<td align="left">-1</td> +<td>The size of the transmit queue for the device, in number of packets. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="id-1.2.9.4.54"></a><h3>loopback setting</h3> <p>Loopback Link Settings.</p> <div class="informaltable"><table class="informaltable" border="1"> <colgroup> @@ -4783,7 +4865,7 @@ Negative values have the special effect of excluding other connections with a gr </div> <hr> <div class="refsect2"> -<a name="id-1.2.9.4.54"></a><h3>ovs-external-ids setting</h3> +<a name="id-1.2.9.4.55"></a><h3>ovs-external-ids setting</h3> <p>OVS External IDs Settings.</p> <div class="informaltable"><table class="informaltable" border="1"> <colgroup> @@ -4809,7 +4891,7 @@ Negative values have the special effect of excluding other connections with a gr </div> <hr> <div class="refsect2"> -<a name="id-1.2.9.4.55"></a><h3>ovs-other-config setting</h3> +<a name="id-1.2.9.4.56"></a><h3>ovs-other-config setting</h3> <p>OVS Other Config Settings.</p> <div class="informaltable"><table class="informaltable" border="1"> <colgroup> @@ -4835,7 +4917,7 @@ Negative values have the special effect of excluding other connections with a gr </div> <hr> <div class="refsect2"> -<a name="id-1.2.9.4.56"></a><h3>veth setting</h3> +<a name="id-1.2.9.4.57"></a><h3>veth setting</h3> <p>Veth Settings.</p> <div class="informaltable"><table class="informaltable" border="1"> <colgroup> diff --git a/docs/api/html/nm-settings-ifcfg-rh.html b/docs/api/html/nm-settings-ifcfg-rh.html index f5674127..187e6a08 100644 --- a/docs/api/html/nm-settings-ifcfg-rh.html +++ b/docs/api/html/nm-settings-ifcfg-rh.html @@ -256,25 +256,7 @@ DEVICETYPE=TeamPort are NetworkManager specific extensions not understood by traditional initscripts. </p> <div class="table"> -<a name="id-1.2.12.7.3"></a><p class="title"><b>Table 11. 6lowpan setting</b></p> -<div class="table-contents"><table class="table" summary="6lowpan setting" border="1"> -<colgroup> -<col> -<col> -<col> -<col> -</colgroup> -<thead><tr> -<th>Property</th> -<th>Ifcfg-rh Variable</th> -<th>Default</th> -<th>Description</th> -</tr></thead> -<tbody></tbody> -</table></div> -</div> -<br class="table-break"><div class="table"> -<a name="id-1.2.12.7.4"></a><p class="title"><b>Table 12. 802-11-wireless setting</b></p> +<a name="id-1.2.12.7.3"></a><p class="title"><b>Table 11. 802-11-wireless setting</b></p> <div class="table-contents"><table class="table" summary="802-11-wireless setting" border="1"> <colgroup> <col> @@ -337,13 +319,13 @@ Example: </strong></span>BSSID=00:1E:BD:64:83:21</td> <td align="left">rate</td> <td align="left">(none)</td> <td align="left"> </td> -<td align="left">This property is not handled by ifcfg-rh plugin.</td> +<td align="left">This property is deprecated and not handled by ifcfg-rh plugin.</td> </tr> <tr> <td align="left">tx-power</td> <td align="left">(none)</td> <td align="left"> </td> -<td align="left">This property is not handled by ifcfg-rh plugin.</td> +<td align="left">This property is deprecated and not handled by ifcfg-rh plugin.</td> </tr> <tr> <td align="left">mac-address</td> @@ -375,7 +357,7 @@ Example: </strong></span>BSSID=00:1E:BD:64:83:21</td> <td align="left">seen-bssids</td> <td align="left">(none)</td> <td align="left"> </td> -<td align="left">This property is not handled by ifcfg-rh plugin.</td> +<td align="left">This is not a regular property that would be configured by the user. It is not handled by ifcfg-rh plugin.</td> </tr> <tr> <td align="left">mtu</td> @@ -413,12 +395,6 @@ Example: </strong></span>MAC_ADDRESS_RANDOMIZATION=always<span class="bold"><str Allowed values: </strong></span>default, never, always</td> </tr> <tr> -<td align="left">security</td> -<td align="left">(none)</td> -<td align="left"> </td> -<td align="left">This property is deprecated and not handled by ifcfg-rh-plugin.</td> -</tr> -<tr> <td align="left">ap-isolation</td> <td align="left">AP_ISOLATION<span class="emphasis"><em>(+)</em></span> </td> @@ -431,7 +407,7 @@ Allowed values: </strong></span>"yes", "no"</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.5"></a><p class="title"><b>Table 13. 802-11-wireless-security setting</b></p> +<a name="id-1.2.12.7.4"></a><p class="title"><b>Table 12. 802-11-wireless-security setting</b></p> <div class="table-contents"><table class="table" summary="802-11-wireless-security setting" border="1"> <colgroup> <col> @@ -613,7 +589,7 @@ Allowed values: </strong></span>default, disable, optional, required</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.6"></a><p class="title"><b>Table 14. 802-1x setting</b></p> +<a name="id-1.2.12.7.5"></a><p class="title"><b>Table 13. 802-1x setting</b></p> <div class="table-contents"><table class="table" summary="802-1x setting" border="1"> <colgroup> <col> @@ -941,7 +917,7 @@ Example: </strong></span>IEEE_8021X_PRIVATE_KEY=/home/joe/mykey.p12</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.7"></a><p class="title"><b>Table 15. 802-3-ethernet setting</b></p> +<a name="id-1.2.12.7.6"></a><p class="title"><b>Table 14. 802-3-ethernet setting</b></p> <div class="table-contents"><table class="table" summary="802-3-ethernet setting" border="1"> <colgroup> <col> @@ -1062,7 +1038,7 @@ Example: </strong></span>ETHTOOL_OPTS="wol gs sopass 00:11:22:33:44:55"</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.8"></a><p class="title"><b>Table 16. bond setting</b></p> +<a name="id-1.2.12.7.7"></a><p class="title"><b>Table 15. bond setting</b></p> <div class="table-contents"><table class="table" summary="bond setting" border="1"> <colgroup> <col> @@ -1087,7 +1063,7 @@ Example: </strong></span>BONDING_OPTS="miimon=100 mode=broadcast"</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.9"></a><p class="title"><b>Table 17. bond-port setting</b></p> +<a name="id-1.2.12.7.8"></a><p class="title"><b>Table 16. bond-port setting</b></p> <div class="table-contents"><table class="table" summary="bond-port setting" border="1"> <colgroup> <col> @@ -1124,7 +1100,7 @@ Allowed values: </strong></span>-2147483648 - 2147483647</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.10"></a><p class="title"><b>Table 18. bridge setting</b></p> +<a name="id-1.2.12.7.9"></a><p class="title"><b>Table 17. bridge setting</b></p> <div class="table-contents"><table class="table" summary="bridge setting" border="1"> <colgroup> <col> @@ -1363,7 +1339,7 @@ Example: </strong></span>BRIDGING_OPTS="multicast_startup_query_interval=4000"</ </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.11"></a><p class="title"><b>Table 19. bridge-port setting</b></p> +<a name="id-1.2.12.7.10"></a><p class="title"><b>Table 18. bridge-port setting</b></p> <div class="table-contents"><table class="table" summary="bridge-port setting" border="1"> <colgroup> <col> @@ -1412,7 +1388,7 @@ Example: </strong></span>BRIDGE_PORT_VLANS="1 pvid untagged,20,300-400 untagged" </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.12"></a><p class="title"><b>Table 20. connection setting</b></p> +<a name="id-1.2.12.7.11"></a><p class="title"><b>Table 19. connection setting</b></p> <div class="table-contents"><table class="table" summary="connection setting" border="1"> <colgroup> <col> @@ -1659,7 +1635,7 @@ Allowed values: </strong></span>delay in milliseconds.</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.13"></a><p class="title"><b>Table 21. dcb setting</b></p> +<a name="id-1.2.12.7.12"></a><p class="title"><b>Table 20. dcb setting</b></p> <div class="table-contents"><table class="table" summary="dcb setting" border="1"> <colgroup> <col> @@ -1794,7 +1770,7 @@ Example: </strong></span>DCB_PG_UP2TC=01623701</td> used explicitly to enable DCB so that the rest of the DCB_* variables can apply. </p> <div class="table"> -<a name="id-1.2.12.7.15"></a><p class="title"><b>Table 22. ethtool setting</b></p> +<a name="id-1.2.12.7.14"></a><p class="title"><b>Table 21. ethtool setting</b></p> <div class="table-contents"><table class="table" summary="ethtool setting" border="1"> <colgroup> <col> @@ -1812,7 +1788,7 @@ Example: </strong></span>DCB_PG_UP2TC=01623701</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.16"></a><p class="title"><b>Table 23. hostname setting</b></p> +<a name="id-1.2.12.7.15"></a><p class="title"><b>Table 22. hostname setting</b></p> <div class="table-contents"><table class="table" summary="hostname setting" border="1"> <colgroup> <col> @@ -1867,7 +1843,7 @@ Example: </strong></span>HOSTNAME_ONLY_FROM_DEFAULT=0,1</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.17"></a><p class="title"><b>Table 24. infiniband setting</b></p> +<a name="id-1.2.12.7.16"></a><p class="title"><b>Table 23. infiniband setting</b></p> <div class="table-contents"><table class="table" summary="infiniband setting" border="1"> <colgroup> <col> @@ -1922,7 +1898,7 @@ Example: </strong></span>PHYSDEV=ib0</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.18"></a><p class="title"><b>Table 25. ipv4 setting</b></p> +<a name="id-1.2.12.7.17"></a><p class="title"><b>Table 24. ipv4 setting</b></p> <div class="table-contents"><table class="table" summary="ipv4 setting" border="1"> <colgroup> <col> @@ -2130,7 +2106,7 @@ Example: </strong></span>IPV4_LINK_LOCAL=auto</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.19"></a><p class="title"><b>Table 26. ipv6 setting</b></p> +<a name="id-1.2.12.7.18"></a><p class="title"><b>Table 25. ipv6 setting</b></p> <div class="table-contents"><table class="table" summary="ipv6 setting" border="1"> <colgroup> <col> @@ -2329,34 +2305,20 @@ Example: </strong></span>IPV6_RA_TIMEOUT=10</td> Example: </strong></span>DHCPV6_DUID=LL; DHCPV6_DUID=0301deadbeef0001; DHCPV6_DUID=03:01:de:ad:be:ef:00:01</td> </tr> -</tbody> -</table></div> -</div> -<br class="table-break"><div class="table"> -<a name="id-1.2.12.7.20"></a><p class="title"><b>Table 27. loopback setting</b></p> -<div class="table-contents"><table class="table" summary="loopback setting" border="1"> -<colgroup> -<col> -<col> -<col> -<col> -</colgroup> -<thead><tr> -<th>Property</th> -<th>Ifcfg-rh Variable</th> -<th>Default</th> -<th>Description</th> -</tr></thead> -<tbody><tr> -<td align="left">mtu</td> -<td align="left">MTU</td> +<tr> +<td align="left">dhcp-pd-hint</td> +<td align="left">DHCPV6_PD_HINT<span class="emphasis"><em>(+)</em></span> +</td> <td align="left"> </td> -<td align="left">MTU of the interface.</td> -</tr></tbody> +<td align="left">Hint for DHCPv6 prefix delegation<span class="bold"><strong> + +Example: </strong></span>DHCPV6_PD_HINT=2001:db8:1111:2220::/60 DHCPV6_PD_HINT=::/60</td> +</tr> +</tbody> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.21"></a><p class="title"><b>Table 28. match setting</b></p> +<a name="id-1.2.12.7.19"></a><p class="title"><b>Table 26. match setting</b></p> <div class="table-contents"><table class="table" summary="match setting" border="1"> <colgroup> <col> @@ -2381,43 +2343,7 @@ Example: </strong></span>MATCH_PATH="pci-0000:01:00.0 pci-0000:0c:00.0"</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.22"></a><p class="title"><b>Table 29. ovs-bridge setting</b></p> -<div class="table-contents"><table class="table" summary="ovs-bridge setting" border="1"> -<colgroup> -<col> -<col> -<col> -<col> -</colgroup> -<thead><tr> -<th>Property</th> -<th>Ifcfg-rh Variable</th> -<th>Default</th> -<th>Description</th> -</tr></thead> -<tbody></tbody> -</table></div> -</div> -<br class="table-break"><div class="table"> -<a name="id-1.2.12.7.23"></a><p class="title"><b>Table 30. ovs-dpdk setting</b></p> -<div class="table-contents"><table class="table" summary="ovs-dpdk setting" border="1"> -<colgroup> -<col> -<col> -<col> -<col> -</colgroup> -<thead><tr> -<th>Property</th> -<th>Ifcfg-rh Variable</th> -<th>Default</th> -<th>Description</th> -</tr></thead> -<tbody></tbody> -</table></div> -</div> -<br class="table-break"><div class="table"> -<a name="id-1.2.12.7.24"></a><p class="title"><b>Table 31. ovs-external-ids setting</b></p> +<a name="id-1.2.12.7.20"></a><p class="title"><b>Table 27. ovs-external-ids setting</b></p> <div class="table-contents"><table class="table" summary="ovs-external-ids setting" border="1"> <colgroup> <col> @@ -2435,25 +2361,7 @@ Example: </strong></span>MATCH_PATH="pci-0000:01:00.0 pci-0000:0c:00.0"</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.25"></a><p class="title"><b>Table 32. ovs-interface setting</b></p> -<div class="table-contents"><table class="table" summary="ovs-interface setting" border="1"> -<colgroup> -<col> -<col> -<col> -<col> -</colgroup> -<thead><tr> -<th>Property</th> -<th>Ifcfg-rh Variable</th> -<th>Default</th> -<th>Description</th> -</tr></thead> -<tbody></tbody> -</table></div> -</div> -<br class="table-break"><div class="table"> -<a name="id-1.2.12.7.26"></a><p class="title"><b>Table 33. ovs-other-config setting</b></p> +<a name="id-1.2.12.7.21"></a><p class="title"><b>Table 28. ovs-other-config setting</b></p> <div class="table-contents"><table class="table" summary="ovs-other-config setting" border="1"> <colgroup> <col> @@ -2471,43 +2379,7 @@ Example: </strong></span>MATCH_PATH="pci-0000:01:00.0 pci-0000:0c:00.0"</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.27"></a><p class="title"><b>Table 34. ovs-patch setting</b></p> -<div class="table-contents"><table class="table" summary="ovs-patch setting" border="1"> -<colgroup> -<col> -<col> -<col> -<col> -</colgroup> -<thead><tr> -<th>Property</th> -<th>Ifcfg-rh Variable</th> -<th>Default</th> -<th>Description</th> -</tr></thead> -<tbody></tbody> -</table></div> -</div> -<br class="table-break"><div class="table"> -<a name="id-1.2.12.7.28"></a><p class="title"><b>Table 35. ovs-port setting</b></p> -<div class="table-contents"><table class="table" summary="ovs-port setting" border="1"> -<colgroup> -<col> -<col> -<col> -<col> -</colgroup> -<thead><tr> -<th>Property</th> -<th>Ifcfg-rh Variable</th> -<th>Default</th> -<th>Description</th> -</tr></thead> -<tbody></tbody> -</table></div> -</div> -<br class="table-break"><div class="table"> -<a name="id-1.2.12.7.29"></a><p class="title"><b>Table 36. proxy setting</b></p> +<a name="id-1.2.12.7.22"></a><p class="title"><b>Table 29. proxy setting</b></p> <div class="table-contents"><table class="table" summary="proxy setting" border="1"> <colgroup> <col> @@ -2560,7 +2432,7 @@ Example: </strong></span>PAC_SCRIPT="function FindProxyForURL (url, host) { retu </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.30"></a><p class="title"><b>Table 37. sriov setting</b></p> +<a name="id-1.2.12.7.23"></a><p class="title"><b>Table 30. sriov setting</b></p> <div class="table-contents"><table class="table" summary="sriov setting" border="1"> <colgroup> <col> @@ -2605,7 +2477,7 @@ Example: </strong></span>SRIOV_AUTOPROBE_DRIVERS=0,1</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.31"></a><p class="title"><b>Table 38. tc setting</b></p> +<a name="id-1.2.12.7.24"></a><p class="title"><b>Table 31. tc setting</b></p> <div class="table-contents"><table class="table" summary="tc setting" border="1"> <colgroup> <col> @@ -2642,7 +2514,7 @@ Example: </strong></span>FILTER1="parent ffff: matchall action simple sdata Inpu </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.32"></a><p class="title"><b>Table 39. team setting</b></p> +<a name="id-1.2.12.7.25"></a><p class="title"><b>Table 32. team setting</b></p> <div class="table-contents"><table class="table" summary="team setting" border="1"> <colgroup> <col> @@ -2665,7 +2537,7 @@ Example: </strong></span>FILTER1="parent ffff: matchall action simple sdata Inpu </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.33"></a><p class="title"><b>Table 40. team-port setting</b></p> +<a name="id-1.2.12.7.26"></a><p class="title"><b>Table 33. team-port setting</b></p> <div class="table-contents"><table class="table" summary="team-port setting" border="1"> <colgroup> <col> @@ -2688,7 +2560,7 @@ Example: </strong></span>FILTER1="parent ffff: matchall action simple sdata Inpu </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.34"></a><p class="title"><b>Table 41. user setting</b></p> +<a name="id-1.2.12.7.27"></a><p class="title"><b>Table 34. user setting</b></p> <div class="table-contents"><table class="table" summary="user setting" border="1"> <colgroup> <col> @@ -2713,25 +2585,7 @@ Example: </strong></span>NM_USER_FOO__BAR=something</td> </table></div> </div> <br class="table-break"><div class="table"> -<a name="id-1.2.12.7.35"></a><p class="title"><b>Table 42. veth setting</b></p> -<div class="table-contents"><table class="table" summary="veth setting" border="1"> -<colgroup> -<col> -<col> -<col> -<col> -</colgroup> -<thead><tr> -<th>Property</th> -<th>Ifcfg-rh Variable</th> -<th>Default</th> -<th>Description</th> -</tr></thead> -<tbody></tbody> -</table></div> -</div> -<br class="table-break"><div class="table"> -<a name="id-1.2.12.7.36"></a><p class="title"><b>Table 43. vlan setting</b></p> +<a name="id-1.2.12.7.28"></a><p class="title"><b>Table 35. vlan setting</b></p> <div class="table-contents"><table class="table" summary="vlan setting" border="1"> <colgroup> <col> @@ -2801,80 +2655,8 @@ Example: </strong></span>PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12</td> </tbody> </table></div> </div> -<br class="table-break"><div class="table"> -<a name="id-1.2.12.7.37"></a><p class="title"><b>Table 44. vrf setting</b></p> -<div class="table-contents"><table class="table" summary="vrf setting" border="1"> -<colgroup> -<col> -<col> -<col> -<col> -</colgroup> -<thead><tr> -<th>Property</th> -<th>Ifcfg-rh Variable</th> -<th>Default</th> -<th>Description</th> -</tr></thead> -<tbody></tbody> -</table></div> -</div> -<br class="table-break"><div class="table"> -<a name="id-1.2.12.7.38"></a><p class="title"><b>Table 45. wifi-p2p setting</b></p> -<div class="table-contents"><table class="table" summary="wifi-p2p setting" border="1"> -<colgroup> -<col> -<col> -<col> -<col> -</colgroup> -<thead><tr> -<th>Property</th> -<th>Ifcfg-rh Variable</th> -<th>Default</th> -<th>Description</th> -</tr></thead> -<tbody></tbody> -</table></div> -</div> -<br class="table-break"><div class="table"> -<a name="id-1.2.12.7.39"></a><p class="title"><b>Table 46. wireguard setting</b></p> -<div class="table-contents"><table class="table" summary="wireguard setting" border="1"> -<colgroup> -<col> -<col> -<col> -<col> -</colgroup> -<thead><tr> -<th>Property</th> -<th>Ifcfg-rh Variable</th> -<th>Default</th> -<th>Description</th> -</tr></thead> -<tbody></tbody> -</table></div> -</div> -<br class="table-break"><div class="table"> -<a name="id-1.2.12.7.40"></a><p class="title"><b>Table 47. wpan setting</b></p> -<div class="table-contents"><table class="table" summary="wpan setting" border="1"> -<colgroup> -<col> -<col> -<col> -<col> -</colgroup> -<thead><tr> -<th>Property</th> -<th>Ifcfg-rh Variable</th> -<th>Default</th> -<th>Description</th> -</tr></thead> -<tbody></tbody> -</table></div> -</div> <br class="table-break"><p>The following settings are not supported by <span class="emphasis"><em>ifcfg-rh</em></span> plugin:</p> -<p>802-11-olpc-mesh, adsl, bluetooth, cdma, dummy, generic, gsm, ip-tunnel, macsec, macvlan, ppp, pppoe, serial, tun, vpn, vxlan, wimax</p> +<p>6lowpan, 802-11-olpc-mesh, adsl, bluetooth, cdma, dummy, generic, gsm, ip-tunnel, link, loopback, macsec, macvlan, ovs-bridge, ovs-dpdk, ovs-interface, ovs-patch, ovs-port, ppp, pppoe, serial, tun, veth, vpn, vrf, vxlan, wifi-p2p, wimax, wireguard, wpan</p> <div class="refsect2"> <a name="secrets-flags"></a><h3>Secret flags</h3> <p> diff --git a/docs/api/html/nm-settings-nmcli.html b/docs/api/html/nm-settings-nmcli.html index 139eac2f..9e45cfc6 100644 --- a/docs/api/html/nm-settings-nmcli.html +++ b/docs/api/html/nm-settings-nmcli.html @@ -79,7 +79,7 @@ </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.auth-retries"></a>auth-retries</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.auth-retries"></a>connection.auth-retries</code></span></p></td> <td> <p>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.</p> <p>Currently, this only applies to 802-1x authentication.</p> @@ -88,7 +88,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.autoconnect"></a>autoconnect</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.autoconnect"></a>connection.autoconnect</code></span></p></td> <td> <p> Alias: autoconnect</p> @@ -102,7 +102,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.autoconnect-priority"></a>autoconnect-priority</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.autoconnect-priority"></a>connection.autoconnect-priority</code></span></p></td> <td> <p>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.</p> <p> @@ -110,7 +110,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.autoconnect-retries"></a>autoconnect-retries</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.autoconnect-retries"></a>connection.autoconnect-retries</code></span></p></td> <td> <p>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.</p> <p> @@ -118,7 +118,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.autoconnect-slaves"></a>autoconnect-slaves</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.autoconnect-slaves"></a>connection.autoconnect-slaves</code></span></p></td> <td> <p>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.</p> <p> @@ -126,7 +126,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.dns-over-tls"></a>dns-over-tls</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.dns-over-tls"></a>connection.dns-over-tls</code></span></p></td> <td> <p>Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic.</p> <p>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.</p> @@ -136,7 +136,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.gateway-ping-timeout"></a>gateway-ping-timeout</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.gateway-ping-timeout"></a>connection.gateway-ping-timeout</code></span></p></td> <td> <p>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</p> <p> @@ -144,7 +144,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.id"></a>id</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.id"></a>connection.id</code></span></p></td> <td> <p> Alias: con-name</p> @@ -154,7 +154,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.interface-name"></a>interface-name</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.interface-name"></a>connection.interface-name</code></span></p></td> <td> <p> Alias: ifname</p> @@ -166,7 +166,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.lldp"></a>lldp</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.lldp"></a>connection.lldp</code></span></p></td> <td> <p>Whether LLDP is enabled for the connection.</p> <p> @@ -174,7 +174,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.llmnr"></a>llmnr</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.llmnr"></a>connection.llmnr</code></span></p></td> <td> <p>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.</p> <p>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").</p> @@ -184,7 +184,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.master"></a>master</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.master"></a>connection.master</code></span></p></td> <td> <p> Alias: master</p> @@ -194,7 +194,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.mdns"></a>mdns</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.mdns"></a>connection.mdns</code></span></p></td> <td> <p>Whether mDNS is enabled for the connection.</p> <p>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").</p> @@ -204,7 +204,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.metered"></a>metered</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.metered"></a>connection.metered</code></span></p></td> <td> <p>Whether the connection is metered.</p> <p>When updating this property on a currently activated connection, the change takes effect immediately.</p> @@ -213,7 +213,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.mptcp-flags"></a>mptcp-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.mptcp-flags"></a>connection.mptcp-flags</code></span></p></td> <td> <p>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.</p> <p>If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.</p> @@ -229,7 +229,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.mud-url"></a>mud-url</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.mud-url"></a>connection.mud-url</code></span></p></td> <td> <p>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://".</p> <p>The special value "none" is allowed to indicate that no MUD URL is used.</p> @@ -239,7 +239,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.multi-connect"></a>multi-connect</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.multi-connect"></a>connection.multi-connect</code></span></p></td> <td> <p>Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</p> <p> @@ -247,7 +247,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.permissions"></a>permissions</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.permissions"></a>connection.permissions</code></span></p></td> <td> <p>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".</p> <p>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.</p> @@ -256,15 +256,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.read-only"></a>read-only</code></span></p></td> -<td> -<p>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.</p> -<p> - Format: boolean</p> -</td> -</tr> -<tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.secondaries"></a>secondaries</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.secondaries"></a>connection.secondaries</code></span></p></td> <td> <p>List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</p> <p> @@ -272,7 +264,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.slave-type"></a>slave-type</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.slave-type"></a>connection.slave-type</code></span></p></td> <td> <p> Alias: slave-type</p> @@ -282,19 +274,19 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.stable-id"></a>stable-id</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.stable-id"></a>connection.stable-id</code></span></p></td> <td> <p>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.</p> -<p>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].</p> +<p>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 to derive the DHCP client identifier with ipv4.dhcp-client-id=stable, the DHCPv6 DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid] and the DHCP IAID with ipv4.iaid=stable and ipv6.iaid=stable.</p> <p>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.</p> -<p>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.</p> -<p>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.</p> +<p>The '$' character is treated special to perform dynamic substitutions at activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. The "${CONNECTION}" uses the profile's connection.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" 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.</p> +<p>If the value is unset, a global connection default is consulted. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile.</p> <p> Format: string</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.timestamp"></a>timestamp</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.timestamp"></a>connection.timestamp</code></span></p></td> <td> <p>The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated.</p> <p>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).</p> @@ -303,7 +295,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.type"></a>type</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.type"></a>connection.type</code></span></p></td> <td> <p> Alias: type</p> @@ -313,16 +305,16 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.uuid"></a>uuid</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.uuid"></a>connection.uuid</code></span></p></td> <td> -<p>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.</p> -<p>The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").</p> +<p>The connection.uuid is the real identifier of a profile. It cannot change and it must be unique. It is therefore often best to refer to a profile by UUID, for example with `nmcli connection up uuid $UUID`.</p> +<p>The UUID cannot be changed, except in offline mode. In that case, the special values "new", "generate" and "" are allowed to generate a new random UUID.</p> <p> Format: a valid RFC4122 universally unique identifier (UUID).</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.wait-activation-delay"></a>wait-activation-delay</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.wait-activation-delay"></a>connection.wait-activation-delay</code></span></p></td> <td> <p>Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event.</p> <p>The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</p> @@ -331,7 +323,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.wait-device-timeout"></a>wait-device-timeout</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.wait-device-timeout"></a>connection.wait-device-timeout</code></span></p></td> <td> <p>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.</p> <p>The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</p> @@ -340,7 +332,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.zone"></a>zone</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.zone"></a>connection.zone</code></span></p></td> <td> <p>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.</p> <p>When updating this property on a currently activated connection, the change takes effect immediately.</p> @@ -364,7 +356,7 @@ <col> </colgroup> <tbody><tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.6lowpan.parent"></a>parent</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.6lowpan.parent"></a>6lowpan.parent</code></span></p></td> <td> <p> Alias: dev</p> @@ -389,7 +381,7 @@ </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.altsubject-matches"></a>altsubject-matches</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.altsubject-matches"></a>802-1x.altsubject-matches</code></span></p></td> <td> <p>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.</p> <p> @@ -397,7 +389,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.anonymous-identity"></a>anonymous-identity</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.anonymous-identity"></a>802-1x.anonymous-identity</code></span></p></td> <td> <p>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</p> <p> @@ -405,7 +397,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.auth-timeout"></a>auth-timeout</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.auth-timeout"></a>802-1x.auth-timeout</code></span></p></td> <td> <p>A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.</p> <p> @@ -413,7 +405,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.ca-cert"></a>ca-cert</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.ca-cert"></a>802-1x.ca-cert</code></span></p></td> <td> <p>Contains the CA certificate if used by the EAP method specified in the "eap" property.</p> <p>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.</p> @@ -423,7 +415,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.ca-cert-password"></a>ca-cert-password</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.ca-cert-password"></a>802-1x.ca-cert-password</code></span></p></td> <td> <p>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.</p> <p> @@ -431,15 +423,18 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.ca-cert-password-flags"></a>ca-cert-password-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.ca-cert-password-flags"></a>802-1x.ca-cert-password-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "ca-cert-password" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.ca-path"></a>ca-path</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.ca-path"></a>802-1x.ca-path</code></span></p></td> <td> <p>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.</p> <p>If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</p> @@ -448,7 +443,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.client-cert"></a>client-cert</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.client-cert"></a>802-1x.client-cert</code></span></p></td> <td> <p>Contains the client certificate if used by the EAP method specified in the "eap" property.</p> <p>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.</p> @@ -457,7 +452,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.client-cert-password"></a>client-cert-password</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.client-cert-password"></a>802-1x.client-cert-password</code></span></p></td> <td> <p>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.</p> <p> @@ -465,15 +460,18 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.client-cert-password-flags"></a>client-cert-password-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.client-cert-password-flags"></a>802-1x.client-cert-password-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "client-cert-password" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.domain-match"></a>domain-match</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.domain-match"></a>802-1x.domain-match</code></span></p></td> <td> <p>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.</p> <p> @@ -481,7 +479,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.domain-suffix-match"></a>domain-suffix-match</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.domain-suffix-match"></a>802-1x.domain-suffix-match</code></span></p></td> <td> <p>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.</p> <p> @@ -489,7 +487,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.eap"></a>eap</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.eap"></a>802-1x.eap</code></span></p></td> <td> <p>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.</p> <p> @@ -497,7 +495,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.identity"></a>identity</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.identity"></a>802-1x.identity</code></span></p></td> <td> <p>Identity string for EAP authentication methods. Often the user's user or login name.</p> <p> @@ -505,7 +503,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.optional"></a>optional</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.optional"></a>802-1x.optional</code></span></p></td> <td> <p>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.</p> <p> @@ -513,7 +511,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.pac-file"></a>pac-file</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.pac-file"></a>802-1x.pac-file</code></span></p></td> <td> <p>UTF-8 encoded file path containing PAC for EAP-FAST.</p> <p> @@ -521,7 +519,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.password"></a>password</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.password"></a>802-1x.password</code></span></p></td> <td> <p>UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</p> <p> @@ -529,15 +527,18 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.password-flags"></a>password-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.password-flags"></a>802-1x.password-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "password" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.password-raw"></a>password-raw</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.password-raw"></a>802-1x.password-raw</code></span></p></td> <td> <p>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.</p> <p> @@ -545,15 +546,18 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.password-raw-flags"></a>password-raw-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.password-raw-flags"></a>802-1x.password-raw-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "password-raw" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase1-auth-flags"></a>phase1-auth-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase1-auth-flags"></a>802-1x.phase1-auth-flags</code></span></p></td> <td> <p>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.</p> <p> @@ -561,7 +565,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase1-fast-provisioning"></a>phase1-fast-provisioning</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase1-fast-provisioning"></a>802-1x.phase1-fast-provisioning</code></span></p></td> <td> <p>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.</p> <p> @@ -569,7 +573,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase1-peaplabel"></a>phase1-peaplabel</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase1-peaplabel"></a>802-1x.phase1-peaplabel</code></span></p></td> <td> <p>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.</p> <p> @@ -577,7 +581,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase1-peapver"></a>phase1-peapver</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase1-peapver"></a>802-1x.phase1-peapver</code></span></p></td> <td> <p>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.</p> <p> @@ -585,7 +589,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-altsubject-matches"></a>phase2-altsubject-matches</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-altsubject-matches"></a>802-1x.phase2-altsubject-matches</code></span></p></td> <td> <p>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.</p> <p> @@ -593,7 +597,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-auth"></a>phase2-auth</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-auth"></a>802-1x.phase2-auth</code></span></p></td> <td> <p>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.</p> <p> @@ -601,7 +605,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-autheap"></a>phase2-autheap</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-autheap"></a>802-1x.phase2-autheap</code></span></p></td> <td> <p>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.</p> <p> @@ -609,7 +613,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-ca-cert"></a>phase2-ca-cert</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-ca-cert"></a>802-1x.phase2-ca-cert</code></span></p></td> <td> <p>Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</p> <p>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.</p> @@ -619,7 +623,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-ca-cert-password"></a>phase2-ca-cert-password</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-ca-cert-password"></a>802-1x.phase2-ca-cert-password</code></span></p></td> <td> <p>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.</p> <p> @@ -627,15 +631,18 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-ca-cert-password-flags"></a>phase2-ca-cert-password-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-ca-cert-password-flags"></a>802-1x.phase2-ca-cert-password-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "phase2-ca-cert-password" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-ca-path"></a>phase2-ca-path</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-ca-path"></a>802-1x.phase2-ca-path</code></span></p></td> <td> <p>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.</p> <p>If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</p> @@ -644,7 +651,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-client-cert"></a>phase2-client-cert</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-client-cert"></a>802-1x.phase2-client-cert</code></span></p></td> <td> <p>Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</p> <p>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.</p> @@ -653,7 +660,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-client-cert-password"></a>phase2-client-cert-password</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-client-cert-password"></a>802-1x.phase2-client-cert-password</code></span></p></td> <td> <p>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.</p> <p> @@ -661,15 +668,18 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-client-cert-password-flags"></a>phase2-client-cert-password-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-client-cert-password-flags"></a>802-1x.phase2-client-cert-password-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "phase2-client-cert-password" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-domain-match"></a>phase2-domain-match</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-domain-match"></a>802-1x.phase2-domain-match</code></span></p></td> <td> <p>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.</p> <p> @@ -677,7 +687,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-domain-suffix-match"></a>phase2-domain-suffix-match</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-domain-suffix-match"></a>802-1x.phase2-domain-suffix-match</code></span></p></td> <td> <p>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.</p> <p> @@ -685,7 +695,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-private-key"></a>phase2-private-key</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-private-key"></a>802-1x.phase2-private-key</code></span></p></td> <td> <p>Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls".</p> <p>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.</p> @@ -694,7 +704,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-private-key-password"></a>phase2-private-key-password</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-private-key-password"></a>802-1x.phase2-private-key-password</code></span></p></td> <td> <p>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.</p> <p> @@ -702,15 +712,18 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-private-key-password-flags"></a>phase2-private-key-password-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-private-key-password-flags"></a>802-1x.phase2-private-key-password-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "phase2-private-key-password" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-subject-match"></a>phase2-subject-match</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.phase2-subject-match"></a>802-1x.phase2-subject-match</code></span></p></td> <td> <p>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.</p> <p> @@ -721,7 +734,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.pin"></a>pin</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.pin"></a>802-1x.pin</code></span></p></td> <td> <p>PIN used for EAP authentication methods.</p> <p> @@ -729,15 +742,18 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.pin-flags"></a>pin-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.pin-flags"></a>802-1x.pin-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "pin" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.private-key"></a>private-key</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.private-key"></a>802-1x.private-key</code></span></p></td> <td> <p>Contains the private key when the "eap" property is set to "tls".</p> <p>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.</p> @@ -747,7 +763,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.private-key-password"></a>private-key-password</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.private-key-password"></a>802-1x.private-key-password</code></span></p></td> <td> <p>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.</p> <p> @@ -755,15 +771,18 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.private-key-password-flags"></a>private-key-password-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.private-key-password-flags"></a>802-1x.private-key-password-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "private-key-password" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.subject-match"></a>subject-match</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.subject-match"></a>802-1x.subject-match</code></span></p></td> <td> <p>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.</p> <p> @@ -774,7 +793,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.system-ca-certs"></a>system-ca-certs</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-1x.system-ca-certs"></a>802-1x.system-ca-certs</code></span></p></td> <td> <p>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).</p> <p> @@ -798,7 +817,7 @@ </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.adsl.encapsulation"></a>encapsulation</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.adsl.encapsulation"></a>adsl.encapsulation</code></span></p></td> <td> <p> Alias: encapsulation</p> @@ -808,7 +827,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.adsl.password"></a>password</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.adsl.password"></a>adsl.password</code></span></p></td> <td> <p> Alias: password</p> @@ -818,15 +837,18 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.adsl.password-flags"></a>password-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.adsl.password-flags"></a>adsl.password-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "password" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.adsl.protocol"></a>protocol</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.adsl.protocol"></a>adsl.protocol</code></span></p></td> <td> <p> Alias: protocol</p> @@ -836,7 +858,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.adsl.username"></a>username</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.adsl.username"></a>adsl.username</code></span></p></td> <td> <p> Alias: username</p> @@ -846,7 +868,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.adsl.vci"></a>vci</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.adsl.vci"></a>adsl.vci</code></span></p></td> <td> <p>VCI of ADSL connection</p> <p> @@ -854,7 +876,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.adsl.vpi"></a>vpi</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.adsl.vpi"></a>adsl.vpi</code></span></p></td> <td> <p>VPI of ADSL connection</p> <p> @@ -878,7 +900,7 @@ </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bluetooth.bdaddr"></a>bdaddr</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bluetooth.bdaddr"></a>bluetooth.bdaddr</code></span></p></td> <td> <p> Alias: addr</p> @@ -888,7 +910,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bluetooth.type"></a>type</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bluetooth.type"></a>bluetooth.type</code></span></p></td> <td> <p> Alias: bt-type</p> @@ -913,7 +935,7 @@ <col> </colgroup> <tbody><tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bond.options"></a>options</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bond.options"></a>bond.options</code></span></p></td> <td> <p>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]).</p> <p> @@ -936,7 +958,7 @@ </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.ageing-time"></a>ageing-time</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.ageing-time"></a>bridge.ageing-time</code></span></p></td> <td> <p> Alias: ageing-time</p> @@ -946,7 +968,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.forward-delay"></a>forward-delay</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.forward-delay"></a>bridge.forward-delay</code></span></p></td> <td> <p> Alias: forward-delay</p> @@ -956,7 +978,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.group-address"></a>group-address</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.group-address"></a>bridge.group-address</code></span></p></td> <td> <p>If specified, The MAC address of the multicast group this bridge uses for STP.</p> <p>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.</p> @@ -965,7 +987,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.group-forward-mask"></a>group-forward-mask</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.group-forward-mask"></a>bridge.group-forward-mask</code></span></p></td> <td> <p> Alias: group-forward-mask</p> @@ -975,7 +997,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.hello-time"></a>hello-time</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.hello-time"></a>bridge.hello-time</code></span></p></td> <td> <p> Alias: hello-time</p> @@ -985,7 +1007,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.mac-address"></a>mac-address</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.mac-address"></a>bridge.mac-address</code></span></p></td> <td> <p> Alias: mac</p> @@ -999,7 +1021,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.max-age"></a>max-age</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.max-age"></a>bridge.max-age</code></span></p></td> <td> <p> Alias: max-age</p> @@ -1009,7 +1031,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-hash-max"></a>multicast-hash-max</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-hash-max"></a>bridge.multicast-hash-max</code></span></p></td> <td> <p>Set maximum size of multicast hash table (value must be a power of 2).</p> <p> @@ -1017,7 +1039,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-last-member-count"></a>multicast-last-member-count</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-last-member-count"></a>bridge.multicast-last-member-count</code></span></p></td> <td> <p>Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.</p> <p> @@ -1025,7 +1047,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-last-member-interval"></a>multicast-last-member-interval</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-last-member-interval"></a>bridge.multicast-last-member-interval</code></span></p></td> <td> <p>Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.</p> <p> @@ -1033,7 +1055,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-membership-interval"></a>multicast-membership-interval</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-membership-interval"></a>bridge.multicast-membership-interval</code></span></p></td> <td> <p>Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.</p> <p> @@ -1041,7 +1063,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-querier"></a>multicast-querier</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-querier"></a>bridge.multicast-querier</code></span></p></td> <td> <p>Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</p> <p> @@ -1049,7 +1071,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-querier-interval"></a>multicast-querier-interval</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-querier-interval"></a>bridge.multicast-querier-interval</code></span></p></td> <td> <p>If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.</p> <p> @@ -1057,7 +1079,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-query-interval"></a>multicast-query-interval</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-query-interval"></a>bridge.multicast-query-interval</code></span></p></td> <td> <p>Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</p> <p> @@ -1065,7 +1087,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-query-response-interval"></a>multicast-query-response-interval</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-query-response-interval"></a>bridge.multicast-query-response-interval</code></span></p></td> <td> <p>Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</p> <p> @@ -1073,7 +1095,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-query-use-ifaddr"></a>multicast-query-use-ifaddr</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-query-use-ifaddr"></a>bridge.multicast-query-use-ifaddr</code></span></p></td> <td> <p>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.</p> <p> @@ -1081,7 +1103,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-router"></a>multicast-router</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-router"></a>bridge.multicast-router</code></span></p></td> <td> <p>Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work.</p> <p>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).</p> @@ -1090,7 +1112,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-snooping"></a>multicast-snooping</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-snooping"></a>bridge.multicast-snooping</code></span></p></td> <td> <p> Alias: multicast-snooping</p> @@ -1100,7 +1122,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-startup-query-count"></a>multicast-startup-query-count</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-startup-query-count"></a>bridge.multicast-startup-query-count</code></span></p></td> <td> <p>Set the number of IGMP queries to send during startup phase.</p> <p> @@ -1108,7 +1130,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-startup-query-interval"></a>multicast-startup-query-interval</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.multicast-startup-query-interval"></a>bridge.multicast-startup-query-interval</code></span></p></td> <td> <p>Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</p> <p> @@ -1116,7 +1138,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.priority"></a>priority</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.priority"></a>bridge.priority</code></span></p></td> <td> <p> Alias: priority</p> @@ -1126,7 +1148,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.stp"></a>stp</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.stp"></a>bridge.stp</code></span></p></td> <td> <p> Alias: stp</p> @@ -1136,7 +1158,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.vlan-default-pvid"></a>vlan-default-pvid</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.vlan-default-pvid"></a>bridge.vlan-default-pvid</code></span></p></td> <td> <p>The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.</p> <p> @@ -1144,7 +1166,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.vlan-filtering"></a>vlan-filtering</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.vlan-filtering"></a>bridge.vlan-filtering</code></span></p></td> <td> <p>Control whether VLAN filtering is enabled on the bridge.</p> <p> @@ -1152,7 +1174,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.vlan-protocol"></a>vlan-protocol</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.vlan-protocol"></a>bridge.vlan-protocol</code></span></p></td> <td> <p>If specified, the protocol used for VLAN filtering.</p> <p>Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</p> @@ -1161,7 +1183,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.vlan-stats-enabled"></a>vlan-stats-enabled</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.vlan-stats-enabled"></a>bridge.vlan-stats-enabled</code></span></p></td> <td> <p>Controls whether per-VLAN stats accounting is enabled.</p> <p> @@ -1169,7 +1191,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.vlans"></a>vlans</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge.vlans"></a>bridge.vlans</code></span></p></td> <td> <p>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.</p> <p>In nmcli the VLAN list can be specified with the following syntax:</p> @@ -1196,7 +1218,7 @@ </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge-port.hairpin-mode"></a>hairpin-mode</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge-port.hairpin-mode"></a>bridge-port.hairpin-mode</code></span></p></td> <td> <p> Alias: hairpin</p> @@ -1206,7 +1228,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge-port.path-cost"></a>path-cost</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge-port.path-cost"></a>bridge-port.path-cost</code></span></p></td> <td> <p> Alias: path-cost</p> @@ -1216,7 +1238,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge-port.priority"></a>priority</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge-port.priority"></a>bridge-port.priority</code></span></p></td> <td> <p> Alias: priority</p> @@ -1226,7 +1248,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge-port.vlans"></a>vlans</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bridge-port.vlans"></a>bridge-port.vlans</code></span></p></td> <td> <p>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.</p> <p>In nmcli the VLAN list can be specified with the following syntax:</p> @@ -1253,7 +1275,7 @@ </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.cdma.mtu"></a>mtu</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.cdma.mtu"></a>cdma.mtu</code></span></p></td> <td> <p>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</p> <p> @@ -1261,7 +1283,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.cdma.number"></a>number</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.cdma.number"></a>cdma.number</code></span></p></td> <td> <p>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.</p> <p> @@ -1269,7 +1291,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.cdma.password"></a>password</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.cdma.password"></a>cdma.password</code></span></p></td> <td> <p> Alias: password</p> @@ -1279,15 +1301,18 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.cdma.password-flags"></a>password-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.cdma.password-flags"></a>cdma.password-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "password" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.cdma.username"></a>username</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.cdma.username"></a>cdma.username</code></span></p></td> <td> <p> Alias: user</p> @@ -1313,7 +1338,7 @@ </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-fcoe-flags"></a>app-fcoe-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-fcoe-flags"></a>dcb.app-fcoe-flags</code></span></p></td> <td> <p>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).</p> <p> @@ -1321,7 +1346,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-fcoe-mode"></a>app-fcoe-mode</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-fcoe-mode"></a>dcb.app-fcoe-mode</code></span></p></td> <td> <p>The FCoE controller mode; either "fabric" or "vn2vn".</p> <p>Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".</p> @@ -1330,7 +1355,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-fcoe-priority"></a>app-fcoe-priority</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-fcoe-priority"></a>dcb.app-fcoe-priority</code></span></p></td> <td> <p>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.</p> <p> @@ -1338,7 +1363,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-fip-flags"></a>app-fip-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-fip-flags"></a>dcb.app-fip-flags</code></span></p></td> <td> <p>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).</p> <p> @@ -1346,7 +1371,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-fip-priority"></a>app-fip-priority</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-fip-priority"></a>dcb.app-fip-priority</code></span></p></td> <td> <p>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.</p> <p> @@ -1354,7 +1379,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-iscsi-flags"></a>app-iscsi-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-iscsi-flags"></a>dcb.app-iscsi-flags</code></span></p></td> <td> <p>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).</p> <p> @@ -1362,7 +1387,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-iscsi-priority"></a>app-iscsi-priority</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-iscsi-priority"></a>dcb.app-iscsi-priority</code></span></p></td> <td> <p>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.</p> <p> @@ -1370,7 +1395,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-bandwidth"></a>priority-bandwidth</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-bandwidth"></a>dcb.priority-bandwidth</code></span></p></td> <td> <p>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.</p> <p> @@ -1378,7 +1403,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-flow-control"></a>priority-flow-control</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-flow-control"></a>dcb.priority-flow-control</code></span></p></td> <td> <p>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.</p> <p> @@ -1386,7 +1411,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-flow-control-flags"></a>priority-flow-control-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-flow-control-flags"></a>dcb.priority-flow-control-flags</code></span></p></td> <td> <p>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).</p> <p> @@ -1394,7 +1419,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-group-bandwidth"></a>priority-group-bandwidth</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-group-bandwidth"></a>dcb.priority-group-bandwidth</code></span></p></td> <td> <p>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.</p> <p> @@ -1402,7 +1427,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-group-flags"></a>priority-group-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-group-flags"></a>dcb.priority-group-flags</code></span></p></td> <td> <p>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).</p> <p> @@ -1410,7 +1435,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-group-id"></a>priority-group-id</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-group-id"></a>dcb.priority-group-id</code></span></p></td> <td> <p>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.</p> <p> @@ -1418,7 +1443,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-strict-bandwidth"></a>priority-strict-bandwidth</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-strict-bandwidth"></a>dcb.priority-strict-bandwidth</code></span></p></td> <td> <p>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.</p> <p> @@ -1426,7 +1451,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-traffic-class"></a>priority-traffic-class</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-traffic-class"></a>dcb.priority-traffic-class</code></span></p></td> <td> <p>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.</p> <p> @@ -1450,352 +1475,352 @@ </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-adaptive-rx"></a>coalesce-adaptive-rx</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-adaptive-rx"></a>ethtool.coalesce-adaptive-rx</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-adaptive-tx"></a>coalesce-adaptive-tx</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-adaptive-tx"></a>ethtool.coalesce-adaptive-tx</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-high"></a>coalesce-pkt-rate-high</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-high"></a>ethtool.coalesce-pkt-rate-high</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-low"></a>coalesce-pkt-rate-low</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-low"></a>ethtool.coalesce-pkt-rate-low</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-frames"></a>coalesce-rx-frames</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-frames"></a>ethtool.coalesce-rx-frames</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-high"></a>coalesce-rx-frames-high</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-high"></a>ethtool.coalesce-rx-frames-high</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-irq"></a>coalesce-rx-frames-irq</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-irq"></a>ethtool.coalesce-rx-frames-irq</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-low"></a>coalesce-rx-frames-low</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-low"></a>ethtool.coalesce-rx-frames-low</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs"></a>coalesce-rx-usecs</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs"></a>ethtool.coalesce-rx-usecs</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-high"></a>coalesce-rx-usecs-high</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-high"></a>ethtool.coalesce-rx-usecs-high</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-irq"></a>coalesce-rx-usecs-irq</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-irq"></a>ethtool.coalesce-rx-usecs-irq</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-low"></a>coalesce-rx-usecs-low</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-low"></a>ethtool.coalesce-rx-usecs-low</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-sample-interval"></a>coalesce-sample-interval</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-sample-interval"></a>ethtool.coalesce-sample-interval</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-stats-block-usecs"></a>coalesce-stats-block-usecs</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-stats-block-usecs"></a>ethtool.coalesce-stats-block-usecs</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-frames"></a>coalesce-tx-frames</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-frames"></a>ethtool.coalesce-tx-frames</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-high"></a>coalesce-tx-frames-high</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-high"></a>ethtool.coalesce-tx-frames-high</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-irq"></a>coalesce-tx-frames-irq</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-irq"></a>ethtool.coalesce-tx-frames-irq</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-low"></a>coalesce-tx-frames-low</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-low"></a>ethtool.coalesce-tx-frames-low</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs"></a>coalesce-tx-usecs</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs"></a>ethtool.coalesce-tx-usecs</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-high"></a>coalesce-tx-usecs-high</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-high"></a>ethtool.coalesce-tx-usecs-high</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-irq"></a>coalesce-tx-usecs-irq</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-irq"></a>ethtool.coalesce-tx-usecs-irq</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-low"></a>coalesce-tx-usecs-low</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-low"></a>ethtool.coalesce-tx-usecs-low</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-esp-hw-offload"></a>feature-esp-hw-offload</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-esp-hw-offload"></a>ethtool.feature-esp-hw-offload</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-esp-tx-csum-hw-offload"></a>feature-esp-tx-csum-hw-offload</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-esp-tx-csum-hw-offload"></a>ethtool.feature-esp-tx-csum-hw-offload</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-fcoe-mtu"></a>feature-fcoe-mtu</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-fcoe-mtu"></a>ethtool.feature-fcoe-mtu</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-gro"></a>feature-gro</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-gro"></a>ethtool.feature-gro</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-gso"></a>feature-gso</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-gso"></a>ethtool.feature-gso</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-highdma"></a>feature-highdma</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-highdma"></a>ethtool.feature-highdma</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-hw-tc-offload"></a>feature-hw-tc-offload</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-hw-tc-offload"></a>ethtool.feature-hw-tc-offload</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-l2-fwd-offload"></a>feature-l2-fwd-offload</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-l2-fwd-offload"></a>ethtool.feature-l2-fwd-offload</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-loopback"></a>feature-loopback</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-loopback"></a>ethtool.feature-loopback</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-lro"></a>feature-lro</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-lro"></a>ethtool.feature-lro</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-macsec-hw-offload"></a>feature-macsec-hw-offload</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-macsec-hw-offload"></a>ethtool.feature-macsec-hw-offload</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-ntuple"></a>feature-ntuple</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-ntuple"></a>ethtool.feature-ntuple</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx"></a>feature-rx</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx"></a>ethtool.feature-rx</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-all"></a>feature-rx-all</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-all"></a>ethtool.feature-rx-all</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-fcs"></a>feature-rx-fcs</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-fcs"></a>ethtool.feature-rx-fcs</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-gro-hw"></a>feature-rx-gro-hw</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-gro-hw"></a>ethtool.feature-rx-gro-hw</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-gro-list"></a>feature-rx-gro-list</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-gro-list"></a>ethtool.feature-rx-gro-list</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-udp-gro-forwarding"></a>feature-rx-udp-gro-forwarding</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-udp-gro-forwarding"></a>ethtool.feature-rx-udp-gro-forwarding</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-udp_tunnel-port-offload"></a>feature-rx-udp_tunnel-port-offload</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-udp_tunnel-port-offload"></a>ethtool.feature-rx-udp_tunnel-port-offload</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-vlan-filter"></a>feature-rx-vlan-filter</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-vlan-filter"></a>ethtool.feature-rx-vlan-filter</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-filter"></a>feature-rx-vlan-stag-filter</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-filter"></a>ethtool.feature-rx-vlan-stag-filter</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-hw-parse"></a>feature-rx-vlan-stag-hw-parse</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-hw-parse"></a>ethtool.feature-rx-vlan-stag-hw-parse</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rxhash"></a>feature-rxhash</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rxhash"></a>ethtool.feature-rxhash</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rxvlan"></a>feature-rxvlan</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rxvlan"></a>ethtool.feature-rxvlan</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-sg"></a>feature-sg</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-sg"></a>ethtool.feature-sg</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tls-hw-record"></a>feature-tls-hw-record</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tls-hw-record"></a>ethtool.feature-tls-hw-record</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tls-hw-rx-offload"></a>feature-tls-hw-rx-offload</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tls-hw-rx-offload"></a>ethtool.feature-tls-hw-rx-offload</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tls-hw-tx-offload"></a>feature-tls-hw-tx-offload</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tls-hw-tx-offload"></a>ethtool.feature-tls-hw-tx-offload</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tso"></a>feature-tso</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tso"></a>ethtool.feature-tso</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx"></a>feature-tx</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx"></a>ethtool.feature-tx</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-fcoe-crc"></a>feature-tx-checksum-fcoe-crc</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-fcoe-crc"></a>ethtool.feature-tx-checksum-fcoe-crc</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ip-generic"></a>feature-tx-checksum-ip-generic</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ip-generic"></a>ethtool.feature-tx-checksum-ip-generic</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv4"></a>feature-tx-checksum-ipv4</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv4"></a>ethtool.feature-tx-checksum-ipv4</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv6"></a>feature-tx-checksum-ipv6</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv6"></a>ethtool.feature-tx-checksum-ipv6</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-sctp"></a>feature-tx-checksum-sctp</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-sctp"></a>ethtool.feature-tx-checksum-sctp</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-esp-segmentation"></a>feature-tx-esp-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-esp-segmentation"></a>ethtool.feature-tx-esp-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-fcoe-segmentation"></a>feature-tx-fcoe-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-fcoe-segmentation"></a>ethtool.feature-tx-fcoe-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gre-csum-segmentation"></a>feature-tx-gre-csum-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gre-csum-segmentation"></a>ethtool.feature-tx-gre-csum-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gre-segmentation"></a>feature-tx-gre-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gre-segmentation"></a>ethtool.feature-tx-gre-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gso-list"></a>feature-tx-gso-list</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gso-list"></a>ethtool.feature-tx-gso-list</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gso-partial"></a>feature-tx-gso-partial</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gso-partial"></a>ethtool.feature-tx-gso-partial</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gso-robust"></a>feature-tx-gso-robust</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gso-robust"></a>ethtool.feature-tx-gso-robust</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-ipxip4-segmentation"></a>feature-tx-ipxip4-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-ipxip4-segmentation"></a>ethtool.feature-tx-ipxip4-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-ipxip6-segmentation"></a>feature-tx-ipxip6-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-ipxip6-segmentation"></a>ethtool.feature-tx-ipxip6-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-nocache-copy"></a>feature-tx-nocache-copy</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-nocache-copy"></a>ethtool.feature-tx-nocache-copy</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather"></a>feature-tx-scatter-gather</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather"></a>ethtool.feature-tx-scatter-gather</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather-fraglist"></a>feature-tx-scatter-gather-fraglist</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather-fraglist"></a>ethtool.feature-tx-scatter-gather-fraglist</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-sctp-segmentation"></a>feature-tx-sctp-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-sctp-segmentation"></a>ethtool.feature-tx-sctp-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tcp-ecn-segmentation"></a>feature-tx-tcp-ecn-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tcp-ecn-segmentation"></a>ethtool.feature-tx-tcp-ecn-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tcp-mangleid-segmentation"></a>feature-tx-tcp-mangleid-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tcp-mangleid-segmentation"></a>ethtool.feature-tx-tcp-mangleid-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tcp-segmentation"></a>feature-tx-tcp-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tcp-segmentation"></a>ethtool.feature-tx-tcp-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tcp6-segmentation"></a>feature-tx-tcp6-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tcp6-segmentation"></a>ethtool.feature-tx-tcp6-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tunnel-remcsum-segmentation"></a>feature-tx-tunnel-remcsum-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tunnel-remcsum-segmentation"></a>ethtool.feature-tx-tunnel-remcsum-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-udp-segmentation"></a>feature-tx-udp-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-udp-segmentation"></a>ethtool.feature-tx-udp-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-csum-segmentation"></a>feature-tx-udp_tnl-csum-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-csum-segmentation"></a>ethtool.feature-tx-udp_tnl-csum-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-segmentation"></a>feature-tx-udp_tnl-segmentation</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-segmentation"></a>ethtool.feature-tx-udp_tnl-segmentation</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-vlan-stag-hw-insert"></a>feature-tx-vlan-stag-hw-insert</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-vlan-stag-hw-insert"></a>ethtool.feature-tx-vlan-stag-hw-insert</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-txvlan"></a>feature-txvlan</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-txvlan"></a>ethtool.feature-txvlan</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.pause-autoneg"></a>pause-autoneg</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.pause-autoneg"></a>ethtool.pause-autoneg</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.pause-rx"></a>pause-rx</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.pause-rx"></a>ethtool.pause-rx</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.pause-tx"></a>pause-tx</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.pause-tx"></a>ethtool.pause-tx</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.ring-rx"></a>ring-rx</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.ring-rx"></a>ethtool.ring-rx</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.ring-rx-jumbo"></a>ring-rx-jumbo</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.ring-rx-jumbo"></a>ethtool.ring-rx-jumbo</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.ring-rx-mini"></a>ring-rx-mini</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.ring-rx-mini"></a>ethtool.ring-rx-mini</code></span></p></td> +<td></td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.ring-tx"></a>ring-tx</code></span></p></td> -<td><p></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.ring-tx"></a>ethtool.ring-tx</code></span></p></td> +<td></td> </tr> </tbody> </table></div> @@ -1814,7 +1839,7 @@ </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.apn"></a>apn</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.apn"></a>gsm.apn</code></span></p></td> <td> <p> Alias: apn</p> @@ -1824,7 +1849,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.auto-config"></a>auto-config</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.auto-config"></a>gsm.auto-config</code></span></p></td> <td> <p>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.</p> <p> @@ -1832,7 +1857,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.device-id"></a>device-id</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.device-id"></a>gsm.device-id</code></span></p></td> <td> <p>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.</p> <p> @@ -1840,7 +1865,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.home-only"></a>home-only</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.home-only"></a>gsm.home-only</code></span></p></td> <td> <p>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</p> <p> @@ -1848,7 +1873,23 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.mtu"></a>mtu</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.initial-eps-bearer-apn"></a>gsm.initial-eps-bearer-apn</code></span></p></td> +<td> +<p>For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network. Setting this parameter implies initial-eps-bearer-configure to be TRUE.</p> +<p> + Format: string</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.initial-eps-bearer-configure"></a>gsm.initial-eps-bearer-configure</code></span></p></td> +<td> +<p>For LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection. It is inferred TRUE if initial-eps-bearer-apn is set.</p> +<p> + Format: boolean</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.mtu"></a>gsm.mtu</code></span></p></td> <td> <p>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</p> <p> @@ -1856,7 +1897,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.network-id"></a>network-id</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.network-id"></a>gsm.network-id</code></span></p></td> <td> <p>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.</p> <p> @@ -1864,7 +1905,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.number"></a>number</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.number"></a>gsm.number</code></span></p></td> <td> <p>Legacy setting that used to help establishing PPP data sessions for GSM-based modems.</p> <p> @@ -1875,7 +1916,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.password"></a>password</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.password"></a>gsm.password</code></span></p></td> <td> <p> Alias: password</p> @@ -1885,15 +1926,18 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.password-flags"></a>password-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.password-flags"></a>gsm.password-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "password" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.pin"></a>pin</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.pin"></a>gsm.pin</code></span></p></td> <td> <p>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.</p> <p> @@ -1901,15 +1945,18 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.pin-flags"></a>pin-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.pin-flags"></a>gsm.pin-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "pin" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.sim-id"></a>sim-id</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.sim-id"></a>gsm.sim-id</code></span></p></td> <td> <p>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.</p> <p> @@ -1917,7 +1964,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.sim-operator-id"></a>sim-operator-id</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.sim-operator-id"></a>gsm.sim-operator-id</code></span></p></td> <td> <p>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.</p> <p> @@ -1925,7 +1972,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.username"></a>username</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.gsm.username"></a>gsm.username</code></span></p></td> <td> <p> Alias: user</p> @@ -1951,7 +1998,7 @@ </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.infiniband.mac-address"></a>mac-address</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.infiniband.mac-address"></a>infiniband.mac-address</code></span></p></td> <td> <p> Alias: mac</p> @@ -1961,7 +2008,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.infiniband.mtu"></a>mtu</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.infiniband.mtu"></a>infiniband.mtu</code></span></p></td> <td> <p> Alias: mtu</p> @@ -1971,7 +2018,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.infiniband.p-key"></a>p-key</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.infiniband.p-key"></a>infiniband.p-key</code></span></p></td> <td> <p> Alias: p-key</p> @@ -1983,7 +2030,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.infiniband.parent"></a>parent</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.infiniband.parent"></a>infiniband.parent</code></span></p></td> <td> <p> Alias: parent</p> @@ -1993,7 +2040,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.infiniband.transport-mode"></a>transport-mode</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.infiniband.transport-mode"></a>infiniband.transport-mode</code></span></p></td> <td> <p> Alias: transport-mode</p> @@ -2019,17 +2066,17 @@ </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.addresses"></a>addresses</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.addresses"></a>ipv4.addresses</code></span></p></td> <td> <p> Alias: ip4</p> -<p>Array of IP addresses.</p> +<p>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.</p> <p> Format: a comma separated list of addresses</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.auto-route-ext-gw"></a>auto-route-ext-gw</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.auto-route-ext-gw"></a>ipv4.auto-route-ext-gw</code></span></p></td> <td> <p>VPN connections will default to add the route automatically unless this setting is set to FALSE.</p> <p>For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</p> @@ -2038,7 +2085,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dad-timeout"></a>dad-timeout</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dad-timeout"></a>ipv4.dad-timeout</code></span></p></td> <td> <p>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.</p> <p>The property is currently implemented only for IPv4.</p> @@ -2047,7 +2094,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-client-id"></a>dhcp-client-id</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-client-id"></a>ipv4.dhcp-client-id</code></span></p></td> <td> <p>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.</p> <p>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.</p> @@ -2060,7 +2107,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-fqdn"></a>dhcp-fqdn</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-fqdn"></a>ipv4.dhcp-fqdn</code></span></p></td> <td> <p>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.</p> <p> @@ -2068,7 +2115,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-hostname"></a>dhcp-hostname</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-hostname"></a>ipv4.dhcp-hostname</code></span></p></td> <td> <p>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.</p> <p> @@ -2076,7 +2123,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-hostname-flags"></a>dhcp-hostname-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-hostname-flags"></a>ipv4.dhcp-hostname-flags</code></span></p></td> <td> <p>Flags for the DHCP hostname and FQDN.</p> <p>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.</p> @@ -2086,9 +2133,9 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-iaid"></a>dhcp-iaid</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-iaid"></a>ipv4.dhcp-iaid</code></span></p></td> <td> -<p>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".</p> +<p>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 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".</p> <p>For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.</p> <p>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.</p> <p>The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.</p> @@ -2097,7 +2144,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-reject-servers"></a>dhcp-reject-servers</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-reject-servers"></a>ipv4.dhcp-reject-servers</code></span></p></td> <td> <p>Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers.</p> <p>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").</p> @@ -2107,7 +2154,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-send-hostname"></a>dhcp-send-hostname</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-send-hostname"></a>ipv4.dhcp-send-hostname</code></span></p></td> <td> <p>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.</p> <p> @@ -2115,7 +2162,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-timeout"></a>dhcp-timeout</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-timeout"></a>ipv4.dhcp-timeout</code></span></p></td> <td> <p>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).</p> <p>Set to 2147483647 (MAXINT32) for infinity.</p> @@ -2124,7 +2171,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-vendor-class-identifier"></a>dhcp-vendor-class-identifier</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-vendor-class-identifier"></a>ipv4.dhcp-vendor-class-identifier</code></span></p></td> <td> <p>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.</p> <p> @@ -2132,7 +2179,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dns"></a>dns</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dns"></a>ipv4.dns</code></span></p></td> <td> <p>Array of IP addresses of DNS servers.</p> <p>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.</p> @@ -2141,19 +2188,20 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dns-options"></a>dns-options</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dns-options"></a>ipv4.dns-options</code></span></p></td> <td> -<p>Array of DNS options as described in man 5 resolv.conf.</p> -<p>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.</p> -<p>The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc".</p> +<p>DNS options for /etc/resolv.conf as described in resolv.conf(5) manual.</p> +<p>The currently supported options are "attempts", "debug", "edns0", "ndots", "no-aaaa", "no-check-names", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". See the resolv.conf(5) manual.</p> +<p>Note that there is a distinction between an unset (default) list and an empty list. In nmcli, to unset the list set the value to "". To set an empty list, set it to " ". Currently, an unset list has the same meaning as an empty list. That might change in the future.</p> <p>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.</p> <p>When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</p> +<p>The valid "ipv4.dns-options" and "ipv6.dns-options" get merged together.</p> <p> - Format: array of string</p> + Format: a comma separated list of DNS options</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dns-priority"></a>dns-priority</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dns-priority"></a>ipv4.dns-priority</code></span></p></td> <td> <p>DNS servers priority.</p> <p>The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</p> @@ -2168,7 +2216,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dns-search"></a>dns-search</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dns-search"></a>ipv4.dns-search</code></span></p></td> <td> <p>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.</p> <p>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.</p> @@ -2178,7 +2226,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.gateway"></a>gateway</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.gateway"></a>ipv4.gateway</code></span></p></td> <td> <p> Alias: gw4</p> @@ -2190,7 +2238,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.ignore-auto-dns"></a>ignore-auto-dns</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.ignore-auto-dns"></a>ipv4.ignore-auto-dns</code></span></p></td> <td> <p>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.</p> <p> @@ -2198,7 +2246,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.ignore-auto-routes"></a>ignore-auto-routes</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.ignore-auto-routes"></a>ipv4.ignore-auto-routes</code></span></p></td> <td> <p>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.</p> <p> @@ -2206,7 +2254,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.link-local"></a>link-local</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.link-local"></a>ipv4.link-local</code></span></p></td> <td> <p>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.</p> <p>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".</p> @@ -2215,7 +2263,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.may-fail"></a>may-fail</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.may-fail"></a>ipv4.may-fail</code></span></p></td> <td> <p>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.</p> <p> @@ -2223,19 +2271,28 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.method"></a>method</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.method"></a>ipv4.method</code></span></p></td> <td> -<p>IP configuration method.</p> -<p>NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.</p> -<p>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.</p> -<p>For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.</p> -<p>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.</p> +<p> + Sets the IPv4 connection method. You can set one of the following values: +</p> +<p> + </p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="literal">"auto"</code> - Enables automatic IPv4 address assignment from DHCP, PPP, or similar services.</p></li> +<li class="listitem"><p><code class="literal">"manual"</code> - Enables the configuration of static IPv4 addresses on the interface. Note that you must set at least one IP address and subnet mask in the "ipv4.addresses" property.</p></li> +<li class="listitem"><p><code class="literal">"disabled"</code> - Disables the IPv4 protocol in this connection profile.</p></li> +<li class="listitem"><p><code class="literal">"shared"</code> - Provides network access to other computers. If you do not specify an IP address and subnet mask in "ipv4.addresses", NetworkManager assigns 10.42.x.1/24 to the interface. Additionally, NetworkManager starts a DHCP server and DNS forwarder. Hosts that connect to this interface will then receive an IP address from the configured range, and NetworkManager configures NAT to map client addresses to the one of the current default network connection.</p></li> +<li class="listitem"><p><code class="literal">"link-local"</code> - Enables link-local addresses according to RFC 3927. NetworkManager assigns a random link-local address from the 169.254.0.0/16 subnet to the interface.</p></li> +</ul></div> +<p> +</p> <p> Format: string</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.never-default"></a>never-default</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.never-default"></a>ipv4.never-default</code></span></p></td> <td> <p>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.</p> <p> @@ -2243,7 +2300,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.replace-local-rule"></a>replace-local-rule</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.replace-local-rule"></a>ipv4.replace-local-rule</code></span></p></td> <td> <p>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</p> <p> @@ -2251,7 +2308,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.required-timeout"></a>required-timeout</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.required-timeout"></a>ipv4.required-timeout</code></span></p></td> <td> <p>The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</p> <p>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.</p> @@ -2262,7 +2319,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.route-metric"></a>route-metric</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.route-metric"></a>ipv4.route-metric</code></span></p></td> <td> <p>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.</p> <p> @@ -2270,7 +2327,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.route-table"></a>route-table</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.route-table"></a>ipv4.route-table</code></span></p></td> <td> <p>Enable policy routing (source routing) and set the routing table used when adding routes.</p> <p>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.</p> @@ -2281,7 +2338,7 @@ </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.routes"></a>routes</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.routes"></a>ipv4.routes</code></span></p></td> <td> <p> A list of IPv4 destination addresses, prefix length, optional IPv4 @@ -2343,7 +2400,7 @@ For details see also `man ip-route`. </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.routing-rules"></a>routing-rules</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.routing-rules"></a>ipv4.routing-rules</code></span></p></td> <td> <p> A comma separated list of routing rules for policy routing. The format @@ -2375,30 +2432,31 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.addr-gen-mode"></a>addr-gen-mode</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.addr-gen-mode"></a>ipv6.addr-gen-mode</code></span></p></td> <td> -<p>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).</p> -<p>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.</p> -<p>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.</p> -<p>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.</p> -<p>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.</p> +<p>Configure method for creating the IPv6 interface identifer of addresses with RFC4862 IPv6 Stateless Address Autoconfiguration and Link Local addresses.</p> +<p>The permitted values are: "eui64" (0), "stable-privacy" (1), "default" (3) or "default-or-eui64" (2).</p> +<p>If the property is set to "eui64", the addresses will be generated using the interface token derived from hardware address. This makes the host part of the address to stay constant, making it possible to track the host's presence when it changes networks. The address changes when the interface hardware is replaced. If a duplicate address is detected, there is also no fallback to generate another address. When configured, the "ipv6.token" is used instead of the MAC address to generate addresses for stateless autoconfiguration.</p> +<p>If the property is set to "stable-privacy", the interface identifier is generated as specified by RFC7217. This works by hashing a host specific key (see NetworkManager(8) manual), the interface name, the connection's "connection.stable-id" property and the address prefix. This improves privacy by making it harder to use the address to track the host's presence and the address is stable when the network interface hardware is replaced.</p> +<p>The special values "default" and "default-or-eui64" will fallback to the global connection default as documented in the NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively.</p> +<p>If not specified, when creating a new profile the default is "default".</p> <p>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.</p> <p> - Format: int32</p> + Format: one of "eui64" (0), "stable-privacy" (1), "default" (3) or "default-or-eui64" (2)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.addresses"></a>addresses</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.addresses"></a>ipv6.addresses</code></span></p></td> <td> <p> Alias: ip6</p> -<p>Array of IP addresses.</p> +<p>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).</p> <p> Format: a comma separated list of addresses</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.auto-route-ext-gw"></a>auto-route-ext-gw</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.auto-route-ext-gw"></a>ipv6.auto-route-ext-gw</code></span></p></td> <td> <p>VPN connections will default to add the route automatically unless this setting is set to FALSE.</p> <p>For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</p> @@ -2407,7 +2465,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dhcp-duid"></a>dhcp-duid</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dhcp-duid"></a>ipv6.dhcp-duid</code></span></p></td> <td> <p>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.</p> <p>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.</p> @@ -2419,7 +2477,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dhcp-hostname"></a>dhcp-hostname</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dhcp-hostname"></a>ipv6.dhcp-hostname</code></span></p></td> <td> <p>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.</p> <p> @@ -2427,7 +2485,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dhcp-hostname-flags"></a>dhcp-hostname-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dhcp-hostname-flags"></a>ipv6.dhcp-hostname-flags</code></span></p></td> <td> <p>Flags for the DHCP hostname and FQDN.</p> <p>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.</p> @@ -2437,9 +2495,9 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dhcp-iaid"></a>dhcp-iaid</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dhcp-iaid"></a>ipv6.dhcp-iaid</code></span></p></td> <td> -<p>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".</p> +<p>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 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".</p> <p>For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.</p> <p>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.</p> <p>The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.</p> @@ -2448,7 +2506,15 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dhcp-send-hostname"></a>dhcp-send-hostname</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dhcp-pd-hint"></a>ipv6.dhcp-pd-hint</code></span></p></td> +<td> +<p>A IPv6 address followed by a slash and a prefix length. If set, the value is sent to the DHCPv6 server as hint indicating the prefix delegation (IA_PD) we want to receive. To only hint a prefix length without prefix, set the address part to the zero address (for example "::/60").</p> +<p> + Format: string</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dhcp-send-hostname"></a>ipv6.dhcp-send-hostname</code></span></p></td> <td> <p>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.</p> <p> @@ -2456,7 +2522,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dhcp-timeout"></a>dhcp-timeout</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dhcp-timeout"></a>ipv6.dhcp-timeout</code></span></p></td> <td> <p>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).</p> <p>Set to 2147483647 (MAXINT32) for infinity.</p> @@ -2465,7 +2531,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dns"></a>dns</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dns"></a>ipv6.dns</code></span></p></td> <td> <p>Array of IP addresses of DNS servers.</p> <p>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.</p> @@ -2474,19 +2540,20 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dns-options"></a>dns-options</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dns-options"></a>ipv6.dns-options</code></span></p></td> <td> -<p>Array of DNS options as described in man 5 resolv.conf.</p> -<p>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.</p> -<p>The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc".</p> +<p>DNS options for /etc/resolv.conf as described in resolv.conf(5) manual.</p> +<p>The currently supported options are "attempts", "debug", "edns0", "ndots", "no-aaaa", "no-check-names", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc" and "inet6", "ip6-bytestring", "ip6-dotint", "no-ip6-dotint". See the resolv.conf(5) manual.</p> +<p>Note that there is a distinction between an unset (default) list and an empty list. In nmcli, to unset the list set the value to "". To set an empty list, set it to " ". Currently, an unset list has the same meaning as an empty list. That might change in the future.</p> <p>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.</p> <p>When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</p> +<p>The valid "ipv4.dns-options" and "ipv6.dns-options" get merged together.</p> <p> - Format: array of string</p> + Format: a comma separated list of DNS options</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dns-priority"></a>dns-priority</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dns-priority"></a>ipv6.dns-priority</code></span></p></td> <td> <p>DNS servers priority.</p> <p>The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</p> @@ -2501,7 +2568,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dns-search"></a>dns-search</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dns-search"></a>ipv6.dns-search</code></span></p></td> <td> <p>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.</p> <p>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.</p> @@ -2511,7 +2578,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.gateway"></a>gateway</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.gateway"></a>ipv6.gateway</code></span></p></td> <td> <p> Alias: gw6</p> @@ -2523,7 +2590,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.ignore-auto-dns"></a>ignore-auto-dns</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.ignore-auto-dns"></a>ipv6.ignore-auto-dns</code></span></p></td> <td> <p>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.</p> <p> @@ -2531,7 +2598,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.ignore-auto-routes"></a>ignore-auto-routes</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.ignore-auto-routes"></a>ipv6.ignore-auto-routes</code></span></p></td> <td> <p>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.</p> <p> @@ -2539,7 +2606,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.ip6-privacy"></a>ip6-privacy</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.ip6-privacy"></a>ipv6.ip6-privacy</code></span></p></td> <td> <p>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).</p> <p>Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy".</p> @@ -2550,7 +2617,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.may-fail"></a>may-fail</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.may-fail"></a>ipv6.may-fail</code></span></p></td> <td> <p>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.</p> <p> @@ -2558,19 +2625,35 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.method"></a>method</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.method"></a>ipv6.method</code></span></p></td> <td> -<p>IP configuration method.</p> -<p>NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.</p> -<p>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.</p> -<p>For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.</p> -<p>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.</p> +<p> + Sets the IPv6 connection method. You can set one of the following values: +</p> +<p> + </p> +<div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "> +<li class="listitem"><p><code class="literal">"auto"</code> - Enables IPv6 auto-configuration. By default, NetworkManager uses Router Advertisements and, if the router announces the "managed" flag, NetworkManager requests an IPv6 address and prefix from a DHCPv6 server.</p></li> +<li class="listitem"><p><code class="literal">"dhcp"</code> - Requests an IPv6 address and prefix from a DHCPv6 server. Note that DHCPv6 does not have options to provide routes and the default gateway. As a consequence, by using the "dhcp" method, connections are limited to their own subnet.</p></li> +<li class="listitem"><p><code class="literal">"manual"</code> - Enables the configuration of static IPv6 addresses on the interface. Note that you must set at least one IP address and prefix in the "ipv6.addresses" property.</p></li> +<li class="listitem"><p><code class="literal">"disabled"</code> - Disables the IPv6 protocol in this connection profile.</p></li> +<li class="listitem"><p><code class="literal">"ignore"</code> - Configures NetworkManager to make no changes to the IPv6 configuration on the interface. For example, you can then use the "accept_ra" feature of the kernel to accept Router Advertisements.</p></li> +<li class="listitem"><p><code class="literal">"shared"</code> - Provides network access to other computers. NetworkManager requests a prefix from an upstream DHCPv6 server, assigns an address to the interface, and announces the prefix to clients that connect to this interface.</p></li> +<li class="listitem"><p><code class="literal">"link-local"</code> - Assigns a random link-local address from the fe80::/64 subnet to the interface.</p></li> +</ul></div> +<p> + </p> +<p> + If you set <code class="literal">"auto"</code>, <code class="literal">"dhcp"</code>, <code class="literal">"manual"</code>, <code class="literal">"ignore"</code>, or <code class="literal">"shared"</code>, NetworkManager assigns, in addition to the global address, an IPv6 link-local address to the interface. This is compliant with RFC 4291. + </p> +<p> +</p> <p> Format: string</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.mtu"></a>mtu</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.mtu"></a>ipv6.mtu</code></span></p></td> <td> <p>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.</p> <p> @@ -2578,7 +2661,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.never-default"></a>never-default</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.never-default"></a>ipv6.never-default</code></span></p></td> <td> <p>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.</p> <p> @@ -2586,7 +2669,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.ra-timeout"></a>ra-timeout</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.ra-timeout"></a>ipv6.ra-timeout</code></span></p></td> <td> <p>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.</p> <p>Set to 2147483647 (MAXINT32) for infinity.</p> @@ -2595,7 +2678,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.replace-local-rule"></a>replace-local-rule</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.replace-local-rule"></a>ipv6.replace-local-rule</code></span></p></td> <td> <p>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</p> <p> @@ -2603,7 +2686,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.required-timeout"></a>required-timeout</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.required-timeout"></a>ipv6.required-timeout</code></span></p></td> <td> <p>The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</p> <p>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.</p> @@ -2614,7 +2697,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.route-metric"></a>route-metric</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.route-metric"></a>ipv6.route-metric</code></span></p></td> <td> <p>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.</p> <p> @@ -2622,7 +2705,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.route-table"></a>route-table</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.route-table"></a>ipv6.route-table</code></span></p></td> <td> <p>Enable policy routing (source routing) and set the routing table used when adding routes.</p> <p>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.</p> @@ -2633,7 +2716,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.routes"></a>routes</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.routes"></a>ipv6.routes</code></span></p></td> <td> <p> A list of IPv6 destination addresses, prefix length, optional IPv6 @@ -2677,7 +2760,7 @@ For details see also `man ip-route`. </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.routing-rules"></a>routing-rules</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.routing-rules"></a>ipv6.routing-rules</code></span></p></td> <td> <p> A comma separated list of routing rules for policy routing. The format @@ -2693,9 +2776,10 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.token"></a>token</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.token"></a>ipv6.token</code></span></p></td> <td> <p>Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</p> +<p>When set, the token is used as IPv6 interface identifier instead of the hardware address. This only applies to addresses from stateless autoconfiguration, not to IPv6 link local addresses.</p> <p> Format: string</p> </td> @@ -2717,7 +2801,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.encapsulation-limit"></a>encapsulation-limit</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.encapsulation-limit"></a>ip-tunnel.encapsulation-limit</code></span></p></td> <td> <p>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1) to ip-tunnel flags.</p> <p> @@ -2725,7 +2809,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.flags"></a>flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.flags"></a>ip-tunnel.flags</code></span></p></td> <td> <p>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.</p> <p> @@ -2733,7 +2817,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.flow-label"></a>flow-label</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.flow-label"></a>ip-tunnel.flow-label</code></span></p></td> <td> <p>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</p> <p> @@ -2741,7 +2825,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.fwmark"></a>fwmark</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.fwmark"></a>ip-tunnel.fwmark</code></span></p></td> <td> <p>The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.</p> <p> @@ -2749,7 +2833,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.input-key"></a>input-key</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.input-key"></a>ip-tunnel.input-key</code></span></p></td> <td> <p>The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</p> <p> @@ -2757,7 +2841,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.local"></a>local</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.local"></a>ip-tunnel.local</code></span></p></td> <td> <p> Alias: local</p> @@ -2767,7 +2851,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.mode"></a>mode</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.mode"></a>ip-tunnel.mode</code></span></p></td> <td> <p> Alias: mode</p> @@ -2777,7 +2861,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.mtu"></a>mtu</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.mtu"></a>ip-tunnel.mtu</code></span></p></td> <td> <p>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</p> <p> @@ -2785,7 +2869,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.output-key"></a>output-key</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.output-key"></a>ip-tunnel.output-key</code></span></p></td> <td> <p>The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</p> <p> @@ -2793,7 +2877,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.parent"></a>parent</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.parent"></a>ip-tunnel.parent</code></span></p></td> <td> <p> Alias: dev</p> @@ -2803,7 +2887,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.path-mtu-discovery"></a>path-mtu-discovery</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.path-mtu-discovery"></a>ip-tunnel.path-mtu-discovery</code></span></p></td> <td> <p>Whether to enable Path MTU Discovery on this tunnel.</p> <p> @@ -2811,7 +2895,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.remote"></a>remote</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.remote"></a>ip-tunnel.remote</code></span></p></td> <td> <p> Alias: remote</p> @@ -2821,7 +2905,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.tos"></a>tos</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.tos"></a>ip-tunnel.tos</code></span></p></td> <td> <p>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</p> <p> @@ -2829,7 +2913,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.ttl"></a>ttl</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ip-tunnel.ttl"></a>ip-tunnel.ttl</code></span></p></td> <td> <p>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</p> <p> @@ -2853,7 +2937,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.encrypt"></a>encrypt</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.encrypt"></a>macsec.encrypt</code></span></p></td> <td> <p> Alias: encrypt</p> @@ -2863,7 +2947,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.mka-cak"></a>mka-cak</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.mka-cak"></a>macsec.mka-cak</code></span></p></td> <td> <p> Alias: cak</p> @@ -2873,15 +2957,18 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.mka-cak-flags"></a>mka-cak-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.mka-cak-flags"></a>macsec.mka-cak-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "mka-cak" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.mka-ckn"></a>mka-ckn</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.mka-ckn"></a>macsec.mka-ckn</code></span></p></td> <td> <p> Alias: ckn</p> @@ -2891,7 +2978,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.mode"></a>mode</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.mode"></a>macsec.mode</code></span></p></td> <td> <p> Alias: mode</p> @@ -2901,7 +2988,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.parent"></a>parent</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.parent"></a>macsec.parent</code></span></p></td> <td> <p> Alias: dev</p> @@ -2911,7 +2998,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.port"></a>port</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.port"></a>macsec.port</code></span></p></td> <td> <p> Alias: port</p> @@ -2921,7 +3008,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.send-sci"></a>send-sci</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.send-sci"></a>macsec.send-sci</code></span></p></td> <td> <p>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</p> <p> @@ -2929,7 +3016,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.validation"></a>validation</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macsec.validation"></a>macsec.validation</code></span></p></td> <td> <p>Specifies the validation mode for incoming frames.</p> <p> @@ -2953,7 +3040,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macvlan.mode"></a>mode</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macvlan.mode"></a>macvlan.mode</code></span></p></td> <td> <p> Alias: mode</p> @@ -2963,7 +3050,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macvlan.parent"></a>parent</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macvlan.parent"></a>macvlan.parent</code></span></p></td> <td> <p> Alias: dev</p> @@ -2973,7 +3060,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macvlan.promiscuous"></a>promiscuous</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macvlan.promiscuous"></a>macvlan.promiscuous</code></span></p></td> <td> <p>Whether the interface should be put in promiscuous mode.</p> <p> @@ -2981,7 +3068,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macvlan.tap"></a>tap</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.macvlan.tap"></a>macvlan.tap</code></span></p></td> <td> <p> Alias: tap</p> @@ -3007,7 +3094,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.match.driver"></a>driver</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.match.driver"></a>match.driver</code></span></p></td> <td> <p>A list of driver names to match. Each element is a shell wildcard pattern.</p> <p>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</p> @@ -3016,7 +3103,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.match.interface-name"></a>interface-name</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.match.interface-name"></a>match.interface-name</code></span></p></td> <td> <p>A list of interface names to match. Each element is a shell wildcard pattern.</p> <p>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".</p> @@ -3025,7 +3112,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.match.kernel-command-line"></a>kernel-command-line</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.match.kernel-command-line"></a>match.kernel-command-line</code></span></p></td> <td> <p>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.</p> <p>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.</p> @@ -3034,7 +3121,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.match.path"></a>path</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.match.path"></a>match.path</code></span></p></td> <td> <p>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.</p> <p>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".</p> @@ -3064,7 +3151,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-olpc-mesh.channel"></a>channel</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-olpc-mesh.channel"></a>802-11-olpc-mesh.channel</code></span></p></td> <td> <p> Alias: channel</p> @@ -3074,7 +3161,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-olpc-mesh.dhcp-anycast-address"></a>dhcp-anycast-address</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-olpc-mesh.dhcp-anycast-address"></a>802-11-olpc-mesh.dhcp-anycast-address</code></span></p></td> <td> <p> Alias: dhcp-anycast</p> @@ -3085,7 +3172,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-olpc-mesh.ssid"></a>ssid</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-olpc-mesh.ssid"></a>802-11-olpc-mesh.ssid</code></span></p></td> <td> <p> Alias: ssid</p> @@ -3111,7 +3198,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-bridge.datapath-type"></a>datapath-type</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-bridge.datapath-type"></a>ovs-bridge.datapath-type</code></span></p></td> <td> <p>The data path type. One of "system", "netdev" or empty.</p> <p> @@ -3119,7 +3206,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-bridge.fail-mode"></a>fail-mode</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-bridge.fail-mode"></a>ovs-bridge.fail-mode</code></span></p></td> <td> <p>The bridge failure mode. One of "secure", "standalone" or empty.</p> <p> @@ -3127,7 +3214,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-bridge.mcast-snooping-enable"></a>mcast-snooping-enable</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-bridge.mcast-snooping-enable"></a>ovs-bridge.mcast-snooping-enable</code></span></p></td> <td> <p>Enable or disable multicast snooping.</p> <p> @@ -3135,7 +3222,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-bridge.rstp-enable"></a>rstp-enable</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-bridge.rstp-enable"></a>ovs-bridge.rstp-enable</code></span></p></td> <td> <p>Enable or disable RSTP.</p> <p> @@ -3143,7 +3230,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-bridge.stp-enable"></a>stp-enable</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-bridge.stp-enable"></a>ovs-bridge.stp-enable</code></span></p></td> <td> <p>Enable or disable STP.</p> <p> @@ -3167,7 +3254,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-dpdk.devargs"></a>devargs</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-dpdk.devargs"></a>ovs-dpdk.devargs</code></span></p></td> <td> <p>Open vSwitch DPDK device arguments.</p> <p> @@ -3175,7 +3262,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-dpdk.n-rxq"></a>n-rxq</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-dpdk.n-rxq"></a>ovs-dpdk.n-rxq</code></span></p></td> <td> <p>Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.</p> <p> @@ -3183,7 +3270,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-dpdk.n-rxq-desc"></a>n-rxq-desc</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-dpdk.n-rxq-desc"></a>ovs-dpdk.n-rxq-desc</code></span></p></td> <td> <p>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.</p> <p> @@ -3191,7 +3278,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-dpdk.n-txq-desc"></a>n-txq-desc</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-dpdk.n-txq-desc"></a>ovs-dpdk.n-txq-desc</code></span></p></td> <td> <p>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.</p> <p> @@ -3215,7 +3302,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-interface.ofport-request"></a>ofport-request</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-interface.ofport-request"></a>ovs-interface.ofport-request</code></span></p></td> <td> <p>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.</p> <p> @@ -3223,7 +3310,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-interface.type"></a>type</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-interface.type"></a>ovs-interface.type</code></span></p></td> <td> <p>The interface type. Either "internal", "system", "patch", "dpdk", or empty.</p> <p> @@ -3246,7 +3333,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <col> </colgroup> <tbody><tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-patch.peer"></a>peer</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-patch.peer"></a>ovs-patch.peer</code></span></p></td> <td> <p>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.</p> <p> @@ -3269,7 +3356,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-port.bond-downdelay"></a>bond-downdelay</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-port.bond-downdelay"></a>ovs-port.bond-downdelay</code></span></p></td> <td> <p>The time port must be inactive in order to be considered down.</p> <p> @@ -3277,7 +3364,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-port.bond-mode"></a>bond-mode</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-port.bond-mode"></a>ovs-port.bond-mode</code></span></p></td> <td> <p>Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</p> <p> @@ -3285,7 +3372,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-port.bond-updelay"></a>bond-updelay</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-port.bond-updelay"></a>ovs-port.bond-updelay</code></span></p></td> <td> <p>The time port must be active before it starts forwarding traffic.</p> <p> @@ -3293,7 +3380,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-port.lacp"></a>lacp</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-port.lacp"></a>ovs-port.lacp</code></span></p></td> <td> <p>LACP mode. One of "active", "off", or "passive".</p> <p> @@ -3301,7 +3388,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-port.tag"></a>tag</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-port.tag"></a>ovs-port.tag</code></span></p></td> <td> <p>The VLAN tag in the range 0-4095.</p> <p> @@ -3309,7 +3396,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-port.trunks"></a>trunks</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-port.trunks"></a>ovs-port.trunks</code></span></p></td> <td> <p>A list of VLAN ranges that this port trunks.</p> <p>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.</p> @@ -3318,7 +3405,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-port.vlan-mode"></a>vlan-mode</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ovs-port.vlan-mode"></a>ovs-port.vlan-mode</code></span></p></td> <td> <p>The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.</p> <p> @@ -3342,7 +3429,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.baud"></a>baud</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.baud"></a>ppp.baud</code></span></p></td> <td> <p>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.</p> <p> @@ -3350,7 +3437,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.crtscts"></a>crtscts</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.crtscts"></a>ppp.crtscts</code></span></p></td> <td> <p>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.</p> <p> @@ -3358,7 +3445,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.lcp-echo-failure"></a>lcp-echo-failure</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.lcp-echo-failure"></a>ppp.lcp-echo-failure</code></span></p></td> <td> <p>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.</p> <p> @@ -3366,7 +3453,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.lcp-echo-interval"></a>lcp-echo-interval</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.lcp-echo-interval"></a>ppp.lcp-echo-interval</code></span></p></td> <td> <p>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.</p> <p> @@ -3374,7 +3461,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.mppe-stateful"></a>mppe-stateful</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.mppe-stateful"></a>ppp.mppe-stateful</code></span></p></td> <td> <p>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</p> <p> @@ -3382,7 +3469,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.mru"></a>mru</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.mru"></a>ppp.mru</code></span></p></td> <td> <p>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.</p> <p> @@ -3390,7 +3477,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.mtu"></a>mtu</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.mtu"></a>ppp.mtu</code></span></p></td> <td> <p>If non-zero, instruct pppd to send packets no larger than the specified size.</p> <p> @@ -3398,7 +3485,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.no-vj-comp"></a>no-vj-comp</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.no-vj-comp"></a>ppp.no-vj-comp</code></span></p></td> <td> <p>If TRUE, Van Jacobsen TCP header compression will not be requested.</p> <p> @@ -3406,7 +3493,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.noauth"></a>noauth</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.noauth"></a>ppp.noauth</code></span></p></td> <td> <p>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.</p> <p> @@ -3414,7 +3501,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.nobsdcomp"></a>nobsdcomp</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.nobsdcomp"></a>ppp.nobsdcomp</code></span></p></td> <td> <p>If TRUE, BSD compression will not be requested.</p> <p> @@ -3422,7 +3509,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.nodeflate"></a>nodeflate</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.nodeflate"></a>ppp.nodeflate</code></span></p></td> <td> <p>If TRUE, "deflate" compression will not be requested.</p> <p> @@ -3430,7 +3517,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.refuse-chap"></a>refuse-chap</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.refuse-chap"></a>ppp.refuse-chap</code></span></p></td> <td> <p>If TRUE, the CHAP authentication method will not be used.</p> <p> @@ -3438,7 +3525,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.refuse-eap"></a>refuse-eap</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.refuse-eap"></a>ppp.refuse-eap</code></span></p></td> <td> <p>If TRUE, the EAP authentication method will not be used.</p> <p> @@ -3446,7 +3533,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.refuse-mschap"></a>refuse-mschap</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.refuse-mschap"></a>ppp.refuse-mschap</code></span></p></td> <td> <p>If TRUE, the MSCHAP authentication method will not be used.</p> <p> @@ -3454,7 +3541,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.refuse-mschapv2"></a>refuse-mschapv2</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.refuse-mschapv2"></a>ppp.refuse-mschapv2</code></span></p></td> <td> <p>If TRUE, the MSCHAPv2 authentication method will not be used.</p> <p> @@ -3462,7 +3549,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.refuse-pap"></a>refuse-pap</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.refuse-pap"></a>ppp.refuse-pap</code></span></p></td> <td> <p>If TRUE, the PAP authentication method will not be used.</p> <p> @@ -3470,7 +3557,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.require-mppe"></a>require-mppe</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.require-mppe"></a>ppp.require-mppe</code></span></p></td> <td> <p>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.</p> <p> @@ -3478,7 +3565,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.require-mppe-128"></a>require-mppe-128</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ppp.require-mppe-128"></a>ppp.require-mppe-128</code></span></p></td> <td> <p>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.</p> <p> @@ -3502,7 +3589,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.pppoe.parent"></a>parent</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.pppoe.parent"></a>pppoe.parent</code></span></p></td> <td> <p> Alias: parent</p> @@ -3512,7 +3599,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.pppoe.password"></a>password</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.pppoe.password"></a>pppoe.password</code></span></p></td> <td> <p> Alias: password</p> @@ -3522,15 +3609,18 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.pppoe.password-flags"></a>password-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.pppoe.password-flags"></a>pppoe.password-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "password" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.pppoe.service"></a>service</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.pppoe.service"></a>pppoe.service</code></span></p></td> <td> <p> Alias: service</p> @@ -3540,7 +3630,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.pppoe.username"></a>username</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.pppoe.username"></a>pppoe.username</code></span></p></td> <td> <p> Alias: username</p> @@ -3566,7 +3656,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.proxy.browser-only"></a>browser-only</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.proxy.browser-only"></a>proxy.browser-only</code></span></p></td> <td> <p> Alias: browser-only</p> @@ -3576,7 +3666,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.proxy.method"></a>method</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.proxy.method"></a>proxy.method</code></span></p></td> <td> <p> Alias: method</p> @@ -3586,17 +3676,17 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.proxy.pac-script"></a>pac-script</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.proxy.pac-script"></a>proxy.pac-script</code></span></p></td> <td> <p> Alias: pac-script</p> -<p>PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.</p> +<p>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.</p> <p> Format: string</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.proxy.pac-url"></a>pac-url</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.proxy.pac-url"></a>proxy.pac-url</code></span></p></td> <td> <p> Alias: pac-url</p> @@ -3622,7 +3712,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.serial.baud"></a>baud</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.serial.baud"></a>serial.baud</code></span></p></td> <td> <p>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.</p> <p> @@ -3630,7 +3720,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.serial.bits"></a>bits</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.serial.bits"></a>serial.bits</code></span></p></td> <td> <p>Byte-width of the serial communication. The 8 in "8n1" for example.</p> <p> @@ -3638,7 +3728,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.serial.parity"></a>parity</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.serial.parity"></a>serial.parity</code></span></p></td> <td> <p>Parity setting of the serial port.</p> <p> @@ -3646,7 +3736,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.serial.send-delay"></a>send-delay</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.serial.send-delay"></a>serial.send-delay</code></span></p></td> <td> <p>Time to delay between each byte sent to the modem, in microseconds.</p> <p> @@ -3654,7 +3744,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.serial.stopbits"></a>stopbits</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.serial.stopbits"></a>serial.stopbits</code></span></p></td> <td> <p>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</p> <p> @@ -3678,7 +3768,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.sriov.autoprobe-drivers"></a>autoprobe-drivers</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.sriov.autoprobe-drivers"></a>sriov.autoprobe-drivers</code></span></p></td> <td> <p>Whether to autoprobe virtual functions by a compatible driver.</p> <p>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.</p> @@ -3689,7 +3779,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.sriov.total-vfs"></a>total-vfs</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.sriov.total-vfs"></a>sriov.total-vfs</code></span></p></td> <td> <p>The total number of virtual functions to create.</p> <p>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.</p> @@ -3698,7 +3788,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.sriov.vfs"></a>vfs</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.sriov.vfs"></a>sriov.vfs</code></span></p></td> <td> <p>Array of virtual function descriptors.</p> <p>Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF.</p> @@ -3731,7 +3821,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tc.qdiscs"></a>qdiscs</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tc.qdiscs"></a>tc.qdiscs</code></span></p></td> <td> <p> Array of TC queueing disciplines. qdisc is a basic block in the @@ -3990,7 +4080,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tc.tfilters"></a>tfilters</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tc.tfilters"></a>tc.tfilters</code></span></p></td> <td> <p> Array of TC traffic filters. Traffic control can manage the packet content during @@ -4108,7 +4198,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.config"></a>config</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.config"></a>team.config</code></span></p></td> <td> <p> Alias: config</p> @@ -4118,7 +4208,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.link-watchers"></a>link-watchers</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.link-watchers"></a>team.link-watchers</code></span></p></td> <td> <p>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.</p> <p> @@ -4126,7 +4216,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.mcast-rejoin-count"></a>mcast-rejoin-count</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.mcast-rejoin-count"></a>team.mcast-rejoin-count</code></span></p></td> <td> <p>Corresponds to the teamd mcast_rejoin.count.</p> <p> @@ -4134,7 +4224,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.mcast-rejoin-interval"></a>mcast-rejoin-interval</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.mcast-rejoin-interval"></a>team.mcast-rejoin-interval</code></span></p></td> <td> <p>Corresponds to the teamd mcast_rejoin.interval.</p> <p> @@ -4142,7 +4232,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.notify-peers-count"></a>notify-peers-count</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.notify-peers-count"></a>team.notify-peers-count</code></span></p></td> <td> <p>Corresponds to the teamd notify_peers.count.</p> <p> @@ -4150,7 +4240,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.notify-peers-interval"></a>notify-peers-interval</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.notify-peers-interval"></a>team.notify-peers-interval</code></span></p></td> <td> <p>Corresponds to the teamd notify_peers.interval.</p> <p> @@ -4158,7 +4248,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner"></a>runner</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner"></a>team.runner</code></span></p></td> <td> <p>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</p> <p> @@ -4166,7 +4256,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-active"></a>runner-active</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-active"></a>team.runner-active</code></span></p></td> <td> <p>Corresponds to the teamd runner.active.</p> <p> @@ -4174,7 +4264,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-agg-select-policy"></a>runner-agg-select-policy</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-agg-select-policy"></a>team.runner-agg-select-policy</code></span></p></td> <td> <p>Corresponds to the teamd runner.agg_select_policy.</p> <p> @@ -4182,7 +4272,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-fast-rate"></a>runner-fast-rate</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-fast-rate"></a>team.runner-fast-rate</code></span></p></td> <td> <p>Corresponds to the teamd runner.fast_rate.</p> <p> @@ -4190,7 +4280,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-hwaddr-policy"></a>runner-hwaddr-policy</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-hwaddr-policy"></a>team.runner-hwaddr-policy</code></span></p></td> <td> <p>Corresponds to the teamd runner.hwaddr_policy.</p> <p> @@ -4198,7 +4288,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-min-ports"></a>runner-min-ports</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-min-ports"></a>team.runner-min-ports</code></span></p></td> <td> <p>Corresponds to the teamd runner.min_ports.</p> <p> @@ -4206,7 +4296,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-sys-prio"></a>runner-sys-prio</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-sys-prio"></a>team.runner-sys-prio</code></span></p></td> <td> <p>Corresponds to the teamd runner.sys_prio.</p> <p> @@ -4214,7 +4304,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-tx-balancer"></a>runner-tx-balancer</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-tx-balancer"></a>team.runner-tx-balancer</code></span></p></td> <td> <p>Corresponds to the teamd runner.tx_balancer.name.</p> <p> @@ -4222,7 +4312,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-tx-balancer-interval"></a>runner-tx-balancer-interval</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-tx-balancer-interval"></a>team.runner-tx-balancer-interval</code></span></p></td> <td> <p>Corresponds to the teamd runner.tx_balancer.interval.</p> <p> @@ -4230,7 +4320,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-tx-hash"></a>runner-tx-hash</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team.runner-tx-hash"></a>team.runner-tx-hash</code></span></p></td> <td> <p>Corresponds to the teamd runner.tx_hash.</p> <p> @@ -4254,7 +4344,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team-port.config"></a>config</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team-port.config"></a>team-port.config</code></span></p></td> <td> <p> Alias: config</p> @@ -4264,7 +4354,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team-port.lacp-key"></a>lacp-key</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team-port.lacp-key"></a>team-port.lacp-key</code></span></p></td> <td> <p>Corresponds to the teamd ports.PORTIFNAME.lacp_key.</p> <p> @@ -4272,7 +4362,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team-port.lacp-prio"></a>lacp-prio</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team-port.lacp-prio"></a>team-port.lacp-prio</code></span></p></td> <td> <p>Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</p> <p> @@ -4280,7 +4370,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team-port.link-watchers"></a>link-watchers</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team-port.link-watchers"></a>team-port.link-watchers</code></span></p></td> <td> <p>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.</p> <p> @@ -4288,7 +4378,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team-port.prio"></a>prio</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team-port.prio"></a>team-port.prio</code></span></p></td> <td> <p>Corresponds to the teamd ports.PORTIFNAME.prio.</p> <p> @@ -4296,7 +4386,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team-port.queue-id"></a>queue-id</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team-port.queue-id"></a>team-port.queue-id</code></span></p></td> <td> <p>Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</p> <p> @@ -4304,7 +4394,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team-port.sticky"></a>sticky</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.team-port.sticky"></a>team-port.sticky</code></span></p></td> <td> <p>Corresponds to the teamd ports.PORTIFNAME.sticky.</p> <p> @@ -4328,7 +4418,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tun.group"></a>group</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tun.group"></a>tun.group</code></span></p></td> <td> <p> Alias: group</p> @@ -4338,7 +4428,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tun.mode"></a>mode</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tun.mode"></a>tun.mode</code></span></p></td> <td> <p> Alias: mode</p> @@ -4348,7 +4438,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tun.multi-queue"></a>multi-queue</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tun.multi-queue"></a>tun.multi-queue</code></span></p></td> <td> <p> Alias: multi-queue</p> @@ -4358,7 +4448,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tun.owner"></a>owner</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tun.owner"></a>tun.owner</code></span></p></td> <td> <p> Alias: owner</p> @@ -4368,7 +4458,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tun.pi"></a>pi</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tun.pi"></a>tun.pi</code></span></p></td> <td> <p> Alias: pi</p> @@ -4378,7 +4468,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tun.vnet-hdr"></a>vnet-hdr</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tun.vnet-hdr"></a>tun.vnet-hdr</code></span></p></td> <td> <p> Alias: vnet-hdr</p> @@ -4404,7 +4494,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vlan.egress-priority-map"></a>egress-priority-map</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vlan.egress-priority-map"></a>vlan.egress-priority-map</code></span></p></td> <td> <p> Alias: egress</p> @@ -4414,7 +4504,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vlan.flags"></a>flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vlan.flags"></a>vlan.flags</code></span></p></td> <td> <p> Alias: flags</p> @@ -4425,7 +4515,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vlan.id"></a>id</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vlan.id"></a>vlan.id</code></span></p></td> <td> <p> Alias: id</p> @@ -4435,7 +4525,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vlan.ingress-priority-map"></a>ingress-priority-map</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vlan.ingress-priority-map"></a>vlan.ingress-priority-map</code></span></p></td> <td> <p> Alias: ingress</p> @@ -4445,7 +4535,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vlan.parent"></a>parent</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vlan.parent"></a>vlan.parent</code></span></p></td> <td> <p> Alias: dev</p> @@ -4455,7 +4545,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vlan.protocol"></a>protocol</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vlan.protocol"></a>vlan.protocol</code></span></p></td> <td> <p>Specifies the VLAN protocol to use for encapsulation.</p> <p>Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</p> @@ -4480,7 +4570,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vpn.data"></a>data</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vpn.data"></a>vpn.data</code></span></p></td> <td> <p>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</p> <p> @@ -4488,7 +4578,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vpn.persistent"></a>persistent</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vpn.persistent"></a>vpn.persistent</code></span></p></td> <td> <p>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.</p> <p> @@ -4496,7 +4586,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vpn.secrets"></a>secrets</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vpn.secrets"></a>vpn.secrets</code></span></p></td> <td> <p>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</p> <p> @@ -4504,7 +4594,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vpn.service-type"></a>service-type</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vpn.service-type"></a>vpn.service-type</code></span></p></td> <td> <p> Alias: vpn-type</p> @@ -4514,7 +4604,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vpn.timeout"></a>timeout</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vpn.timeout"></a>vpn.timeout</code></span></p></td> <td> <p>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.</p> <p> @@ -4522,7 +4612,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vpn.user-name"></a>user-name</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vpn.user-name"></a>vpn.user-name</code></span></p></td> <td> <p> Alias: user</p> @@ -4547,7 +4637,7 @@ Linux traffic control subsystem <col> </colgroup> <tbody><tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vrf.table"></a>table</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vrf.table"></a>vrf.table</code></span></p></td> <td> <p> Alias: table</p> @@ -4572,7 +4662,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.ageing"></a>ageing</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.ageing"></a>vxlan.ageing</code></span></p></td> <td> <p>Specifies the lifetime in seconds of FDB entries learnt by the kernel.</p> <p> @@ -4580,7 +4670,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.destination-port"></a>destination-port</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.destination-port"></a>vxlan.destination-port</code></span></p></td> <td> <p> Alias: destination-port</p> @@ -4590,7 +4680,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.id"></a>id</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.id"></a>vxlan.id</code></span></p></td> <td> <p> Alias: id</p> @@ -4600,7 +4690,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.l2-miss"></a>l2-miss</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.l2-miss"></a>vxlan.l2-miss</code></span></p></td> <td> <p>Specifies whether netlink LL ADDR miss notifications are generated.</p> <p> @@ -4608,7 +4698,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.l3-miss"></a>l3-miss</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.l3-miss"></a>vxlan.l3-miss</code></span></p></td> <td> <p>Specifies whether netlink IP ADDR miss notifications are generated.</p> <p> @@ -4616,7 +4706,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.learning"></a>learning</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.learning"></a>vxlan.learning</code></span></p></td> <td> <p>Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</p> <p> @@ -4624,7 +4714,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.limit"></a>limit</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.limit"></a>vxlan.limit</code></span></p></td> <td> <p>Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</p> <p> @@ -4632,7 +4722,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.local"></a>local</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.local"></a>vxlan.local</code></span></p></td> <td> <p> Alias: local</p> @@ -4642,7 +4732,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.parent"></a>parent</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.parent"></a>vxlan.parent</code></span></p></td> <td> <p> Alias: dev</p> @@ -4652,7 +4742,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.proxy"></a>proxy</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.proxy"></a>vxlan.proxy</code></span></p></td> <td> <p>Specifies whether ARP proxy is turned on.</p> <p> @@ -4660,7 +4750,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.remote"></a>remote</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.remote"></a>vxlan.remote</code></span></p></td> <td> <p> Alias: remote</p> @@ -4670,7 +4760,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.rsc"></a>rsc</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.rsc"></a>vxlan.rsc</code></span></p></td> <td> <p>Specifies whether route short circuit is turned on.</p> <p> @@ -4678,7 +4768,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.source-port-max"></a>source-port-max</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.source-port-max"></a>vxlan.source-port-max</code></span></p></td> <td> <p> Alias: source-port-max</p> @@ -4688,7 +4778,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.source-port-min"></a>source-port-min</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.source-port-min"></a>vxlan.source-port-min</code></span></p></td> <td> <p> Alias: source-port-min</p> @@ -4698,7 +4788,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.tos"></a>tos</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.tos"></a>vxlan.tos</code></span></p></td> <td> <p>Specifies the TOS value to use in outgoing packets.</p> <p> @@ -4706,7 +4796,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.ttl"></a>ttl</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.vxlan.ttl"></a>vxlan.ttl</code></span></p></td> <td> <p>Specifies the time-to-live value to use in outgoing packets.</p> <p> @@ -4730,7 +4820,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wifi-p2p.peer"></a>peer</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wifi-p2p.peer"></a>wifi-p2p.peer</code></span></p></td> <td> <p> Alias: peer</p> @@ -4740,7 +4830,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wifi-p2p.wfd-ies"></a>wfd-ies</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wifi-p2p.wfd-ies"></a>wifi-p2p.wfd-ies</code></span></p></td> <td> <p>The Wi-Fi Display (WFD) Information Elements (IEs) to set.</p> <p>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.</p> @@ -4749,7 +4839,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wifi-p2p.wps-method"></a>wps-method</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wifi-p2p.wps-method"></a>wifi-p2p.wps-method</code></span></p></td> <td> <p>Flags indicating which mode of WPS is to be used.</p> <p>There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.</p> @@ -4774,7 +4864,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wimax.mac-address"></a>mac-address</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wimax.mac-address"></a>wimax.mac-address</code></span></p></td> <td> <p> Alias: mac</p> @@ -4787,7 +4877,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wimax.network-name"></a>network-name</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wimax.network-name"></a>wimax.network-name</code></span></p></td> <td> <p> Alias: nsp</p> @@ -4818,7 +4908,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.accept-all-mac-addresses"></a>accept-all-mac-addresses</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.accept-all-mac-addresses"></a>802-3-ethernet.accept-all-mac-addresses</code></span></p></td> <td> <p>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.</p> <p> @@ -4826,7 +4916,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.auto-negotiate"></a>auto-negotiate</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.auto-negotiate"></a>802-3-ethernet.auto-negotiate</code></span></p></td> <td> <p>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.</p> <p> @@ -4834,7 +4924,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.cloned-mac-address"></a>cloned-mac-address</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.cloned-mac-address"></a>802-3-ethernet.cloned-mac-address</code></span></p></td> <td> <p> Alias: cloned-mac</p> @@ -4847,7 +4937,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.duplex"></a>duplex</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.duplex"></a>802-3-ethernet.duplex</code></span></p></td> <td> <p>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.</p> <p> @@ -4855,7 +4945,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.generate-mac-address-mask"></a>generate-mac-address-mask</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.generate-mac-address-mask"></a>802-3-ethernet.generate-mac-address-mask</code></span></p></td> <td> <p>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.</p> <p>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.</p> @@ -4867,7 +4957,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.mac-address"></a>mac-address</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.mac-address"></a>802-3-ethernet.mac-address</code></span></p></td> <td> <p> Alias: mac</p> @@ -4877,7 +4967,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.mac-address-blacklist"></a>mac-address-blacklist</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.mac-address-blacklist"></a>802-3-ethernet.mac-address-blacklist</code></span></p></td> <td> <p>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).</p> <p> @@ -4885,7 +4975,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.mtu"></a>mtu</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.mtu"></a>802-3-ethernet.mtu</code></span></p></td> <td> <p> Alias: mtu</p> @@ -4895,7 +4985,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.port"></a>port</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.port"></a>802-3-ethernet.port</code></span></p></td> <td> <p>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.</p> <p> @@ -4903,7 +4993,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.s390-nettype"></a>s390-nettype</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.s390-nettype"></a>802-3-ethernet.s390-nettype</code></span></p></td> <td> <p>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</p> <p> @@ -4911,7 +5001,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.s390-options"></a>s390-options</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.s390-options"></a>802-3-ethernet.s390-options</code></span></p></td> <td> <p>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]).</p> <p>Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.</p> @@ -4920,7 +5010,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.s390-subchannels"></a>s390-subchannels</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.s390-subchannels"></a>802-3-ethernet.s390-subchannels</code></span></p></td> <td> <p>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.</p> <p> @@ -4928,7 +5018,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.speed"></a>speed</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.speed"></a>802-3-ethernet.speed</code></span></p></td> <td> <p>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.</p> <p> @@ -4936,7 +5026,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan"></a>wake-on-lan</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan"></a>802-3-ethernet.wake-on-lan</code></span></p></td> <td> <p>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).</p> <p> @@ -4944,7 +5034,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan-password"></a>wake-on-lan-password</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan-password"></a>802-3-ethernet.wake-on-lan-password</code></span></p></td> <td> <p>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.</p> <p> @@ -4968,7 +5058,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.fwmark"></a>fwmark</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.fwmark"></a>wireguard.fwmark</code></span></p></td> <td> <p>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.</p> <p>Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.</p> @@ -4977,7 +5067,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.ip4-auto-default-route"></a>ip4-auto-default-route</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.ip4-auto-default-route"></a>wireguard.ip4-auto-default-route</code></span></p></td> <td> <p>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".</p> <p>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.</p> @@ -4987,7 +5077,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.ip6-auto-default-route"></a>ip6-auto-default-route</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.ip6-auto-default-route"></a>wireguard.ip6-auto-default-route</code></span></p></td> <td> <p>Like ip4-auto-default-route, but for the IPv6 default route.</p> <p> @@ -4995,7 +5085,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.listen-port"></a>listen-port</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.listen-port"></a>wireguard.listen-port</code></span></p></td> <td> <p>The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</p> <p> @@ -5003,7 +5093,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.mtu"></a>mtu</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.mtu"></a>wireguard.mtu</code></span></p></td> <td> <p>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</p> <p>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.</p> @@ -5012,7 +5102,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.peer-routes"></a>peer-routes</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.peer-routes"></a>wireguard.peer-routes</code></span></p></td> <td> <p>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.</p> <p>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.</p> @@ -5021,7 +5111,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.private-key"></a>private-key</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.private-key"></a>wireguard.private-key</code></span></p></td> <td> <p>The 256 bit private-key in base64 encoding.</p> <p> @@ -5029,10 +5119,13 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.private-key-flags"></a>private-key-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wireguard.private-key-flags"></a>wireguard.private-key-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "private-key" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> @@ -5055,7 +5148,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.ap-isolation"></a>ap-isolation</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.ap-isolation"></a>802-11-wireless.ap-isolation</code></span></p></td> <td> <p>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.</p> <p>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.</p> @@ -5066,7 +5159,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.band"></a>band</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.band"></a>802-11-wireless.band</code></span></p></td> <td> <p>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.</p> <p> @@ -5074,7 +5167,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.bssid"></a>bssid</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.bssid"></a>802-11-wireless.bssid</code></span></p></td> <td> <p>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.</p> <p>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.</p> @@ -5083,7 +5176,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.channel"></a>channel</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.channel"></a>802-11-wireless.channel</code></span></p></td> <td> <p>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.</p> <p> @@ -5091,7 +5184,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.cloned-mac-address"></a>cloned-mac-address</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.cloned-mac-address"></a>802-11-wireless.cloned-mac-address</code></span></p></td> <td> <p> Alias: cloned-mac</p> @@ -5104,7 +5197,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.generate-mac-address-mask"></a>generate-mac-address-mask</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.generate-mac-address-mask"></a>802-11-wireless.generate-mac-address-mask</code></span></p></td> <td> <p>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.</p> <p>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.</p> @@ -5116,7 +5209,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.hidden"></a>hidden</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.hidden"></a>802-11-wireless.hidden</code></span></p></td> <td> <p>If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.</p> <p>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.</p> @@ -5127,7 +5220,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.mac-address"></a>mac-address</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.mac-address"></a>802-11-wireless.mac-address</code></span></p></td> <td> <p> Alias: mac</p> @@ -5137,7 +5230,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.mac-address-blacklist"></a>mac-address-blacklist</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.mac-address-blacklist"></a>802-11-wireless.mac-address-blacklist</code></span></p></td> <td> <p>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").</p> <p> @@ -5145,7 +5238,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.mac-address-randomization"></a>mac-address-randomization</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.mac-address-randomization"></a>802-11-wireless.mac-address-randomization</code></span></p></td> <td> <p>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).</p> <p> @@ -5156,7 +5249,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.mode"></a>mode</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.mode"></a>802-11-wireless.mode</code></span></p></td> <td> <p> Alias: mode</p> @@ -5166,7 +5259,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.mtu"></a>mtu</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.mtu"></a>802-11-wireless.mtu</code></span></p></td> <td> <p> Alias: mtu</p> @@ -5176,7 +5269,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.powersave"></a>powersave</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.powersave"></a>802-11-wireless.powersave</code></span></p></td> <td> <p>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.</p> <p> @@ -5184,23 +5277,16 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.rate"></a>rate</code></span></p></td> -<td> -<p>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.</p> -<p> - Format: uint32</p> -</td> -</tr> -<tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.seen-bssids"></a>seen-bssids</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.seen-bssids"></a>802-11-wireless.seen-bssids</code></span></p></td> <td> <p>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.</p> +<p>This is not a regular property that the user would configure. Instead, NetworkManager automatically sets the seen BSSIDs and tracks them internally in "/var/lib/NetworkManager/seen-bssids" file.</p> <p> Format: array of string</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.ssid"></a>ssid</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.ssid"></a>802-11-wireless.ssid</code></span></p></td> <td> <p> Alias: ssid</p> @@ -5210,15 +5296,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.tx-power"></a>tx-power</code></span></p></td> -<td> -<p>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.</p> -<p> - Format: uint32</p> -</td> -</tr> -<tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.wake-on-wlan"></a>wake-on-wlan</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.wake-on-wlan"></a>802-11-wireless.wake-on-wlan</code></span></p></td> <td> <p>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).</p> <p> @@ -5244,7 +5322,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.auth-alg"></a>auth-alg</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.auth-alg"></a>802-11-wireless-security.auth-alg</code></span></p></td> <td> <p>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.</p> <p> @@ -5252,7 +5330,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.fils"></a>fils</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.fils"></a>802-11-wireless-security.fils</code></span></p></td> <td> <p>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.</p> <p> @@ -5260,7 +5338,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.group"></a>group</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.group"></a>802-11-wireless-security.group</code></span></p></td> <td> <p>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".</p> <p> @@ -5268,7 +5346,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.key-mgmt"></a>key-mgmt</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.key-mgmt"></a>802-11-wireless-security.key-mgmt</code></span></p></td> <td> <p>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).</p> <p>This property must be set for any Wi-Fi connection that uses security.</p> @@ -5277,7 +5355,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.leap-password"></a>leap-password</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.leap-password"></a>802-11-wireless-security.leap-password</code></span></p></td> <td> <p>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</p> <p> @@ -5285,15 +5363,18 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.leap-password-flags"></a>leap-password-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.leap-password-flags"></a>802-11-wireless-security.leap-password-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "leap-password" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.leap-username"></a>leap-username</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.leap-username"></a>802-11-wireless-security.leap-username</code></span></p></td> <td> <p>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</p> <p> @@ -5301,7 +5382,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.pairwise"></a>pairwise</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.pairwise"></a>802-11-wireless-security.pairwise</code></span></p></td> <td> <p>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".</p> <p> @@ -5309,7 +5390,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.pmf"></a>pmf</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.pmf"></a>802-11-wireless-security.pmf</code></span></p></td> <td> <p>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.</p> <p> @@ -5317,7 +5398,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.proto"></a>proto</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.proto"></a>802-11-wireless-security.proto</code></span></p></td> <td> <p>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.</p> <p> @@ -5325,7 +5406,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.psk"></a>psk</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.psk"></a>802-11-wireless-security.psk</code></span></p></td> <td> <p>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.</p> <p> @@ -5333,23 +5414,29 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.psk-flags"></a>psk-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.psk-flags"></a>802-11-wireless-security.psk-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "psk" property.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-key-flags"></a>wep-key-flags</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-key-flags"></a>802-11-wireless-security.wep-key-flags</code></span></p></td> <td> <p>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</p> <p> + See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. + </p> +<p> Format: NMSettingSecretFlags (uint32)</p> </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-key-type"></a>wep-key-type</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-key-type"></a>802-11-wireless-security.wep-key-type</code></span></p></td> <td> <p>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.</p> <p> @@ -5357,7 +5444,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-key0"></a>wep-key0</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-key0"></a>802-11-wireless-security.wep-key0</code></span></p></td> <td> <p>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.</p> <p> @@ -5365,7 +5452,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-key1"></a>wep-key1</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-key1"></a>802-11-wireless-security.wep-key1</code></span></p></td> <td> <p>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.</p> <p> @@ -5373,7 +5460,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-key2"></a>wep-key2</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-key2"></a>802-11-wireless-security.wep-key2</code></span></p></td> <td> <p>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.</p> <p> @@ -5381,7 +5468,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-key3"></a>wep-key3</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-key3"></a>802-11-wireless-security.wep-key3</code></span></p></td> <td> <p>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.</p> <p> @@ -5389,7 +5476,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-tx-keyidx"></a>wep-tx-keyidx</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-tx-keyidx"></a>802-11-wireless-security.wep-tx-keyidx</code></span></p></td> <td> <p>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.</p> <p> @@ -5397,7 +5484,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wps-method"></a>wps-method</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wps-method"></a>802-11-wireless-security.wps-method</code></span></p></td> <td> <p>Flags indicating which mode of WPS is to be used if any.</p> <p>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.</p> @@ -5423,7 +5510,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wpan.channel"></a>channel</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wpan.channel"></a>wpan.channel</code></span></p></td> <td> <p> Alias: channel</p> @@ -5433,7 +5520,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wpan.mac-address"></a>mac-address</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wpan.mac-address"></a>wpan.mac-address</code></span></p></td> <td> <p> Alias: mac</p> @@ -5443,7 +5530,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wpan.page"></a>page</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wpan.page"></a>wpan.page</code></span></p></td> <td> <p> Alias: page</p> @@ -5453,7 +5540,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wpan.pan-id"></a>pan-id</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wpan.pan-id"></a>wpan.pan-id</code></span></p></td> <td> <p> Alias: pan-id</p> @@ -5463,7 +5550,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wpan.short-address"></a>short-address</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.wpan.short-address"></a>wpan.short-address</code></span></p></td> <td> <p> Alias: short-addr</p> @@ -5489,7 +5576,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bond-port.prio"></a>prio</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bond-port.prio"></a>bond-port.prio</code></span></p></td> <td> <p> Alias: prio</p> @@ -5499,7 +5586,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bond-port.queue-id"></a>queue-id</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bond-port.queue-id"></a>bond-port.queue-id</code></span></p></td> <td> <p> Alias: queue-id</p> @@ -5525,7 +5612,7 @@ Linux traffic control subsystem </colgroup> <tbody> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hostname.from-dhcp"></a>from-dhcp</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hostname.from-dhcp"></a>hostname.from-dhcp</code></span></p></td> <td> <p>Whether the system hostname can be determined from DHCP on this connection.</p> <p>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).</p> @@ -5534,7 +5621,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hostname.from-dns-lookup"></a>from-dns-lookup</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hostname.from-dns-lookup"></a>hostname.from-dns-lookup</code></span></p></td> <td> <p>Whether the system hostname can be determined from reverse DNS lookup of addresses on this device.</p> <p>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).</p> @@ -5543,7 +5630,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hostname.only-from-default"></a>only-from-default</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hostname.only-from-default"></a>hostname.only-from-default</code></span></p></td> <td> <p>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).</p> <p>If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route.</p> @@ -5553,7 +5640,7 @@ Linux traffic control subsystem </td> </tr> <tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hostname.priority"></a>priority</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hostname.priority"></a>hostname.priority</code></span></p></td> <td> <p>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.</p> <p>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.</p> @@ -5567,7 +5654,55 @@ Linux traffic control subsystem </div> <hr> <div class="refsect2"> -<a name="id-1.2.10.4.54"></a><h3>loopback setting</h3> +<a name="id-1.2.10.4.54"></a><h3>link setting</h3> +<p>Link settings.</p> +<p> + Properties: + </p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.link.gro-max-size"></a>link.gro-max-size</code></span></p></td> +<td> +<p>The maximum size of a packet built by the Generic Receive Offload stack for this device. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</p> +<p> + Format: int64</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.link.gso-max-segments"></a>link.gso-max-segments</code></span></p></td> +<td> +<p>The maximum segments of a Generic Segment Offload packet the device should accept. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</p> +<p> + Format: int64</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.link.gso-max-size"></a>link.gso-max-size</code></span></p></td> +<td> +<p>The maximum size of a Generic Segment Offload packet the device should accept. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</p> +<p> + Format: int64</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.link.tx-queue-length"></a>link.tx-queue-length</code></span></p></td> +<td> +<p>The size of the transmit queue for the device, in number of packets. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</p> +<p> + Format: int64</p> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="id-1.2.10.4.55"></a><h3>loopback setting</h3> <p>Loopback Link Settings.</p> <p> Properties: @@ -5578,7 +5713,7 @@ Linux traffic control subsystem <col> </colgroup> <tbody><tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.loopback.mtu"></a>mtu</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.loopback.mtu"></a>loopback.mtu</code></span></p></td> <td> <p> Alias: mtu</p> @@ -5591,7 +5726,7 @@ Linux traffic control subsystem </div> <hr> <div class="refsect2"> -<a name="id-1.2.10.4.55"></a><h3>veth setting</h3> +<a name="id-1.2.10.4.56"></a><h3>veth setting</h3> <p>Veth Settings.</p> <p> Properties: @@ -5602,7 +5737,7 @@ Linux traffic control subsystem <col> </colgroup> <tbody><tr> -<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.veth.peer"></a>peer</code></span></p></td> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.veth.peer"></a>veth.peer</code></span></p></td> <td> <p> Alias: peer</p> diff --git a/docs/api/html/ref-settings.html b/docs/api/html/ref-settings.html index f0cec0d7..1beceeb8 100644 --- a/docs/api/html/ref-settings.html +++ b/docs/api/html/ref-settings.html @@ -178,6 +178,9 @@ <span class="refentrytitle"><a href="settings-hostname.html">hostname</a></span><span class="refpurpose"> — Hostname settings</span> </dt> <dt> +<span class="refentrytitle"><a href="settings-link.html">link</a></span><span class="refpurpose"> — Link settings</span> +</dt> +<dt> <span class="refentrytitle"><a href="settings-loopback.html">loopback</a></span><span class="refpurpose"> — Loopback Link Settings</span> </dt> <dt> diff --git a/docs/api/html/settings-6lowpan.html b/docs/api/html/settings-6lowpan.html index 1d692e4d..0f6ffd16 100644 --- a/docs/api/html/settings-6lowpan.html +++ b/docs/api/html/settings-6lowpan.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.3.2.2.1"></a><p class="title"><b>Table 49. </b></p> +<a name="id-1.3.3.3.2.2.1"></a><p class="title"><b>Table 37. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -56,7 +56,7 @@ <td><pre class="screen">parent</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.</td> </tr></tbody> </table></div> </div> diff --git a/docs/api/html/settings-802-11-olpc-mesh.html b/docs/api/html/settings-802-11-olpc-mesh.html index 031ccb05..f67b9882 100644 --- a/docs/api/html/settings-802-11-olpc-mesh.html +++ b/docs/api/html/settings-802-11-olpc-mesh.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.23.2.2.1"></a><p class="title"><b>Table 69. </b></p> +<a name="id-1.3.3.23.2.2.1"></a><p class="title"><b>Table 57. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,19 +57,21 @@ <td><pre class="screen">channel</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>Channel on which the mesh network to join is located.</td> </tr> <tr> <td><pre class="screen">dhcp-anycast-address</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">ssid</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>SSID of the mesh network to join.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-802-11-wireless-security.html b/docs/api/html/settings-802-11-wireless-security.html index 83f4300e..c6eded77 100644 --- a/docs/api/html/settings-802-11-wireless-security.html +++ b/docs/api/html/settings-802-11-wireless-security.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.48.2.2.1"></a><p class="title"><b>Table 94. </b></p> +<a name="id-1.3.3.48.2.2.1"></a><p class="title"><b>Table 82. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,121 +57,127 @@ <td><pre class="screen">auth-alg</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">fils</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">group</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">key-mgmt</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">leap-password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</td> </tr> <tr> <td><pre class="screen">leap-password-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "leap-password" property.</td> </tr> <tr> <td><pre class="screen">leap-username</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</td> </tr> <tr> <td><pre class="screen">pairwise</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">pmf</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">proto</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">psk</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">psk-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "psk" property.</td> </tr> <tr> <td><pre class="screen">wep-key-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</td> </tr> <tr> <td><pre class="screen">wep-key-type</pre></td> <td><pre class="screen">NMWepKeyType (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">wep-key0</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">wep-key1</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">wep-key2</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">wep-key3</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">wep-tx-keyidx</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">wps-method</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-802-11-wireless.html b/docs/api/html/settings-802-11-wireless.html index 24700c54..3589a25c 100644 --- a/docs/api/html/settings-802-11-wireless.html +++ b/docs/api/html/settings-802-11-wireless.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.47.2.2.1"></a><p class="title"><b>Table 93. </b></p> +<a name="id-1.3.3.47.2.2.1"></a><p class="title"><b>Table 81. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,121 +57,145 @@ <td><pre class="screen">ap-isolation</pre></td> <td><pre class="screen">NMTernary (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">assigned-mac-address</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">band</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">bssid</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">channel</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">cloned-mac-address</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">generate-mac-address-mask</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">hidden</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">mac-address</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">mac-address-blacklist</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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").</td> </tr> <tr> <td><pre class="screen">mac-address-randomization</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">mode</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</td> </tr> <tr> <td><pre class="screen">mtu</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</td> </tr> <tr> <td><pre class="screen">powersave</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">rate</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>This property is not implemented and has no effect.</td> </tr> <tr> <td><pre class="screen">security</pre></td> <td><pre class="screen"></pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>This property is deprecated and has no effect. For backwards compatibility, it can be set to "802-11-wireless-security" if the profile has a wireless security setting.</td> </tr> <tr> <td><pre class="screen">seen-bssids</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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. + +This is not a regular property that the user would configure. Instead, NetworkManager automatically sets the seen BSSIDs and tracks them internally in "/var/lib/NetworkManager/seen-bssids" file.</td> </tr> <tr> <td><pre class="screen">ssid</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>SSID of the Wi-Fi network. Must be specified.</td> </tr> <tr> <td><pre class="screen">tx-power</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>This property is not implemented and has no effect.</td> </tr> <tr> <td><pre class="screen">wake-on-wlan</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">1</pre></td> -<td> </td> +<td>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).</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-802-1x.html b/docs/api/html/settings-802-1x.html index 4ad4158d..32c1d60e 100644 --- a/docs/api/html/settings-802-1x.html +++ b/docs/api/html/settings-802-1x.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.4.2.2.1"></a><p class="title"><b>Table 50. </b></p> +<a name="id-1.3.3.4.2.2.1"></a><p class="title"><b>Table 38. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,283 +57,305 @@ <td><pre class="screen">altsubject-matches</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">anonymous-identity</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</td> </tr> <tr> <td><pre class="screen">auth-timeout</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.</td> </tr> <tr> <td><pre class="screen">ca-cert</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">ca-cert-password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">ca-cert-password-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "ca-cert-password" property.</td> </tr> <tr> <td><pre class="screen">ca-path</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">client-cert</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">client-cert-password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">client-cert-password-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "client-cert-password" property.</td> </tr> <tr> <td><pre class="screen">domain-match</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">domain-suffix-match</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">eap</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">identity</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Identity string for EAP authentication methods. Often the user's user or login name.</td> </tr> <tr> <td><pre class="screen">optional</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">pac-file</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>UTF-8 encoded file path containing PAC for EAP-FAST.</td> </tr> <tr> <td><pre class="screen">password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</td> </tr> <tr> <td><pre class="screen">password-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "password" property.</td> </tr> <tr> <td><pre class="screen">password-raw</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">password-raw-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "password-raw" property.</td> </tr> <tr> <td><pre class="screen">phase1-auth-flags</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase1-fast-provisioning</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase1-peaplabel</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase1-peapver</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase2-altsubject-matches</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase2-auth</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase2-autheap</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase2-ca-cert</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase2-ca-cert-password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase2-ca-cert-password-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "phase2-ca-cert-password" property.</td> </tr> <tr> <td><pre class="screen">phase2-ca-path</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase2-client-cert</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase2-client-cert-password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase2-client-cert-password-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "phase2-client-cert-password" property.</td> </tr> <tr> <td><pre class="screen">phase2-domain-match</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase2-domain-suffix-match</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase2-private-key</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase2-private-key-password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">phase2-private-key-password-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "phase2-private-key-password" property.</td> </tr> <tr> <td><pre class="screen">phase2-subject-match</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">pin</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>PIN used for EAP authentication methods.</td> </tr> <tr> <td><pre class="screen">pin-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "pin" property.</td> </tr> <tr> <td><pre class="screen">private-key</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">private-key-password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">private-key-password-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "private-key-password" property.</td> </tr> <tr> <td><pre class="screen">subject-match</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">system-ca-certs</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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).</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-802-3-ethernet.html b/docs/api/html/settings-802-3-ethernet.html index b232048e..100e5f46 100644 --- a/docs/api/html/settings-802-3-ethernet.html +++ b/docs/api/html/settings-802-3-ethernet.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.45.2.2.1"></a><p class="title"><b>Table 91. </b></p> +<a name="id-1.3.3.45.2.2.1"></a><p class="title"><b>Table 79. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,97 +57,107 @@ <td><pre class="screen">accept-all-mac-addresses</pre></td> <td><pre class="screen">NMTernary (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">assigned-mac-address</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">auto-negotiate</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">cloned-mac-address</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">duplex</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">generate-mac-address-mask</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">mac-address</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">mac-address-blacklist</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">mtu</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</td> </tr> <tr> <td><pre class="screen">port</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">s390-nettype</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</td> </tr> <tr> <td><pre class="screen">s390-options</pre></td> <td><pre class="screen">dict of string to string</pre></td> <td><pre class="screen">{}</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">s390-subchannels</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">speed</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">wake-on-lan</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">1</pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">wake-on-lan-password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-adsl.html b/docs/api/html/settings-adsl.html index ab01cb14..e387739d 100644 --- a/docs/api/html/settings-adsl.html +++ b/docs/api/html/settings-adsl.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.5.2.2.1"></a><p class="title"><b>Table 51. </b></p> +<a name="id-1.3.3.5.2.2.1"></a><p class="title"><b>Table 39. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,43 +57,43 @@ <td><pre class="screen">encapsulation</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Encapsulation of ADSL connection. Can be "vcmux" or "llc".</td> </tr> <tr> <td><pre class="screen">password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Password used to authenticate with the ADSL service.</td> </tr> <tr> <td><pre class="screen">password-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "password" property.</td> </tr> <tr> <td><pre class="screen">protocol</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</td> </tr> <tr> <td><pre class="screen">username</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Username used to authenticate with the ADSL service.</td> </tr> <tr> <td><pre class="screen">vci</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>VCI of ADSL connection</td> </tr> <tr> <td><pre class="screen">vpi</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>VPI of ADSL connection</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-bluetooth.html b/docs/api/html/settings-bluetooth.html index cc035095..9c329bbc 100644 --- a/docs/api/html/settings-bluetooth.html +++ b/docs/api/html/settings-bluetooth.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.6.2.2.1"></a><p class="title"><b>Table 52. </b></p> +<a name="id-1.3.3.6.2.2.1"></a><p class="title"><b>Table 40. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,13 +57,13 @@ <td><pre class="screen">bdaddr</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The Bluetooth address of the device.</td> </tr> <tr> <td><pre class="screen">type</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-bond-port.html b/docs/api/html/settings-bond-port.html index 4cece6ef..9b2eb6e5 100644 --- a/docs/api/html/settings-bond-port.html +++ b/docs/api/html/settings-bond-port.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.50.2.2.1"></a><p class="title"><b>Table 96. </b></p> +<a name="id-1.3.3.50.2.2.1"></a><p class="title"><b>Table 84. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,13 +57,13 @@ <td><pre class="screen">prio</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>The port priority for bond active port re-selection during failover. A higher number means a higher priority in selection. The primary port has the highest priority. This option is only compatible with active-backup, balance-tlb and balance-alb modes.</td> </tr> <tr> <td><pre class="screen">queue-id</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-bond.html b/docs/api/html/settings-bond.html index 21d2ff0f..f76e24d1 100644 --- a/docs/api/html/settings-bond.html +++ b/docs/api/html/settings-bond.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.7.2.2.1"></a><p class="title"><b>Table 53. </b></p> +<a name="id-1.3.3.7.2.2.1"></a><p class="title"><b>Table 41. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,13 +57,13 @@ <td><pre class="screen">interface-name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.</td> </tr> <tr> <td><pre class="screen">options</pre></td> <td><pre class="screen">dict of string to string</pre></td> <td><pre class="screen">{'mode': 'balance-rr'}</pre></td> -<td> </td> +<td>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]).</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-bridge-port.html b/docs/api/html/settings-bridge-port.html index 05b27bc4..689f63ab 100644 --- a/docs/api/html/settings-bridge-port.html +++ b/docs/api/html/settings-bridge-port.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.9.2.2.1"></a><p class="title"><b>Table 55. </b></p> +<a name="id-1.3.3.9.2.2.1"></a><p class="title"><b>Table 43. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,25 +57,31 @@ <td><pre class="screen">hairpin-mode</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.</td> </tr> <tr> <td><pre class="screen">path-cost</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">100</pre></td> -<td> </td> +<td>The Spanning Tree Protocol (STP) port cost for destinations via this port.</td> </tr> <tr> <td><pre class="screen">priority</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">32</pre></td> -<td> </td> +<td>The Spanning Tree Protocol (STP) priority of this bridge port.</td> </tr> <tr> <td><pre class="screen">vlans</pre></td> <td><pre class="screen">array of vardict</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-bridge.html b/docs/api/html/settings-bridge.html index 27f4d555..745b81b3 100644 --- a/docs/api/html/settings-bridge.html +++ b/docs/api/html/settings-bridge.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.8.2.2.1"></a><p class="title"><b>Table 54. </b></p> +<a name="id-1.3.3.8.2.2.1"></a><p class="title"><b>Table 42. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,169 +57,183 @@ <td><pre class="screen">ageing-time</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">300</pre></td> -<td> </td> +<td>The Ethernet MAC address aging time, in seconds.</td> </tr> <tr> <td><pre class="screen">forward-delay</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">15</pre></td> -<td> </td> +<td>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</td> </tr> <tr> <td><pre class="screen">group-address</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">group-forward-mask</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">hello-time</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">2</pre></td> -<td> </td> +<td>The Spanning Tree Protocol (STP) hello time, in seconds.</td> </tr> <tr> <td><pre class="screen">interface-name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name.</td> </tr> <tr> <td><pre class="screen">mac-address</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">max-age</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">20</pre></td> -<td> </td> +<td>The Spanning Tree Protocol (STP) maximum message age, in seconds.</td> </tr> <tr> <td><pre class="screen">multicast-hash-max</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">4096</pre></td> -<td> </td> +<td>Set maximum size of multicast hash table (value must be a power of 2).</td> </tr> <tr> <td><pre class="screen">multicast-last-member-count</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">2</pre></td> -<td> </td> +<td>Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.</td> </tr> <tr> <td><pre class="screen">multicast-last-member-interval</pre></td> <td><pre class="screen">uint64</pre></td> <td><pre class="screen">100</pre></td> -<td> </td> +<td>Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.</td> </tr> <tr> <td><pre class="screen">multicast-membership-interval</pre></td> <td><pre class="screen">uint64</pre></td> <td><pre class="screen">26000</pre></td> -<td> </td> +<td>Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.</td> </tr> <tr> <td><pre class="screen">multicast-querier</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</td> </tr> <tr> <td><pre class="screen">multicast-querier-interval</pre></td> <td><pre class="screen">uint64</pre></td> <td><pre class="screen">25500</pre></td> -<td> </td> +<td>If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.</td> </tr> <tr> <td><pre class="screen">multicast-query-interval</pre></td> <td><pre class="screen">uint64</pre></td> <td><pre class="screen">12500</pre></td> -<td> </td> +<td>Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</td> </tr> <tr> <td><pre class="screen">multicast-query-response-interval</pre></td> <td><pre class="screen">uint64</pre></td> <td><pre class="screen">1000</pre></td> -<td> </td> +<td>Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</td> </tr> <tr> <td><pre class="screen">multicast-query-use-ifaddr</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">multicast-router</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">multicast-snooping</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">multicast-startup-query-count</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">2</pre></td> -<td> </td> +<td>Set the number of IGMP queries to send during startup phase.</td> </tr> <tr> <td><pre class="screen">multicast-startup-query-interval</pre></td> <td><pre class="screen">uint64</pre></td> <td><pre class="screen">3125</pre></td> -<td> </td> +<td>Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</td> </tr> <tr> <td><pre class="screen">priority</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">32768</pre></td> -<td> </td> +<td>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</td> </tr> <tr> <td><pre class="screen">stp</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</td> </tr> <tr> <td><pre class="screen">vlan-default-pvid</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">1</pre></td> -<td> </td> +<td>The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.</td> </tr> <tr> <td><pre class="screen">vlan-filtering</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Control whether VLAN filtering is enabled on the bridge.</td> </tr> <tr> <td><pre class="screen">vlan-protocol</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>If specified, the protocol used for VLAN filtering. + +Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</td> </tr> <tr> <td><pre class="screen">vlan-stats-enabled</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Controls whether per-VLAN stats accounting is enabled.</td> </tr> <tr> <td><pre class="screen">vlans</pre></td> <td><pre class="screen">array of vardict</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-cdma.html b/docs/api/html/settings-cdma.html index c579ce75..56fdf8c0 100644 --- a/docs/api/html/settings-cdma.html +++ b/docs/api/html/settings-cdma.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.10.2.2.1"></a><p class="title"><b>Table 56. </b></p> +<a name="id-1.3.3.10.2.2.1"></a><p class="title"><b>Table 44. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,31 +57,31 @@ <td><pre class="screen">mtu</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</td> </tr> <tr> <td><pre class="screen">number</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">password-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "password" property.</td> </tr> <tr> <td><pre class="screen">username</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-connection.html b/docs/api/html/settings-connection.html index 47eb2f12..cb7262c2 100644 --- a/docs/api/html/settings-connection.html +++ b/docs/api/html/settings-connection.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.2.2.2.1"></a><p class="title"><b>Table 48. </b></p> +<a name="id-1.3.3.2.2.2.1"></a><p class="title"><b>Table 36. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,169 +57,237 @@ <td><pre class="screen">auth-retries</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">autoconnect</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">autoconnect-priority</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">autoconnect-retries</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">autoconnect-slaves</pre></td> <td><pre class="screen">NMSettingConnectionAutoconnectSlaves (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dns-over-tls</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">gateway-ping-timeout</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</td> </tr> <tr> <td><pre class="screen">id</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</td> </tr> <tr> <td><pre class="screen">interface-name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">lldp</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>Whether LLDP is enabled for the connection.</td> </tr> <tr> <td><pre class="screen">llmnr</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">master</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Interface name of the master device or UUID of the master connection.</td> </tr> <tr> <td><pre class="screen">mdns</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">metered</pre></td> <td><pre class="screen">NMMetered (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Whether the connection is metered. + +When updating this property on a currently activated connection, the change takes effect immediately.</td> </tr> <tr> <td><pre class="screen">mptcp-flags</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">mud-url</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">multi-connect</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</td> </tr> <tr> <td><pre class="screen">permissions</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">read-only</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>This property is deprecated and has no meaning.</td> </tr> <tr> <td><pre class="screen">secondaries</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</td> </tr> <tr> <td><pre class="screen">slave-type</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</td> </tr> <tr> <td><pre class="screen">stable-id</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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 to derive the DHCP client identifier with ipv4.dhcp-client-id=stable, the DHCPv6 DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid] and the DHCP IAID with ipv4.iaid=stable and ipv6.iaid=stable. + +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 activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. The "${CONNECTION}" uses the profile's connection.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" 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 "default${CONNECTION}" go generate an ID unique per connection profile.</td> </tr> <tr> <td><pre class="screen">timestamp</pre></td> <td><pre class="screen">uint64</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">type</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">uuid</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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 "-").</td> </tr> <tr> <td><pre class="screen">wait-activation-delay</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">wait-device-timeout</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">zone</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-dcb.html b/docs/api/html/settings-dcb.html index acaaf982..7f179d8f 100644 --- a/docs/api/html/settings-dcb.html +++ b/docs/api/html/settings-dcb.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.11.2.2.1"></a><p class="title"><b>Table 57. </b></p> +<a name="id-1.3.3.11.2.2.1"></a><p class="title"><b>Table 45. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,91 +57,93 @@ <td><pre class="screen">app-fcoe-flags</pre></td> <td><pre class="screen">NMSettingDcbFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">app-fcoe-mode</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">app-fcoe-priority</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">app-fip-flags</pre></td> <td><pre class="screen">NMSettingDcbFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">app-fip-priority</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">app-iscsi-flags</pre></td> <td><pre class="screen">NMSettingDcbFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">app-iscsi-priority</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">priority-bandwidth</pre></td> <td><pre class="screen">array of uint32</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">priority-flow-control</pre></td> <td><pre class="screen">array of uint32</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">priority-flow-control-flags</pre></td> <td><pre class="screen">NMSettingDcbFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">priority-group-bandwidth</pre></td> <td><pre class="screen">array of uint32</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">priority-group-flags</pre></td> <td><pre class="screen">NMSettingDcbFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">priority-group-id</pre></td> <td><pre class="screen">array of uint32</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">priority-strict-bandwidth</pre></td> <td><pre class="screen">array of uint32</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">priority-traffic-class</pre></td> <td><pre class="screen">array of uint32</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-dummy.html b/docs/api/html/settings-dummy.html index f2929aab..5193e674 100644 --- a/docs/api/html/settings-dummy.html +++ b/docs/api/html/settings-dummy.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.12.2.2.1"></a><p class="title"><b>Table 58. </b></p> +<a name="id-1.3.3.12.2.2.1"></a><p class="title"><b>Table 46. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> diff --git a/docs/api/html/settings-ethtool.html b/docs/api/html/settings-ethtool.html index 35273827..0013fe8d 100644 --- a/docs/api/html/settings-ethtool.html +++ b/docs/api/html/settings-ethtool.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.13.2.2.1"></a><p class="title"><b>Table 59. </b></p> +<a name="id-1.3.3.13.2.2.1"></a><p class="title"><b>Table 47. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> diff --git a/docs/api/html/settings-generic.html b/docs/api/html/settings-generic.html index 23ef5e04..5c1254d8 100644 --- a/docs/api/html/settings-generic.html +++ b/docs/api/html/settings-generic.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.14.2.2.1"></a><p class="title"><b>Table 60. </b></p> +<a name="id-1.3.3.14.2.2.1"></a><p class="title"><b>Table 48. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> diff --git a/docs/api/html/settings-gsm.html b/docs/api/html/settings-gsm.html index 0f57507e..0e250b4a 100644 --- a/docs/api/html/settings-gsm.html +++ b/docs/api/html/settings-gsm.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.15.2.2.1"></a><p class="title"><b>Table 61. </b></p> +<a name="id-1.3.3.15.2.2.1"></a><p class="title"><b>Table 49. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,85 +57,97 @@ <td><pre class="screen">apn</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">auto-config</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">device-id</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">home-only</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</td> +</tr> +<tr> +<td><pre class="screen">initial-eps-bearer-apn</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network. Setting this parameter implies initial-eps-bearer-configure to be TRUE.</td> +</tr> +<tr> +<td><pre class="screen">initial-eps-bearer-configure</pre></td> +<td><pre class="screen">boolean</pre></td> +<td><pre class="screen">FALSE</pre></td> +<td>For LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection. It is inferred TRUE if initial-eps-bearer-apn is set.</td> </tr> <tr> <td><pre class="screen">mtu</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</td> </tr> <tr> <td><pre class="screen">network-id</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">number</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Legacy setting that used to help establishing PPP data sessions for GSM-based modems.</td> </tr> <tr> <td><pre class="screen">password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">password-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "password" property.</td> </tr> <tr> <td><pre class="screen">pin</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">pin-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "pin" property.</td> </tr> <tr> <td><pre class="screen">sim-id</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">sim-operator-id</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">username</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-hostname.html b/docs/api/html/settings-hostname.html index d12fcfba..4f6fe458 100644 --- a/docs/api/html/settings-hostname.html +++ b/docs/api/html/settings-hostname.html @@ -7,7 +7,7 @@ <link rel="home" href="index.html" title="NetworkManager Reference Manual"> <link rel="up" href="ch01.html" title="Configuration Settings"> <link rel="prev" href="settings-bond-port.html" title="bond-port"> -<link rel="next" href="settings-loopback.html" title="loopback"> +<link rel="next" href="settings-link.html" title="link"> <meta name="generator" content="GTK-Doc V1.33.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> </head> @@ -22,7 +22,7 @@ <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> <td><a accesskey="p" href="settings-bond-port.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> -<td><a accesskey="n" href="settings-loopback.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +<td><a accesskey="n" href="settings-link.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> <a name="settings-hostname"></a><div class="titlepage"></div> @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.51.2.2.1"></a><p class="title"><b>Table 97. </b></p> +<a name="id-1.3.3.51.2.2.1"></a><p class="title"><b>Table 85. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,25 +57,37 @@ <td><pre class="screen">from-dhcp</pre></td> <td><pre class="screen">NMTernary (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">from-dns-lookup</pre></td> <td><pre class="screen">NMTernary (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">only-from-default</pre></td> <td><pre class="screen">NMTernary (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">priority</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-infiniband.html b/docs/api/html/settings-infiniband.html index 6b509038..c7a5e73c 100644 --- a/docs/api/html/settings-infiniband.html +++ b/docs/api/html/settings-infiniband.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.16.2.2.1"></a><p class="title"><b>Table 62. </b></p> +<a name="id-1.3.3.16.2.2.1"></a><p class="title"><b>Table 50. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,31 +57,35 @@ <td><pre class="screen">mac-address</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">mtu</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</td> </tr> <tr> <td><pre class="screen">p-key</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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 0x8000 is set if it is a "full membership" p-key. The values 0 and 0x8000 are not allowed. + +With the p-key set, the interface name is always "$parent.$p_key". Setting "connection.interface-name" to another name is not supported. + +Note that kernel will internally always set the full membership bit, although the interface name does not reflect that. Usually the user would want to configure a full membership p-key with 0x8000 flag set.</td> </tr> <tr> <td><pre class="screen">parent</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">transport-mode</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-ip-tunnel.html b/docs/api/html/settings-ip-tunnel.html index 4f35a153..a012de37 100644 --- a/docs/api/html/settings-ip-tunnel.html +++ b/docs/api/html/settings-ip-tunnel.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.19.2.2.1"></a><p class="title"><b>Table 65. </b></p> +<a name="id-1.3.3.19.2.2.1"></a><p class="title"><b>Table 53. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,85 +57,85 @@ <td><pre class="screen">encapsulation-limit</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1) to ip-tunnel flags.</td> </tr> <tr> <td><pre class="screen">flags</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">flow-label</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</td> </tr> <tr> <td><pre class="screen">fwmark</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.</td> </tr> <tr> <td><pre class="screen">input-key</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</td> </tr> <tr> <td><pre class="screen">local</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</td> </tr> <tr> <td><pre class="screen">mode</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</td> </tr> <tr> <td><pre class="screen">mtu</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</td> </tr> <tr> <td><pre class="screen">output-key</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</td> </tr> <tr> <td><pre class="screen">parent</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">path-mtu-discovery</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>Whether to enable Path MTU Discovery on this tunnel.</td> </tr> <tr> <td><pre class="screen">remote</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</td> </tr> <tr> <td><pre class="screen">tos</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</td> </tr> <tr> <td><pre class="screen">ttl</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-ipv4.html b/docs/api/html/settings-ipv4.html index 24361ef7..37aaaed0 100644 --- a/docs/api/html/settings-ipv4.html +++ b/docs/api/html/settings-ipv4.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.17.2.2.1"></a><p class="title"><b>Table 63. </b></p> +<a name="id-1.3.3.17.2.2.1"></a><p class="title"><b>Table 51. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,193 +57,277 @@ <td><pre class="screen">address-data</pre></td> <td><pre class="screen">array of vardict</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">addresses</pre></td> <td><pre class="screen">array of array of uint32</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">auto-route-ext-gw</pre></td> <td><pre class="screen">NMTernary (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dad-timeout</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dhcp-client-id</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dhcp-fqdn</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dhcp-hostname</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dhcp-hostname-flags</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dhcp-iaid</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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 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.</td> </tr> <tr> <td><pre class="screen">dhcp-reject-servers</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dhcp-send-hostname</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dhcp-timeout</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dhcp-vendor-class-identifier</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dns</pre></td> <td><pre class="screen">array of uint32</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Array of IP addresses of DNS servers (as network-byte-order integers)</td> </tr> <tr> <td><pre class="screen">dns-data</pre></td> <td><pre class="screen">array of strings</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Array of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.</td> </tr> <tr> <td><pre class="screen">dns-options</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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-aaaa", "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.</td> </tr> <tr> <td><pre class="screen">dns-priority</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dns-search</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">gateway</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">ignore-auto-dns</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">ignore-auto-routes</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">link-local</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">may-fail</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">method</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">never-default</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">replace-local-rule</pre></td> <td><pre class="screen">NMTernary (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</td> </tr> <tr> <td><pre class="screen">required-timeout</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">route-data</pre></td> <td><pre class="screen">array of vardict</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">route-metric</pre></td> <td><pre class="screen">int64</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">route-table</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">routes</pre></td> <td><pre class="screen">array of array of uint32</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.)</td> </tr> <tr> <td><pre class="screen">routing-rules</pre></td> <td><pre class="screen">array of 'a{sv}'</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-ipv6.html b/docs/api/html/settings-ipv6.html index 776d231e..2e8747cc 100644 --- a/docs/api/html/settings-ipv6.html +++ b/docs/api/html/settings-ipv6.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.18.2.2.1"></a><p class="title"><b>Table 64. </b></p> +<a name="id-1.3.3.18.2.2.1"></a><p class="title"><b>Table 52. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,205 +57,313 @@ <td><pre class="screen">addr-gen-mode</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">3</pre></td> -<td> </td> +<td>Configure the method for creating the IPv6 interface identifier of addresses for RFC4862 IPv6 Stateless Address Autoconfiguration and IPv6 Link Local. + +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 token derived from the hardware address. This makes the host part of the address constant, making it possible to track the host's presence when it changes networks. The address changes when the interface hardware is replaced. If a duplicate address is detected, there is no fallback to generate another address. When configured, the "ipv6.token" is used instead of the MAC address to generate addresses for stateless autoconfiguration. + +If the property is set to "stable-privacy", the interface identifier is generated as specified by RFC7217. This works by hashing a host specific key (see NetworkManager(8) manual), the interface name, the connection's "connection.stable-id" property and the address prefix. This improves privacy by making it harder to use the address to track the host's presence as every prefix and network has a different identifier. Also, the address is stable when the network interface hardware is replaced. + +The special values "default" and "default-or-eui64" will fallback to the global connection default as documented in the 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 used to default 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.</td> </tr> <tr> <td><pre class="screen">address-data</pre></td> <td><pre class="screen">array of vardict</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">addresses</pre></td> <td><pre class="screen">array of legacy IPv6 address struct (a(ayuay))</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">auto-route-ext-gw</pre></td> <td><pre class="screen">NMTernary (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dad-timeout</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dhcp-duid</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dhcp-hostname</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dhcp-hostname-flags</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dhcp-iaid</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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 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.</td> +</tr> +<tr> +<td><pre class="screen">dhcp-pd-hint</pre></td> +<td><pre class="screen">string</pre></td> +<td><pre class="screen"></pre></td> +<td>A IPv6 address followed by a slash and a prefix length. If set, the value is sent to the DHCPv6 server as hint indicating the prefix delegation (IA_PD) we want to receive. To only hint a prefix length without prefix, set the address part to the zero address (for example "::/60").</td> </tr> <tr> <td><pre class="screen">dhcp-reject-servers</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dhcp-send-hostname</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dhcp-timeout</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dns</pre></td> <td><pre class="screen">array of byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Array of IP addresses of DNS servers (in network byte order)</td> </tr> <tr> <td><pre class="screen">dns-data</pre></td> <td><pre class="screen">array of strings</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Array of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.</td> </tr> <tr> <td><pre class="screen">dns-options</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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-aaaa", "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.</td> </tr> <tr> <td><pre class="screen">dns-priority</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">dns-search</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">gateway</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">ignore-auto-dns</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">ignore-auto-routes</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">ip6-privacy</pre></td> <td><pre class="screen">NMSettingIP6ConfigPrivacy (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">may-fail</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">method</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">mtu</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">never-default</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">ra-timeout</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">replace-local-rule</pre></td> <td><pre class="screen">NMTernary (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</td> </tr> <tr> <td><pre class="screen">required-timeout</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">route-data</pre></td> <td><pre class="screen">array of vardict</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">route-metric</pre></td> <td><pre class="screen">int64</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">route-table</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">routes</pre></td> <td><pre class="screen">array of legacy IPv6 route struct (a(ayuayu))</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">routing-rules</pre></td> <td><pre class="screen">array of 'a{sv}'</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">token</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode. + +When set, the token is used as IPv6 interface identifier instead of the hardware address. This only applies to addresses from stateless autoconfiguration, not to IPv6 link local addresses.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-link.html b/docs/api/html/settings-link.html new file mode 100644 index 00000000..c06d98d7 --- /dev/null +++ b/docs/api/html/settings-link.html @@ -0,0 +1,89 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>link: NetworkManager Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="NetworkManager Reference Manual"> +<link rel="up" href="ch01.html" title="Configuration Settings"> +<link rel="prev" href="settings-hostname.html" title="hostname"> +<link rel="next" href="settings-loopback.html" title="loopback"> +<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_properties"> <span class="dim">|</span> + <a href="#settings-link.properties" class="shortcut"> + Properties + </a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="settings-hostname.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="settings-loopback.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="settings-link"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2>link</h2> +<p>link — Link settings</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="id-1.3.3.52.2"></a><h2> + Properties + </h2> +<div class="table"> +<a name="id-1.3.3.52.2.2.1"></a><p class="title"><b>Table 86. </b></p> +<div class="table-contents"><table class="table" border="1"> +<colgroup> +<col> +<col> +<col> +<col> +</colgroup> +<thead><tr> +<th>Key Name</th> +<th>Value Type</th> +<th>Default Value</th> +<th>Value Description</th> +</tr></thead> +<tbody> +<tr> +<td><pre class="screen">gro-max-size</pre></td> +<td><pre class="screen">int64</pre></td> +<td><pre class="screen">-1</pre></td> +<td>The maximum size of a packet built by the Generic Receive Offload stack for this device. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</td> +</tr> +<tr> +<td><pre class="screen">gso-max-segments</pre></td> +<td><pre class="screen">int64</pre></td> +<td><pre class="screen">-1</pre></td> +<td>The maximum segments of a Generic Segment Offload packet the device should accept. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</td> +</tr> +<tr> +<td><pre class="screen">gso-max-size</pre></td> +<td><pre class="screen">int64</pre></td> +<td><pre class="screen">-1</pre></td> +<td>The maximum size of a Generic Segment Offload packet the device should accept. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</td> +</tr> +<tr> +<td><pre class="screen">tx-queue-length</pre></td> +<td><pre class="screen">int64</pre></td> +<td><pre class="screen">-1</pre></td> +<td>The size of the transmit queue for the device, in number of packets. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</td> +</tr> +</tbody> +</table></div> +</div> +<p><br class="table-break"></p> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.33.1</div> +</body> +</html> \ No newline at end of file diff --git a/docs/api/html/settings-loopback.html b/docs/api/html/settings-loopback.html index 05caf07c..d8073387 100644 --- a/docs/api/html/settings-loopback.html +++ b/docs/api/html/settings-loopback.html @@ -6,7 +6,7 @@ <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> <link rel="home" href="index.html" title="NetworkManager Reference Manual"> <link rel="up" href="ch01.html" title="Configuration Settings"> -<link rel="prev" href="settings-hostname.html" title="hostname"> +<link rel="prev" href="settings-link.html" title="link"> <link rel="next" href="settings-ovs-external-ids.html" title="ovs-external-ids"> <meta name="generator" content="GTK-Doc V1.33.1 (XML mode)"> <link rel="stylesheet" href="style.css" type="text/css"> @@ -21,7 +21,7 @@ </td> <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> <td><a accesskey="u" href="ch01.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> -<td><a accesskey="p" href="settings-hostname.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="p" href="settings-link.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> <td><a accesskey="n" href="settings-ovs-external-ids.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> </tr></table> <div class="refentry"> @@ -34,11 +34,11 @@ <td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> -<a name="id-1.3.3.52.2"></a><h2> +<a name="id-1.3.3.53.2"></a><h2> Properties </h2> <div class="table"> -<a name="id-1.3.3.52.2.2.1"></a><p class="title"><b>Table 98. </b></p> +<a name="id-1.3.3.53.2.2.1"></a><p class="title"><b>Table 87. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -56,7 +56,7 @@ <td><pre class="screen">mtu</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</td> </tr></tbody> </table></div> </div> diff --git a/docs/api/html/settings-macsec.html b/docs/api/html/settings-macsec.html index 6b19558f..6659b01f 100644 --- a/docs/api/html/settings-macsec.html +++ b/docs/api/html/settings-macsec.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.20.2.2.1"></a><p class="title"><b>Table 66. </b></p> +<a name="id-1.3.3.20.2.2.1"></a><p class="title"><b>Table 54. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,55 +57,55 @@ <td><pre class="screen">encrypt</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>Whether the transmitted traffic must be encrypted.</td> </tr> <tr> <td><pre class="screen">mka-cak</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</td> </tr> <tr> <td><pre class="screen">mka-cak-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "mka-cak" property.</td> </tr> <tr> <td><pre class="screen">mka-ckn</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">mode</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</td> </tr> <tr> <td><pre class="screen">parent</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">port</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">1</pre></td> -<td> </td> +<td>The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</td> </tr> <tr> <td><pre class="screen">send-sci</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</td> </tr> <tr> <td><pre class="screen">validation</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">2</pre></td> -<td> </td> +<td>Specifies the validation mode for incoming frames.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-macvlan.html b/docs/api/html/settings-macvlan.html index 645bee54..54733b85 100644 --- a/docs/api/html/settings-macvlan.html +++ b/docs/api/html/settings-macvlan.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.21.2.2.1"></a><p class="title"><b>Table 67. </b></p> +<a name="id-1.3.3.21.2.2.1"></a><p class="title"><b>Table 55. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,25 +57,25 @@ <td><pre class="screen">mode</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</td> </tr> <tr> <td><pre class="screen">parent</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">promiscuous</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>Whether the interface should be put in promiscuous mode.</td> </tr> <tr> <td><pre class="screen">tap</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Whether the interface should be a MACVTAP.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-match.html b/docs/api/html/settings-match.html index 916d91ef..828fb6e7 100644 --- a/docs/api/html/settings-match.html +++ b/docs/api/html/settings-match.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.22.2.2.1"></a><p class="title"><b>Table 68. </b></p> +<a name="id-1.3.3.22.2.2.1"></a><p class="title"><b>Table 56. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,25 +57,39 @@ <td><pre class="screen">driver</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">interface-name</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">kernel-command-line</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">path</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-ovs-bridge.html b/docs/api/html/settings-ovs-bridge.html index 24b481f6..bfa44b26 100644 --- a/docs/api/html/settings-ovs-bridge.html +++ b/docs/api/html/settings-ovs-bridge.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.24.2.2.1"></a><p class="title"><b>Table 70. </b></p> +<a name="id-1.3.3.24.2.2.1"></a><p class="title"><b>Table 58. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,31 +57,31 @@ <td><pre class="screen">datapath-type</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The data path type. One of "system", "netdev" or empty.</td> </tr> <tr> <td><pre class="screen">fail-mode</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The bridge failure mode. One of "secure", "standalone" or empty.</td> </tr> <tr> <td><pre class="screen">mcast-snooping-enable</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Enable or disable multicast snooping.</td> </tr> <tr> <td><pre class="screen">rstp-enable</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Enable or disable RSTP.</td> </tr> <tr> <td><pre class="screen">stp-enable</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Enable or disable STP.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-ovs-dpdk.html b/docs/api/html/settings-ovs-dpdk.html index bbd4d878..39eed1ef 100644 --- a/docs/api/html/settings-ovs-dpdk.html +++ b/docs/api/html/settings-ovs-dpdk.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.25.2.2.1"></a><p class="title"><b>Table 71. </b></p> +<a name="id-1.3.3.25.2.2.1"></a><p class="title"><b>Table 59. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,25 +57,25 @@ <td><pre class="screen">devargs</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Open vSwitch DPDK device arguments.</td> </tr> <tr> <td><pre class="screen">n-rxq</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.</td> </tr> <tr> <td><pre class="screen">n-rxq-desc</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">n-txq-desc</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-ovs-external-ids.html b/docs/api/html/settings-ovs-external-ids.html index c41f7ba5..ad8a703b 100644 --- a/docs/api/html/settings-ovs-external-ids.html +++ b/docs/api/html/settings-ovs-external-ids.html @@ -34,11 +34,11 @@ <td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> -<a name="id-1.3.3.53.2"></a><h2> +<a name="id-1.3.3.54.2"></a><h2> Properties </h2> <div class="table"> -<a name="id-1.3.3.53.2.2.1"></a><p class="title"><b>Table 99. </b></p> +<a name="id-1.3.3.54.2.2.1"></a><p class="title"><b>Table 88. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -56,7 +56,7 @@ <td><pre class="screen">data</pre></td> <td><pre class="screen">dict of string to string</pre></td> <td><pre class="screen">{}</pre></td> -<td> </td> +<td>A dictionary of key/value pairs with external-ids for OVS.</td> </tr></tbody> </table></div> </div> diff --git a/docs/api/html/settings-ovs-interface.html b/docs/api/html/settings-ovs-interface.html index c1dabd02..0e3b830e 100644 --- a/docs/api/html/settings-ovs-interface.html +++ b/docs/api/html/settings-ovs-interface.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.26.2.2.1"></a><p class="title"><b>Table 72. </b></p> +<a name="id-1.3.3.26.2.2.1"></a><p class="title"><b>Table 60. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,13 +57,13 @@ <td><pre class="screen">ofport-request</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">type</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The interface type. Either "internal", "system", "patch", "dpdk", or empty.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-ovs-other-config.html b/docs/api/html/settings-ovs-other-config.html index 5b3c728e..bd188e63 100644 --- a/docs/api/html/settings-ovs-other-config.html +++ b/docs/api/html/settings-ovs-other-config.html @@ -34,11 +34,11 @@ <td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> -<a name="id-1.3.3.54.2"></a><h2> +<a name="id-1.3.3.55.2"></a><h2> Properties </h2> <div class="table"> -<a name="id-1.3.3.54.2.2.1"></a><p class="title"><b>Table 100. </b></p> +<a name="id-1.3.3.55.2.2.1"></a><p class="title"><b>Table 89. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -56,7 +56,7 @@ <td><pre class="screen">data</pre></td> <td><pre class="screen">dict of string to string</pre></td> <td><pre class="screen">{}</pre></td> -<td> </td> +<td>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.</td> </tr></tbody> </table></div> </div> diff --git a/docs/api/html/settings-ovs-patch.html b/docs/api/html/settings-ovs-patch.html index 1abb2211..e97d2974 100644 --- a/docs/api/html/settings-ovs-patch.html +++ b/docs/api/html/settings-ovs-patch.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.27.2.2.1"></a><p class="title"><b>Table 73. </b></p> +<a name="id-1.3.3.27.2.2.1"></a><p class="title"><b>Table 61. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -56,7 +56,7 @@ <td><pre class="screen">peer</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr></tbody> </table></div> </div> diff --git a/docs/api/html/settings-ovs-port.html b/docs/api/html/settings-ovs-port.html index 35f828c5..e53d3aba 100644 --- a/docs/api/html/settings-ovs-port.html +++ b/docs/api/html/settings-ovs-port.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.28.2.2.1"></a><p class="title"><b>Table 74. </b></p> +<a name="id-1.3.3.28.2.2.1"></a><p class="title"><b>Table 62. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,43 +57,45 @@ <td><pre class="screen">bond-downdelay</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>The time port must be inactive in order to be considered down.</td> </tr> <tr> <td><pre class="screen">bond-mode</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</td> </tr> <tr> <td><pre class="screen">bond-updelay</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>The time port must be active before it starts forwarding traffic.</td> </tr> <tr> <td><pre class="screen">lacp</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>LACP mode. One of "active", "off", or "passive".</td> </tr> <tr> <td><pre class="screen">tag</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>The VLAN tag in the range 0-4095.</td> </tr> <tr> <td><pre class="screen">trunks</pre></td> <td><pre class="screen">array of vardict</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">vlan-mode</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-ppp.html b/docs/api/html/settings-ppp.html index baf53247..a8d08545 100644 --- a/docs/api/html/settings-ppp.html +++ b/docs/api/html/settings-ppp.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.29.2.2.1"></a><p class="title"><b>Table 75. </b></p> +<a name="id-1.3.3.29.2.2.1"></a><p class="title"><b>Table 63. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,109 +57,109 @@ <td><pre class="screen">baud</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">crtscts</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">lcp-echo-failure</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">lcp-echo-interval</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">mppe-stateful</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</td> </tr> <tr> <td><pre class="screen">mru</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">mtu</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>If non-zero, instruct pppd to send packets no larger than the specified size.</td> </tr> <tr> <td><pre class="screen">no-vj-comp</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>If TRUE, Van Jacobsen TCP header compression will not be requested.</td> </tr> <tr> <td><pre class="screen">noauth</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">nobsdcomp</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>If TRUE, BSD compression will not be requested.</td> </tr> <tr> <td><pre class="screen">nodeflate</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>If TRUE, "deflate" compression will not be requested.</td> </tr> <tr> <td><pre class="screen">refuse-chap</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>If TRUE, the CHAP authentication method will not be used.</td> </tr> <tr> <td><pre class="screen">refuse-eap</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>If TRUE, the EAP authentication method will not be used.</td> </tr> <tr> <td><pre class="screen">refuse-mschap</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>If TRUE, the MSCHAP authentication method will not be used.</td> </tr> <tr> <td><pre class="screen">refuse-mschapv2</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>If TRUE, the MSCHAPv2 authentication method will not be used.</td> </tr> <tr> <td><pre class="screen">refuse-pap</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>If TRUE, the PAP authentication method will not be used.</td> </tr> <tr> <td><pre class="screen">require-mppe</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">require-mppe-128</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-pppoe.html b/docs/api/html/settings-pppoe.html index 5cfac707..7dee82f6 100644 --- a/docs/api/html/settings-pppoe.html +++ b/docs/api/html/settings-pppoe.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.30.2.2.1"></a><p class="title"><b>Table 76. </b></p> +<a name="id-1.3.3.30.2.2.1"></a><p class="title"><b>Table 64. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,31 +57,31 @@ <td><pre class="screen">parent</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">password</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Password used to authenticate with the PPPoE service.</td> </tr> <tr> <td><pre class="screen">password-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "password" property.</td> </tr> <tr> <td><pre class="screen">service</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">username</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Username used to authenticate with the PPPoE service.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-proxy.html b/docs/api/html/settings-proxy.html index 5a28d81a..15deb102 100644 --- a/docs/api/html/settings-proxy.html +++ b/docs/api/html/settings-proxy.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.31.2.2.1"></a><p class="title"><b>Table 77. </b></p> +<a name="id-1.3.3.31.2.2.1"></a><p class="title"><b>Table 65. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,25 +57,25 @@ <td><pre class="screen">browser-only</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Whether the proxy configuration is for browser only.</td> </tr> <tr> <td><pre class="screen">method</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</td> </tr> <tr> <td><pre class="screen">pac-script</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.</td> </tr> <tr> <td><pre class="screen">pac-url</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>PAC URL for obtaining PAC file.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-serial.html b/docs/api/html/settings-serial.html index 70dfcbc3..e8397851 100644 --- a/docs/api/html/settings-serial.html +++ b/docs/api/html/settings-serial.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.32.2.2.1"></a><p class="title"><b>Table 78. </b></p> +<a name="id-1.3.3.32.2.2.1"></a><p class="title"><b>Table 66. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,31 +57,31 @@ <td><pre class="screen">baud</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">57600</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">bits</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">8</pre></td> -<td> </td> +<td>Byte-width of the serial communication. The 8 in "8n1" for example.</td> </tr> <tr> <td><pre class="screen">parity</pre></td> <td><pre class="screen">byte</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.</td> </tr> <tr> <td><pre class="screen">send-delay</pre></td> <td><pre class="screen">uint64</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>Time to delay between each byte sent to the modem, in microseconds.</td> </tr> <tr> <td><pre class="screen">stopbits</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">1</pre></td> -<td> </td> +<td>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-sriov.html b/docs/api/html/settings-sriov.html index 62f7e68a..7610c14b 100644 --- a/docs/api/html/settings-sriov.html +++ b/docs/api/html/settings-sriov.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.33.2.2.1"></a><p class="title"><b>Table 79. </b></p> +<a name="id-1.3.3.33.2.2.1"></a><p class="title"><b>Table 67. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,19 +57,45 @@ <td><pre class="screen">autoprobe-drivers</pre></td> <td><pre class="screen">NMTernary (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">total-vfs</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">vfs</pre></td> <td><pre class="screen">array of vardict</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-tc.html b/docs/api/html/settings-tc.html index d83d148a..abc54523 100644 --- a/docs/api/html/settings-tc.html +++ b/docs/api/html/settings-tc.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.34.2.2.1"></a><p class="title"><b>Table 80. </b></p> +<a name="id-1.3.3.34.2.2.1"></a><p class="title"><b>Table 68. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,13 +57,21 @@ <td><pre class="screen">qdiscs</pre></td> <td><pre class="screen">array of vardict</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">tfilters</pre></td> <td><pre class="screen">array of vardict</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-team-port.html b/docs/api/html/settings-team-port.html index 333d7677..73db2e13 100644 --- a/docs/api/html/settings-team-port.html +++ b/docs/api/html/settings-team-port.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.36.2.2.1"></a><p class="title"><b>Table 82. </b></p> +<a name="id-1.3.3.36.2.2.1"></a><p class="title"><b>Table 70. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,43 +57,43 @@ <td><pre class="screen">config</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">lacp-key</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>Corresponds to the teamd ports.PORTIFNAME.lacp_key.</td> </tr> <tr> <td><pre class="screen">lacp-prio</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</td> </tr> <tr> <td><pre class="screen">link-watchers</pre></td> <td><pre class="screen">array of vardict</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">prio</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>Corresponds to the teamd ports.PORTIFNAME.prio.</td> </tr> <tr> <td><pre class="screen">queue-id</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</td> </tr> <tr> <td><pre class="screen">sticky</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Corresponds to the teamd ports.PORTIFNAME.sticky.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-team.html b/docs/api/html/settings-team.html index 640185f6..c6adf30a 100644 --- a/docs/api/html/settings-team.html +++ b/docs/api/html/settings-team.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.35.2.2.1"></a><p class="title"><b>Table 81. </b></p> +<a name="id-1.3.3.35.2.2.1"></a><p class="title"><b>Table 69. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,103 +57,103 @@ <td><pre class="screen">config</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">interface-name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.</td> </tr> <tr> <td><pre class="screen">link-watchers</pre></td> <td><pre class="screen">array of vardict</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">mcast-rejoin-count</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>Corresponds to the teamd mcast_rejoin.count.</td> </tr> <tr> <td><pre class="screen">mcast-rejoin-interval</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>Corresponds to the teamd mcast_rejoin.interval.</td> </tr> <tr> <td><pre class="screen">notify-peers-count</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>Corresponds to the teamd notify_peers.count.</td> </tr> <tr> <td><pre class="screen">notify-peers-interval</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>Corresponds to the teamd notify_peers.interval.</td> </tr> <tr> <td><pre class="screen">runner</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</td> </tr> <tr> <td><pre class="screen">runner-active</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>Corresponds to the teamd runner.active.</td> </tr> <tr> <td><pre class="screen">runner-agg-select-policy</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Corresponds to the teamd runner.agg_select_policy.</td> </tr> <tr> <td><pre class="screen">runner-fast-rate</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Corresponds to the teamd runner.fast_rate.</td> </tr> <tr> <td><pre class="screen">runner-hwaddr-policy</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Corresponds to the teamd runner.hwaddr_policy.</td> </tr> <tr> <td><pre class="screen">runner-min-ports</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>Corresponds to the teamd runner.min_ports.</td> </tr> <tr> <td><pre class="screen">runner-sys-prio</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>Corresponds to the teamd runner.sys_prio.</td> </tr> <tr> <td><pre class="screen">runner-tx-balancer</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Corresponds to the teamd runner.tx_balancer.name.</td> </tr> <tr> <td><pre class="screen">runner-tx-balancer-interval</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>Corresponds to the teamd runner.tx_balancer.interval.</td> </tr> <tr> <td><pre class="screen">runner-tx-hash</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Corresponds to the teamd runner.tx_hash.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-tun.html b/docs/api/html/settings-tun.html index 3691e124..a5b5a994 100644 --- a/docs/api/html/settings-tun.html +++ b/docs/api/html/settings-tun.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.37.2.2.1"></a><p class="title"><b>Table 83. </b></p> +<a name="id-1.3.3.37.2.2.1"></a><p class="title"><b>Table 71. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,37 +57,37 @@ <td><pre class="screen">group</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The group ID which will own the device. If set to NULL everyone will be able to use the device.</td> </tr> <tr> <td><pre class="screen">mode</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">1</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">multi-queue</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">owner</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The user ID which will own the device. If set to NULL everyone will be able to use the device.</td> </tr> <tr> <td><pre class="screen">pi</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</td> </tr> <tr> <td><pre class="screen">vnet-hdr</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-user.html b/docs/api/html/settings-user.html index 8ce10de8..704c4580 100644 --- a/docs/api/html/settings-user.html +++ b/docs/api/html/settings-user.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.38.2.2.1"></a><p class="title"><b>Table 84. </b></p> +<a name="id-1.3.3.38.2.2.1"></a><p class="title"><b>Table 72. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -56,7 +56,7 @@ <td><pre class="screen">data</pre></td> <td><pre class="screen">dict of string to string</pre></td> <td><pre class="screen">{}</pre></td> -<td> </td> +<td>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.</td> </tr></tbody> </table></div> </div> diff --git a/docs/api/html/settings-veth.html b/docs/api/html/settings-veth.html index d045edae..586a57bd 100644 --- a/docs/api/html/settings-veth.html +++ b/docs/api/html/settings-veth.html @@ -34,11 +34,11 @@ <td class="gallery_image" valign="top" align="right"></td> </tr></table></div> <div class="refsect1"> -<a name="id-1.3.3.55.2"></a><h2> +<a name="id-1.3.3.56.2"></a><h2> Properties </h2> <div class="table"> -<a name="id-1.3.3.55.2.2.1"></a><p class="title"><b>Table 101. </b></p> +<a name="id-1.3.3.56.2.2.1"></a><p class="title"><b>Table 90. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -56,7 +56,7 @@ <td><pre class="screen">peer</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>This property specifies the peer interface name of the veth. This property is mandatory.</td> </tr></tbody> </table></div> </div> diff --git a/docs/api/html/settings-vlan.html b/docs/api/html/settings-vlan.html index 5a310346..f6d6f1aa 100644 --- a/docs/api/html/settings-vlan.html +++ b/docs/api/html/settings-vlan.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.39.2.2.1"></a><p class="title"><b>Table 85. </b></p> +<a name="id-1.3.3.39.2.2.1"></a><p class="title"><b>Table 73. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,43 +57,47 @@ <td><pre class="screen">egress-priority-map</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">flags</pre></td> <td><pre class="screen">NMVlanFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">id</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">ingress-priority-map</pre></td> <td><pre class="screen">array of string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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".</td> </tr> <tr> <td><pre class="screen">interface-name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.</td> </tr> <tr> <td><pre class="screen">parent</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">protocol</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Specifies the VLAN protocol to use for encapsulation. + +Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-vpn.html b/docs/api/html/settings-vpn.html index bb452283..612a69dd 100644 --- a/docs/api/html/settings-vpn.html +++ b/docs/api/html/settings-vpn.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.40.2.2.1"></a><p class="title"><b>Table 86. </b></p> +<a name="id-1.3.3.40.2.2.1"></a><p class="title"><b>Table 74. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,37 +57,37 @@ <td><pre class="screen">data</pre></td> <td><pre class="screen">dict of string to string</pre></td> <td><pre class="screen">{}</pre></td> -<td> </td> +<td>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</td> </tr> <tr> <td><pre class="screen">persistent</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">secrets</pre></td> <td><pre class="screen">dict of string to string</pre></td> <td><pre class="screen">{}</pre></td> -<td> </td> +<td>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</td> </tr> <tr> <td><pre class="screen">service-type</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">timeout</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">user-name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-vrf.html b/docs/api/html/settings-vrf.html index e23ce0bc..d9f90e04 100644 --- a/docs/api/html/settings-vrf.html +++ b/docs/api/html/settings-vrf.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.41.2.2.1"></a><p class="title"><b>Table 87. </b></p> +<a name="id-1.3.3.41.2.2.1"></a><p class="title"><b>Table 75. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -56,7 +56,7 @@ <td><pre class="screen">table</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>The routing table for this VRF.</td> </tr></tbody> </table></div> </div> diff --git a/docs/api/html/settings-vxlan.html b/docs/api/html/settings-vxlan.html index c00e3c0d..be0edb5a 100644 --- a/docs/api/html/settings-vxlan.html +++ b/docs/api/html/settings-vxlan.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.42.2.2.1"></a><p class="title"><b>Table 88. </b></p> +<a name="id-1.3.3.42.2.2.1"></a><p class="title"><b>Table 76. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,97 +57,97 @@ <td><pre class="screen">ageing</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">300</pre></td> -<td> </td> +<td>Specifies the lifetime in seconds of FDB entries learnt by the kernel.</td> </tr> <tr> <td><pre class="screen">destination-port</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">8472</pre></td> -<td> </td> +<td>Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</td> </tr> <tr> <td><pre class="screen">id</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.</td> </tr> <tr> <td><pre class="screen">l2-miss</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Specifies whether netlink LL ADDR miss notifications are generated.</td> </tr> <tr> <td><pre class="screen">l3-miss</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Specifies whether netlink IP ADDR miss notifications are generated.</td> </tr> <tr> <td><pre class="screen">learning</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</td> </tr> <tr> <td><pre class="screen">limit</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</td> </tr> <tr> <td><pre class="screen">local</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>If given, specifies the source IP address to use in outgoing packets.</td> </tr> <tr> <td><pre class="screen">parent</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>If given, specifies the parent interface name or parent connection UUID.</td> </tr> <tr> <td><pre class="screen">proxy</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Specifies whether ARP proxy is turned on.</td> </tr> <tr> <td><pre class="screen">remote</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">rsc</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">FALSE</pre></td> -<td> </td> +<td>Specifies whether route short circuit is turned on.</td> </tr> <tr> <td><pre class="screen">source-port-max</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</td> </tr> <tr> <td><pre class="screen">source-port-min</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</td> </tr> <tr> <td><pre class="screen">tos</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>Specifies the TOS value to use in outgoing packets.</td> </tr> <tr> <td><pre class="screen">ttl</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>Specifies the time-to-live value to use in outgoing packets.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-wifi-p2p.html b/docs/api/html/settings-wifi-p2p.html index 566e1109..ac0865b7 100644 --- a/docs/api/html/settings-wifi-p2p.html +++ b/docs/api/html/settings-wifi-p2p.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.43.2.2.1"></a><p class="title"><b>Table 89. </b></p> +<a name="id-1.3.3.43.2.2.1"></a><p class="title"><b>Table 77. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,19 +57,23 @@ <td><pre class="screen">peer</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The P2P device that should be connected to. Currently, this is the only way to create or join a group.</td> </tr> <tr> <td><pre class="screen">wfd-ies</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">wps-method</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-wimax.html b/docs/api/html/settings-wimax.html index 770a44a8..56bf88d7 100644 --- a/docs/api/html/settings-wimax.html +++ b/docs/api/html/settings-wimax.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.44.2.2.1"></a><p class="title"><b>Table 90. </b></p> +<a name="id-1.3.3.44.2.2.1"></a><p class="title"><b>Table 78. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,13 +57,13 @@ <td><pre class="screen">mac-address</pre></td> <td><pre class="screen">byte array</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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).</td> </tr> <tr> <td><pre class="screen">network-name</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Network Service Provider (NSP) name of the WiMAX network this connection should use.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-wireguard.html b/docs/api/html/settings-wireguard.html index c5c3fe23..685061fb 100644 --- a/docs/api/html/settings-wireguard.html +++ b/docs/api/html/settings-wireguard.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.46.2.2.1"></a><p class="title"><b>Table 92. </b></p> +<a name="id-1.3.3.46.2.2.1"></a><p class="title"><b>Table 80. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,55 +57,65 @@ <td><pre class="screen">fwmark</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">ip4-auto-default-route</pre></td> <td><pre class="screen">NMTernary (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">ip6-auto-default-route</pre></td> <td><pre class="screen">NMTernary (int32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Like ip4-auto-default-route, but for the IPv6 default route.</td> </tr> <tr> <td><pre class="screen">listen-port</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</td> </tr> <tr> <td><pre class="screen">mtu</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">0</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">peer-routes</pre></td> <td><pre class="screen">boolean</pre></td> <td><pre class="screen">TRUE</pre></td> -<td> </td> +<td>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.</td> </tr> <tr> <td><pre class="screen">peers</pre></td> <td><pre class="screen">array of 'a{sv}'</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Array of dictionaries for the WireGuard peers.</td> </tr> <tr> <td><pre class="screen">private-key</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>The 256 bit private-key in base64 encoding.</td> </tr> <tr> <td><pre class="screen">private-key-flags</pre></td> <td><pre class="screen">NMSettingSecretFlags (uint32)</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>Flags indicating how to handle the "private-key" property.</td> </tr> </tbody> </table></div> diff --git a/docs/api/html/settings-wpan.html b/docs/api/html/settings-wpan.html index f6560737..4fddfd2a 100644 --- a/docs/api/html/settings-wpan.html +++ b/docs/api/html/settings-wpan.html @@ -38,7 +38,7 @@ Properties </h2> <div class="table"> -<a name="id-1.3.3.49.2.2.1"></a><p class="title"><b>Table 95. </b></p> +<a name="id-1.3.3.49.2.2.1"></a><p class="title"><b>Table 83. </b></p> <div class="table-contents"><table class="table" border="1"> <colgroup> <col> @@ -57,31 +57,31 @@ <td><pre class="screen">channel</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</td> </tr> <tr> <td><pre class="screen">mac-address</pre></td> <td><pre class="screen">string</pre></td> <td><pre class="screen"></pre></td> -<td> </td> +<td>If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.</td> </tr> <tr> <td><pre class="screen">page</pre></td> <td><pre class="screen">int32</pre></td> <td><pre class="screen">-1</pre></td> -<td> </td> +<td>IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</td> </tr> <tr> <td><pre class="screen">pan-id</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">65535</pre></td> -<td> </td> +<td>IEEE 802.15.4 Personal Area Network (PAN) identifier.</td> </tr> <tr> <td><pre class="screen">short-address</pre></td> <td><pre class="screen">uint32</pre></td> <td><pre class="screen">65535</pre></td> -<td> </td> +<td>Short IEEE 802.15.4 address to be used within a restricted environment.</td> </tr> </tbody> </table></div> diff --git a/docs/api/settings-spec.xml b/docs/api/settings-spec.xml index ee0b1a61..8b2e382f 100644 --- a/docs/api/settings-spec.xml +++ b/docs/api/settings-spec.xml @@ -2,25 +2,137 @@ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> <chapter><title>Configuration Settings</title><refentry id="settings-connection"><refnamediv><refname>connection</refname><refpurpose>General Connection Profile Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-connection.properties"> Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>auth-retries<indexterm zone="settings-connection"><primary sortas="auth-retries">auth-retries</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>autoconnect<indexterm zone="settings-connection"><primary sortas="autoconnect">autoconnect</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>autoconnect-priority<indexterm zone="settings-connection"><primary sortas="autoconnect-priority">autoconnect-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>autoconnect-retries<indexterm zone="settings-connection"><primary sortas="autoconnect-retries">autoconnect-retries</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>autoconnect-slaves<indexterm zone="settings-connection"><primary sortas="autoconnect-slaves">autoconnect-slaves</primary></indexterm></screen></entry><entry><screen>NMSettingConnectionAutoconnectSlaves (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dns-over-tls<indexterm zone="settings-connection"><primary sortas="dns-over-tls">dns-over-tls</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>gateway-ping-timeout<indexterm zone="settings-connection"><primary sortas="gateway-ping-timeout">gateway-ping-timeout</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>id<indexterm zone="settings-connection"><primary sortas="id">id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>interface-name<indexterm zone="settings-connection"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>lldp<indexterm zone="settings-connection"><primary sortas="lldp">lldp</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>llmnr<indexterm zone="settings-connection"><primary sortas="llmnr">llmnr</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>master<indexterm zone="settings-connection"><primary sortas="master">master</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mdns<indexterm zone="settings-connection"><primary sortas="mdns">mdns</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>metered<indexterm zone="settings-connection"><primary sortas="metered">metered</primary></indexterm></screen></entry><entry><screen>NMMetered (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mptcp-flags<indexterm zone="settings-connection"><primary sortas="mptcp-flags">mptcp-flags</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>mud-url<indexterm zone="settings-connection"><primary sortas="mud-url">mud-url</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>multi-connect<indexterm zone="settings-connection"><primary sortas="multi-connect">multi-connect</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>permissions<indexterm zone="settings-connection"><primary sortas="permissions">permissions</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>read-only<indexterm zone="settings-connection"><primary sortas="read-only">read-only</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>secondaries<indexterm zone="settings-connection"><primary sortas="secondaries">secondaries</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>slave-type<indexterm zone="settings-connection"><primary sortas="slave-type">slave-type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>stable-id<indexterm zone="settings-connection"><primary sortas="stable-id">stable-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>timestamp<indexterm zone="settings-connection"><primary sortas="timestamp">timestamp</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>type<indexterm zone="settings-connection"><primary sortas="type">type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>uuid<indexterm zone="settings-connection"><primary sortas="uuid">uuid</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>wait-activation-delay<indexterm zone="settings-connection"><primary sortas="wait-activation-delay">wait-activation-delay</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>wait-device-timeout<indexterm zone="settings-connection"><primary sortas="wait-device-timeout">wait-device-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>zone<indexterm zone="settings-connection"><primary sortas="zone">zone</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-6lowpan"><refnamediv><refname>6lowpan</refname><refpurpose>6LoWPAN Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-6lowpan.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>parent<indexterm zone="settings-6lowpan"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-1x"><refnamediv><refname>802-1x</refname><refpurpose>IEEE 802.1x Authentication Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-1x.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>altsubject-matches<indexterm zone="settings-802-1x"><primary sortas="altsubject-matches">altsubject-matches</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>anonymous-identity<indexterm zone="settings-802-1x"><primary sortas="anonymous-identity">anonymous-identity</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>auth-timeout<indexterm zone="settings-802-1x"><primary sortas="auth-timeout">auth-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>ca-cert<indexterm zone="settings-802-1x"><primary sortas="ca-cert">ca-cert</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>ca-cert-password<indexterm zone="settings-802-1x"><primary sortas="ca-cert-password">ca-cert-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>ca-cert-password-flags<indexterm zone="settings-802-1x"><primary sortas="ca-cert-password-flags">ca-cert-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>ca-path<indexterm zone="settings-802-1x"><primary sortas="ca-path">ca-path</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>client-cert<indexterm zone="settings-802-1x"><primary sortas="client-cert">client-cert</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>client-cert-password<indexterm zone="settings-802-1x"><primary sortas="client-cert-password">client-cert-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>client-cert-password-flags<indexterm zone="settings-802-1x"><primary sortas="client-cert-password-flags">client-cert-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>domain-match<indexterm zone="settings-802-1x"><primary sortas="domain-match">domain-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>domain-suffix-match<indexterm zone="settings-802-1x"><primary sortas="domain-suffix-match">domain-suffix-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>eap<indexterm zone="settings-802-1x"><primary sortas="eap">eap</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>identity<indexterm zone="settings-802-1x"><primary sortas="identity">identity</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>optional<indexterm zone="settings-802-1x"><primary sortas="optional">optional</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>pac-file<indexterm zone="settings-802-1x"><primary sortas="pac-file">pac-file</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>password<indexterm zone="settings-802-1x"><primary sortas="password">password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>password-flags<indexterm zone="settings-802-1x"><primary sortas="password-flags">password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>password-raw<indexterm zone="settings-802-1x"><primary sortas="password-raw">password-raw</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>password-raw-flags<indexterm zone="settings-802-1x"><primary sortas="password-raw-flags">password-raw-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase1-auth-flags<indexterm zone="settings-802-1x"><primary sortas="phase1-auth-flags">phase1-auth-flags</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>phase1-fast-provisioning<indexterm zone="settings-802-1x"><primary sortas="phase1-fast-provisioning">phase1-fast-provisioning</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase1-peaplabel<indexterm zone="settings-802-1x"><primary sortas="phase1-peaplabel">phase1-peaplabel</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase1-peapver<indexterm zone="settings-802-1x"><primary sortas="phase1-peapver">phase1-peapver</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-altsubject-matches<indexterm zone="settings-802-1x"><primary sortas="phase2-altsubject-matches">phase2-altsubject-matches</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-auth<indexterm zone="settings-802-1x"><primary sortas="phase2-auth">phase2-auth</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-autheap<indexterm zone="settings-802-1x"><primary sortas="phase2-autheap">phase2-autheap</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-ca-cert<indexterm zone="settings-802-1x"><primary sortas="phase2-ca-cert">phase2-ca-cert</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-ca-cert-password<indexterm zone="settings-802-1x"><primary sortas="phase2-ca-cert-password">phase2-ca-cert-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-ca-cert-password-flags<indexterm zone="settings-802-1x"><primary sortas="phase2-ca-cert-password-flags">phase2-ca-cert-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-ca-path<indexterm zone="settings-802-1x"><primary sortas="phase2-ca-path">phase2-ca-path</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-client-cert<indexterm zone="settings-802-1x"><primary sortas="phase2-client-cert">phase2-client-cert</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-client-cert-password<indexterm zone="settings-802-1x"><primary sortas="phase2-client-cert-password">phase2-client-cert-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-client-cert-password-flags<indexterm zone="settings-802-1x"><primary sortas="phase2-client-cert-password-flags">phase2-client-cert-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-domain-match<indexterm zone="settings-802-1x"><primary sortas="phase2-domain-match">phase2-domain-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-domain-suffix-match<indexterm zone="settings-802-1x"><primary sortas="phase2-domain-suffix-match">phase2-domain-suffix-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-private-key<indexterm zone="settings-802-1x"><primary sortas="phase2-private-key">phase2-private-key</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-private-key-password<indexterm zone="settings-802-1x"><primary sortas="phase2-private-key-password">phase2-private-key-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-private-key-password-flags<indexterm zone="settings-802-1x"><primary sortas="phase2-private-key-password-flags">phase2-private-key-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>phase2-subject-match<indexterm zone="settings-802-1x"><primary sortas="phase2-subject-match">phase2-subject-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>pin<indexterm zone="settings-802-1x"><primary sortas="pin">pin</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>pin-flags<indexterm zone="settings-802-1x"><primary sortas="pin-flags">pin-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>private-key<indexterm zone="settings-802-1x"><primary sortas="private-key">private-key</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>private-key-password<indexterm zone="settings-802-1x"><primary sortas="private-key-password">private-key-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>private-key-password-flags<indexterm zone="settings-802-1x"><primary sortas="private-key-password-flags">private-key-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>subject-match<indexterm zone="settings-802-1x"><primary sortas="subject-match">subject-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>system-ca-certs<indexterm zone="settings-802-1x"><primary sortas="system-ca-certs">system-ca-certs</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-adsl"><refnamediv><refname>adsl</refname><refpurpose>ADSL Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-adsl.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>encapsulation<indexterm zone="settings-adsl"><primary sortas="encapsulation">encapsulation</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>password<indexterm zone="settings-adsl"><primary sortas="password">password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>password-flags<indexterm zone="settings-adsl"><primary sortas="password-flags">password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>protocol<indexterm zone="settings-adsl"><primary sortas="protocol">protocol</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>username<indexterm zone="settings-adsl"><primary sortas="username">username</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>vci<indexterm zone="settings-adsl"><primary sortas="vci">vci</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>vpi<indexterm zone="settings-adsl"><primary sortas="vpi">vpi</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-bluetooth"><refnamediv><refname>bluetooth</refname><refpurpose>Bluetooth Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-bluetooth.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>bdaddr<indexterm zone="settings-bluetooth"><primary sortas="bdaddr">bdaddr</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>type<indexterm zone="settings-bluetooth"><primary sortas="type">type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-bond"><refnamediv><refname>bond</refname><refpurpose>Bonding Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-bond.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>interface-name<indexterm zone="settings-bond"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>options<indexterm zone="settings-bond"><primary sortas="options">options</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{'mode': 'balance-rr'}</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-bridge"><refnamediv><refname>bridge</refname><refpurpose>Bridging Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-bridge.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>ageing-time<indexterm zone="settings-bridge"><primary sortas="ageing-time">ageing-time</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>300</screen></entry><entry/></row><row><entry><screen>forward-delay<indexterm zone="settings-bridge"><primary sortas="forward-delay">forward-delay</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>15</screen></entry><entry/></row><row><entry><screen>group-address<indexterm zone="settings-bridge"><primary sortas="group-address">group-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>group-forward-mask<indexterm zone="settings-bridge"><primary sortas="group-forward-mask">group-forward-mask</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>hello-time<indexterm zone="settings-bridge"><primary sortas="hello-time">hello-time</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>2</screen></entry><entry/></row><row><entry><screen>interface-name<indexterm zone="settings-bridge"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mac-address<indexterm zone="settings-bridge"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>max-age<indexterm zone="settings-bridge"><primary sortas="max-age">max-age</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>20</screen></entry><entry/></row><row><entry><screen>multicast-hash-max<indexterm zone="settings-bridge"><primary sortas="multicast-hash-max">multicast-hash-max</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>4096</screen></entry><entry/></row><row><entry><screen>multicast-last-member-count<indexterm zone="settings-bridge"><primary sortas="multicast-last-member-count">multicast-last-member-count</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>2</screen></entry><entry/></row><row><entry><screen>multicast-last-member-interval<indexterm zone="settings-bridge"><primary sortas="multicast-last-member-interval">multicast-last-member-interval</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>100</screen></entry><entry/></row><row><entry><screen>multicast-membership-interval<indexterm zone="settings-bridge"><primary sortas="multicast-membership-interval">multicast-membership-interval</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>26000</screen></entry><entry/></row><row><entry><screen>multicast-querier<indexterm zone="settings-bridge"><primary sortas="multicast-querier">multicast-querier</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>multicast-querier-interval<indexterm zone="settings-bridge"><primary sortas="multicast-querier-interval">multicast-querier-interval</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>25500</screen></entry><entry/></row><row><entry><screen>multicast-query-interval<indexterm zone="settings-bridge"><primary sortas="multicast-query-interval">multicast-query-interval</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>12500</screen></entry><entry/></row><row><entry><screen>multicast-query-response-interval<indexterm zone="settings-bridge"><primary sortas="multicast-query-response-interval">multicast-query-response-interval</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>1000</screen></entry><entry/></row><row><entry><screen>multicast-query-use-ifaddr<indexterm zone="settings-bridge"><primary sortas="multicast-query-use-ifaddr">multicast-query-use-ifaddr</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>multicast-router<indexterm zone="settings-bridge"><primary sortas="multicast-router">multicast-router</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>multicast-snooping<indexterm zone="settings-bridge"><primary sortas="multicast-snooping">multicast-snooping</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>multicast-startup-query-count<indexterm zone="settings-bridge"><primary sortas="multicast-startup-query-count">multicast-startup-query-count</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>2</screen></entry><entry/></row><row><entry><screen>multicast-startup-query-interval<indexterm zone="settings-bridge"><primary sortas="multicast-startup-query-interval">multicast-startup-query-interval</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>3125</screen></entry><entry/></row><row><entry><screen>priority<indexterm zone="settings-bridge"><primary sortas="priority">priority</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>32768</screen></entry><entry/></row><row><entry><screen>stp<indexterm zone="settings-bridge"><primary sortas="stp">stp</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>vlan-default-pvid<indexterm zone="settings-bridge"><primary sortas="vlan-default-pvid">vlan-default-pvid</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry/></row><row><entry><screen>vlan-filtering<indexterm zone="settings-bridge"><primary sortas="vlan-filtering">vlan-filtering</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>vlan-protocol<indexterm zone="settings-bridge"><primary sortas="vlan-protocol">vlan-protocol</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>vlan-stats-enabled<indexterm zone="settings-bridge"><primary sortas="vlan-stats-enabled">vlan-stats-enabled</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>vlans<indexterm zone="settings-bridge"><primary sortas="vlans">vlans</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-bridge-port"><refnamediv><refname>bridge-port</refname><refpurpose>Bridge Port Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-bridge-port.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>hairpin-mode<indexterm zone="settings-bridge-port"><primary sortas="hairpin-mode">hairpin-mode</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>path-cost<indexterm zone="settings-bridge-port"><primary sortas="path-cost">path-cost</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>100</screen></entry><entry/></row><row><entry><screen>priority<indexterm zone="settings-bridge-port"><primary sortas="priority">priority</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>32</screen></entry><entry/></row><row><entry><screen>vlans<indexterm zone="settings-bridge-port"><primary sortas="vlans">vlans</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-cdma"><refnamediv><refname>cdma</refname><refpurpose>CDMA-based Mobile Broadband Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-cdma.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>mtu<indexterm zone="settings-cdma"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>number<indexterm zone="settings-cdma"><primary sortas="number">number</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>password<indexterm zone="settings-cdma"><primary sortas="password">password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>password-flags<indexterm zone="settings-cdma"><primary sortas="password-flags">password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>username<indexterm zone="settings-cdma"><primary sortas="username">username</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-dcb"><refnamediv><refname>dcb</refname><refpurpose>Data Center Bridging Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-dcb.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>app-fcoe-flags<indexterm zone="settings-dcb"><primary sortas="app-fcoe-flags">app-fcoe-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>app-fcoe-mode<indexterm zone="settings-dcb"><primary sortas="app-fcoe-mode">app-fcoe-mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>app-fcoe-priority<indexterm zone="settings-dcb"><primary sortas="app-fcoe-priority">app-fcoe-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>app-fip-flags<indexterm zone="settings-dcb"><primary sortas="app-fip-flags">app-fip-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>app-fip-priority<indexterm zone="settings-dcb"><primary sortas="app-fip-priority">app-fip-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>app-iscsi-flags<indexterm zone="settings-dcb"><primary sortas="app-iscsi-flags">app-iscsi-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>app-iscsi-priority<indexterm zone="settings-dcb"><primary sortas="app-iscsi-priority">app-iscsi-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>priority-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-bandwidth">priority-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>priority-flow-control<indexterm zone="settings-dcb"><primary sortas="priority-flow-control">priority-flow-control</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>priority-flow-control-flags<indexterm zone="settings-dcb"><primary sortas="priority-flow-control-flags">priority-flow-control-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>priority-group-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-group-bandwidth">priority-group-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>priority-group-flags<indexterm zone="settings-dcb"><primary sortas="priority-group-flags">priority-group-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>priority-group-id<indexterm zone="settings-dcb"><primary sortas="priority-group-id">priority-group-id</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>priority-strict-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-strict-bandwidth">priority-strict-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>priority-traffic-class<indexterm zone="settings-dcb"><primary sortas="priority-traffic-class">priority-traffic-class</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-dummy"><refnamediv><refname>dummy</refname><refpurpose>Dummy Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-dummy.properties"> + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>auth-retries<indexterm zone="settings-connection"><primary sortas="auth-retries">auth-retries</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection. + +Currently, this only applies to 802-1x authentication.</entry></row><row><entry><screen>autoconnect<indexterm zone="settings-connection"><primary sortas="autoconnect">autoconnect</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection. + +Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile. + +Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles. + +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><screen>autoconnect-priority<indexterm zone="settings-connection"><primary sortas="autoconnect-priority">autoconnect-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.</entry></row><row><entry><screen>autoconnect-retries<indexterm zone="settings-connection"><primary sortas="autoconnect-retries">autoconnect-retries</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.</entry></row><row><entry><screen>autoconnect-slaves<indexterm zone="settings-connection"><primary sortas="autoconnect-slaves">autoconnect-slaves</primary></indexterm></screen></entry><entry><screen>NMSettingConnectionAutoconnectSlaves (int32)</screen></entry><entry><screen/></entry><entry>Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.</entry></row><row><entry><screen>dns-over-tls<indexterm zone="settings-connection"><primary sortas="dns-over-tls">dns-over-tls</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic. + +The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting. + +This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</entry></row><row><entry><screen>gateway-ping-timeout<indexterm zone="settings-connection"><primary sortas="gateway-ping-timeout">gateway-ping-timeout</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</entry></row><row><entry><screen>id<indexterm zone="settings-connection"><primary sortas="id">id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</entry></row><row><entry><screen>interface-name<indexterm zone="settings-connection"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). + +For software devices this specifies the name of the created device. + +For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.</entry></row><row><entry><screen>lldp<indexterm zone="settings-connection"><primary sortas="lldp">lldp</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Whether LLDP is enabled for the connection.</entry></row><row><entry><screen>llmnr<indexterm zone="settings-connection"><primary sortas="llmnr">llmnr</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link. + +The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes"). + +This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</entry></row><row><entry><screen>master<indexterm zone="settings-connection"><primary sortas="master">master</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Interface name of the master device or UUID of the master connection.</entry></row><row><entry><screen>mdns<indexterm zone="settings-connection"><primary sortas="mdns">mdns</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Whether mDNS is enabled for the connection. + +The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no"). + +This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</entry></row><row><entry><screen>metered<indexterm zone="settings-connection"><primary sortas="metered">metered</primary></indexterm></screen></entry><entry><screen>NMMetered (int32)</screen></entry><entry><screen/></entry><entry>Whether the connection is metered. + +When updating this property on a currently activated connection, the change takes effect immediately.</entry></row><row><entry><screen>mptcp-flags<indexterm zone="settings-connection"><primary sortas="mptcp-flags">mptcp-flags</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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. + +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).</entry></row><row><entry><screen>mud-url<indexterm zone="settings-connection"><primary sortas="mud-url">mud-url</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://". + +The special value "none" is allowed to indicate that no MUD URL is used. + +If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".</entry></row><row><entry><screen>multi-connect<indexterm zone="settings-connection"><primary sortas="multi-connect">multi-connect</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</entry></row><row><entry><screen>permissions<indexterm zone="settings-connection"><primary sortas="permissions">permissions</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". + +At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</entry></row><row><entry><screen>read-only<indexterm zone="settings-connection"><primary sortas="read-only">read-only</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>This property is deprecated and has no meaning.</entry></row><row><entry><screen>secondaries<indexterm zone="settings-connection"><primary sortas="secondaries">secondaries</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</entry></row><row><entry><screen>slave-type<indexterm zone="settings-connection"><primary sortas="slave-type">slave-type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</entry></row><row><entry><screen>stable-id<indexterm zone="settings-connection"><primary sortas="stable-id">stable-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context. + +The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used to derive the DHCP client identifier with ipv4.dhcp-client-id=stable, the DHCPv6 DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid] and the DHCP IAID with ipv4.iaid=stable and ipv6.iaid=stable. + +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 activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. The "${CONNECTION}" uses the profile's connection.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" 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 "default${CONNECTION}" go generate an ID unique per connection profile.</entry></row><row><entry><screen>timestamp<indexterm zone="settings-connection"><primary sortas="timestamp">timestamp</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>0</screen></entry><entry>The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. + +NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).</entry></row><row><entry><screen>type<indexterm zone="settings-connection"><primary sortas="type">type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).</entry></row><row><entry><screen>uuid<indexterm zone="settings-connection"><primary sortas="uuid">uuid</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. + +The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").</entry></row><row><entry><screen>wait-activation-delay<indexterm zone="settings-connection"><primary sortas="wait-activation-delay">wait-activation-delay</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></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><screen>wait-device-timeout<indexterm zone="settings-connection"><primary sortas="wait-device-timeout">wait-device-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed. + +The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</entry></row><row><entry><screen>zone<indexterm zone="settings-connection"><primary sortas="zone">zone</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. + +When updating this property on a currently activated connection, the change takes effect immediately.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-6lowpan"><refnamediv><refname>6lowpan</refname><refpurpose>6LoWPAN Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-6lowpan.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>parent<indexterm zone="settings-6lowpan"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-1x"><refnamediv><refname>802-1x</refname><refpurpose>IEEE 802.1x Authentication Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-1x.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>altsubject-matches<indexterm zone="settings-802-1x"><primary sortas="altsubject-matches">altsubject-matches</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</entry></row><row><entry><screen>anonymous-identity<indexterm zone="settings-802-1x"><primary sortas="anonymous-identity">anonymous-identity</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</entry></row><row><entry><screen>auth-timeout<indexterm zone="settings-802-1x"><primary sortas="auth-timeout">auth-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></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><screen>ca-cert<indexterm zone="settings-802-1x"><primary sortas="ca-cert">ca-cert</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><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. + +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><screen>ca-cert-password<indexterm zone="settings-802-1x"><primary sortas="ca-cert-password">ca-cert-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>ca-cert-password-flags<indexterm zone="settings-802-1x"><primary sortas="ca-cert-password-flags">ca-cert-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "ca-cert-password" property.</entry></row><row><entry><screen>ca-path<indexterm zone="settings-802-1x"><primary sortas="ca-path">ca-path</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property. + +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><screen>client-cert<indexterm zone="settings-802-1x"><primary sortas="client-cert">client-cert</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>Contains the client certificate if used by the EAP method specified in the "eap" property. + +Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.</entry></row><row><entry><screen>client-cert-password<indexterm zone="settings-802-1x"><primary sortas="client-cert-password">client-cert-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</entry></row><row><entry><screen>client-cert-password-flags<indexterm zone="settings-802-1x"><primary sortas="client-cert-password-flags">client-cert-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "client-cert-password" property.</entry></row><row><entry><screen>domain-match<indexterm zone="settings-802-1x"><primary sortas="domain-match">domain-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.</entry></row><row><entry><screen>domain-suffix-match<indexterm zone="settings-802-1x"><primary sortas="domain-suffix-match">domain-suffix-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.</entry></row><row><entry><screen>eap<indexterm zone="settings-802-1x"><primary sortas="eap">eap</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.</entry></row><row><entry><screen>identity<indexterm zone="settings-802-1x"><primary sortas="identity">identity</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Identity string for EAP authentication methods. Often the user's user or login name.</entry></row><row><entry><screen>optional<indexterm zone="settings-802-1x"><primary sortas="optional">optional</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Whether the 802.1X authentication is optional. If TRUE, the activation will continue even after a timeout or an authentication failure. Setting the property to TRUE is currently allowed only for Ethernet connections. If set to FALSE, the activation can continue only after a successful authentication.</entry></row><row><entry><screen>pac-file<indexterm zone="settings-802-1x"><primary sortas="pac-file">pac-file</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>UTF-8 encoded file path containing PAC for EAP-FAST.</entry></row><row><entry><screen>password<indexterm zone="settings-802-1x"><primary sortas="password">password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>password-flags<indexterm zone="settings-802-1x"><primary sortas="password-flags">password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry><screen>password-raw<indexterm zone="settings-802-1x"><primary sortas="password-raw">password-raw</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><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><screen>password-raw-flags<indexterm zone="settings-802-1x"><primary sortas="password-raw-flags">password-raw-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "password-raw" property.</entry></row><row><entry><screen>phase1-auth-flags<indexterm zone="settings-802-1x"><primary sortas="phase1-auth-flags">phase1-auth-flags</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>phase1-fast-provisioning<indexterm zone="settings-802-1x"><primary sortas="phase1-fast-provisioning">phase1-fast-provisioning</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>phase1-peaplabel<indexterm zone="settings-802-1x"><primary sortas="phase1-peaplabel">phase1-peaplabel</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</entry></row><row><entry><screen>phase1-peapver<indexterm zone="settings-802-1x"><primary sortas="phase1-peapver">phase1-peapver</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>phase2-altsubject-matches<indexterm zone="settings-802-1x"><primary sortas="phase2-altsubject-matches">phase2-altsubject-matches</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><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><screen>phase2-auth<indexterm zone="settings-802-1x"><primary sortas="phase2-auth">phase2-auth</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>phase2-autheap<indexterm zone="settings-802-1x"><primary sortas="phase2-autheap">phase2-autheap</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>phase2-ca-cert<indexterm zone="settings-802-1x"><primary sortas="phase2-ca-cert">phase2-ca-cert</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. + +Certificate data is specified using a "scheme"; 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><screen>phase2-ca-cert-password<indexterm zone="settings-802-1x"><primary sortas="phase2-ca-cert-password">phase2-ca-cert-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>phase2-ca-cert-password-flags<indexterm zone="settings-802-1x"><primary sortas="phase2-ca-cert-password-flags">phase2-ca-cert-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "phase2-ca-cert-password" property.</entry></row><row><entry><screen>phase2-ca-path<indexterm zone="settings-802-1x"><primary sortas="phase2-ca-path">phase2-ca-path</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property. + +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><screen>phase2-client-cert<indexterm zone="settings-802-1x"><primary sortas="phase2-client-cert">phase2-client-cert</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. + +Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</entry></row><row><entry><screen>phase2-client-cert-password<indexterm zone="settings-802-1x"><primary sortas="phase2-client-cert-password">phase2-client-cert-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</entry></row><row><entry><screen>phase2-client-cert-password-flags<indexterm zone="settings-802-1x"><primary sortas="phase2-client-cert-password-flags">phase2-client-cert-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "phase2-client-cert-password" property.</entry></row><row><entry><screen>phase2-domain-match<indexterm zone="settings-802-1x"><primary sortas="phase2-domain-match">phase2-domain-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.</entry></row><row><entry><screen>phase2-domain-suffix-match<indexterm zone="settings-802-1x"><primary sortas="phase2-domain-suffix-match">phase2-domain-suffix-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.</entry></row><row><entry><screen>phase2-private-key<indexterm zone="settings-802-1x"><primary sortas="phase2-private-key">phase2-private-key</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". + +Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</entry></row><row><entry><screen>phase2-private-key-password<indexterm zone="settings-802-1x"><primary sortas="phase2-private-key-password">phase2-private-key-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.</entry></row><row><entry><screen>phase2-private-key-password-flags<indexterm zone="settings-802-1x"><primary sortas="phase2-private-key-password-flags">phase2-private-key-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "phase2-private-key-password" property.</entry></row><row><entry><screen>phase2-subject-match<indexterm zone="settings-802-1x"><primary sortas="phase2-subject-match">phase2-subject-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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.</entry></row><row><entry><screen>pin<indexterm zone="settings-802-1x"><primary sortas="pin">pin</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>PIN used for EAP authentication methods.</entry></row><row><entry><screen>pin-flags<indexterm zone="settings-802-1x"><primary sortas="pin-flags">pin-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "pin" property.</entry></row><row><entry><screen>private-key<indexterm zone="settings-802-1x"><primary sortas="private-key">private-key</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>Contains the private key when the "eap" property is set to "tls". + +Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating 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.</entry></row><row><entry><screen>private-key-password<indexterm zone="settings-802-1x"><primary sortas="private-key-password">private-key-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</entry></row><row><entry><screen>private-key-password-flags<indexterm zone="settings-802-1x"><primary sortas="private-key-password-flags">private-key-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "private-key-password" property.</entry></row><row><entry><screen>subject-match<indexterm zone="settings-802-1x"><primary sortas="subject-match">subject-match</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.</entry></row><row><entry><screen>system-ca-certs<indexterm zone="settings-802-1x"><primary sortas="system-ca-certs">system-ca-certs</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></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></table></para></refsect1></refentry><refentry id="settings-adsl"><refnamediv><refname>adsl</refname><refpurpose>ADSL Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-adsl.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>encapsulation<indexterm zone="settings-adsl"><primary sortas="encapsulation">encapsulation</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Encapsulation of ADSL connection. Can be "vcmux" or "llc".</entry></row><row><entry><screen>password<indexterm zone="settings-adsl"><primary sortas="password">password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Password used to authenticate with the ADSL service.</entry></row><row><entry><screen>password-flags<indexterm zone="settings-adsl"><primary sortas="password-flags">password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry><screen>protocol<indexterm zone="settings-adsl"><primary sortas="protocol">protocol</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</entry></row><row><entry><screen>username<indexterm zone="settings-adsl"><primary sortas="username">username</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Username used to authenticate with the ADSL service.</entry></row><row><entry><screen>vci<indexterm zone="settings-adsl"><primary sortas="vci">vci</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>VCI of ADSL connection</entry></row><row><entry><screen>vpi<indexterm zone="settings-adsl"><primary sortas="vpi">vpi</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>VPI of ADSL connection</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-bluetooth"><refnamediv><refname>bluetooth</refname><refpurpose>Bluetooth Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-bluetooth.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>bdaddr<indexterm zone="settings-bluetooth"><primary sortas="bdaddr">bdaddr</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>The Bluetooth address of the device.</entry></row><row><entry><screen>type<indexterm zone="settings-bluetooth"><primary sortas="type">type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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></table></para></refsect1></refentry><refentry id="settings-bond"><refnamediv><refname>bond</refname><refpurpose>Bonding Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-bond.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>interface-name<indexterm zone="settings-bond"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.</entry></row><row><entry><screen>options<indexterm zone="settings-bond"><primary sortas="options">options</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{'mode': 'balance-rr'}</screen></entry><entry>Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-bridge"><refnamediv><refname>bridge</refname><refpurpose>Bridging Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-bridge.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>ageing-time<indexterm zone="settings-bridge"><primary sortas="ageing-time">ageing-time</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>300</screen></entry><entry>The Ethernet MAC address aging time, in seconds.</entry></row><row><entry><screen>forward-delay<indexterm zone="settings-bridge"><primary sortas="forward-delay">forward-delay</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>15</screen></entry><entry>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</entry></row><row><entry><screen>group-address<indexterm zone="settings-bridge"><primary sortas="group-address">group-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, The MAC address of the multicast group this bridge uses for STP. + +The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.</entry></row><row><entry><screen>group-forward-mask<indexterm zone="settings-bridge"><primary sortas="group-forward-mask">group-forward-mask</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.</entry></row><row><entry><screen>hello-time<indexterm zone="settings-bridge"><primary sortas="hello-time">hello-time</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>2</screen></entry><entry>The Spanning Tree Protocol (STP) hello time, in seconds.</entry></row><row><entry><screen>interface-name<indexterm zone="settings-bridge"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name.</entry></row><row><entry><screen>mac-address<indexterm zone="settings-bridge"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. + +If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge.</entry></row><row><entry><screen>max-age<indexterm zone="settings-bridge"><primary sortas="max-age">max-age</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>20</screen></entry><entry>The Spanning Tree Protocol (STP) maximum message age, in seconds.</entry></row><row><entry><screen>multicast-hash-max<indexterm zone="settings-bridge"><primary sortas="multicast-hash-max">multicast-hash-max</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>4096</screen></entry><entry>Set maximum size of multicast hash table (value must be a power of 2).</entry></row><row><entry><screen>multicast-last-member-count<indexterm zone="settings-bridge"><primary sortas="multicast-last-member-count">multicast-last-member-count</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>2</screen></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><screen>multicast-last-member-interval<indexterm zone="settings-bridge"><primary sortas="multicast-last-member-interval">multicast-last-member-interval</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>100</screen></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><screen>multicast-membership-interval<indexterm zone="settings-bridge"><primary sortas="multicast-membership-interval">multicast-membership-interval</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>26000</screen></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><screen>multicast-querier<indexterm zone="settings-bridge"><primary sortas="multicast-querier">multicast-querier</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</entry></row><row><entry><screen>multicast-querier-interval<indexterm zone="settings-bridge"><primary sortas="multicast-querier-interval">multicast-querier-interval</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>25500</screen></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><screen>multicast-query-interval<indexterm zone="settings-bridge"><primary sortas="multicast-query-interval">multicast-query-interval</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>12500</screen></entry><entry>Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</entry></row><row><entry><screen>multicast-query-response-interval<indexterm zone="settings-bridge"><primary sortas="multicast-query-response-interval">multicast-query-response-interval</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>1000</screen></entry><entry>Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</entry></row><row><entry><screen>multicast-query-use-ifaddr<indexterm zone="settings-bridge"><primary sortas="multicast-query-use-ifaddr">multicast-query-use-ifaddr</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.</entry></row><row><entry><screen>multicast-router<indexterm zone="settings-bridge"><primary sortas="multicast-router">multicast-router</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work. + +Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).</entry></row><row><entry><screen>multicast-snooping<indexterm zone="settings-bridge"><primary sortas="multicast-snooping">multicast-snooping</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.</entry></row><row><entry><screen>multicast-startup-query-count<indexterm zone="settings-bridge"><primary sortas="multicast-startup-query-count">multicast-startup-query-count</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>2</screen></entry><entry>Set the number of IGMP queries to send during startup phase.</entry></row><row><entry><screen>multicast-startup-query-interval<indexterm zone="settings-bridge"><primary sortas="multicast-startup-query-interval">multicast-startup-query-interval</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>3125</screen></entry><entry>Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</entry></row><row><entry><screen>priority<indexterm zone="settings-bridge"><primary sortas="priority">priority</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>32768</screen></entry><entry>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</entry></row><row><entry><screen>stp<indexterm zone="settings-bridge"><primary sortas="stp">stp</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</entry></row><row><entry><screen>vlan-default-pvid<indexterm zone="settings-bridge"><primary sortas="vlan-default-pvid">vlan-default-pvid</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry>The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.</entry></row><row><entry><screen>vlan-filtering<indexterm zone="settings-bridge"><primary sortas="vlan-filtering">vlan-filtering</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Control whether VLAN filtering is enabled on the bridge.</entry></row><row><entry><screen>vlan-protocol<indexterm zone="settings-bridge"><primary sortas="vlan-protocol">vlan-protocol</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If specified, the protocol used for VLAN filtering. + +Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</entry></row><row><entry><screen>vlan-stats-enabled<indexterm zone="settings-bridge"><primary sortas="vlan-stats-enabled">vlan-stats-enabled</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Controls whether per-VLAN stats accounting is enabled.</entry></row><row><entry><screen>vlans<indexterm zone="settings-bridge"><primary sortas="vlans">vlans</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property. + +In nmcli the VLAN list can be specified with the following syntax: + +$vid [pvid] [untagged] [, $vid [pvid] [untagged]]... + +where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-bridge-port"><refnamediv><refname>bridge-port</refname><refpurpose>Bridge Port Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-bridge-port.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>hairpin-mode<indexterm zone="settings-bridge-port"><primary sortas="hairpin-mode">hairpin-mode</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></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><screen>path-cost<indexterm zone="settings-bridge-port"><primary sortas="path-cost">path-cost</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>100</screen></entry><entry>The Spanning Tree Protocol (STP) port cost for destinations via this port.</entry></row><row><entry><screen>priority<indexterm zone="settings-bridge-port"><primary sortas="priority">priority</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>32</screen></entry><entry>The Spanning Tree Protocol (STP) priority of this bridge port.</entry></row><row><entry><screen>vlans<indexterm zone="settings-bridge-port"><primary sortas="vlans">vlans</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>Array of bridge VLAN objects. In addition to the VLANs specified here, the 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.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-cdma"><refnamediv><refname>cdma</refname><refpurpose>CDMA-based Mobile Broadband Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-cdma.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>mtu<indexterm zone="settings-cdma"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry><screen>number<indexterm zone="settings-cdma"><primary sortas="number">number</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.</entry></row><row><entry><screen>password<indexterm zone="settings-cdma"><primary sortas="password">password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.</entry></row><row><entry><screen>password-flags<indexterm zone="settings-cdma"><primary sortas="password-flags">password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry><screen>username<indexterm zone="settings-cdma"><primary sortas="username">username</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-dcb"><refnamediv><refname>dcb</refname><refpurpose>Data Center Bridging Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-dcb.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>app-fcoe-flags<indexterm zone="settings-dcb"><primary sortas="app-fcoe-flags">app-fcoe-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>app-fcoe-mode<indexterm zone="settings-dcb"><primary sortas="app-fcoe-mode">app-fcoe-mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The FCoE controller mode; either "fabric" or "vn2vn". + +Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".</entry></row><row><entry><screen>app-fcoe-priority<indexterm zone="settings-dcb"><primary sortas="app-fcoe-priority">app-fcoe-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry><screen>app-fip-flags<indexterm zone="settings-dcb"><primary sortas="app-fip-flags">app-fip-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>app-fip-priority<indexterm zone="settings-dcb"><primary sortas="app-fip-priority">app-fip-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry><screen>app-iscsi-flags<indexterm zone="settings-dcb"><primary sortas="app-iscsi-flags">app-iscsi-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>app-iscsi-priority<indexterm zone="settings-dcb"><primary sortas="app-iscsi-priority">app-iscsi-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry><screen>priority-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-bandwidth">priority-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.</entry></row><row><entry><screen>priority-flow-control<indexterm zone="settings-dcb"><primary sortas="priority-flow-control">priority-flow-control</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.</entry></row><row><entry><screen>priority-flow-control-flags<indexterm zone="settings-dcb"><primary sortas="priority-flow-control-flags">priority-flow-control-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>priority-group-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-group-bandwidth">priority-group-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.</entry></row><row><entry><screen>priority-group-flags<indexterm zone="settings-dcb"><primary sortas="priority-group-flags">priority-group-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry><screen>priority-group-id<indexterm zone="settings-dcb"><primary sortas="priority-group-id">priority-group-id</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.</entry></row><row><entry><screen>priority-strict-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-strict-bandwidth">priority-strict-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.</entry></row><row><entry><screen>priority-traffic-class<indexterm zone="settings-dcb"><primary sortas="priority-traffic-class">priority-traffic-class</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-dummy"><refnamediv><refname>dummy</refname><refpurpose>Dummy Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-dummy.properties"> Properties </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody/></tgroup></table></para></refsect1></refentry><refentry id="settings-ethtool"><refnamediv><refname>ethtool</refname><refpurpose>Ethtool Ethernet Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ethtool.properties"> Properties @@ -28,84 +140,398 @@ Properties </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody/></tgroup></table></para></refsect1></refentry><refentry id="settings-gsm"><refnamediv><refname>gsm</refname><refpurpose>GSM-based Mobile Broadband Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-gsm.properties"> Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>apn<indexterm zone="settings-gsm"><primary sortas="apn">apn</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>auto-config<indexterm zone="settings-gsm"><primary sortas="auto-config">auto-config</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>device-id<indexterm zone="settings-gsm"><primary sortas="device-id">device-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>home-only<indexterm zone="settings-gsm"><primary sortas="home-only">home-only</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>mtu<indexterm zone="settings-gsm"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>network-id<indexterm zone="settings-gsm"><primary sortas="network-id">network-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>number<indexterm zone="settings-gsm"><primary sortas="number">number</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>password<indexterm zone="settings-gsm"><primary sortas="password">password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>password-flags<indexterm zone="settings-gsm"><primary sortas="password-flags">password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>pin<indexterm zone="settings-gsm"><primary sortas="pin">pin</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>pin-flags<indexterm zone="settings-gsm"><primary sortas="pin-flags">pin-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>sim-id<indexterm zone="settings-gsm"><primary sortas="sim-id">sim-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>sim-operator-id<indexterm zone="settings-gsm"><primary sortas="sim-operator-id">sim-operator-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>username<indexterm zone="settings-gsm"><primary sortas="username">username</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-infiniband"><refnamediv><refname>infiniband</refname><refpurpose>Infiniband Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-infiniband.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>mac-address<indexterm zone="settings-infiniband"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mtu<indexterm zone="settings-infiniband"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>p-key<indexterm zone="settings-infiniband"><primary sortas="p-key">p-key</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>parent<indexterm zone="settings-infiniband"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>transport-mode<indexterm zone="settings-infiniband"><primary sortas="transport-mode">transport-mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ipv4"><refnamediv><refname>ipv4</refname><refpurpose>IPv4 Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ipv4.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>address-data<indexterm zone="settings-ipv4"><primary sortas="address-data">address-data</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>addresses<indexterm zone="settings-ipv4"><primary sortas="addresses">addresses</primary></indexterm></screen></entry><entry><screen>array of array of uint32</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>auto-route-ext-gw<indexterm zone="settings-ipv4"><primary sortas="auto-route-ext-gw">auto-route-ext-gw</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dad-timeout<indexterm zone="settings-ipv4"><primary sortas="dad-timeout">dad-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>dhcp-client-id<indexterm zone="settings-ipv4"><primary sortas="dhcp-client-id">dhcp-client-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dhcp-fqdn<indexterm zone="settings-ipv4"><primary sortas="dhcp-fqdn">dhcp-fqdn</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dhcp-hostname<indexterm zone="settings-ipv4"><primary sortas="dhcp-hostname">dhcp-hostname</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dhcp-hostname-flags<indexterm zone="settings-ipv4"><primary sortas="dhcp-hostname-flags">dhcp-hostname-flags</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>dhcp-iaid<indexterm zone="settings-ipv4"><primary sortas="dhcp-iaid">dhcp-iaid</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dhcp-reject-servers<indexterm zone="settings-ipv4"><primary sortas="dhcp-reject-servers">dhcp-reject-servers</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dhcp-send-hostname<indexterm zone="settings-ipv4"><primary sortas="dhcp-send-hostname">dhcp-send-hostname</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>dhcp-timeout<indexterm zone="settings-ipv4"><primary sortas="dhcp-timeout">dhcp-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>dhcp-vendor-class-identifier<indexterm zone="settings-ipv4"><primary sortas="dhcp-vendor-class-identifier">dhcp-vendor-class-identifier</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dns<indexterm zone="settings-ipv4"><primary sortas="dns">dns</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dns-data<indexterm zone="settings-ipv4"><primary sortas="dns-data">dns-data</primary></indexterm></screen></entry><entry><screen>array of strings</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dns-options<indexterm zone="settings-ipv4"><primary sortas="dns-options">dns-options</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dns-priority<indexterm zone="settings-ipv4"><primary sortas="dns-priority">dns-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>dns-search<indexterm zone="settings-ipv4"><primary sortas="dns-search">dns-search</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>gateway<indexterm zone="settings-ipv4"><primary sortas="gateway">gateway</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>ignore-auto-dns<indexterm zone="settings-ipv4"><primary sortas="ignore-auto-dns">ignore-auto-dns</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>ignore-auto-routes<indexterm zone="settings-ipv4"><primary sortas="ignore-auto-routes">ignore-auto-routes</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>link-local<indexterm zone="settings-ipv4"><primary sortas="link-local">link-local</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>may-fail<indexterm zone="settings-ipv4"><primary sortas="may-fail">may-fail</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>method<indexterm zone="settings-ipv4"><primary sortas="method">method</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>never-default<indexterm zone="settings-ipv4"><primary sortas="never-default">never-default</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>replace-local-rule<indexterm zone="settings-ipv4"><primary sortas="replace-local-rule">replace-local-rule</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>required-timeout<indexterm zone="settings-ipv4"><primary sortas="required-timeout">required-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>route-data<indexterm zone="settings-ipv4"><primary sortas="route-data">route-data</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>route-metric<indexterm zone="settings-ipv4"><primary sortas="route-metric">route-metric</primary></indexterm></screen></entry><entry><screen>int64</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>route-table<indexterm zone="settings-ipv4"><primary sortas="route-table">route-table</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>routes<indexterm zone="settings-ipv4"><primary sortas="routes">routes</primary></indexterm></screen></entry><entry><screen>array of array of uint32</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>routing-rules<indexterm zone="settings-ipv4"><primary sortas="routing-rules">routing-rules</primary></indexterm></screen></entry><entry><screen>array of 'a{sv}'</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ipv6"><refnamediv><refname>ipv6</refname><refpurpose>IPv6 Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ipv6.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>addr-gen-mode<indexterm zone="settings-ipv6"><primary sortas="addr-gen-mode">addr-gen-mode</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>3</screen></entry><entry/></row><row><entry><screen>address-data<indexterm zone="settings-ipv6"><primary sortas="address-data">address-data</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>addresses<indexterm zone="settings-ipv6"><primary sortas="addresses">addresses</primary></indexterm></screen></entry><entry><screen>array of legacy IPv6 address struct (a(ayuay))</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>auto-route-ext-gw<indexterm zone="settings-ipv6"><primary sortas="auto-route-ext-gw">auto-route-ext-gw</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dad-timeout<indexterm zone="settings-ipv6"><primary sortas="dad-timeout">dad-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>dhcp-duid<indexterm zone="settings-ipv6"><primary sortas="dhcp-duid">dhcp-duid</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dhcp-hostname<indexterm zone="settings-ipv6"><primary sortas="dhcp-hostname">dhcp-hostname</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dhcp-hostname-flags<indexterm zone="settings-ipv6"><primary sortas="dhcp-hostname-flags">dhcp-hostname-flags</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>dhcp-iaid<indexterm zone="settings-ipv6"><primary sortas="dhcp-iaid">dhcp-iaid</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dhcp-reject-servers<indexterm zone="settings-ipv6"><primary sortas="dhcp-reject-servers">dhcp-reject-servers</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dhcp-send-hostname<indexterm zone="settings-ipv6"><primary sortas="dhcp-send-hostname">dhcp-send-hostname</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>dhcp-timeout<indexterm zone="settings-ipv6"><primary sortas="dhcp-timeout">dhcp-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>dns<indexterm zone="settings-ipv6"><primary sortas="dns">dns</primary></indexterm></screen></entry><entry><screen>array of byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dns-data<indexterm zone="settings-ipv6"><primary sortas="dns-data">dns-data</primary></indexterm></screen></entry><entry><screen>array of strings</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dns-options<indexterm zone="settings-ipv6"><primary sortas="dns-options">dns-options</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>dns-priority<indexterm zone="settings-ipv6"><primary sortas="dns-priority">dns-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>dns-search<indexterm zone="settings-ipv6"><primary sortas="dns-search">dns-search</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>gateway<indexterm zone="settings-ipv6"><primary sortas="gateway">gateway</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>ignore-auto-dns<indexterm zone="settings-ipv6"><primary sortas="ignore-auto-dns">ignore-auto-dns</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>ignore-auto-routes<indexterm zone="settings-ipv6"><primary sortas="ignore-auto-routes">ignore-auto-routes</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>ip6-privacy<indexterm zone="settings-ipv6"><primary sortas="ip6-privacy">ip6-privacy</primary></indexterm></screen></entry><entry><screen>NMSettingIP6ConfigPrivacy (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>may-fail<indexterm zone="settings-ipv6"><primary sortas="may-fail">may-fail</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>method<indexterm zone="settings-ipv6"><primary sortas="method">method</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mtu<indexterm zone="settings-ipv6"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>never-default<indexterm zone="settings-ipv6"><primary sortas="never-default">never-default</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>ra-timeout<indexterm zone="settings-ipv6"><primary sortas="ra-timeout">ra-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>replace-local-rule<indexterm zone="settings-ipv6"><primary sortas="replace-local-rule">replace-local-rule</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>required-timeout<indexterm zone="settings-ipv6"><primary sortas="required-timeout">required-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>route-data<indexterm zone="settings-ipv6"><primary sortas="route-data">route-data</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>route-metric<indexterm zone="settings-ipv6"><primary sortas="route-metric">route-metric</primary></indexterm></screen></entry><entry><screen>int64</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>route-table<indexterm zone="settings-ipv6"><primary sortas="route-table">route-table</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>routes<indexterm zone="settings-ipv6"><primary sortas="routes">routes</primary></indexterm></screen></entry><entry><screen>array of legacy IPv6 route struct (a(ayuayu))</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>routing-rules<indexterm zone="settings-ipv6"><primary sortas="routing-rules">routing-rules</primary></indexterm></screen></entry><entry><screen>array of 'a{sv}'</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>token<indexterm zone="settings-ipv6"><primary sortas="token">token</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ip-tunnel"><refnamediv><refname>ip-tunnel</refname><refpurpose>IP Tunneling Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ip-tunnel.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>encapsulation-limit<indexterm zone="settings-ip-tunnel"><primary sortas="encapsulation-limit">encapsulation-limit</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>flags<indexterm zone="settings-ip-tunnel"><primary sortas="flags">flags</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>flow-label<indexterm zone="settings-ip-tunnel"><primary sortas="flow-label">flow-label</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>fwmark<indexterm zone="settings-ip-tunnel"><primary sortas="fwmark">fwmark</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>input-key<indexterm zone="settings-ip-tunnel"><primary sortas="input-key">input-key</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>local<indexterm zone="settings-ip-tunnel"><primary sortas="local">local</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mode<indexterm zone="settings-ip-tunnel"><primary sortas="mode">mode</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>mtu<indexterm zone="settings-ip-tunnel"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>output-key<indexterm zone="settings-ip-tunnel"><primary sortas="output-key">output-key</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>parent<indexterm zone="settings-ip-tunnel"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>path-mtu-discovery<indexterm zone="settings-ip-tunnel"><primary sortas="path-mtu-discovery">path-mtu-discovery</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>remote<indexterm zone="settings-ip-tunnel"><primary sortas="remote">remote</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>tos<indexterm zone="settings-ip-tunnel"><primary sortas="tos">tos</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>ttl<indexterm zone="settings-ip-tunnel"><primary sortas="ttl">ttl</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-macsec"><refnamediv><refname>macsec</refname><refpurpose>MACSec Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-macsec.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>encrypt<indexterm zone="settings-macsec"><primary sortas="encrypt">encrypt</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>mka-cak<indexterm zone="settings-macsec"><primary sortas="mka-cak">mka-cak</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mka-cak-flags<indexterm zone="settings-macsec"><primary sortas="mka-cak-flags">mka-cak-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mka-ckn<indexterm zone="settings-macsec"><primary sortas="mka-ckn">mka-ckn</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mode<indexterm zone="settings-macsec"><primary sortas="mode">mode</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>parent<indexterm zone="settings-macsec"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>port<indexterm zone="settings-macsec"><primary sortas="port">port</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>1</screen></entry><entry/></row><row><entry><screen>send-sci<indexterm zone="settings-macsec"><primary sortas="send-sci">send-sci</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>validation<indexterm zone="settings-macsec"><primary sortas="validation">validation</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>2</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-macvlan"><refnamediv><refname>macvlan</refname><refpurpose>MAC VLAN Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-macvlan.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>mode<indexterm zone="settings-macvlan"><primary sortas="mode">mode</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>parent<indexterm zone="settings-macvlan"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>promiscuous<indexterm zone="settings-macvlan"><primary sortas="promiscuous">promiscuous</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>tap<indexterm zone="settings-macvlan"><primary sortas="tap">tap</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-match"><refnamediv><refname>match</refname><refpurpose>Match settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-match.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>driver<indexterm zone="settings-match"><primary sortas="driver">driver</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>interface-name<indexterm zone="settings-match"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>kernel-command-line<indexterm zone="settings-match"><primary sortas="kernel-command-line">kernel-command-line</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>path<indexterm zone="settings-match"><primary sortas="path">path</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-11-olpc-mesh"><refnamediv><refname>802-11-olpc-mesh</refname><refpurpose>OLPC Wireless Mesh Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-11-olpc-mesh.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>channel<indexterm zone="settings-802-11-olpc-mesh"><primary sortas="channel">channel</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>dhcp-anycast-address<indexterm zone="settings-802-11-olpc-mesh"><primary sortas="dhcp-anycast-address">dhcp-anycast-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>ssid<indexterm zone="settings-802-11-olpc-mesh"><primary sortas="ssid">ssid</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ovs-bridge"><refnamediv><refname>ovs-bridge</refname><refpurpose>OvsBridge Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-bridge.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>datapath-type<indexterm zone="settings-ovs-bridge"><primary sortas="datapath-type">datapath-type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>fail-mode<indexterm zone="settings-ovs-bridge"><primary sortas="fail-mode">fail-mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mcast-snooping-enable<indexterm zone="settings-ovs-bridge"><primary sortas="mcast-snooping-enable">mcast-snooping-enable</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>rstp-enable<indexterm zone="settings-ovs-bridge"><primary sortas="rstp-enable">rstp-enable</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>stp-enable<indexterm zone="settings-ovs-bridge"><primary sortas="stp-enable">stp-enable</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ovs-dpdk"><refnamediv><refname>ovs-dpdk</refname><refpurpose>OvsDpdk Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-dpdk.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>devargs<indexterm zone="settings-ovs-dpdk"><primary sortas="devargs">devargs</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>n-rxq<indexterm zone="settings-ovs-dpdk"><primary sortas="n-rxq">n-rxq</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>n-rxq-desc<indexterm zone="settings-ovs-dpdk"><primary sortas="n-rxq-desc">n-rxq-desc</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>n-txq-desc<indexterm zone="settings-ovs-dpdk"><primary sortas="n-txq-desc">n-txq-desc</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ovs-interface"><refnamediv><refname>ovs-interface</refname><refpurpose>Open vSwitch Interface Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-interface.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>ofport-request<indexterm zone="settings-ovs-interface"><primary sortas="ofport-request">ofport-request</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>type<indexterm zone="settings-ovs-interface"><primary sortas="type">type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ovs-patch"><refnamediv><refname>ovs-patch</refname><refpurpose>OvsPatch Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-patch.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>peer<indexterm zone="settings-ovs-patch"><primary sortas="peer">peer</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ovs-port"><refnamediv><refname>ovs-port</refname><refpurpose>OvsPort Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-port.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>bond-downdelay<indexterm zone="settings-ovs-port"><primary sortas="bond-downdelay">bond-downdelay</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>bond-mode<indexterm zone="settings-ovs-port"><primary sortas="bond-mode">bond-mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>bond-updelay<indexterm zone="settings-ovs-port"><primary sortas="bond-updelay">bond-updelay</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>lacp<indexterm zone="settings-ovs-port"><primary sortas="lacp">lacp</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>tag<indexterm zone="settings-ovs-port"><primary sortas="tag">tag</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>trunks<indexterm zone="settings-ovs-port"><primary sortas="trunks">trunks</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>vlan-mode<indexterm zone="settings-ovs-port"><primary sortas="vlan-mode">vlan-mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ppp"><refnamediv><refname>ppp</refname><refpurpose>Point-to-Point Protocol Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ppp.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>baud<indexterm zone="settings-ppp"><primary sortas="baud">baud</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>crtscts<indexterm zone="settings-ppp"><primary sortas="crtscts">crtscts</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>lcp-echo-failure<indexterm zone="settings-ppp"><primary sortas="lcp-echo-failure">lcp-echo-failure</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>lcp-echo-interval<indexterm zone="settings-ppp"><primary sortas="lcp-echo-interval">lcp-echo-interval</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>mppe-stateful<indexterm zone="settings-ppp"><primary sortas="mppe-stateful">mppe-stateful</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>mru<indexterm zone="settings-ppp"><primary sortas="mru">mru</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>mtu<indexterm zone="settings-ppp"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>no-vj-comp<indexterm zone="settings-ppp"><primary sortas="no-vj-comp">no-vj-comp</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>noauth<indexterm zone="settings-ppp"><primary sortas="noauth">noauth</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>nobsdcomp<indexterm zone="settings-ppp"><primary sortas="nobsdcomp">nobsdcomp</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>nodeflate<indexterm zone="settings-ppp"><primary sortas="nodeflate">nodeflate</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>refuse-chap<indexterm zone="settings-ppp"><primary sortas="refuse-chap">refuse-chap</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>refuse-eap<indexterm zone="settings-ppp"><primary sortas="refuse-eap">refuse-eap</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>refuse-mschap<indexterm zone="settings-ppp"><primary sortas="refuse-mschap">refuse-mschap</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>refuse-mschapv2<indexterm zone="settings-ppp"><primary sortas="refuse-mschapv2">refuse-mschapv2</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>refuse-pap<indexterm zone="settings-ppp"><primary sortas="refuse-pap">refuse-pap</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>require-mppe<indexterm zone="settings-ppp"><primary sortas="require-mppe">require-mppe</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>require-mppe-128<indexterm zone="settings-ppp"><primary sortas="require-mppe-128">require-mppe-128</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-pppoe"><refnamediv><refname>pppoe</refname><refpurpose>PPP-over-Ethernet Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-pppoe.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>parent<indexterm zone="settings-pppoe"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>password<indexterm zone="settings-pppoe"><primary sortas="password">password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>password-flags<indexterm zone="settings-pppoe"><primary sortas="password-flags">password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>service<indexterm zone="settings-pppoe"><primary sortas="service">service</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>username<indexterm zone="settings-pppoe"><primary sortas="username">username</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-proxy"><refnamediv><refname>proxy</refname><refpurpose>WWW Proxy Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-proxy.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>browser-only<indexterm zone="settings-proxy"><primary sortas="browser-only">browser-only</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>method<indexterm zone="settings-proxy"><primary sortas="method">method</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>pac-script<indexterm zone="settings-proxy"><primary sortas="pac-script">pac-script</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>pac-url<indexterm zone="settings-proxy"><primary sortas="pac-url">pac-url</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-serial"><refnamediv><refname>serial</refname><refpurpose>Serial Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-serial.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>baud<indexterm zone="settings-serial"><primary sortas="baud">baud</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>57600</screen></entry><entry/></row><row><entry><screen>bits<indexterm zone="settings-serial"><primary sortas="bits">bits</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>8</screen></entry><entry/></row><row><entry><screen>parity<indexterm zone="settings-serial"><primary sortas="parity">parity</primary></indexterm></screen></entry><entry><screen>byte</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>send-delay<indexterm zone="settings-serial"><primary sortas="send-delay">send-delay</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>stopbits<indexterm zone="settings-serial"><primary sortas="stopbits">stopbits</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-sriov"><refnamediv><refname>sriov</refname><refpurpose>SR-IOV settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-sriov.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>autoprobe-drivers<indexterm zone="settings-sriov"><primary sortas="autoprobe-drivers">autoprobe-drivers</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>total-vfs<indexterm zone="settings-sriov"><primary sortas="total-vfs">total-vfs</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>vfs<indexterm zone="settings-sriov"><primary sortas="vfs">vfs</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-tc"><refnamediv><refname>tc</refname><refpurpose>Linux Traffic Control Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-tc.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>qdiscs<indexterm zone="settings-tc"><primary sortas="qdiscs">qdiscs</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>tfilters<indexterm zone="settings-tc"><primary sortas="tfilters">tfilters</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-team"><refnamediv><refname>team</refname><refpurpose>Teaming Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-team.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>config<indexterm zone="settings-team"><primary sortas="config">config</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>interface-name<indexterm zone="settings-team"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>link-watchers<indexterm zone="settings-team"><primary sortas="link-watchers">link-watchers</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mcast-rejoin-count<indexterm zone="settings-team"><primary sortas="mcast-rejoin-count">mcast-rejoin-count</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>mcast-rejoin-interval<indexterm zone="settings-team"><primary sortas="mcast-rejoin-interval">mcast-rejoin-interval</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>notify-peers-count<indexterm zone="settings-team"><primary sortas="notify-peers-count">notify-peers-count</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>notify-peers-interval<indexterm zone="settings-team"><primary sortas="notify-peers-interval">notify-peers-interval</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>runner<indexterm zone="settings-team"><primary sortas="runner">runner</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>runner-active<indexterm zone="settings-team"><primary sortas="runner-active">runner-active</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>runner-agg-select-policy<indexterm zone="settings-team"><primary sortas="runner-agg-select-policy">runner-agg-select-policy</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>runner-fast-rate<indexterm zone="settings-team"><primary sortas="runner-fast-rate">runner-fast-rate</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>runner-hwaddr-policy<indexterm zone="settings-team"><primary sortas="runner-hwaddr-policy">runner-hwaddr-policy</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>runner-min-ports<indexterm zone="settings-team"><primary sortas="runner-min-ports">runner-min-ports</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>runner-sys-prio<indexterm zone="settings-team"><primary sortas="runner-sys-prio">runner-sys-prio</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>runner-tx-balancer<indexterm zone="settings-team"><primary sortas="runner-tx-balancer">runner-tx-balancer</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>runner-tx-balancer-interval<indexterm zone="settings-team"><primary sortas="runner-tx-balancer-interval">runner-tx-balancer-interval</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>runner-tx-hash<indexterm zone="settings-team"><primary sortas="runner-tx-hash">runner-tx-hash</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-team-port"><refnamediv><refname>team-port</refname><refpurpose>Team Port Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-team-port.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>config<indexterm zone="settings-team-port"><primary sortas="config">config</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>lacp-key<indexterm zone="settings-team-port"><primary sortas="lacp-key">lacp-key</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>lacp-prio<indexterm zone="settings-team-port"><primary sortas="lacp-prio">lacp-prio</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>link-watchers<indexterm zone="settings-team-port"><primary sortas="link-watchers">link-watchers</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>prio<indexterm zone="settings-team-port"><primary sortas="prio">prio</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>queue-id<indexterm zone="settings-team-port"><primary sortas="queue-id">queue-id</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>sticky<indexterm zone="settings-team-port"><primary sortas="sticky">sticky</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-tun"><refnamediv><refname>tun</refname><refpurpose>Tunnel Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-tun.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>group<indexterm zone="settings-tun"><primary sortas="group">group</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mode<indexterm zone="settings-tun"><primary sortas="mode">mode</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry/></row><row><entry><screen>multi-queue<indexterm zone="settings-tun"><primary sortas="multi-queue">multi-queue</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>owner<indexterm zone="settings-tun"><primary sortas="owner">owner</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>pi<indexterm zone="settings-tun"><primary sortas="pi">pi</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>vnet-hdr<indexterm zone="settings-tun"><primary sortas="vnet-hdr">vnet-hdr</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-user"><refnamediv><refname>user</refname><refpurpose>General User Profile Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-user.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>data<indexterm zone="settings-user"><primary sortas="data">data</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-vlan"><refnamediv><refname>vlan</refname><refpurpose>VLAN Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-vlan.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>egress-priority-map<indexterm zone="settings-vlan"><primary sortas="egress-priority-map">egress-priority-map</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>flags<indexterm zone="settings-vlan"><primary sortas="flags">flags</primary></indexterm></screen></entry><entry><screen>NMVlanFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>id<indexterm zone="settings-vlan"><primary sortas="id">id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>ingress-priority-map<indexterm zone="settings-vlan"><primary sortas="ingress-priority-map">ingress-priority-map</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>interface-name<indexterm zone="settings-vlan"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>parent<indexterm zone="settings-vlan"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>protocol<indexterm zone="settings-vlan"><primary sortas="protocol">protocol</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-vpn"><refnamediv><refname>vpn</refname><refpurpose>VPN Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-vpn.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>data<indexterm zone="settings-vpn"><primary sortas="data">data</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></entry><entry/></row><row><entry><screen>persistent<indexterm zone="settings-vpn"><primary sortas="persistent">persistent</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>secrets<indexterm zone="settings-vpn"><primary sortas="secrets">secrets</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></entry><entry/></row><row><entry><screen>service-type<indexterm zone="settings-vpn"><primary sortas="service-type">service-type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>timeout<indexterm zone="settings-vpn"><primary sortas="timeout">timeout</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>user-name<indexterm zone="settings-vpn"><primary sortas="user-name">user-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-vrf"><refnamediv><refname>vrf</refname><refpurpose>VRF settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-vrf.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>table<indexterm zone="settings-vrf"><primary sortas="table">table</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-vxlan"><refnamediv><refname>vxlan</refname><refpurpose>VXLAN Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-vxlan.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>ageing<indexterm zone="settings-vxlan"><primary sortas="ageing">ageing</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>300</screen></entry><entry/></row><row><entry><screen>destination-port<indexterm zone="settings-vxlan"><primary sortas="destination-port">destination-port</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>8472</screen></entry><entry/></row><row><entry><screen>id<indexterm zone="settings-vxlan"><primary sortas="id">id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>l2-miss<indexterm zone="settings-vxlan"><primary sortas="l2-miss">l2-miss</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>l3-miss<indexterm zone="settings-vxlan"><primary sortas="l3-miss">l3-miss</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>learning<indexterm zone="settings-vxlan"><primary sortas="learning">learning</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>limit<indexterm zone="settings-vxlan"><primary sortas="limit">limit</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>local<indexterm zone="settings-vxlan"><primary sortas="local">local</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>parent<indexterm zone="settings-vxlan"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>proxy<indexterm zone="settings-vxlan"><primary sortas="proxy">proxy</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>remote<indexterm zone="settings-vxlan"><primary sortas="remote">remote</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>rsc<indexterm zone="settings-vxlan"><primary sortas="rsc">rsc</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>source-port-max<indexterm zone="settings-vxlan"><primary sortas="source-port-max">source-port-max</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>source-port-min<indexterm zone="settings-vxlan"><primary sortas="source-port-min">source-port-min</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>tos<indexterm zone="settings-vxlan"><primary sortas="tos">tos</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>ttl<indexterm zone="settings-vxlan"><primary sortas="ttl">ttl</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-wifi-p2p"><refnamediv><refname>wifi-p2p</refname><refpurpose>Wi-Fi P2P Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wifi-p2p.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>peer<indexterm zone="settings-wifi-p2p"><primary sortas="peer">peer</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>wfd-ies<indexterm zone="settings-wifi-p2p"><primary sortas="wfd-ies">wfd-ies</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>wps-method<indexterm zone="settings-wifi-p2p"><primary sortas="wps-method">wps-method</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-wimax"><refnamediv><refname>wimax</refname><refpurpose>WiMax Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wimax.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>mac-address<indexterm zone="settings-wimax"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>network-name<indexterm zone="settings-wimax"><primary sortas="network-name">network-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-3-ethernet"><refnamediv><refname>802-3-ethernet</refname><refpurpose>Wired Ethernet Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-3-ethernet.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>accept-all-mac-addresses<indexterm zone="settings-802-3-ethernet"><primary sortas="accept-all-mac-addresses">accept-all-mac-addresses</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>assigned-mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="assigned-mac-address">assigned-mac-address</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>auto-negotiate<indexterm zone="settings-802-3-ethernet"><primary sortas="auto-negotiate">auto-negotiate</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>cloned-mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="cloned-mac-address">cloned-mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>duplex<indexterm zone="settings-802-3-ethernet"><primary sortas="duplex">duplex</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>generate-mac-address-mask<indexterm zone="settings-802-3-ethernet"><primary sortas="generate-mac-address-mask">generate-mac-address-mask</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mac-address-blacklist<indexterm zone="settings-802-3-ethernet"><primary sortas="mac-address-blacklist">mac-address-blacklist</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mtu<indexterm zone="settings-802-3-ethernet"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>port<indexterm zone="settings-802-3-ethernet"><primary sortas="port">port</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>s390-nettype<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-nettype">s390-nettype</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>s390-options<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-options">s390-options</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></entry><entry/></row><row><entry><screen>s390-subchannels<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-subchannels">s390-subchannels</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>speed<indexterm zone="settings-802-3-ethernet"><primary sortas="speed">speed</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>wake-on-lan<indexterm zone="settings-802-3-ethernet"><primary sortas="wake-on-lan">wake-on-lan</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry/></row><row><entry><screen>wake-on-lan-password<indexterm zone="settings-802-3-ethernet"><primary sortas="wake-on-lan-password">wake-on-lan-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-wireguard"><refnamediv><refname>wireguard</refname><refpurpose>WireGuard Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wireguard.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>fwmark<indexterm zone="settings-wireguard"><primary sortas="fwmark">fwmark</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>ip4-auto-default-route<indexterm zone="settings-wireguard"><primary sortas="ip4-auto-default-route">ip4-auto-default-route</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>ip6-auto-default-route<indexterm zone="settings-wireguard"><primary sortas="ip6-auto-default-route">ip6-auto-default-route</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>listen-port<indexterm zone="settings-wireguard"><primary sortas="listen-port">listen-port</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>mtu<indexterm zone="settings-wireguard"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>peer-routes<indexterm zone="settings-wireguard"><primary sortas="peer-routes">peer-routes</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry/></row><row><entry><screen>peers<indexterm zone="settings-wireguard"><primary sortas="peers">peers</primary></indexterm></screen></entry><entry><screen>array of 'a{sv}'</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>private-key<indexterm zone="settings-wireguard"><primary sortas="private-key">private-key</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>private-key-flags<indexterm zone="settings-wireguard"><primary sortas="private-key-flags">private-key-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-11-wireless"><refnamediv><refname>802-11-wireless</refname><refpurpose>Wi-Fi Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-11-wireless.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>ap-isolation<indexterm zone="settings-802-11-wireless"><primary sortas="ap-isolation">ap-isolation</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>assigned-mac-address<indexterm zone="settings-802-11-wireless"><primary sortas="assigned-mac-address">assigned-mac-address</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>band<indexterm zone="settings-802-11-wireless"><primary sortas="band">band</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>bssid<indexterm zone="settings-802-11-wireless"><primary sortas="bssid">bssid</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>channel<indexterm zone="settings-802-11-wireless"><primary sortas="channel">channel</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>cloned-mac-address<indexterm zone="settings-802-11-wireless"><primary sortas="cloned-mac-address">cloned-mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>generate-mac-address-mask<indexterm zone="settings-802-11-wireless"><primary sortas="generate-mac-address-mask">generate-mac-address-mask</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>hidden<indexterm zone="settings-802-11-wireless"><primary sortas="hidden">hidden</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry/></row><row><entry><screen>mac-address<indexterm zone="settings-802-11-wireless"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mac-address-blacklist<indexterm zone="settings-802-11-wireless"><primary sortas="mac-address-blacklist">mac-address-blacklist</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mac-address-randomization<indexterm zone="settings-802-11-wireless"><primary sortas="mac-address-randomization">mac-address-randomization</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>mode<indexterm zone="settings-802-11-wireless"><primary sortas="mode">mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>mtu<indexterm zone="settings-802-11-wireless"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>powersave<indexterm zone="settings-802-11-wireless"><primary sortas="powersave">powersave</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>rate<indexterm zone="settings-802-11-wireless"><primary sortas="rate">rate</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>security<indexterm zone="settings-802-11-wireless"><primary sortas="security">security</primary></indexterm></screen></entry><entry><screen/></entry><entry><screen/></entry><entry/></row><row><entry><screen>seen-bssids<indexterm zone="settings-802-11-wireless"><primary sortas="seen-bssids">seen-bssids</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>ssid<indexterm zone="settings-802-11-wireless"><primary sortas="ssid">ssid</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>tx-power<indexterm zone="settings-802-11-wireless"><primary sortas="tx-power">tx-power</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>wake-on-wlan<indexterm zone="settings-802-11-wireless"><primary sortas="wake-on-wlan">wake-on-wlan</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-11-wireless-security"><refnamediv><refname>802-11-wireless-security</refname><refpurpose>Wi-Fi Security Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-11-wireless-security.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>auth-alg<indexterm zone="settings-802-11-wireless-security"><primary sortas="auth-alg">auth-alg</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>fils<indexterm zone="settings-802-11-wireless-security"><primary sortas="fils">fils</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>group<indexterm zone="settings-802-11-wireless-security"><primary sortas="group">group</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>key-mgmt<indexterm zone="settings-802-11-wireless-security"><primary sortas="key-mgmt">key-mgmt</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>leap-password<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-password">leap-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>leap-password-flags<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-password-flags">leap-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>leap-username<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-username">leap-username</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>pairwise<indexterm zone="settings-802-11-wireless-security"><primary sortas="pairwise">pairwise</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>pmf<indexterm zone="settings-802-11-wireless-security"><primary sortas="pmf">pmf</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>proto<indexterm zone="settings-802-11-wireless-security"><primary sortas="proto">proto</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>psk<indexterm zone="settings-802-11-wireless-security"><primary sortas="psk">psk</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>psk-flags<indexterm zone="settings-802-11-wireless-security"><primary sortas="psk-flags">psk-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>wep-key-flags<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key-flags">wep-key-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>wep-key-type<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key-type">wep-key-type</primary></indexterm></screen></entry><entry><screen>NMWepKeyType (uint32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>wep-key0<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key0">wep-key0</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>wep-key1<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key1">wep-key1</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>wep-key2<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key2">wep-key2</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>wep-key3<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key3">wep-key3</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>wep-tx-keyidx<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-tx-keyidx">wep-tx-keyidx</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>wps-method<indexterm zone="settings-802-11-wireless-security"><primary sortas="wps-method">wps-method</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-wpan"><refnamediv><refname>wpan</refname><refpurpose>IEEE 802.15.4 (WPAN) MAC Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wpan.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>channel<indexterm zone="settings-wpan"><primary sortas="channel">channel</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>mac-address<indexterm zone="settings-wpan"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>page<indexterm zone="settings-wpan"><primary sortas="page">page</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>pan-id<indexterm zone="settings-wpan"><primary sortas="pan-id">pan-id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>65535</screen></entry><entry/></row><row><entry><screen>short-address<indexterm zone="settings-wpan"><primary sortas="short-address">short-address</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>65535</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-bond-port"><refnamediv><refname>bond-port</refname><refpurpose>Bond Port Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-bond-port.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>prio<indexterm zone="settings-bond-port"><primary sortas="prio">prio</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>queue-id<indexterm zone="settings-bond-port"><primary sortas="queue-id">queue-id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-hostname"><refnamediv><refname>hostname</refname><refpurpose>Hostname settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-hostname.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>from-dhcp<indexterm zone="settings-hostname"><primary sortas="from-dhcp">from-dhcp</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>from-dns-lookup<indexterm zone="settings-hostname"><primary sortas="from-dns-lookup">from-dns-lookup</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>only-from-default<indexterm zone="settings-hostname"><primary sortas="only-from-default">only-from-default</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>priority<indexterm zone="settings-hostname"><primary sortas="priority">priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-loopback"><refnamediv><refname>loopback</refname><refpurpose>Loopback Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-loopback.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>mtu<indexterm zone="settings-loopback"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ovs-external-ids"><refnamediv><refname>ovs-external-ids</refname><refpurpose>OVS External IDs Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-external-ids.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>data<indexterm zone="settings-ovs-external-ids"><primary sortas="data">data</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ovs-other-config"><refnamediv><refname>ovs-other-config</refname><refpurpose>OVS Other Config Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-other-config.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>data<indexterm zone="settings-ovs-other-config"><primary sortas="data">data</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-veth"><refnamediv><refname>veth</refname><refpurpose>Veth Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-veth.properties"> - Properties - </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>peer<indexterm zone="settings-veth"><primary sortas="peer">peer</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry></chapter> + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>apn<indexterm zone="settings-gsm"><primary sortas="apn">apn</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</entry></row><row><entry><screen>auto-config<indexterm zone="settings-gsm"><primary sortas="auto-config">auto-config</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></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><screen>device-id<indexterm zone="settings-gsm"><primary sortas="device-id">device-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>home-only<indexterm zone="settings-gsm"><primary sortas="home-only">home-only</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></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><screen>initial-eps-bearer-apn<indexterm zone="settings-gsm"><primary sortas="initial-eps-bearer-apn">initial-eps-bearer-apn</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network. Setting this parameter implies initial-eps-bearer-configure to be TRUE.</entry></row><row><entry><screen>initial-eps-bearer-configure<indexterm zone="settings-gsm"><primary sortas="initial-eps-bearer-configure">initial-eps-bearer-configure</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>For LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection. It is inferred TRUE if initial-eps-bearer-apn is set.</entry></row><row><entry><screen>mtu<indexterm zone="settings-gsm"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry><screen>network-id<indexterm zone="settings-gsm"><primary sortas="network-id">network-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</entry></row><row><entry><screen>number<indexterm zone="settings-gsm"><primary sortas="number">number</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Legacy setting that used to help establishing PPP data sessions for GSM-based modems.</entry></row><row><entry><screen>password<indexterm zone="settings-gsm"><primary sortas="password">password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.</entry></row><row><entry><screen>password-flags<indexterm zone="settings-gsm"><primary sortas="password-flags">password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry><screen>pin<indexterm zone="settings-gsm"><primary sortas="pin">pin</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</entry></row><row><entry><screen>pin-flags<indexterm zone="settings-gsm"><primary sortas="pin-flags">pin-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "pin" property.</entry></row><row><entry><screen>sim-id<indexterm zone="settings-gsm"><primary sortas="sim-id">sim-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>sim-operator-id<indexterm zone="settings-gsm"><primary sortas="sim-operator-id">sim-operator-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>username<indexterm zone="settings-gsm"><primary sortas="username">username</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-infiniband"><refnamediv><refname>infiniband</refname><refpurpose>Infiniband Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-infiniband.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>mac-address<indexterm zone="settings-infiniband"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, this connection will only apply to the 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><screen>mtu<indexterm zone="settings-infiniband"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry><screen>p-key<indexterm zone="settings-infiniband"><primary sortas="p-key">p-key</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></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 0x8000 is set if it is a "full membership" p-key. The values 0 and 0x8000 are not allowed. + +With the p-key set, the interface name is always "$parent.$p_key". Setting "connection.interface-name" to another name is not supported. + +Note that kernel will internally always set the full membership bit, although the interface name does not reflect that. Usually the user would want to configure a full membership p-key with 0x8000 flag set.</entry></row><row><entry><screen>parent<indexterm zone="settings-infiniband"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>transport-mode<indexterm zone="settings-infiniband"><primary sortas="transport-mode">transport-mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ipv4"><refnamediv><refname>ipv4</refname><refpurpose>IPv4 Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ipv4.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>address-data<indexterm zone="settings-ipv4"><primary sortas="address-data">address-data</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><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><screen>addresses<indexterm zone="settings-ipv4"><primary sortas="addresses">addresses</primary></indexterm></screen></entry><entry><screen>array of array of uint32</screen></entry><entry><screen/></entry><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><screen>auto-route-ext-gw<indexterm zone="settings-ipv4"><primary sortas="auto-route-ext-gw">auto-route-ext-gw</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>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><screen>dad-timeout<indexterm zone="settings-ipv4"><primary sortas="dad-timeout">dad-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></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. + +The property is currently implemented only for IPv4.</entry></row><row><entry><screen>dhcp-client-id<indexterm zone="settings-ipv4"><primary sortas="dhcp-client-id">dhcp-client-id</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. 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.</entry></row><row><entry><screen>dhcp-fqdn<indexterm zone="settings-ipv4"><primary sortas="dhcp-fqdn">dhcp-fqdn</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>dhcp-hostname<indexterm zone="settings-ipv4"><primary sortas="dhcp-hostname">dhcp-hostname</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row><row><entry><screen>dhcp-hostname-flags<indexterm zone="settings-ipv4"><primary sortas="dhcp-hostname-flags">dhcp-hostname-flags</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>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.</entry></row><row><entry><screen>dhcp-iaid<indexterm zone="settings-ipv4"><primary sortas="dhcp-iaid">dhcp-iaid</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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 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.</entry></row><row><entry><screen>dhcp-reject-servers<indexterm zone="settings-ipv4"><primary sortas="dhcp-reject-servers">dhcp-reject-servers</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><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 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.</entry></row><row><entry><screen>dhcp-send-hostname<indexterm zone="settings-ipv4"><primary sortas="dhcp-send-hostname">dhcp-send-hostname</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></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><screen>dhcp-timeout<indexterm zone="settings-ipv4"><primary sortas="dhcp-timeout">dhcp-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). + +Set to 2147483647 (MAXINT32) for infinity.</entry></row><row><entry><screen>dhcp-vendor-class-identifier<indexterm zone="settings-ipv4"><primary sortas="dhcp-vendor-class-identifier">dhcp-vendor-class-identifier</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>dns<indexterm zone="settings-ipv4"><primary sortas="dns">dns</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen/></entry><entry>Array of IP addresses of DNS servers (as network-byte-order integers)</entry></row><row><entry><screen>dns-data<indexterm zone="settings-ipv4"><primary sortas="dns-data">dns-data</primary></indexterm></screen></entry><entry><screen>array of strings</screen></entry><entry><screen/></entry><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><screen>dns-options<indexterm zone="settings-ipv4"><primary sortas="dns-options">dns-options</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>Array of DNS options as described in man 5 resolv.conf. + +NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. + +The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "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.</entry></row><row><entry><screen>dns-priority<indexterm zone="settings-ipv4"><primary sortas="dns-priority">dns-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>DNS servers priority. + +The relative priority for DNS servers specified by this setting. A lower 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.</entry></row><row><entry><screen>dns-search<indexterm zone="settings-ipv4"><primary sortas="dns-search">dns-search</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>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).</entry></row><row><entry><screen>gateway<indexterm zone="settings-ipv4"><primary sortas="gateway">gateway</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The gateway associated with this configuration. This is only meaningful if "addresses" is also set. + +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".</entry></row><row><entry><screen>ignore-auto-dns<indexterm zone="settings-ipv4"><primary sortas="ignore-auto-dns">ignore-auto-dns</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured 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><screen>ignore-auto-routes<indexterm zone="settings-ipv4"><primary sortas="ignore-auto-routes">ignore-auto-routes</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</entry></row><row><entry><screen>link-local<indexterm zone="settings-ipv4"><primary sortas="link-local">link-local</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></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. + +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><screen>may-fail<indexterm zone="settings-ipv4"><primary sortas="may-fail">may-fail</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></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><screen>method<indexterm zone="settings-ipv4"><primary sortas="method">method</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row><row><entry><screen>never-default<indexterm zone="settings-ipv4"><primary sortas="never-default">never-default</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></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><screen>replace-local-rule<indexterm zone="settings-ipv4"><primary sortas="replace-local-rule">replace-local-rule</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</entry></row><row><entry><screen>required-timeout<indexterm zone="settings-ipv4"><primary sortas="required-timeout">required-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>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).</entry></row><row><entry><screen>route-data<indexterm zone="settings-ipv4"><primary sortas="route-data">route-data</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><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><screen>route-metric<indexterm zone="settings-ipv4"><primary sortas="route-metric">route-metric</primary></indexterm></screen></entry><entry><screen>int64</screen></entry><entry><screen>-1</screen></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><screen>route-table<indexterm zone="settings-ipv4"><primary sortas="route-table">route-table</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>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.</entry></row><row><entry><screen>routes<indexterm zone="settings-ipv4"><primary sortas="routes">routes</primary></indexterm></screen></entry><entry><screen>array of array of uint32</screen></entry><entry><screen/></entry><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><screen>routing-rules<indexterm zone="settings-ipv4"><primary sortas="routing-rules">routing-rules</primary></indexterm></screen></entry><entry><screen>array of 'a{sv}'</screen></entry><entry><screen/></entry><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></table></para></refsect1></refentry><refentry id="settings-ipv6"><refnamediv><refname>ipv6</refname><refpurpose>IPv6 Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ipv6.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>addr-gen-mode<indexterm zone="settings-ipv6"><primary sortas="addr-gen-mode">addr-gen-mode</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>3</screen></entry><entry>Configure the method for creating the IPv6 interface identifier of addresses for RFC4862 IPv6 Stateless Address Autoconfiguration and IPv6 Link Local. + +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 token derived from the hardware address. This makes the host part of the address constant, making it possible to track the host's presence when it changes networks. The address changes when the interface hardware is replaced. If a duplicate address is detected, there is no fallback to generate another address. When configured, the "ipv6.token" is used instead of the MAC address to generate addresses for stateless autoconfiguration. + +If the property is set to "stable-privacy", the interface identifier is generated as specified by RFC7217. This works by hashing a host specific key (see NetworkManager(8) manual), the interface name, the connection's "connection.stable-id" property and the address prefix. This improves privacy by making it harder to use the address to track the host's presence as every prefix and network has a different identifier. Also, the address is stable when the network interface hardware is replaced. + +The special values "default" and "default-or-eui64" will fallback to the global connection default as documented in the 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 used to default 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.</entry></row><row><entry><screen>address-data<indexterm zone="settings-ipv6"><primary sortas="address-data">address-data</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><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><screen>addresses<indexterm zone="settings-ipv6"><primary sortas="addresses">addresses</primary></indexterm></screen></entry><entry><screen>array of legacy IPv6 address struct (a(ayuay))</screen></entry><entry><screen/></entry><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><screen>auto-route-ext-gw<indexterm zone="settings-ipv6"><primary sortas="auto-route-ext-gw">auto-route-ext-gw</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>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><screen>dad-timeout<indexterm zone="settings-ipv6"><primary sortas="dad-timeout">dad-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></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. + +The property is currently implemented only for IPv4.</entry></row><row><entry><screen>dhcp-duid<indexterm zone="settings-ipv6"><primary sortas="dhcp-duid">dhcp-duid</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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. + +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.</entry></row><row><entry><screen>dhcp-hostname<indexterm zone="settings-ipv6"><primary sortas="dhcp-hostname">dhcp-hostname</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row><row><entry><screen>dhcp-hostname-flags<indexterm zone="settings-ipv6"><primary sortas="dhcp-hostname-flags">dhcp-hostname-flags</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>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.</entry></row><row><entry><screen>dhcp-iaid<indexterm zone="settings-ipv6"><primary sortas="dhcp-iaid">dhcp-iaid</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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 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.</entry></row><row><entry><screen>dhcp-pd-hint<indexterm zone="settings-ipv6"><primary sortas="dhcp-pd-hint">dhcp-pd-hint</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>A IPv6 address followed by a slash and a prefix length. If set, the value is sent to the DHCPv6 server as hint indicating the prefix delegation (IA_PD) we want to receive. To only hint a prefix length without prefix, set the address part to the zero address (for example "::/60").</entry></row><row><entry><screen>dhcp-reject-servers<indexterm zone="settings-ipv6"><primary sortas="dhcp-reject-servers">dhcp-reject-servers</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><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 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.</entry></row><row><entry><screen>dhcp-send-hostname<indexterm zone="settings-ipv6"><primary sortas="dhcp-send-hostname">dhcp-send-hostname</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></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><screen>dhcp-timeout<indexterm zone="settings-ipv6"><primary sortas="dhcp-timeout">dhcp-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). + +Set to 2147483647 (MAXINT32) for infinity.</entry></row><row><entry><screen>dns<indexterm zone="settings-ipv6"><primary sortas="dns">dns</primary></indexterm></screen></entry><entry><screen>array of byte array</screen></entry><entry><screen/></entry><entry>Array of IP addresses of DNS servers (in network byte order)</entry></row><row><entry><screen>dns-data<indexterm zone="settings-ipv6"><primary sortas="dns-data">dns-data</primary></indexterm></screen></entry><entry><screen>array of strings</screen></entry><entry><screen/></entry><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><screen>dns-options<indexterm zone="settings-ipv6"><primary sortas="dns-options">dns-options</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>Array of DNS options as described in man 5 resolv.conf. + +NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. + +The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "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.</entry></row><row><entry><screen>dns-priority<indexterm zone="settings-ipv6"><primary sortas="dns-priority">dns-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>DNS servers priority. + +The relative priority for DNS servers specified by this setting. A lower 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.</entry></row><row><entry><screen>dns-search<indexterm zone="settings-ipv6"><primary sortas="dns-search">dns-search</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>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).</entry></row><row><entry><screen>gateway<indexterm zone="settings-ipv6"><primary sortas="gateway">gateway</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The gateway associated with this configuration. This is only meaningful if "addresses" is also set. + +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".</entry></row><row><entry><screen>ignore-auto-dns<indexterm zone="settings-ipv6"><primary sortas="ignore-auto-dns">ignore-auto-dns</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured 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><screen>ignore-auto-routes<indexterm zone="settings-ipv6"><primary sortas="ignore-auto-routes">ignore-auto-routes</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</entry></row><row><entry><screen>ip6-privacy<indexterm zone="settings-ipv6"><primary sortas="ip6-privacy">ip6-privacy</primary></indexterm></screen></entry><entry><screen>NMSettingIP6ConfigPrivacy (int32)</screen></entry><entry><screen/></entry><entry>Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -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.</entry></row><row><entry><screen>may-fail<indexterm zone="settings-ipv6"><primary sortas="may-fail">may-fail</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></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><screen>method<indexterm zone="settings-ipv6"><primary sortas="method">method</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>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.</entry></row><row><entry><screen>mtu<indexterm zone="settings-ipv6"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>never-default<indexterm zone="settings-ipv6"><primary sortas="never-default">never-default</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></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><screen>ra-timeout<indexterm zone="settings-ipv6"><primary sortas="ra-timeout">ra-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></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. + +Set to 2147483647 (MAXINT32) for infinity.</entry></row><row><entry><screen>replace-local-rule<indexterm zone="settings-ipv6"><primary sortas="replace-local-rule">replace-local-rule</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</entry></row><row><entry><screen>required-timeout<indexterm zone="settings-ipv6"><primary sortas="required-timeout">required-timeout</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>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).</entry></row><row><entry><screen>route-data<indexterm zone="settings-ipv6"><primary sortas="route-data">route-data</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><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><screen>route-metric<indexterm zone="settings-ipv6"><primary sortas="route-metric">route-metric</primary></indexterm></screen></entry><entry><screen>int64</screen></entry><entry><screen>-1</screen></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><screen>route-table<indexterm zone="settings-ipv6"><primary sortas="route-table">route-table</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>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.</entry></row><row><entry><screen>routes<indexterm zone="settings-ipv6"><primary sortas="routes">routes</primary></indexterm></screen></entry><entry><screen>array of legacy IPv6 route struct (a(ayuayu))</screen></entry><entry><screen/></entry><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><screen>routing-rules<indexterm zone="settings-ipv6"><primary sortas="routing-rules">routing-rules</primary></indexterm></screen></entry><entry><screen>array of 'a{sv}'</screen></entry><entry><screen/></entry><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><screen>token<indexterm zone="settings-ipv6"><primary sortas="token">token</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode. + +When set, the token is used as IPv6 interface identifier instead of the hardware address. This only applies to addresses from stateless autoconfiguration, not to IPv6 link local addresses.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ip-tunnel"><refnamediv><refname>ip-tunnel</refname><refpurpose>IP Tunneling Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ip-tunnel.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>encapsulation-limit<indexterm zone="settings-ip-tunnel"><primary sortas="encapsulation-limit">encapsulation-limit</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1) to ip-tunnel flags.</entry></row><row><entry><screen>flags<indexterm zone="settings-ip-tunnel"><primary sortas="flags">flags</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>flow-label<indexterm zone="settings-ip-tunnel"><primary sortas="flow-label">flow-label</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</entry></row><row><entry><screen>fwmark<indexterm zone="settings-ip-tunnel"><primary sortas="fwmark">fwmark</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>input-key<indexterm zone="settings-ip-tunnel"><primary sortas="input-key">input-key</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>local<indexterm zone="settings-ip-tunnel"><primary sortas="local">local</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>mode<indexterm zone="settings-ip-tunnel"><primary sortas="mode">mode</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</entry></row><row><entry><screen>mtu<indexterm zone="settings-ip-tunnel"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</entry></row><row><entry><screen>output-key<indexterm zone="settings-ip-tunnel"><primary sortas="output-key">output-key</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>parent<indexterm zone="settings-ip-tunnel"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</entry></row><row><entry><screen>path-mtu-discovery<indexterm zone="settings-ip-tunnel"><primary sortas="path-mtu-discovery">path-mtu-discovery</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Whether to enable Path MTU Discovery on this tunnel.</entry></row><row><entry><screen>remote<indexterm zone="settings-ip-tunnel"><primary sortas="remote">remote</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</entry></row><row><entry><screen>tos<indexterm zone="settings-ip-tunnel"><primary sortas="tos">tos</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</entry></row><row><entry><screen>ttl<indexterm zone="settings-ip-tunnel"><primary sortas="ttl">ttl</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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></table></para></refsect1></refentry><refentry id="settings-macsec"><refnamediv><refname>macsec</refname><refpurpose>MACSec Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-macsec.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>encrypt<indexterm zone="settings-macsec"><primary sortas="encrypt">encrypt</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Whether the transmitted traffic must be encrypted.</entry></row><row><entry><screen>mka-cak<indexterm zone="settings-macsec"><primary sortas="mka-cak">mka-cak</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</entry></row><row><entry><screen>mka-cak-flags<indexterm zone="settings-macsec"><primary sortas="mka-cak-flags">mka-cak-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "mka-cak" property.</entry></row><row><entry><screen>mka-ckn<indexterm zone="settings-macsec"><primary sortas="mka-ckn">mka-ckn</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>mode<indexterm zone="settings-macsec"><primary sortas="mode">mode</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</entry></row><row><entry><screen>parent<indexterm zone="settings-macsec"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If given, specifies the parent interface name or parent connection UUID from which this 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><screen>port<indexterm zone="settings-macsec"><primary sortas="port">port</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>1</screen></entry><entry>The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</entry></row><row><entry><screen>send-sci<indexterm zone="settings-macsec"><primary sortas="send-sci">send-sci</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</entry></row><row><entry><screen>validation<indexterm zone="settings-macsec"><primary sortas="validation">validation</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>2</screen></entry><entry>Specifies the validation mode for incoming frames.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-macvlan"><refnamediv><refname>macvlan</refname><refpurpose>MAC VLAN Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-macvlan.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>mode<indexterm zone="settings-macvlan"><primary sortas="mode">mode</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</entry></row><row><entry><screen>parent<indexterm zone="settings-macvlan"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If given, specifies the parent interface name or parent connection UUID from which this 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><screen>promiscuous<indexterm zone="settings-macvlan"><primary sortas="promiscuous">promiscuous</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Whether the interface should be put in promiscuous mode.</entry></row><row><entry><screen>tap<indexterm zone="settings-macvlan"><primary sortas="tap">tap</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Whether the interface should be a MACVTAP.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-match"><refnamediv><refname>match</refname><refpurpose>Match settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-match.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>driver<indexterm zone="settings-match"><primary sortas="driver">driver</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>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.</entry></row><row><entry><screen>interface-name<indexterm zone="settings-match"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of interface names to match. Each element is a shell wildcard pattern. + +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><screen>kernel-command-line<indexterm zone="settings-match"><primary sortas="kernel-command-line">kernel-command-line</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><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. + +See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.</entry></row><row><entry><screen>path<indexterm zone="settings-match"><primary sortas="path">path</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><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 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.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-11-olpc-mesh"><refnamediv><refname>802-11-olpc-mesh</refname><refpurpose>OLPC Wireless Mesh Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-11-olpc-mesh.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>channel<indexterm zone="settings-802-11-olpc-mesh"><primary sortas="channel">channel</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Channel on which the mesh network to join is located.</entry></row><row><entry><screen>dhcp-anycast-address<indexterm zone="settings-802-11-olpc-mesh"><primary sortas="dhcp-anycast-address">dhcp-anycast-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. + +This is currently only implemented by dhclient DHCP plugin.</entry></row><row><entry><screen>ssid<indexterm zone="settings-802-11-olpc-mesh"><primary sortas="ssid">ssid</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>SSID of the mesh network to join.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ovs-bridge"><refnamediv><refname>ovs-bridge</refname><refpurpose>OvsBridge Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-bridge.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>datapath-type<indexterm zone="settings-ovs-bridge"><primary sortas="datapath-type">datapath-type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The data path type. One of "system", "netdev" or empty.</entry></row><row><entry><screen>fail-mode<indexterm zone="settings-ovs-bridge"><primary sortas="fail-mode">fail-mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The bridge failure mode. One of "secure", "standalone" or empty.</entry></row><row><entry><screen>mcast-snooping-enable<indexterm zone="settings-ovs-bridge"><primary sortas="mcast-snooping-enable">mcast-snooping-enable</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Enable or disable multicast snooping.</entry></row><row><entry><screen>rstp-enable<indexterm zone="settings-ovs-bridge"><primary sortas="rstp-enable">rstp-enable</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Enable or disable RSTP.</entry></row><row><entry><screen>stp-enable<indexterm zone="settings-ovs-bridge"><primary sortas="stp-enable">stp-enable</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Enable or disable STP.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ovs-dpdk"><refnamediv><refname>ovs-dpdk</refname><refpurpose>OvsDpdk Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-dpdk.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>devargs<indexterm zone="settings-ovs-dpdk"><primary sortas="devargs">devargs</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Open vSwitch DPDK device arguments.</entry></row><row><entry><screen>n-rxq<indexterm zone="settings-ovs-dpdk"><primary sortas="n-rxq">n-rxq</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>n-rxq-desc<indexterm zone="settings-ovs-dpdk"><primary sortas="n-rxq-desc">n-rxq-desc</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>n-txq-desc<indexterm zone="settings-ovs-dpdk"><primary sortas="n-txq-desc">n-txq-desc</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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></table></para></refsect1></refentry><refentry id="settings-ovs-interface"><refnamediv><refname>ovs-interface</refname><refpurpose>Open vSwitch Interface Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-interface.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>ofport-request<indexterm zone="settings-ovs-interface"><primary sortas="ofport-request">ofport-request</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>type<indexterm zone="settings-ovs-interface"><primary sortas="type">type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The interface type. Either "internal", "system", "patch", "dpdk", or empty.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ovs-patch"><refnamediv><refname>ovs-patch</refname><refpurpose>OvsPatch Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-patch.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>peer<indexterm zone="settings-ovs-patch"><primary sortas="peer">peer</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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></table></para></refsect1></refentry><refentry id="settings-ovs-port"><refnamediv><refname>ovs-port</refname><refpurpose>OvsPort Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-port.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>bond-downdelay<indexterm zone="settings-ovs-port"><primary sortas="bond-downdelay">bond-downdelay</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The time port must be inactive in order to be considered down.</entry></row><row><entry><screen>bond-mode<indexterm zone="settings-ovs-port"><primary sortas="bond-mode">bond-mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</entry></row><row><entry><screen>bond-updelay<indexterm zone="settings-ovs-port"><primary sortas="bond-updelay">bond-updelay</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The time port must be active before it starts forwarding traffic.</entry></row><row><entry><screen>lacp<indexterm zone="settings-ovs-port"><primary sortas="lacp">lacp</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>LACP mode. One of "active", "off", or "passive".</entry></row><row><entry><screen>tag<indexterm zone="settings-ovs-port"><primary sortas="tag">tag</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The VLAN tag in the range 0-4095.</entry></row><row><entry><screen>trunks<indexterm zone="settings-ovs-port"><primary sortas="trunks">trunks</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>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.</entry></row><row><entry><screen>vlan-mode<indexterm zone="settings-ovs-port"><primary sortas="vlan-mode">vlan-mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ppp"><refnamediv><refname>ppp</refname><refpurpose>Point-to-Point Protocol Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ppp.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>baud<indexterm zone="settings-ppp"><primary sortas="baud">baud</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>crtscts<indexterm zone="settings-ppp"><primary sortas="crtscts">crtscts</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></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><screen>lcp-echo-failure<indexterm zone="settings-ppp"><primary sortas="lcp-echo-failure">lcp-echo-failure</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>lcp-echo-interval<indexterm zone="settings-ppp"><primary sortas="lcp-echo-interval">lcp-echo-interval</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>mppe-stateful<indexterm zone="settings-ppp"><primary sortas="mppe-stateful">mppe-stateful</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</entry></row><row><entry><screen>mru<indexterm zone="settings-ppp"><primary sortas="mru">mru</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>mtu<indexterm zone="settings-ppp"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, instruct pppd to send packets no larger than the specified size.</entry></row><row><entry><screen>no-vj-comp<indexterm zone="settings-ppp"><primary sortas="no-vj-comp">no-vj-comp</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, Van Jacobsen TCP header compression will not be requested.</entry></row><row><entry><screen>noauth<indexterm zone="settings-ppp"><primary sortas="noauth">noauth</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></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><screen>nobsdcomp<indexterm zone="settings-ppp"><primary sortas="nobsdcomp">nobsdcomp</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, BSD compression will not be requested.</entry></row><row><entry><screen>nodeflate<indexterm zone="settings-ppp"><primary sortas="nodeflate">nodeflate</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, "deflate" compression will not be requested.</entry></row><row><entry><screen>refuse-chap<indexterm zone="settings-ppp"><primary sortas="refuse-chap">refuse-chap</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, the CHAP authentication method will not be used.</entry></row><row><entry><screen>refuse-eap<indexterm zone="settings-ppp"><primary sortas="refuse-eap">refuse-eap</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, the EAP authentication method will not be used.</entry></row><row><entry><screen>refuse-mschap<indexterm zone="settings-ppp"><primary sortas="refuse-mschap">refuse-mschap</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, the MSCHAP authentication method will not be used.</entry></row><row><entry><screen>refuse-mschapv2<indexterm zone="settings-ppp"><primary sortas="refuse-mschapv2">refuse-mschapv2</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, the MSCHAPv2 authentication method will not be used.</entry></row><row><entry><screen>refuse-pap<indexterm zone="settings-ppp"><primary sortas="refuse-pap">refuse-pap</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, the PAP authentication method will not be used.</entry></row><row><entry><screen>require-mppe<indexterm zone="settings-ppp"><primary sortas="require-mppe">require-mppe</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></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><screen>require-mppe-128<indexterm zone="settings-ppp"><primary sortas="require-mppe-128">require-mppe-128</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></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></table></para></refsect1></refentry><refentry id="settings-pppoe"><refnamediv><refname>pppoe</refname><refpurpose>PPP-over-Ethernet Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-pppoe.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>parent<indexterm zone="settings-pppoe"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>password<indexterm zone="settings-pppoe"><primary sortas="password">password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Password used to authenticate with the PPPoE service.</entry></row><row><entry><screen>password-flags<indexterm zone="settings-pppoe"><primary sortas="password-flags">password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry><screen>service<indexterm zone="settings-pppoe"><primary sortas="service">service</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>username<indexterm zone="settings-pppoe"><primary sortas="username">username</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Username used to authenticate with the PPPoE service.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-proxy"><refnamediv><refname>proxy</refname><refpurpose>WWW Proxy Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-proxy.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>browser-only<indexterm zone="settings-proxy"><primary sortas="browser-only">browser-only</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Whether the proxy configuration is for browser only.</entry></row><row><entry><screen>method<indexterm zone="settings-proxy"><primary sortas="method">method</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</entry></row><row><entry><screen>pac-script<indexterm zone="settings-proxy"><primary sortas="pac-script">pac-script</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.</entry></row><row><entry><screen>pac-url<indexterm zone="settings-proxy"><primary sortas="pac-url">pac-url</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>PAC URL for obtaining PAC file.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-serial"><refnamediv><refname>serial</refname><refpurpose>Serial Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-serial.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>baud<indexterm zone="settings-serial"><primary sortas="baud">baud</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>57600</screen></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><screen>bits<indexterm zone="settings-serial"><primary sortas="bits">bits</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>8</screen></entry><entry>Byte-width of the serial communication. The 8 in "8n1" for example.</entry></row><row><entry><screen>parity<indexterm zone="settings-serial"><primary sortas="parity">parity</primary></indexterm></screen></entry><entry><screen>byte</screen></entry><entry><screen/></entry><entry>The connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.</entry></row><row><entry><screen>send-delay<indexterm zone="settings-serial"><primary sortas="send-delay">send-delay</primary></indexterm></screen></entry><entry><screen>uint64</screen></entry><entry><screen>0</screen></entry><entry>Time to delay between each byte sent to the modem, in microseconds.</entry></row><row><entry><screen>stopbits<indexterm zone="settings-serial"><primary sortas="stopbits">stopbits</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-sriov"><refnamediv><refname>sriov</refname><refpurpose>SR-IOV settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-sriov.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>autoprobe-drivers<indexterm zone="settings-sriov"><primary sortas="autoprobe-drivers">autoprobe-drivers</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>Whether to autoprobe virtual functions by a compatible driver. + +If set to NM_TERNARY_TRUE (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF. + +If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them. + +When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_TRUE (1).</entry></row><row><entry><screen>total-vfs<indexterm zone="settings-sriov"><primary sortas="total-vfs">total-vfs</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The total number of virtual functions to create. + +Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.</entry></row><row><entry><screen>vfs<indexterm zone="settings-sriov"><primary sortas="vfs">vfs</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>Array of virtual function descriptors. + +Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF. + +When represented as string a VF is in the form: + +"INDEX [ATTR=VALUE[ ATTR=VALUE]...]". + +for example: + +"2 mac=00:11:22:33:44:55 spoof-check=true". + +Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans. + +The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form + +"ID[.PRIORITY[.PROTO]]". + +PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-tc"><refnamediv><refname>tc</refname><refpurpose>Linux Traffic Control Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-tc.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>qdiscs<indexterm zone="settings-tc"><primary sortas="qdiscs">qdiscs</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>Array of TC queueing disciplines. + +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.</entry></row><row><entry><screen>tfilters<indexterm zone="settings-tc"><primary sortas="tfilters">tfilters</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>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.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-team"><refnamediv><refname>team</refname><refpurpose>Teaming Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-team.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>config<indexterm zone="settings-team"><primary sortas="config">config</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>interface-name<indexterm zone="settings-team"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.</entry></row><row><entry><screen>link-watchers<indexterm zone="settings-team"><primary sortas="link-watchers">link-watchers</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><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><screen>mcast-rejoin-count<indexterm zone="settings-team"><primary sortas="mcast-rejoin-count">mcast-rejoin-count</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Corresponds to the teamd mcast_rejoin.count.</entry></row><row><entry><screen>mcast-rejoin-interval<indexterm zone="settings-team"><primary sortas="mcast-rejoin-interval">mcast-rejoin-interval</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Corresponds to the teamd mcast_rejoin.interval.</entry></row><row><entry><screen>notify-peers-count<indexterm zone="settings-team"><primary sortas="notify-peers-count">notify-peers-count</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Corresponds to the teamd notify_peers.count.</entry></row><row><entry><screen>notify-peers-interval<indexterm zone="settings-team"><primary sortas="notify-peers-interval">notify-peers-interval</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Corresponds to the teamd notify_peers.interval.</entry></row><row><entry><screen>runner<indexterm zone="settings-team"><primary sortas="runner">runner</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</entry></row><row><entry><screen>runner-active<indexterm zone="settings-team"><primary sortas="runner-active">runner-active</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Corresponds to the teamd runner.active.</entry></row><row><entry><screen>runner-agg-select-policy<indexterm zone="settings-team"><primary sortas="runner-agg-select-policy">runner-agg-select-policy</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Corresponds to the teamd runner.agg_select_policy.</entry></row><row><entry><screen>runner-fast-rate<indexterm zone="settings-team"><primary sortas="runner-fast-rate">runner-fast-rate</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Corresponds to the teamd runner.fast_rate.</entry></row><row><entry><screen>runner-hwaddr-policy<indexterm zone="settings-team"><primary sortas="runner-hwaddr-policy">runner-hwaddr-policy</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Corresponds to the teamd runner.hwaddr_policy.</entry></row><row><entry><screen>runner-min-ports<indexterm zone="settings-team"><primary sortas="runner-min-ports">runner-min-ports</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Corresponds to the teamd runner.min_ports.</entry></row><row><entry><screen>runner-sys-prio<indexterm zone="settings-team"><primary sortas="runner-sys-prio">runner-sys-prio</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Corresponds to the teamd runner.sys_prio.</entry></row><row><entry><screen>runner-tx-balancer<indexterm zone="settings-team"><primary sortas="runner-tx-balancer">runner-tx-balancer</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Corresponds to the teamd runner.tx_balancer.name.</entry></row><row><entry><screen>runner-tx-balancer-interval<indexterm zone="settings-team"><primary sortas="runner-tx-balancer-interval">runner-tx-balancer-interval</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Corresponds to the teamd runner.tx_balancer.interval.</entry></row><row><entry><screen>runner-tx-hash<indexterm zone="settings-team"><primary sortas="runner-tx-hash">runner-tx-hash</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>Corresponds to the teamd runner.tx_hash.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-team-port"><refnamediv><refname>team-port</refname><refpurpose>Team Port Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-team-port.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>config<indexterm zone="settings-team-port"><primary sortas="config">config</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>lacp-key<indexterm zone="settings-team-port"><primary sortas="lacp-key">lacp-key</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Corresponds to the teamd ports.PORTIFNAME.lacp_key.</entry></row><row><entry><screen>lacp-prio<indexterm zone="settings-team-port"><primary sortas="lacp-prio">lacp-prio</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</entry></row><row><entry><screen>link-watchers<indexterm zone="settings-team-port"><primary sortas="link-watchers">link-watchers</primary></indexterm></screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><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><screen>prio<indexterm zone="settings-team-port"><primary sortas="prio">prio</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Corresponds to the teamd ports.PORTIFNAME.prio.</entry></row><row><entry><screen>queue-id<indexterm zone="settings-team-port"><primary sortas="queue-id">queue-id</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></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><screen>sticky<indexterm zone="settings-team-port"><primary sortas="sticky">sticky</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Corresponds to the teamd ports.PORTIFNAME.sticky.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-tun"><refnamediv><refname>tun</refname><refpurpose>Tunnel Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-tun.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>group<indexterm zone="settings-tun"><primary sortas="group">group</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>mode<indexterm zone="settings-tun"><primary sortas="mode">mode</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></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><screen>multi-queue<indexterm zone="settings-tun"><primary sortas="multi-queue">multi-queue</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></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><screen>owner<indexterm zone="settings-tun"><primary sortas="owner">owner</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>pi<indexterm zone="settings-tun"><primary sortas="pi">pi</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</entry></row><row><entry><screen>vnet-hdr<indexterm zone="settings-tun"><primary sortas="vnet-hdr">vnet-hdr</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-user"><refnamediv><refname>user</refname><refpurpose>General User Profile Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-user.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>data<indexterm zone="settings-user"><primary sortas="data">data</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></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></table></para></refsect1></refentry><refentry id="settings-vlan"><refnamediv><refname>vlan</refname><refpurpose>VLAN Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-vlan.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>egress-priority-map<indexterm zone="settings-vlan"><primary sortas="egress-priority-map">egress-priority-map</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</entry></row><row><entry><screen>flags<indexterm zone="settings-vlan"><primary sortas="flags">flags</primary></indexterm></screen></entry><entry><screen>NMVlanFlags (uint32)</screen></entry><entry><screen/></entry><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). + +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><screen>id<indexterm zone="settings-vlan"><primary sortas="id">id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>ingress-priority-map<indexterm zone="settings-vlan"><primary sortas="ingress-priority-map">ingress-priority-map</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</entry></row><row><entry><screen>interface-name<indexterm zone="settings-vlan"><primary sortas="interface-name">interface-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.</entry></row><row><entry><screen>parent<indexterm zone="settings-vlan"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If given, specifies the parent interface name or parent connection UUID from which this 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><screen>protocol<indexterm zone="settings-vlan"><primary sortas="protocol">protocol</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Specifies the VLAN protocol to use for encapsulation. + +Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-vpn"><refnamediv><refname>vpn</refname><refpurpose>VPN Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-vpn.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>data<indexterm zone="settings-vpn"><primary sortas="data">data</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></entry><entry>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</entry></row><row><entry><screen>persistent<indexterm zone="settings-vpn"><primary sortas="persistent">persistent</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></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><screen>secrets<indexterm zone="settings-vpn"><primary sortas="secrets">secrets</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></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><screen>service-type<indexterm zone="settings-vpn"><primary sortas="service-type">service-type</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</entry></row><row><entry><screen>timeout<indexterm zone="settings-vpn"><primary sortas="timeout">timeout</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.</entry></row><row><entry><screen>user-name<indexterm zone="settings-vpn"><primary sortas="user-name">user-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-vrf"><refnamediv><refname>vrf</refname><refpurpose>VRF settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-vrf.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>table<indexterm zone="settings-vrf"><primary sortas="table">table</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The routing table for this VRF.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-vxlan"><refnamediv><refname>vxlan</refname><refpurpose>VXLAN Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-vxlan.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>ageing<indexterm zone="settings-vxlan"><primary sortas="ageing">ageing</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>300</screen></entry><entry>Specifies the lifetime in seconds of FDB entries learnt by the kernel.</entry></row><row><entry><screen>destination-port<indexterm zone="settings-vxlan"><primary sortas="destination-port">destination-port</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>8472</screen></entry><entry>Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</entry></row><row><entry><screen>id<indexterm zone="settings-vxlan"><primary sortas="id">id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.</entry></row><row><entry><screen>l2-miss<indexterm zone="settings-vxlan"><primary sortas="l2-miss">l2-miss</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Specifies whether netlink LL ADDR miss notifications are generated.</entry></row><row><entry><screen>l3-miss<indexterm zone="settings-vxlan"><primary sortas="l3-miss">l3-miss</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Specifies whether netlink IP ADDR miss notifications are generated.</entry></row><row><entry><screen>learning<indexterm zone="settings-vxlan"><primary sortas="learning">learning</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</entry></row><row><entry><screen>limit<indexterm zone="settings-vxlan"><primary sortas="limit">limit</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>local<indexterm zone="settings-vxlan"><primary sortas="local">local</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If given, specifies the source IP address to use in outgoing packets.</entry></row><row><entry><screen>parent<indexterm zone="settings-vxlan"><primary sortas="parent">parent</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If given, specifies the parent interface name or parent connection UUID.</entry></row><row><entry><screen>proxy<indexterm zone="settings-vxlan"><primary sortas="proxy">proxy</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Specifies whether ARP proxy is turned on.</entry></row><row><entry><screen>remote<indexterm zone="settings-vxlan"><primary sortas="remote">remote</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>rsc<indexterm zone="settings-vxlan"><primary sortas="rsc">rsc</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Specifies whether route short circuit is turned on.</entry></row><row><entry><screen>source-port-max<indexterm zone="settings-vxlan"><primary sortas="source-port-max">source-port-max</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</entry></row><row><entry><screen>source-port-min<indexterm zone="settings-vxlan"><primary sortas="source-port-min">source-port-min</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</entry></row><row><entry><screen>tos<indexterm zone="settings-vxlan"><primary sortas="tos">tos</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Specifies the TOS value to use in outgoing packets.</entry></row><row><entry><screen>ttl<indexterm zone="settings-vxlan"><primary sortas="ttl">ttl</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Specifies the time-to-live value to use in outgoing packets.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-wifi-p2p"><refnamediv><refname>wifi-p2p</refname><refpurpose>Wi-Fi P2P Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wifi-p2p.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>peer<indexterm zone="settings-wifi-p2p"><primary sortas="peer">peer</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><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><screen>wfd-ies<indexterm zone="settings-wifi-p2p"><primary sortas="wfd-ies">wfd-ies</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>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.</entry></row><row><entry><screen>wps-method<indexterm zone="settings-wifi-p2p"><primary sortas="wps-method">wps-method</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Flags indicating which mode of WPS is to be used. + +There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-wimax"><refnamediv><refname>wimax</refname><refpurpose>WiMax Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wimax.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>mac-address<indexterm zone="settings-wimax"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing).</entry></row><row><entry><screen>network-name<indexterm zone="settings-wimax"><primary sortas="network-name">network-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Network Service Provider (NSP) name of the WiMAX network this connection should use.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-3-ethernet"><refnamediv><refname>802-3-ethernet</refname><refpurpose>Wired Ethernet Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-3-ethernet.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>accept-all-mac-addresses<indexterm zone="settings-802-3-ethernet"><primary sortas="accept-all-mac-addresses">accept-all-mac-addresses</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.</entry></row><row><entry><screen>assigned-mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="assigned-mac-address">assigned-mac-address</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".</entry></row><row><entry><screen>auto-negotiate<indexterm zone="settings-802-3-ethernet"><primary sortas="auto-negotiate">auto-negotiate</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.</entry></row><row><entry><screen>cloned-mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="cloned-mac-address">cloned-mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".</entry></row><row><entry><screen>duplex<indexterm zone="settings-802-3-ethernet"><primary sortas="duplex">duplex</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.</entry></row><row><entry><screen>generate-mac-address-mask<indexterm zone="settings-802-3-ethernet"><primary sortas="generate-mac-address-mask">generate-mac-address-mask</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. + +If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. + +If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. + +If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. + +If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</entry></row><row><entry><screen>mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row><row><entry><screen>mac-address-blacklist<indexterm zone="settings-802-3-ethernet"><primary sortas="mac-address-blacklist">mac-address-blacklist</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</entry></row><row><entry><screen>mtu<indexterm zone="settings-802-3-ethernet"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row><row><entry><screen>port<indexterm zone="settings-802-3-ethernet"><primary sortas="port">port</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Specific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.</entry></row><row><entry><screen>s390-nettype<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-nettype">s390-nettype</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</entry></row><row><entry><screen>s390-options<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-options">s390-options</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></entry><entry>Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). + +Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.</entry></row><row><entry><screen>s390-subchannels<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-subchannels">s390-subchannels</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</entry></row><row><entry><screen>speed<indexterm zone="settings-802-3-ethernet"><primary sortas="speed">speed</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.</entry></row><row><entry><screen>wake-on-lan<indexterm zone="settings-802-3-ethernet"><primary sortas="wake-on-lan">wake-on-lan</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry>The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</entry></row><row><entry><screen>wake-on-lan-password<indexterm zone="settings-802-3-ethernet"><primary sortas="wake-on-lan-password">wake-on-lan-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-wireguard"><refnamediv><refname>wireguard</refname><refpurpose>WireGuard Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wireguard.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>fwmark<indexterm zone="settings-wireguard"><primary sortas="fwmark">fwmark</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets. + +Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.</entry></row><row><entry><screen>ip4-auto-default-route<indexterm zone="settings-wireguard"><primary sortas="ip4-auto-default-route">ip4-auto-default-route</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing". + +Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route. + +Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. 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><screen>ip6-auto-default-route<indexterm zone="settings-wireguard"><primary sortas="ip6-auto-default-route">ip6-auto-default-route</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>Like ip4-auto-default-route, but for the IPv6 default route.</entry></row><row><entry><screen>listen-port<indexterm zone="settings-wireguard"><primary sortas="listen-port">listen-port</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</entry></row><row><entry><screen>mtu<indexterm zone="settings-wireguard"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. + +If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.</entry></row><row><entry><screen>peer-routes<indexterm zone="settings-wireguard"><primary sortas="peer-routes">peer-routes</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Whether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively. + +Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.</entry></row><row><entry><screen>peers<indexterm zone="settings-wireguard"><primary sortas="peers">peers</primary></indexterm></screen></entry><entry><screen>array of 'a{sv}'</screen></entry><entry><screen/></entry><entry>Array of dictionaries for the WireGuard peers.</entry></row><row><entry><screen>private-key<indexterm zone="settings-wireguard"><primary sortas="private-key">private-key</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The 256 bit private-key in base64 encoding.</entry></row><row><entry><screen>private-key-flags<indexterm zone="settings-wireguard"><primary sortas="private-key-flags">private-key-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "private-key" property.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-11-wireless"><refnamediv><refname>802-11-wireless</refname><refpurpose>Wi-Fi Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-11-wireless.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>ap-isolation<indexterm zone="settings-802-11-wireless"><primary sortas="ap-isolation">ap-isolation</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><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_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).</entry></row><row><entry><screen>assigned-mac-address<indexterm zone="settings-802-11-wireless"><primary sortas="assigned-mac-address">assigned-mac-address</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".</entry></row><row><entry><screen>band<indexterm zone="settings-802-11-wireless"><primary sortas="band">band</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the 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><screen>bssid<indexterm zone="settings-802-11-wireless"><primary sortas="bssid">bssid</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future. + +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><screen>channel<indexterm zone="settings-802-11-wireless"><primary sortas="channel">channel</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>cloned-mac-address<indexterm zone="settings-802-11-wireless"><primary sortas="cloned-mac-address">cloned-mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".</entry></row><row><entry><screen>generate-mac-address-mask<indexterm zone="settings-802-11-wireless"><primary sortas="generate-mac-address-mask">generate-mac-address-mask</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. + +If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. + +If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. + +If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. + +If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</entry></row><row><entry><screen>hidden<indexterm zone="settings-802-11-wireless"><primary sortas="hidden">hidden</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></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><screen>mac-address<indexterm zone="settings-802-11-wireless"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, this connection will only apply to the 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><screen>mac-address-blacklist<indexterm zone="settings-802-11-wireless"><primary sortas="mac-address-blacklist">mac-address-blacklist</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><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><screen>mac-address-randomization<indexterm zone="settings-802-11-wireless"><primary sortas="mac-address-randomization">mac-address-randomization</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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).</entry></row><row><entry><screen>mode<indexterm zone="settings-802-11-wireless"><primary sortas="mode">mode</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</entry></row><row><entry><screen>mtu<indexterm zone="settings-802-11-wireless"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row><row><entry><screen>powersave<indexterm zone="settings-802-11-wireless"><primary sortas="powersave">powersave</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></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><screen>rate<indexterm zone="settings-802-11-wireless"><primary sortas="rate">rate</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>This property is not implemented and has no effect.</entry></row><row><entry><screen>security<indexterm zone="settings-802-11-wireless"><primary sortas="security">security</primary></indexterm></screen></entry><entry><screen/></entry><entry><screen/></entry><entry>This property is deprecated and has no effect. For backwards compatibility, it can be set to "802-11-wireless-security" if the profile has a wireless security setting.</entry></row><row><entry><screen>seen-bssids<indexterm zone="settings-802-11-wireless"><primary sortas="seen-bssids">seen-bssids</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the 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. + +This is not a regular property that the user would configure. Instead, NetworkManager automatically sets the seen BSSIDs and tracks them internally in "/var/lib/NetworkManager/seen-bssids" file.</entry></row><row><entry><screen>ssid<indexterm zone="settings-802-11-wireless"><primary sortas="ssid">ssid</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>SSID of the Wi-Fi network. Must be specified.</entry></row><row><entry><screen>tx-power<indexterm zone="settings-802-11-wireless"><primary sortas="tx-power">tx-power</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>This property is not implemented and has no effect.</entry></row><row><entry><screen>wake-on-wlan<indexterm zone="settings-802-11-wireless"><primary sortas="wake-on-wlan">wake-on-wlan</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></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></table></para></refsect1></refentry><refentry id="settings-802-11-wireless-security"><refnamediv><refname>802-11-wireless-security</refname><refpurpose>Wi-Fi Security Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-11-wireless-security.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>auth-alg<indexterm zone="settings-802-11-wireless-security"><primary sortas="auth-alg">auth-alg</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.</entry></row><row><entry><screen>fils<indexterm zone="settings-802-11-wireless-security"><primary sortas="fils">fils</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled.</entry></row><row><entry><screen>group<indexterm zone="settings-802-11-wireless-security"><primary sortas="group">group</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".</entry></row><row><entry><screen>key-mgmt<indexterm zone="settings-802-11-wireless-security"><primary sortas="key-mgmt">key-mgmt</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only). + +This property must be set for any Wi-Fi connection that uses security.</entry></row><row><entry><screen>leap-password<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-password">leap-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row><row><entry><screen>leap-password-flags<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-password-flags">leap-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "leap-password" property.</entry></row><row><entry><screen>leap-username<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-username">leap-username</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row><row><entry><screen>pairwise<indexterm zone="settings-802-11-wireless-security"><primary sortas="pairwise">pairwise</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp".</entry></row><row><entry><screen>pmf<indexterm zone="settings-802-11-wireless-security"><primary sortas="pmf">pmf</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled.</entry></row><row><entry><screen>proto<indexterm zone="settings-802-11-wireless-security"><primary sortas="proto">proto</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.</entry></row><row><entry><screen>psk<indexterm zone="settings-802-11-wireless-security"><primary sortas="psk">psk</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.</entry></row><row><entry><screen>psk-flags<indexterm zone="settings-802-11-wireless-security"><primary sortas="psk-flags">psk-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "psk" property.</entry></row><row><entry><screen>wep-key-flags<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key-flags">wep-key-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</entry></row><row><entry><screen>wep-key-type<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key-type">wep-key-type</primary></indexterm></screen></entry><entry><screen>NMWepKeyType (uint32)</screen></entry><entry><screen/></entry><entry>Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.</entry></row><row><entry><screen>wep-key0<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key0">wep-key0</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry><screen>wep-key1<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key1">wep-key1</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry><screen>wep-key2<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key2">wep-key2</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry><screen>wep-key3<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key3">wep-key3</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry><screen>wep-tx-keyidx<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-tx-keyidx">wep-tx-keyidx</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.</entry></row><row><entry><screen>wps-method<indexterm zone="settings-802-11-wireless-security"><primary sortas="wps-method">wps-method</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Flags indicating which mode of WPS is to be used if any. + +There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities. + +WPS can be disabled by setting this property to a value of 1.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-wpan"><refnamediv><refname>wpan</refname><refpurpose>IEEE 802.15.4 (WPAN) MAC Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wpan.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>channel<indexterm zone="settings-wpan"><primary sortas="channel">channel</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</entry></row><row><entry><screen>mac-address<indexterm zone="settings-wpan"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.</entry></row><row><entry><screen>page<indexterm zone="settings-wpan"><primary sortas="page">page</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</entry></row><row><entry><screen>pan-id<indexterm zone="settings-wpan"><primary sortas="pan-id">pan-id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>65535</screen></entry><entry>IEEE 802.15.4 Personal Area Network (PAN) identifier.</entry></row><row><entry><screen>short-address<indexterm zone="settings-wpan"><primary sortas="short-address">short-address</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>65535</screen></entry><entry>Short IEEE 802.15.4 address to be used within a restricted environment.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-bond-port"><refnamediv><refname>bond-port</refname><refpurpose>Bond Port Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-bond-port.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>prio<indexterm zone="settings-bond-port"><primary sortas="prio">prio</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>The port priority for bond active port re-selection during failover. A higher number means a higher priority in selection. The primary port has the highest priority. This option is only compatible with active-backup, balance-tlb and balance-alb modes.</entry></row><row><entry><screen>queue-id<indexterm zone="settings-bond-port"><primary sortas="queue-id">queue-id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-hostname"><refnamediv><refname>hostname</refname><refpurpose>Hostname settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-hostname.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>from-dhcp<indexterm zone="settings-hostname"><primary sortas="from-dhcp">from-dhcp</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>Whether the system hostname can be determined from DHCP on this connection. + +When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).</entry></row><row><entry><screen>from-dns-lookup<indexterm zone="settings-hostname"><primary sortas="from-dns-lookup">from-dns-lookup</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>Whether the system hostname can be determined from reverse DNS lookup of addresses on this device. + +When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).</entry></row><row><entry><screen>only-from-default<indexterm zone="settings-hostname"><primary sortas="only-from-default">only-from-default</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>If set to NM_TERNARY_TRUE (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6). + +If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route. + +When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0).</entry></row><row><entry><screen>priority<indexterm zone="settings-hostname"><primary sortas="priority">priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority. + +If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100. + +Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-link"><refnamediv><refname>link</refname><refpurpose>Link settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-link.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>gro-max-size<indexterm zone="settings-link"><primary sortas="gro-max-size">gro-max-size</primary></indexterm></screen></entry><entry><screen>int64</screen></entry><entry><screen>-1</screen></entry><entry>The maximum size of a packet built by the Generic Receive Offload stack for this device. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</entry></row><row><entry><screen>gso-max-segments<indexterm zone="settings-link"><primary sortas="gso-max-segments">gso-max-segments</primary></indexterm></screen></entry><entry><screen>int64</screen></entry><entry><screen>-1</screen></entry><entry>The maximum segments of a Generic Segment Offload packet the device should accept. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</entry></row><row><entry><screen>gso-max-size<indexterm zone="settings-link"><primary sortas="gso-max-size">gso-max-size</primary></indexterm></screen></entry><entry><screen>int64</screen></entry><entry><screen>-1</screen></entry><entry>The maximum size of a Generic Segment Offload packet the device should accept. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</entry></row><row><entry><screen>tx-queue-length<indexterm zone="settings-link"><primary sortas="tx-queue-length">tx-queue-length</primary></indexterm></screen></entry><entry><screen>int64</screen></entry><entry><screen>-1</screen></entry><entry>The size of the transmit queue for the device, in number of packets. The value must be between 0 and 4294967295. When set to -1, the existing value is preserved.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-loopback"><refnamediv><refname>loopback</refname><refpurpose>Loopback Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-loopback.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>mtu<indexterm zone="settings-loopback"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ovs-external-ids"><refnamediv><refname>ovs-external-ids</refname><refpurpose>OVS External IDs Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-external-ids.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>data<indexterm zone="settings-ovs-external-ids"><primary sortas="data">data</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></entry><entry>A dictionary of key/value pairs with external-ids for OVS.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-ovs-other-config"><refnamediv><refname>ovs-other-config</refname><refpurpose>OVS Other Config Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-ovs-other-config.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>data<indexterm zone="settings-ovs-other-config"><primary sortas="data">data</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></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></table></para></refsect1></refentry><refentry id="settings-veth"><refnamediv><refname>veth</refname><refpurpose>Veth Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-veth.properties"> + Properties + </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>peer<indexterm zone="settings-veth"><primary sortas="peer">peer</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>This property specifies the peer interface name of the veth. This property is mandatory.</entry></row></tbody></tgroup></table></para></refsect1></refentry></chapter> diff --git a/docs/api/settings-spec.xsl b/docs/api/settings-spec.xsl index 80f27309..7a452237 100644 --- a/docs/api/settings-spec.xsl +++ b/docs/api/settings-spec.xsl @@ -63,7 +63,7 @@ </screen></entry> <entry><screen><xsl:value-of select="@type"/></screen></entry> <entry><screen><xsl:value-of select="@default"/></screen></entry> - <entry><xsl:value-of select="@description"/><xsl:if test="@type = 'NMSettingSecretFlags'"> (see <xref linkend="secrets-flags"/> for flag values)</xsl:if></entry> + <entry><xsl:value-of select="description"/><xsl:if test="@type = 'NMSettingSecretFlags'"> (see <xref linkend="secrets-flags"/> for flag values)</xsl:if></entry> </row> </xsl:template> diff --git a/docs/api/version.xml b/docs/api/version.xml index 31ffe251..372cf402 100644 --- a/docs/api/version.xml +++ b/docs/api/version.xml @@ -1 +1 @@ -1.42.8 +1.44.0 |