New upstream version 1.32.2

author: Sebastien Bacher <seb128@ubuntu.com> 2021-07-05 20:35:03 +0200
committer: Sebastien Bacher <seb128@ubuntu.com> 2021-07-05 20:35:03 +0200
commit: 35779c6675728fa6f0fd0a21cefb904408509c23 (patch)
tree: 553e7239e0ba182b4f9b29b1e7a9d66a595d08bc /docs/api/settings-spec.xml
parent: d92aa7f298fe84d4cf686c5ad64b73438e00d377 (diff)
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/api/settings-spec.xml b/docs/api/settings-spec.xml
index c6155585..3b41220c 100644
--- a/docs/api/settings-spec.xml
+++ b/docs/api/settings-spec.xml
@@ -42,9 +42,9 @@
             Properties
         </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>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 '|', '&amp;', '!' 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 (&amp;). 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 "&amp;!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, "&amp;\\!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 if prefixed with the exclamation mark unset). The argument must either be a single word, or an assignment (i.e. two words, separated "="). 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. See NMSettingMatch:interface-name for how special characters '|', '&amp;', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</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 '|', '&amp;', '!' 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">
+        </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 '|', '&amp;', '!' 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 (&amp;). 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 "&amp;!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, "&amp;\\!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 '|', '&amp;', '!' 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 '|', '&amp;', '!' 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.</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">
+        </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
@@ -66,7 +66,7 @@
             Properties
         </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>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.</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.</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">
+        </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
@@ -88,13 +88,13 @@
             Properties
         </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>mac-address<indexterm zone="settings-wimax"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). Deprecated: 1</entry></row><row><entry><screen>network-name<indexterm zone="settings-wimax"><primary sortas="network-name">network-name</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-3-ethernet"><refnamediv><refname>802-3-ethernet</refname><refpurpose>Wired Ethernet Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-3-ethernet.properties">
             Properties
-        </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>assigned-mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="assigned-mac-address">assigned-mac-address</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".</entry></row><row><entry><screen>auto-negotiate<indexterm zone="settings-802-3-ethernet"><primary sortas="auto-negotiate">auto-negotiate</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.</entry></row><row><entry><screen>cloned-mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="cloned-mac-address">cloned-mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".</entry></row><row><entry><screen>duplex<indexterm zone="settings-802-3-ethernet"><primary sortas="duplex">duplex</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.</entry></row><row><entry><screen>generate-mac-address-mask<indexterm zone="settings-802-3-ethernet"><primary sortas="generate-mac-address-mask">generate-mac-address-mask</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</entry></row><row><entry><screen>mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row><row><entry><screen>mac-address-blacklist<indexterm zone="settings-802-3-ethernet"><primary sortas="mac-address-blacklist">mac-address-blacklist</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list.  Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</entry></row><row><entry><screen>mtu<indexterm zone="settings-802-3-ethernet"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row><row><entry><screen>port<indexterm zone="settings-802-3-ethernet"><primary sortas="port">port</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Specific port type to use if the device supports multiple attachment methods.  One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.</entry></row><row><entry><screen>s390-nettype<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-nettype">s390-nettype</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</entry></row><row><entry><screen>s390-options<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-options">s390-options</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></entry><entry>Dictionary of key/value pairs of s390-specific device options.  Both keys and values must be strings.  Allowed keys include "portno", "layer2", "portname", "protocol", among others.  Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</entry></row><row><entry><screen>s390-subchannels<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-subchannels">s390-subchannels</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>Identifies specific subchannels that this network device uses for communication with z/VM or s390 host.  Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels.  The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</entry></row><row><entry><screen>speed<indexterm zone="settings-802-3-ethernet"><primary sortas="speed">speed</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.</entry></row><row><entry><screen>wake-on-lan<indexterm zone="settings-802-3-ethernet"><primary sortas="wake-on-lan">wake-on-lan</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry>The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</entry></row><row><entry><screen>wake-on-lan-password<indexterm zone="settings-802-3-ethernet"><primary sortas="wake-on-lan-password">wake-on-lan-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address.  If NULL, no password will be required.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-wireguard"><refnamediv><refname>wireguard</refname><refpurpose>WireGuard Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wireguard.properties">
+        </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>accept-all-mac-addresses<indexterm zone="settings-802-3-ethernet"><primary sortas="accept-all-mac-addresses">accept-all-mac-addresses</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.</entry></row><row><entry><screen>assigned-mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="assigned-mac-address">assigned-mac-address</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".</entry></row><row><entry><screen>auto-negotiate<indexterm zone="settings-802-3-ethernet"><primary sortas="auto-negotiate">auto-negotiate</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.</entry></row><row><entry><screen>cloned-mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="cloned-mac-address">cloned-mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".</entry></row><row><entry><screen>duplex<indexterm zone="settings-802-3-ethernet"><primary sortas="duplex">duplex</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.</entry></row><row><entry><screen>generate-mac-address-mask<indexterm zone="settings-802-3-ethernet"><primary sortas="generate-mac-address-mask">generate-mac-address-mask</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</entry></row><row><entry><screen>mac-address<indexterm zone="settings-802-3-ethernet"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row><row><entry><screen>mac-address-blacklist<indexterm zone="settings-802-3-ethernet"><primary sortas="mac-address-blacklist">mac-address-blacklist</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list.  Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</entry></row><row><entry><screen>mtu<indexterm zone="settings-802-3-ethernet"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row><row><entry><screen>port<indexterm zone="settings-802-3-ethernet"><primary sortas="port">port</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Specific port type to use if the device supports multiple attachment methods.  One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.</entry></row><row><entry><screen>s390-nettype<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-nettype">s390-nettype</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</entry></row><row><entry><screen>s390-options<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-options">s390-options</primary></indexterm></screen></entry><entry><screen>dict of string to string</screen></entry><entry><screen>{}</screen></entry><entry>Dictionary of key/value pairs of s390-specific device options.  Both keys and values must be strings.  Allowed keys include "portno", "layer2", "portname", "protocol", among others.  Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</entry></row><row><entry><screen>s390-subchannels<indexterm zone="settings-802-3-ethernet"><primary sortas="s390-subchannels">s390-subchannels</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>Identifies specific subchannels that this network device uses for communication with z/VM or s390 host.  Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels.  The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</entry></row><row><entry><screen>speed<indexterm zone="settings-802-3-ethernet"><primary sortas="speed">speed</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.</entry></row><row><entry><screen>wake-on-lan<indexterm zone="settings-802-3-ethernet"><primary sortas="wake-on-lan">wake-on-lan</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>1</screen></entry><entry>The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</entry></row><row><entry><screen>wake-on-lan-password<indexterm zone="settings-802-3-ethernet"><primary sortas="wake-on-lan-password">wake-on-lan-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address.  If NULL, no password will be required.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-wireguard"><refnamediv><refname>wireguard</refname><refpurpose>WireGuard Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wireguard.properties">
             Properties
         </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>fwmark<indexterm zone="settings-wireguard"><primary sortas="fwmark">fwmark</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets. Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.</entry></row><row><entry><screen>ip4-auto-default-route<indexterm zone="settings-wireguard"><primary sortas="ip4-auto-default-route">ip4-auto-default-route</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing". Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route. Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips.</entry></row><row><entry><screen>ip6-auto-default-route<indexterm zone="settings-wireguard"><primary sortas="ip6-auto-default-route">ip6-auto-default-route</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry>Like ip4-auto-default-route, but for the IPv6 default route.</entry></row><row><entry><screen>listen-port<indexterm zone="settings-wireguard"><primary sortas="listen-port">listen-port</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</entry></row><row><entry><screen>mtu<indexterm zone="settings-wireguard"><primary sortas="mtu">mtu</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.</entry></row><row><entry><screen>peer-routes<indexterm zone="settings-wireguard"><primary sortas="peer-routes">peer-routes</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>Whether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively. Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.</entry></row><row><entry><screen>peers<indexterm zone="settings-wireguard"><primary sortas="peers">peers</primary></indexterm></screen></entry><entry><screen>array of 'a{sv}'</screen></entry><entry><screen/></entry><entry>Array of dictionaries for the WireGuard peers.</entry></row><row><entry><screen>private-key<indexterm zone="settings-wireguard"><primary sortas="private-key">private-key</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The 256 bit private-key in base64 encoding.</entry></row><row><entry><screen>private-key-flags<indexterm zone="settings-wireguard"><primary sortas="private-key-flags">private-key-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "private-key" property.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-802-11-wireless"><refnamediv><refname>802-11-wireless</refname><refpurpose>Wi-Fi Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-802-11-wireless.properties">
             Properties
         </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.</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). This property is deprecated for 'cloned-mac-address'. Deprecated: 1</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>If non-zero, directs the device to only use the specified bitrate for communication with the access point.  Units are in Kb/s, ie 5500 = 5.5 Mbit/s.  This property is highly driver dependent and not all devices support setting a static bitrate.</entry></row><row><entry><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, but can be set to the value '802-11-wireless-security' when a wireless security setting is also present in the connection dictionary, for compatibility with very old NetworkManager daemons.</entry></row><row><entry><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.</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>If non-zero, directs the device to use the specified transmit power. Units are dBm.  This property is highly driver dependent and not all devices support setting a static transmit power.</entry></row><row><entry><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), "ieee8021x" (Dynamic WEP), "wpa-psk" (infrastructure WPA-PSK), "sae" (SAE), "owe" (Opportunistic Wireless Encryption), "wpa-eap" (WPA-Enterprise) or "wpa-eap-suite-b-192" (WPA3-Enterprise Suite B). 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">
+        </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>auth-alg<indexterm zone="settings-802-11-wireless-security"><primary sortas="auth-alg">auth-alg</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here.  One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP.  When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.</entry></row><row><entry><screen>fils<indexterm zone="settings-802-11-wireless-security"><primary sortas="fils">fils</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection.  One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported).  When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled.</entry></row><row><entry><screen>group<indexterm zone="settings-802-11-wireless-security"><primary sortas="group">group</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list.  For maximum compatibility leave this property empty.  Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".</entry></row><row><entry><screen>key-mgmt<indexterm zone="settings-802-11-wireless-security"><primary sortas="key-mgmt">key-mgmt</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only). This property must be set for any Wi-Fi connection that uses security.</entry></row><row><entry><screen>leap-password<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-password">leap-password</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row><row><entry><screen>leap-password-flags<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-password-flags">leap-password-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "leap-password" property.</entry></row><row><entry><screen>leap-username<indexterm zone="settings-802-11-wireless-security"><primary sortas="leap-username">leap-username</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row><row><entry><screen>pairwise<indexterm zone="settings-802-11-wireless-security"><primary sortas="pairwise">pairwise</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty.  Each list element may be one of "tkip" or "ccmp".</entry></row><row><entry><screen>pmf<indexterm zone="settings-802-11-wireless-security"><primary sortas="pmf">pmf</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>Indicates whether Protected Management Frames (802.11w) must be enabled for the connection.  One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported).  When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled.</entry></row><row><entry><screen>proto<indexterm zone="settings-802-11-wireless-security"><primary sortas="proto">proto</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen/></entry><entry>List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN).  If not specified, both WPA and RSN connections are allowed.</entry></row><row><entry><screen>psk<indexterm zone="settings-802-11-wireless-security"><primary sortas="psk">psk</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.</entry></row><row><entry><screen>psk-flags<indexterm zone="settings-802-11-wireless-security"><primary sortas="psk-flags">psk-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "psk" property.</entry></row><row><entry><screen>wep-key-flags<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key-flags">wep-key-flags</primary></indexterm></screen></entry><entry><screen>NMSettingSecretFlags (uint32)</screen></entry><entry><screen/></entry><entry>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</entry></row><row><entry><screen>wep-key-type<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key-type">wep-key-type</primary></indexterm></screen></entry><entry><screen>NMWepKeyType (uint32)</screen></entry><entry><screen/></entry><entry>Controls the interpretation of WEP keys.  Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.</entry></row><row><entry><screen>wep-key0<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key0">wep-key0</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Index 0 WEP key.  This is the WEP key used in most networks.  See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry><screen>wep-key1<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key1">wep-key1</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Index 1 WEP key.  This WEP index is not used by most networks.  See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry><screen>wep-key2<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key2">wep-key2</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Index 2 WEP key.  This WEP index is not used by most networks.  See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry><screen>wep-key3<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-key3">wep-key3</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Index 3 WEP key.  This WEP index is not used by most networks.  See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry><screen>wep-tx-keyidx<indexterm zone="settings-802-11-wireless-security"><primary sortas="wep-tx-keyidx">wep-tx-keyidx</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here.  Valid values are 0 (default key) through 3.  Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.</entry></row><row><entry><screen>wps-method<indexterm zone="settings-802-11-wireless-security"><primary sortas="wps-method">wps-method</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Flags indicating which mode of WPS is to be used if any. There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities. WPS can be disabled by setting this property to a value of 1.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-wpan"><refnamediv><refname>wpan</refname><refpurpose>IEEE 802.15.4 (WPAN) MAC Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-wpan.properties">
             Properties
         </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>channel<indexterm zone="settings-wpan"><primary sortas="channel">channel</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</entry></row><row><entry><screen>mac-address<indexterm zone="settings-wpan"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.</entry></row><row><entry><screen>page<indexterm zone="settings-wpan"><primary sortas="page">page</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</entry></row><row><entry><screen>pan-id<indexterm zone="settings-wpan"><primary sortas="pan-id">pan-id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>65535</screen></entry><entry>IEEE 802.15.4 Personal Area Network (PAN) identifier.</entry></row><row><entry><screen>short-address<indexterm zone="settings-wpan"><primary sortas="short-address">short-address</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>65535</screen></entry><entry>Short IEEE 802.15.4 address to be used within a restricted environment.</entry></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-hostname"><refnamediv><refname>hostname</refname><refpurpose>Hostname settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-hostname.properties">
             Properties
author	Sebastien Bacher <seb128@ubuntu.com>	2021-07-05 20:35:03 +0200
committer	Sebastien Bacher <seb128@ubuntu.com>	2021-07-05 20:35:03 +0200
commit	35779c6675728fa6f0fd0a21cefb904408509c23 (patch)
tree	553e7239e0ba182b4f9b29b1e7a9d66a595d08bc /docs/api/settings-spec.xml
parent	d92aa7f298fe84d4cf686c5ad64b73438e00d377 (diff)