diff options
Diffstat (limited to 'man')
34 files changed, 2743 insertions, 1148 deletions
diff --git a/man/NetworkManager-dispatcher.8 b/man/NetworkManager-dispatcher.8 index 1c64fa85..ad442441 100644 --- a/man/NetworkManager-dispatcher.8 +++ b/man/NetworkManager-dispatcher.8 @@ -2,9 +2,9 @@ .\" Title: NetworkManager-dispatcher .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: Network management daemons -.\" Source: NetworkManager-dispatcher 1.44.2 +.\" Source: NetworkManager-dispatcher 1.45.90 .\" Language: English .\" .TH "NETWORKMANAGER\-DISPATCHER" "8" "" "NetworkManager\-dispatcher 1\&" "Network management daemons" @@ -43,9 +43,10 @@ directory or subdirectories in alphabetical order in response to network events\ Each script receives two arguments, the first being the interface name of the device an operation just happened on, and second the action\&. For device actions, the interface is the name of the kernel interface suitable for IP configuration\&. Thus it is either VPN_IP_IFACE, DEVICE_IP_IFACE, or DEVICE_IFACE, as applicable\&. For the \fIhostname\fR action the device name is always -"none" -and for +"none"\&. For \fIconnectivity\-change\fR +and +\fIdns\-change\fR it is empty\&. .PP The actions are: @@ -123,6 +124,12 @@ The network connectivity state has changed (no connectivity, went online, etc)\& The connection was reapplied on the device\&. .RE .PP +\fIdns\-change\fR +.RS 4 +The DNS configuration has changed\&. This action is raised even if NetworkManager is configured to not manage resolv\&.conf (for example, via dns=none)\&. In such case, the dispatch script can discover the DNS configuration provided by currently active connections by looking at file +/run/NetworkManager/resolv\&.conf +.RE +.PP The environment contains more information about the interface and the connection\&. The following variables are available for the use in the dispatcher scripts: .PP \fINM_DISPATCHER_ACTION\fR diff --git a/man/NetworkManager-dispatcher.xml b/man/NetworkManager-dispatcher.xml index 036b3c8d..f6e1d22d 100644 --- a/man/NetworkManager-dispatcher.xml +++ b/man/NetworkManager-dispatcher.xml @@ -7,22 +7,13 @@ ]> <!-- + SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later + NetworkManager-dispatcher(8) manual page Copyright 2005 - 2016 Red Hat, Inc. Copyright 2005 - 2009 Novell, Inc. Copyright 2005 Robert Love - - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. You may obtain a copy of the GNU Free Documentation License - from the Free Software Foundation by visiting their Web site or by - writing to: - - Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. --> <refentry id="NetworkManager-dispatcher"> @@ -68,8 +59,9 @@ device an operation just happened on, and second the action. For device actions, the interface is the name of the kernel interface suitable for IP configuration. Thus it is either VPN_IP_IFACE, DEVICE_IP_IFACE, or DEVICE_IFACE, as applicable. - For the <varname>hostname</varname> action the device name is always <literal>"none"</literal> - and for <varname>connectivity-change</varname> it is empty. + For the <varname>hostname</varname> action the device name is always + <literal>"none"</literal>. For <varname>connectivity-change</varname> and + <varname>dns-change</varname> it is empty. </para> <para>The actions are:</para> <variablelist class="dispatcher-options"> @@ -170,6 +162,16 @@ The connection was reapplied on the device. </para></listitem> </varlistentry> + <varlistentry> + <term><varname>dns-change</varname></term> + <listitem><para> + The DNS configuration has changed. This action is raised even if + NetworkManager is configured to not manage resolv.conf (for example, + via dns=none). In such case, the dispatch script can discover the + DNS configuration provided by currently active connections by + looking at file <filename>/run/NetworkManager/resolv.conf</filename> + </para></listitem> + </varlistentry> </variablelist> <para> The environment contains more information about the interface and the connection. diff --git a/man/NetworkManager-wait-online.service.8 b/man/NetworkManager-wait-online.service.8 index e7ffd0d7..37077e93 100644 --- a/man/NetworkManager-wait-online.service.8 +++ b/man/NetworkManager-wait-online.service.8 @@ -2,9 +2,9 @@ .\" Title: NetworkManager-wait-online.service .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: Network management daemons -.\" Source: NetworkManager-wait-online.service 1.44.2 +.\" Source: NetworkManager-wait-online.service 1.45.90 .\" Language: English .\" .TH "NETWORKMANAGER\-WAIT\-ONLINE\&" "8" "" "NetworkManager\-wait\-online\&" "Network management daemons" diff --git a/man/NetworkManager-wait-online.service.xml b/man/NetworkManager-wait-online.service.xml index 46068ea5..4776002c 100644 --- a/man/NetworkManager-wait-online.service.xml +++ b/man/NetworkManager-wait-online.service.xml @@ -7,18 +7,9 @@ ]> <!-- - NetworkManager-wait-online.service(8) manual page - - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. You may obtain a copy of the GNU Free Documentation License - from the Free Software Foundation by visiting their Web site or by - writing to: + SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later - Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + NetworkManager-wait-online.service(8) manual page --> <refentry id="NetworkManager-wait-online.service"> diff --git a/man/NetworkManager.8 b/man/NetworkManager.8 index 1df61c61..eb5ec2c8 100644 --- a/man/NetworkManager.8 +++ b/man/NetworkManager.8 @@ -2,12 +2,12 @@ .\" Title: NetworkManager .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: Network management daemons -.\" Source: NetworkManager 1.44.2 +.\" Source: NetworkManager 1.45.90 .\" Language: English .\" -.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.44\&.2" "Network management daemons" +.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.45\&.90" "Network management daemons" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -143,6 +143,37 @@ or "device*\&.managed=1" in NetworkManager\&.conf\&. .RE +.PP +\fIID_NET_MANAGED_BY\fR +.RS 4 +If +\fINM_UNMANAGED\fR +is set, this has no effect\&. Otherwise, if the attribute is set to anything but +"org\&.freedesktop\&.NetworkManager", the device is unmanaged\&. +.RE +.PP +\fINM_AUTO_DEFAULT_LINK_LOCAL_ONLY\fR +.RS 4 +If set to +"1" +or +"true", the automatically generated connections "Wired connection N" will only enable link local addressing for IPv4 and IPv6\&. This can be useful on thunderbolt devices or host\-to\-host USB devices\&. +.RE +.PP +\fIID_NET_AUTO_LINK_LOCAL_ONLY\fR +.RS 4 +Honored and treated the same as if +\fINM_AUTO_DEFAULT_LINK_LOCAL_ONLY\fR +were set\&. +.RE +.PP +\fIID_NET_DHCP_BROADCAST\fR +.RS 4 +If set to +"1" +or +"true", use broadcast requests for DHCPv4 offers\&. This can make sense of devices that can\*(Aqt handle unicast messages until being configured\&. +.RE .SH "SIGNALS" .PP NetworkManager process handles the following signals: @@ -241,7 +272,7 @@ Please report any bugs you find in NetworkManager at the \fBnmcli\fR(1), \fBnmcli-examples\fR(7), \fBnm-online\fR(1), -\fBnm-settings\fR(5), +\fBnm-settings-nmcli\fR(5), \fBnm-applet\fR(1), \fBnm-connection-editor\fR(1), \fBudev\fR(7) diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5 index d85d3950..f321598d 100644 --- a/man/NetworkManager.conf.5 +++ b/man/NetworkManager.conf.5 @@ -2,12 +2,12 @@ .\" Title: NetworkManager.conf .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: Configuration -.\" Source: NetworkManager 1.44.2 +.\" Source: NetworkManager 1.45.90 .\" Language: English .\" -.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.44\&.2" "Configuration" +.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.45\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -370,15 +370,6 @@ connection\&.autoconnect\-retries property set to \-1\&. If not specified, connections will be tried 4 times\&. Setting this value to 1 means to try activation once, without retry\&. .RE .PP -\fIslaves\-order\fR -.RS 4 -This key specifies in which order slave connections are auto\-activated on boot or when the master activates them\&. Allowed values are -name -(order connection by interface name, the default), or -index -(order slaves by their kernel index)\&. -.RE -.PP \fIfirewall\-backend\fR .RS 4 The firewall backend for configuring masquerading with shared mode\&. Set to either @@ -509,7 +500,9 @@ domains=ALL .sp and restart the daemon with \fBsystemctl restart NetworkManager\fR\&. Then reproduce the problem\&. You can find the logs in syslog (for example -\fBjournalctl\fR)\&. +\fBjournalctl\fR, or +\fBjournalctl \-u NetworkManager\fR +to show only logs from NetworkManager)\&. .PP Any settings here are overridden by the \fB\-\-log\-level\fR @@ -770,7 +763,7 @@ ipv6\&.ip6\-privacy=0 .SS "Supported Properties" .PP Not all properties can be overwritten, only the following properties are supported to have their default values configured (see -\fBnm-settings\fR(5) +\fBnm-settings-nmcli\fR(5) for details)\&. .PP @@ -1215,7 +1208,7 @@ Like the per\-connection settings ethernet\&.generate\-mac\-address\-mask and wifi\&.generate\-mac\-address\-mask, this allows to configure the generated MAC addresses during scanning\&. See -\fBnm-settings\fR(5) +\fBnm-settings-nmcli\fR(5) for details\&. .RE .PP @@ -1426,7 +1419,7 @@ plugin is the generic plugin that supports all the connection types and capabili for details about the file format\&. .sp The stored connection file may contain passwords, secrets and private keys in plain text, so it will be made readable only to root, and the plugin will ignore files that are readable or writable by any user or group other than root\&. See "Secret flag types" in -\fBnm-settings\fR(5) +\fBnm-settings-nmcli\fR(5) for how to avoid storing passwords in plain text\&. .sp This plugin is always active, and will automatically be used to store any connections that aren\*(Aqt supported by any other active plugin\&. @@ -1621,6 +1614,6 @@ Backslash is supported to escape the separators \*(Aq;\*(Aq and \*(Aq,\*(Aq, and \fBnmcli\fR(1), \fBnmcli-examples\fR(7), \fBnm-online\fR(1), -\fBnm-settings\fR(5), +\fBnm-settings-nmcli\fR(5), \fBnm-applet\fR(1), \fBnm-connection-editor\fR(1) diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml index c795d295..5a7f0d83 100644 --- a/man/NetworkManager.conf.xml +++ b/man/NetworkManager.conf.xml @@ -7,20 +7,11 @@ ]> <!-- - NetworkManager.conf(5) manual page - - Copyright 2010 - 2016 Red Hat, Inc. + SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. You may obtain a copy of the GNU Free Documentation License - from the Free Software Foundation by visiting their Web site or by - writing to: + NetworkManager.conf(5) manual page - Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + Copyright 2010 - 2023 Red Hat, Inc. --> <refentry id="NetworkManager.conf"> @@ -470,20 +461,6 @@ no-auto-default=* </varlistentry> <varlistentry> - <term><varname>slaves-order</varname></term> - <listitem> - <para> - This key specifies in which order slave connections are - auto-activated on boot or when the master activates - them. Allowed values are <literal>name</literal> (order - connection by interface name, the default), or - <literal>index</literal> (order slaves by their kernel - index). - </para> - </listitem> - </varlistentry> - - <varlistentry> <term><varname>firewall-backend</varname></term> <listitem> <para> @@ -657,7 +634,9 @@ level=TRACE domains=ALL </programlisting> and restart the daemon with <command>systemctl restart NetworkManager</command>. Then - reproduce the problem. You can find the logs in syslog (for example <command>journalctl</command>). + reproduce the problem. You can find the logs in syslog (for example + <command>journalctl</command>, or <command>journalctl -u NetworkManager</command> + to show only logs from NetworkManager). </para> <para> @@ -856,7 +835,7 @@ ipv6.ip6-privacy=0 <para> Not all properties can be overwritten, only the following properties are supported to have their default values configured - (see <link linkend='nm-settings'><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> for details). + (see <link linkend='nm-settings-nmcli'><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> for details). </para> <para> <!-- The following comment is used by check-config-options.sh, don't remove it. --> @@ -1353,7 +1332,7 @@ managed=1 <para> Like the per-connection settings <literal>ethernet.generate-mac-address-mask</literal> and <literal>wifi.generate-mac-address-mask</literal>, this allows to configure the - generated MAC addresses during scanning. See <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry> + generated MAC addresses during scanning. See <citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details. </para> </listitem> @@ -1656,7 +1635,7 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16 private keys in plain text, so it will be made readable only to root, and the plugin will ignore files that are readable or writable by any user or group other than root. See "Secret flag types" - in <link linkend='nm-settings'><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> + in <link linkend='nm-settings-nmcli'><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> for how to avoid storing passwords in plain text. </para> <para> @@ -1881,7 +1860,7 @@ interface-name:vboxnet*,except:interface-name:vboxnet2 <link linkend='nmcli'><citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link linkend='nmcli-examples'><citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>7</manvolnum></citerefentry></link>, <link linkend='nm-online'><citerefentry><refentrytitle>nm-online</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, - <link linkend='nm-settings'><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, + <link linkend='nm-settings-nmcli'><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <citerefentry><refentrytitle>nm-applet</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>nm-connection-editor</refentrytitle><manvolnum>1</manvolnum></citerefentry> </para> diff --git a/man/NetworkManager.xml b/man/NetworkManager.xml index f0b0f33f..ff1635cd 100644 --- a/man/NetworkManager.xml +++ b/man/NetworkManager.xml @@ -7,22 +7,13 @@ ]> <!-- + SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later + NetworkManager(8) manual page Copyright 2005 - 2016 Red Hat, Inc. Copyright 2005 - 2009 Novell, Inc. Copyright 2005 Robert Love - - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. You may obtain a copy of the GNU Free Documentation License - from the Free Software Foundation by visiting their Web site or by - writing to: - - Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. --> <refentry id="NetworkManager"> @@ -202,6 +193,42 @@ </para> </listitem> </varlistentry> + <varlistentry> + <term><varname>ID_NET_MANAGED_BY</varname></term> + <listitem><para> + If <varname>NM_UNMANAGED</varname> is set, this has no effect. Otherwise, + if the attribute is set to anything but + <literal>"org.freedesktop.NetworkManager"</literal>, the device is unmanaged. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>NM_AUTO_DEFAULT_LINK_LOCAL_ONLY</varname></term> + <listitem><para> + If set to <literal>"1"</literal> or <literal>"true"</literal>, the + automatically generated connections "Wired connection N" will only + enable link local addressing for IPv4 and IPv6. This can be useful + on thunderbolt devices or host-to-host USB devices. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>ID_NET_AUTO_LINK_LOCAL_ONLY</varname></term> + <listitem><para> + Honored and treated the same as if <varname>NM_AUTO_DEFAULT_LINK_LOCAL_ONLY</varname> + were set. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>ID_NET_DHCP_BROADCAST</varname></term> + <listitem><para> + If set to <literal>"1"</literal> or <literal>"true"</literal>, use + broadcast requests for DHCPv4 offers. This can make sense of devices + that can't handle unicast messages until being configured. + </para> + </listitem> + </varlistentry> </variablelist> </refsect1> @@ -357,7 +384,7 @@ <link linkend='nmcli'><citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link linkend='nmcli-examples'><citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>7</manvolnum></citerefentry></link>, <link linkend='nm-online'><citerefentry><refentrytitle>nm-online</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, - <link linkend='nm-settings'><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, + <link linkend='nm-settings-nmcli'><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <citerefentry><refentrytitle>nm-applet</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>nm-connection-editor</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry> diff --git a/man/meson.build b/man/meson.build index a2e1de83..f0113cd5 100644 --- a/man/meson.build +++ b/man/meson.build @@ -62,40 +62,40 @@ foreach man: mans endforeach if enable_introspection + merge_cmd = join_paths(meson.source_root(), 'tools', 'generate-docs-nm-settings-docs-merge.py') name = 'dbus' nm_settings_docs_xml_dbus = custom_target( 'nm-settings-docs-' + name + '.xml', - input: [nm_settings_docs_xml_gir, nm_property_infos_xml[name]], + input: [merge_cmd, nm_property_infos_xml[name], nm_settings_docs_xml_gir[name]], output: 'nm-settings-docs-' + name + '.xml', command: [ python.path(), - join_paths(meson.source_root(), 'tools', 'generate-docs-nm-settings-docs-merge.py'), + merge_cmd, '@OUTPUT@', nm_property_infos_xml[name], - nm_settings_docs_xml_gir, + nm_settings_docs_xml_gir[name] ], ) name = 'nmcli' nm_settings_docs_xml_nmcli = custom_target( 'nm-settings-docs-' + name + '.xml', - input: [nm_settings_docs_xml_gir, nm_property_infos_xml[name]], + input: [merge_cmd, nm_property_infos_xml[name], gen_metadata_nm_settings_nmcli_xml, nm_settings_docs_xml_gir[name]], output: 'nm-settings-docs-' + name + '.xml', command: [ python.path(), - join_paths(meson.source_root(), 'tools', 'generate-docs-nm-settings-docs-merge.py'), + merge_cmd, '@OUTPUT@', '--only-properties-from', gen_metadata_nm_settings_nmcli_xml, nm_property_infos_xml[name], gen_metadata_nm_settings_nmcli_xml, - nm_settings_docs_xml_gir, + nm_settings_docs_xml_gir[name] ], ) nm_settings_docs_xml = { - 'gir': nm_settings_docs_xml_gir, 'dbus': nm_settings_docs_xml_dbus, 'nmcli': nm_settings_docs_xml_nmcli, } @@ -112,14 +112,15 @@ if enable_introspection foreach man: mans output = man[0] + '.xml' + template = join_paths(meson.current_source_dir(), man[0] + '.xsl') input = custom_target( output, - input: man[2], + input: [template, man[2]], output: output, - command: xsltproc_options + [join_paths(meson.current_source_dir(), man[0] + '.xsl'), '@INPUT@'], + command: xsltproc_options + ['@INPUT@'], ) - content_files += input.full_path() + content_files += input output = '@0@.@1@'.format(man[0], man[1]) diff --git a/man/nm-cloud-setup.8 b/man/nm-cloud-setup.8 index d7f70191..3f10803c 100644 --- a/man/nm-cloud-setup.8 +++ b/man/nm-cloud-setup.8 @@ -2,12 +2,12 @@ .\" Title: nm-cloud-setup .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: Automatic Network Configuration in Cloud with NetworkManager -.\" Source: NetworkManager 1.44.2 +.\" Source: NetworkManager 1.45.90 .\" Language: English .\" -.TH "NM\-CLOUD\-SETUP" "8" "" "NetworkManager 1\&.44\&.2" "Automatic Network Configuratio" +.TH "NM\-CLOUD\-SETUP" "8" "" "NetworkManager 1\&.45\&.90" "Automatic Network Configuratio" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-cloud-setup.xml b/man/nm-cloud-setup.xml index 74ec0400..d0e14b4f 100644 --- a/man/nm-cloud-setup.xml +++ b/man/nm-cloud-setup.xml @@ -7,20 +7,11 @@ ]> <!-- + SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later + nm-cloud-setup(8) manual page Copyright 2020 Red Hat, Inc. - - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. You may obtain a copy of the GNU Free Documentation License - from the Free Software Foundation by visiting their Web site or by - writing to: - - Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. --> <refentry id="nm-cloud-setup"> diff --git a/man/nm-initrd-generator.8 b/man/nm-initrd-generator.8 index 6b78b351..8684c7cc 100644 --- a/man/nm-initrd-generator.8 +++ b/man/nm-initrd-generator.8 @@ -2,12 +2,12 @@ .\" Title: nm-initrd-generator .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: System Administration -.\" Source: NetworkManager 1.44.2 +.\" Source: NetworkManager 1.45.90 .\" Language: English .\" -.TH "NM\-INITRD\-GENERATOR" "8" "" "NetworkManager 1\&.44\&.2" "System Administration" +.TH "NM\-INITRD\-GENERATOR" "8" "" "NetworkManager 1\&.45\&.90" "System Administration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-initrd-generator.xml b/man/nm-initrd-generator.xml index 1905b7b6..336d7f03 100644 --- a/man/nm-initrd-generator.xml +++ b/man/nm-initrd-generator.xml @@ -7,20 +7,11 @@ ]> <!-- + SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later + nm-initrd-generator(8) manual page Copyright 2018 Red Hat, Inc. - - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. You may obtain a copy of the GNU Free Documentation License - from the Free Software Foundation by visiting their Web site or by - writing to: - - Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. --> <refentry id='nm-initrd-generator'> diff --git a/man/nm-online.1 b/man/nm-online.1 index 801577c8..1525bc66 100644 --- a/man/nm-online.1 +++ b/man/nm-online.1 @@ -2,12 +2,12 @@ .\" Title: nm-online .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.44.2 +.\" Source: NetworkManager 1.45.90 .\" Language: English .\" -.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.44\&.2" "General Commands Manual" +.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.45\&.90" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-online.xml b/man/nm-online.xml index 87672f74..e9deb83e 100644 --- a/man/nm-online.xml +++ b/man/nm-online.xml @@ -7,20 +7,11 @@ ]> <!-- + SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later + nm-online(1) manual page Copyright 2010 - 2016 Red Hat, Inc. - - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. You may obtain a copy of the GNU Free Documentation License - from the Free Software Foundation by visiting their Web site or by - writing to: - - Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. --> <refentry id='nm-online'> diff --git a/man/nm-openvswitch.7 b/man/nm-openvswitch.7 index acc5a824..0078cf7d 100644 --- a/man/nm-openvswitch.7 +++ b/man/nm-openvswitch.7 @@ -2,12 +2,12 @@ .\" Title: nm-openvswitch .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: Open vSwitch support overview -.\" Source: NetworkManager 1.44.2 +.\" Source: NetworkManager 1.45.90 .\" Language: English .\" -.TH "NM\-OPENVSWITCH" "7" "" "NetworkManager 1\&.44\&.2" "Open vSwitch support overview" +.TH "NM\-OPENVSWITCH" "7" "" "NetworkManager 1\&.45\&.90" "Open vSwitch support overview" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -195,7 +195,7 @@ Connection \*(Aqovs\-slave\-eth3\*(Aq (8dedeecb\-ed12\-482b\-b77a\-24a4fb835136) .RE .\} .PP -It\*(Aqs just a Port with multiple interfaces\&. See nm\-settings manual for Bonding options you can use with "nmcli c add" or "nmcli c modify"\&. You could even set a VLAN tag on the same Port to do VLAN tagging and bonding at the same time\&. +It\*(Aqs just a Port with multiple interfaces\&. See nm\-settings\-nmcli manual for Bonding options you can use with "nmcli c add" or "nmcli c modify"\&. You could even set a VLAN tag on the same Port to do VLAN tagging and bonding at the same time\&. .SH "BUGS" .sp .RS 4 @@ -226,7 +226,7 @@ Probably many more\&. \m[blue]\fBRFC 7047: The Open vSwitch Database Management Protocol\fR\m[]\&\s-2\u[1]\d\s+2, \fBovs-vsctl\fR(8), \fBovs-vswitchd.conf.db\fR(5), -\fBnm-settings\fR(5), +\fBnm-settings-nmcli\fR(5), \fBnmcli\fR(1) .SH "NOTES" .IP " 1." 4 diff --git a/man/nm-openvswitch.xml b/man/nm-openvswitch.xml index 52ecf96b..f0c2ca94 100644 --- a/man/nm-openvswitch.xml +++ b/man/nm-openvswitch.xml @@ -7,20 +7,11 @@ ]> <!-- + SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later + nm-openvswitch(7) manual page Copyright 2017 Red Hat, Inc. - - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. You may obtain a copy of the GNU Free Documentation License - from the Free Software Foundation by visiting their Web site or by - writing to: - - Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. --> <refentry id="nm-openvswitch"> @@ -170,7 +161,7 @@ Connection 'ovs-slave-eth2' (475ac1bf-30b2-4534-a877-27f33f58b082) successfully <prompt>$ </prompt><userinput>nmcli conn add type ethernet conn.interface eth3 master bond0</userinput> Connection 'ovs-slave-eth3' (8dedeecb-ed12-482b-b77a-24a4fb835136) successfully added. </screen> - <para>It's just a Port with multiple interfaces. See nm-settings manual for + <para>It's just a Port with multiple interfaces. See nm-settings-nmcli manual for Bonding options you can use with "nmcli c add" or "nmcli c modify". You could even set a VLAN tag on the same Port to do VLAN tagging and bonding at the same time.</para> @@ -197,7 +188,7 @@ Connection 'ovs-slave-eth3' (8dedeecb-ed12-482b-b77a-24a4fb835136) successfully <ulink url="https://www.rfc-editor.org/rfc/rfc7047.txt">RFC 7047: The Open vSwitch Database Management Protocol</ulink>, <citerefentry><refentrytitle>ovs-vsctl</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>ovs-vswitchd.conf.db</refentrytitle><manvolnum>5</manvolnum></citerefentry>, - <link linkend='nm-settings'><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, + <link linkend='nm-settings-nmcli'><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <link linkend='nmcli'><citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry></link> </para> </refsect1> diff --git a/man/nm-settings-dbus.5 b/man/nm-settings-dbus.5 index 400bb91e..d8c4087a 100644 --- a/man/nm-settings-dbus.5 +++ b/man/nm-settings-dbus.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-dbus .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: Configuration -.\" Source: NetworkManager 1.44.2 +.\" Source: NetworkManager 1.45.90 .\" Language: English .\" -.TH "NM\-SETTINGS\-DBUS" "5" "" "NetworkManager 1\&.44\&.2" "Configuration" +.TH "NM\-SETTINGS\-DBUS" "5" "" "NetworkManager 1\&.45\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -101,6 +101,8 @@ l l l l l l l l l l l l l l l l +l l l l +l l l l l l l l. T{ auth\-retries @@ -158,6 +160,15 @@ T}:T{ 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\&. T} T{ +controller +T}:T{ +string +T}:T{ +\ \& +T}:T{ +Interface name of the controller device or UUID of the controller connection\&. +T} +T{ dns\-over\-tls T}:T{ int32 @@ -231,6 +242,8 @@ T}:T{ \ \& T}:T{ Interface name of the master device or UUID of the master connection\&. + +Deprecated 1\&.46\&. Use "controller" instead, this is just an alias\&. T} T{ mdns @@ -315,6 +328,15 @@ An array of strings defining what access a given user has to this connection\&. At this time only the "user" [type] is allowed\&. Any other values are ignored and reserved for future use\&. [id] is the username that this permission refers to, which may not contain the ":" character\&. Any [reserved] information present must be ignored and is reserved for future use\&. All of [type], [id], and [reserved] must be valid UTF\-8\&. T} T{ +port\-type +T}:T{ +string +T}:T{ +\ \& +T}:T{ +Setting name of the device type of this port\*(Aqs controller connection (eg, "bond"), or NULL if this connection is not a port\&. +T} +T{ read\-only T}:T{ boolean @@ -342,6 +364,8 @@ T}:T{ \ \& T}:T{ Setting name of the device type of this slave\*(Aqs master connection (eg, "bond"), or NULL if this connection is not a slave\&. + +Deprecated 1\&.46\&. Use "port\-type" instead, this is just an alias\&. T} T{ stable\-id @@ -356,7 +380,7 @@ The stable\-id is used for generating IPv6 stable private addresses with ipv6\&. Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm\&. For example, a per\-host key is commonly also included, so that different systems end up generating different IDs\&. Or with ipv6\&.addr\-gen\-mode=stable\-privacy, also the device\*(Aqs name is included, so that different interfaces yield different addresses\&. The per\-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key\&. See NetworkManager(8) manual about the secret\-key and the host identity\&. -The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at 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\*(Aqs connection\&.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}\-${BOOT}\-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates\&. +The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at activation time\&. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${NETWORK_SSID}", "${BOOT}", "${RANDOM}"\&. These effectively create unique IDs per\-connection, per\-device, per\-SSID, per\-boot, or every time\&. The "${CONNECTION}" uses the profile\*(Aqs connection\&.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device\&. "${NETWORK_SSID}" uses the SSID for Wi\-Fi networks and falls back to "${CONNECTION}" on other networks\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}\-${BOOT}\-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates\&. If the value is unset, a global connection default is consulted\&. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile\&. T} @@ -1616,7 +1640,7 @@ NMSettingDcbFlags (uint32) T}:T{ \ \& T}:T{ -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)\&. +Specifies the NMSettingDcbFlags for the DCB FCoE application\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. T} T{ app\-fcoe\-mode @@ -1636,7 +1660,7 @@ int32 T}:T{ \-1 T}:T{ -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\&. +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 0x1 (enable) flag\&. T} T{ app\-fip\-flags @@ -1645,7 +1669,7 @@ NMSettingDcbFlags (uint32) T}:T{ \ \& T}:T{ -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)\&. +Specifies the NMSettingDcbFlags for the DCB FIP application\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. T} T{ app\-fip\-priority @@ -1654,7 +1678,7 @@ int32 T}:T{ \-1 T}:T{ -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\&. +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 0x1 (enable) flag\&. T} T{ app\-iscsi\-flags @@ -1663,7 +1687,7 @@ NMSettingDcbFlags (uint32) T}:T{ \ \& T}:T{ -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)\&. +Specifies the NMSettingDcbFlags for the DCB iSCSI application\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. T} T{ app\-iscsi\-priority @@ -1672,7 +1696,7 @@ int32 T}:T{ \-1 T}:T{ -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\&. +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 0x1 (enable) flag\&. T} T{ priority\-bandwidth @@ -1699,7 +1723,7 @@ NMSettingDcbFlags (uint32) T}:T{ \ \& T}:T{ -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)\&. +Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC)\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. T} T{ priority\-group\-bandwidth @@ -1717,7 +1741,7 @@ NMSettingDcbFlags (uint32) T}:T{ \ \& T}:T{ -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)\&. +Specifies the NMSettingDcbFlags for DCB Priority Groups\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. T} T{ priority\-group\-id @@ -1845,6 +1869,8 @@ T}:T{ \ \& T}:T{ 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\*(Aqs mobile broadband plan\&. The APN may only be composed of the characters a\-z, 0\-9, \&., and \- per GSM 03\&.60 Section 14\&.9\&. + +If the APN is unset (the default) then it may be detected based on "auto\-config" setting\&. The property can be explicitly set to the empty string to prevent that and use no APN\&. T} T{ auto\-config @@ -2142,9 +2168,9 @@ int32 T}:T{ \-1 T}:T{ -Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network\&. If an address conflict is detected, the activation will fail\&. A zero value means that no duplicate address detection is performed, \-1 means the default value (either configuration ipvx\&.dad\-timeout override or zero)\&. A value greater than zero is a timeout in milliseconds\&. +Maximum 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\&. The property is currently implemented only for IPv4\&. -The property is currently implemented only for IPv4\&. +A zero value means that no duplicate address detection is performed, \-1 means the default value (either the value configured globally in NetworkManger\&.conf or 200ms)\&. A value greater than zero is a timeout in milliseconds\&. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property\&. T} T{ dhcp\-client\-id @@ -2163,7 +2189,9 @@ The special value "duid" generates a RFC4361\-compliant client identifier based 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\&. +The special value "none" prevents any client identifier from being sent\&. Note that this is normally not recommended\&. + +If unset, a globally configured default from NetworkManager\&.conf is used\&. If still unset, the default depends on the DHCP plugin\&. The internal dhcp client will default to "mac" and the dhclient plugin will try to use one from its config file if present, or won\*(Aqt sent any client\-id otherwise\&. T} T{ dhcp\-fqdn @@ -2192,9 +2220,9 @@ T}:T{ T}:T{ Flags for the DHCP hostname and FQDN\&. -Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4)\&. When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6\&. +Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are 0x1 (fqdn\-serv\-update), 0x2 (fqdn\-encoded) and 0x4 (fqdn\-no\-update)\&. When no FQDN flag is set and 0x8 (fqdn\-clear\-flags) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and 0x8 (fqdn\-clear\-flags) is not set, the standard FQDN flags are set in the request: 0x1 (fqdn\-serv\-update), 0x2 (fqdn\-encoded) for IPv4 and 0x1 (fqdn\-serv\-update) for IPv6\&. -When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration\&. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests\&. +When this property is set to the default value 0x0 (none), a global default is looked up in NetworkManager configuration\&. If that value is unset or also 0x0 (none), then the standard FQDN flags described above are sent in the DHCP requests\&. T} T{ dhcp\-iaid @@ -2278,15 +2306,17 @@ array of string T}:T{ \ \& T}:T{ -Array of DNS options as described in man 5 resolv\&.conf\&. +Array of DNS options to be added to 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 following options are directly added to resolv\&.conf: "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"\&. See the resolv\&.conf(5) man page for a detailed description of these options\&. + +In addition, NetworkManager supports the special options "_no\-add\-edns0" and "_no\-add\-trust\-ad"\&. They are not added to resolv\&.conf, and can be used to prevent the automatic addition of options "edns0" and "trust\-ad" when using caching DNS plugins (see below)\&. The "trust\-ad" setting is only honored if the profile contributes name servers to resolv\&.conf, and if all contributing profiles have "trust\-ad" enabled\&. -When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added\&. +When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added, unless "_no\-add\-edns0" and "_no\-add\-trust\-ad" are present\&. T} T{ dns\-priority @@ -2539,7 +2569,7 @@ T}:T{ T}:T{ 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)\&. +The permitted values are: 0 (eui64), 1 (stable\-privacy)\&. 2 (default\-or\-eui64) or 3 (default)\&. 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\*(Aqs 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\&. @@ -2588,9 +2618,9 @@ int32 T}:T{ \-1 T}:T{ -Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network\&. If an address conflict is detected, the activation will fail\&. A zero value means that no duplicate address detection is performed, \-1 means the default value (either configuration ipvx\&.dad\-timeout override or zero)\&. A value greater than zero is a timeout in milliseconds\&. +Maximum 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\&. The property is currently implemented only for IPv4\&. -The property is currently implemented only for IPv4\&. +A zero value means that no duplicate address detection is performed, \-1 means the default value (either the value configured globally in NetworkManger\&.conf or 200ms)\&. A value greater than zero is a timeout in milliseconds\&. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property\&. T} T{ dhcp\-duid @@ -2627,9 +2657,9 @@ T}:T{ T}:T{ Flags for the DHCP hostname and FQDN\&. -Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4)\&. When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6\&. +Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are 0x1 (fqdn\-serv\-update), 0x2 (fqdn\-encoded) and 0x4 (fqdn\-no\-update)\&. When no FQDN flag is set and 0x8 (fqdn\-clear\-flags) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and 0x8 (fqdn\-clear\-flags) is not set, the standard FQDN flags are set in the request: 0x1 (fqdn\-serv\-update), 0x2 (fqdn\-encoded) for IPv4 and 0x1 (fqdn\-serv\-update) for IPv6\&. -When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration\&. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests\&. +When this property is set to the default value 0x0 (none), a global default is looked up in NetworkManager configuration\&. If that value is unset or also 0x0 (none), then the standard FQDN flags described above are sent in the DHCP requests\&. T} T{ dhcp\-iaid @@ -2713,15 +2743,17 @@ array of string T}:T{ \ \& T}:T{ -Array of DNS options as described in man 5 resolv\&.conf\&. +Array of DNS options to be added to 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 following options are directly added to resolv\&.conf: "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"\&. See the resolv\&.conf(5) man page for a detailed description of these options\&. + +In addition, NetworkManager supports the special options "_no\-add\-edns0" and "_no\-add\-trust\-ad"\&. They are not added to resolv\&.conf, and can be used to prevent the automatic addition of options "edns0" and "trust\-ad" when using caching DNS plugins (see below)\&. The "trust\-ad" setting is only honored if the profile contributes name servers to resolv\&.conf, and if all contributing profiles have "trust\-ad" enabled\&. -When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added\&. +When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added, unless "_no\-add\-edns0" and "_no\-add\-trust\-ad" are present\&. T} T{ dns\-priority @@ -2986,7 +3018,7 @@ uint32 T}:T{ 0 T}:T{ -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\&. +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 0x1 (ip6\-ign\-encap\-limit) to ip\-tunnel flags\&. T} T{ flags @@ -2995,7 +3027,7 @@ uint32 T}:T{ 0 T}:T{ -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\&. +Tunnel flags\&. Currently, the following values are supported: 0x1 (ip6\-ign\-encap\-limit), 0x2 (ip6\-use\-orig\-tclass), 0x4 (ip6\-use\-orig\-flowlabel), 0x8 (ip6\-mip6\-dev), 0x10 (ip6\-rcv\-dscp\-copy), 0x20 (ip6\-use\-orig\-fwmark)\&. They are valid only for IPv6 tunnels\&. T} T{ flow\-label @@ -3040,7 +3072,7 @@ uint32 T}:T{ 0 T}:T{ -The tunneling mode\&. Valid values: NM_IP_TUNNEL_MODE_IPIP (1), NM_IP_TUNNEL_MODE_GRE (2), NM_IP_TUNNEL_MODE_SIT (3), NM_IP_TUNNEL_MODE_ISATAP (4), NM_IP_TUNNEL_MODE_VTI (5), NM_IP_TUNNEL_MODE_IP6IP6 (6), NM_IP_TUNNEL_MODE_IPIP6 (7), NM_IP_TUNNEL_MODE_IP6GRE (8), NM_IP_TUNNEL_MODE_VTI6 (9), NM_IP_TUNNEL_MODE_GRETAP (10) and NM_IP_TUNNEL_MODE_IP6GRETAP (11) +The tunneling mode\&. Valid values: 1 (ipip), 2 (gre), 3 (sit), 4 (isatap), 5 (vti), 6 (ip6ip6), 7 (ipip6), 8 (ip6gre), 9 (vti6), 10 (gretap) and 11 (ip6gretap) T} T{ mtu @@ -3979,7 +4011,7 @@ int32 T}:T{ 0 T}:T{ -Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0) +Method for proxy configuration, Default is 0 (none) T} T{ pac\-script @@ -4097,11 +4129,11 @@ T}:T{ T}:T{ Whether to autoprobe virtual functions by a compatible driver\&. -If set to NM_TERNARY_TRUE (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF\&. +If set to 1 (true), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF\&. -If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them\&. +If set to 0 (false), VFs will not be claimed and no network interfaces will be created for them\&. -When set to NM_TERNARY_DEFAULT (\-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_TRUE (1)\&. +When set to \-1 (default), the global default is used; in case the global default is unspecified it is assumed to be 1 (true)\&. T} T{ total\-vfs @@ -4503,7 +4535,7 @@ uint32 T}:T{ 1 T}:T{ -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\&. +The operating mode of the virtual device\&. Allowed values are 1 (tun) to create a layer 3 device and 2 (tap) to create an Ethernet\-like layer 2 one\&. T} T{ multi\-queue @@ -4610,7 +4642,7 @@ NMVlanFlags (uint32) T}:T{ \ \& T}:T{ -One or more flags which control the behavior and features of the VLAN interface\&. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device\*(Aqs operating state)\&. NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol)\&. +One or more flags which control the behavior and features of the VLAN interface\&. Flags include 0x1 (reorder\-headers) (reordering of output packet headers), 0x2 (gvrp) (use of the GVRP protocol), and 0x4 (loose\-binding) (loose binding of the interface to its master device\*(Aqs operating state)\&. 0x8 (mvrp) (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\&. T} @@ -5216,7 +5248,7 @@ uint32 T}:T{ 1 T}:T{ -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)\&. +The NMSettingWiredWakeOnLan options to enable\&. Not all devices support all options\&. May be any combination of 0x2 (phy), 0x4 (unicast), 0x8 (multicast), 0x10 (broadcast), 0x20 (arp), 0x40 (magic) or the special values 0x1 (default) (to use global settings) and 0x8000 (ignore) (to disable management of Wake\-on\-LAN in NetworkManager)\&. T} T{ wake\-on\-lan\-password @@ -5390,13 +5422,13 @@ NMTernary (int32) T}:T{ \ \& T}:T{ -Configures AP isolation, which prevents communication between wireless devices connected to this AP\&. This property can be set to a value different from NM_TERNARY_DEFAULT (\-1) only when the interface is configured in AP mode\&. +Configures AP isolation, which prevents communication between wireless devices connected to this AP\&. This property can be set to a value different from \-1 (default) 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 1 (true), devices are not able to communicate with each other\&. This increases security because it protects devices against attacks from other clients in the network\&. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc\&. -If set to NM_TERNARY_FALSE (0), devices can talk to each other\&. +If set to 0 (false), devices can talk to each other\&. -When set to NM_TERNARY_DEFAULT (\-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_FALSE (0)\&. +When set to \-1 (default), the global default is used; in case the global default is unspecified it is assumed to be 0 (false)\&. T} T{ assigned\-mac\-address @@ -5502,7 +5534,7 @@ uint32 T}:T{ 0 T}:T{ -One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address)\&. +One of 0 (default) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), 1 (never) (never randomize the MAC address), or 2 (always) (always randomize the MAC address)\&. This property is deprecated since version 1\&.4\&.Use the "cloned\-mac\-address" property instead\&. T} @@ -5531,7 +5563,7 @@ uint32 T}:T{ 0 T}:T{ -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\*(Aqt touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value)\&. All other values are reserved\&. +One of 2 (disable) (disable Wi\-Fi power saving), 3 (enable) (enable Wi\-Fi power saving), 1 (ignore) (don\*(Aqt touch currently configure setting) or 0 (default) (use the globally configured value)\&. All other values are reserved\&. T} T{ rate @@ -5591,7 +5623,7 @@ uint32 T}:T{ 1 T}:T{ -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)\&. +The NMSettingWirelessWakeOnWLan options to enable\&. Not all devices support all options\&. May be any combination of 0x2 (any), 0x4 (disconnect), 0x8 (magic), 0x10 (gtk\-rekey\-failure), 0x20 (eap\-identity\-request), 0x40 (4way\-handshake), 0x80 (rfkill\-release), 0x100 (tcp) or the special values 0x1 (default) (to use global settings) and 0x8000 (ignore) (to disable management of Wake\-on\-LAN in NetworkManager)\&. T} .TE .sp 1 @@ -5647,7 +5679,7 @@ int32 T}:T{ 0 T}:T{ -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\&. +Indicates whether Fast Initial Link Setup (802\&.11ai) must be enabled for the connection\&. One of 0 (default) (use global default value), 1 (disable) (disable FILS), 2 (optional) (enable FILS if the supplicant and the access point support it) or 3 (required) (enable FILS and fail if not supported)\&. When set to 0 (default) and no global default is set, FILS will be optionally enabled\&. T} T{ group @@ -5712,7 +5744,7 @@ int32 T}:T{ 0 T}:T{ -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\&. +Indicates whether Protected Management Frames (802\&.11w) must be enabled for the connection\&. One of 0 (default) (use global default value), 1 (disable) (disable PMF), 2 (optional) (enable PMF if the supplicant and the access point support it) or 3 (required) (enable PMF and fail if not supported)\&. When set to 0 (default) and no global default is set, PMF will be optionally enabled\&. T} T{ proto @@ -5757,7 +5789,7 @@ NMWepKeyType (uint32) T}:T{ \ \& T}:T{ -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\&. +Controls the interpretation of WEP keys\&. Allowed values are 1 (key), in which case the key is either a 10\- or 26\-character hexadecimal string, or a 5\- or 13\-character ASCII password; or 2 (passphrase), 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\&. T} T{ wep\-key0 @@ -5954,7 +5986,7 @@ T}:T{ T}:T{ Whether the system hostname can be determined from DHCP on this connection\&. -When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1)\&. +When set to \-1 (default), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be 1 (true)\&. T} T{ from\-dns\-lookup @@ -5965,7 +5997,7 @@ T}:T{ T}:T{ Whether the system hostname can be determined from reverse DNS lookup of addresses on this device\&. -When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1)\&. +When set to \-1 (default), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be 1 (true)\&. T} T{ only\-from\-default @@ -5974,11 +6006,11 @@ NMTernary (int32) T}:T{ \ \& T}:T{ -If set to NM_TERNARY_TRUE (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6)\&. +If set to 1 (true), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6)\&. -If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn\*(Aqt have the default route\&. +If set to 0 (false), the hostname can be set from this device even if it doesn\*(Aqt have the default route\&. -When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0)\&. +When set to \-1 (default), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be 0 (false)\&. T} T{ priority @@ -5995,6 +6027,64 @@ Negative values have the special effect of excluding other connections with a gr T} .TE .sp 1 +.SS "hsr setting" +.PP +HSR/PRP Settings\&. +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l +l l l l +l l l l +l l l l. +T{ +multicast\-spec +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +The last byte of supervision address\&. +T} +T{ +port1 +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The port1 interface name of the HSR\&. This property is mandatory\&. +T} +T{ +port2 +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The port2 interface name of the HSR\&. This property is mandatory\&. +T} +T{ +prp +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +The protocol used by the interface, whether it is PRP or HSR\&. +T} +.TE +.sp 1 .SS "link setting" .PP Link settings\&. diff --git a/man/nm-settings-dbus.xml b/man/nm-settings-dbus.xml index db2f3b12..d7184d26 100644 --- a/man/nm-settings-dbus.xml +++ b/man/nm-settings-dbus.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-dbus"><refentryinfo><title>nm-settings-dbus</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-dbus</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.44.2</refmiscinfo></refmeta><refnamediv><refname>nm-settings-dbus</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles on the D-Bus API</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> +<refentry id="nm-settings-dbus"><refentryinfo><title>nm-settings-dbus</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-dbus</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.45.90</refmiscinfo></refmeta><refnamediv><refname>nm-settings-dbus</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles on the D-Bus API</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on a concept of connection profiles, sometimes referred to as connections only. These connection profiles contain a network configuration. When NetworkManager activates a connection profile on a network device the configuration will @@ -42,7 +42,7 @@ Note that autoconnect is not implemented for VPN profiles. See "secondaries" as If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined. -Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.autoconnect-priority">autoconnect-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.autoconnect-retries">autoconnect-retries</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.autoconnect-slaves">autoconnect-slaves</entry><entry align="left">NMSettingConnectionAutoconnectSlaves (int32)</entry><entry align="left"/><entry>Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.dns-over-tls">dns-over-tls</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic. +Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.autoconnect-priority">autoconnect-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.autoconnect-retries">autoconnect-retries</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.autoconnect-slaves">autoconnect-slaves</entry><entry align="left">NMSettingConnectionAutoconnectSlaves (int32)</entry><entry align="left"/><entry>Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.controller">controller</entry><entry align="left">string</entry><entry align="left"/><entry>Interface name of the controller device or UUID of the controller connection.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.dns-over-tls">dns-over-tls</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic. The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting. @@ -54,7 +54,9 @@ For connection types where interface names cannot easily be made persistent (e.g The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes"). -This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.master">master</entry><entry align="left">string</entry><entry align="left"/><entry>Interface name of the master device or UUID of the master connection.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.mdns">mdns</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Whether mDNS is enabled for the connection. +This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.master">master</entry><entry align="left">string</entry><entry align="left"/><entry>Interface name of the master device or UUID of the master connection. + +Deprecated 1.46. Use "controller" instead, this is just an alias.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.mdns">mdns</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Whether mDNS is enabled for the connection. The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no"). @@ -82,15 +84,17 @@ The special value "none" is allowed to indicate that no MUD URL is used. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.multi-connect">multi-connect</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.permissions">permissions</entry><entry align="left">array of string</entry><entry align="left"/><entry>An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". -At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.read-only">read-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>This property is deprecated and has no meaning. +At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.port-type">port-type</entry><entry align="left">string</entry><entry align="left"/><entry>Setting name of the device type of this port's controller connection (eg, "bond"), or NULL if this connection is not a port.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.read-only">read-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>This property is deprecated and has no meaning. + +This property is deprecated since version 1.44.This property is deprecated and has no meaning.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.secondaries">secondaries</entry><entry align="left">array of string</entry><entry align="left"/><entry>List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.slave-type">slave-type</entry><entry align="left">string</entry><entry align="left"/><entry>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave. -This property is deprecated since version 1.44.This property is deprecated and has no meaning.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.secondaries">secondaries</entry><entry align="left">array of string</entry><entry align="left"/><entry>List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.slave-type">slave-type</entry><entry align="left">string</entry><entry align="left"/><entry>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.stable-id">stable-id</entry><entry align="left">string</entry><entry align="left"/><entry>This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context. +Deprecated 1.46. Use "port-type" instead, this is just an alias.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.stable-id">stable-id</entry><entry align="left">string</entry><entry align="left"/><entry>This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context. The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used 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. +The '$' character is treated special to perform dynamic substitutions at activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${NETWORK_SSID}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-SSID, 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. "${NETWORK_SSID}" uses the SSID for Wi-Fi networks and falls back to "${CONNECTION}" on other networks. 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 align="left" id="nm-settings-dbus.property.connection.timestamp">timestamp</entry><entry align="left">uint64</entry><entry align="left">0</entry><entry>The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. @@ -150,9 +154,11 @@ 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></informaltable></refsect2><refsect2><title>cdma setting</title><para>CDMA-based Mobile Broadband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.cdma.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.cdma.number">number</entry><entry align="left">string</entry><entry align="left"/><entry>The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.</entry></row><row><entry align="left" id="nm-settings-dbus.property.cdma.password">password</entry><entry align="left">string</entry><entry align="left"/><entry>The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.</entry></row><row><entry align="left" id="nm-settings-dbus.property.cdma.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.cdma.username">username</entry><entry align="left">string</entry><entry align="left"/><entry>The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>dcb setting</title><para>Data Center Bridging Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fcoe-flags">app-fcoe-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fcoe-mode">app-fcoe-mode</entry><entry align="left">string</entry><entry align="left"/><entry>The FCoE controller mode; either "fabric" or "vn2vn". +where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>cdma setting</title><para>CDMA-based Mobile Broadband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.cdma.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.cdma.number">number</entry><entry align="left">string</entry><entry align="left"/><entry>The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.</entry></row><row><entry align="left" id="nm-settings-dbus.property.cdma.password">password</entry><entry align="left">string</entry><entry align="left"/><entry>The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.</entry></row><row><entry align="left" id="nm-settings-dbus.property.cdma.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.cdma.username">username</entry><entry align="left">string</entry><entry align="left"/><entry>The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>dcb setting</title><para>Data Center Bridging Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fcoe-flags">app-fcoe-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fcoe-mode">app-fcoe-mode</entry><entry align="left">string</entry><entry align="left"/><entry>The FCoE controller mode; either "fabric" or "vn2vn". + +Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fcoe-priority">app-fcoe-priority</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the 0x1 (enable) flag.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fip-flags">app-fip-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fip-priority">app-fip-priority</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the 0x1 (enable) flag.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-iscsi-flags">app-iscsi-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-iscsi-priority">app-iscsi-priority</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the 0x1 (enable) flag.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-bandwidth">priority-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-flow-control">priority-flow-control</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-flow-control-flags">priority-flow-control-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-group-bandwidth">priority-group-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-group-flags">priority-group-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-group-id">priority-group-id</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-strict-bandwidth">priority-strict-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-traffic-class">priority-traffic-class</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>dummy setting</title><para>Dummy Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody/></tgroup></informaltable></refsect2><refsect2><title>ethtool setting</title><para>Ethtool Ethernet Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody/></tgroup></informaltable></refsect2><refsect2><title>generic setting</title><para>Generic Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody/></tgroup></informaltable></refsect2><refsect2><title>gsm setting</title><para>GSM-based Mobile Broadband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.gsm.apn">apn</entry><entry align="left">string</entry><entry align="left"/><entry>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9. -Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fcoe-priority">app-fcoe-priority</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fip-flags">app-fip-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fip-priority">app-fip-priority</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-iscsi-flags">app-iscsi-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-iscsi-priority">app-iscsi-priority</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-bandwidth">priority-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-flow-control">priority-flow-control</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-flow-control-flags">priority-flow-control-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-group-bandwidth">priority-group-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-group-flags">priority-group-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-group-id">priority-group-id</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-strict-bandwidth">priority-strict-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-traffic-class">priority-traffic-class</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>dummy setting</title><para>Dummy Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody/></tgroup></informaltable></refsect2><refsect2><title>ethtool setting</title><para>Ethtool Ethernet Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody/></tgroup></informaltable></refsect2><refsect2><title>generic setting</title><para>Generic Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody/></tgroup></informaltable></refsect2><refsect2><title>gsm setting</title><para>GSM-based Mobile Broadband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.gsm.apn">apn</entry><entry align="left">string</entry><entry align="left"/><entry>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.auto-config">auto-config</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.device-id">device-id</entry><entry align="left">string</entry><entry align="left"/><entry>The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.home-only">home-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.initial-eps-bearer-apn">initial-eps-bearer-apn</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.gsm.initial-eps-bearer-configure">initial-eps-bearer-configure</entry><entry align="left">boolean</entry><entry align="left">FALSE</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 align="left" id="nm-settings-dbus.property.gsm.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.network-id">network-id</entry><entry align="left">string</entry><entry align="left"/><entry>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.number">number</entry><entry align="left">string</entry><entry align="left"/><entry>Legacy setting that used to help establishing PPP data sessions for GSM-based modems. +If the APN is unset (the default) then it may be detected based on "auto-config" setting. The property can be explicitly set to the empty string to prevent that and use no APN.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.auto-config">auto-config</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.device-id">device-id</entry><entry align="left">string</entry><entry align="left"/><entry>The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.home-only">home-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.initial-eps-bearer-apn">initial-eps-bearer-apn</entry><entry align="left">string</entry><entry align="left"/><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 align="left" id="nm-settings-dbus.property.gsm.initial-eps-bearer-configure">initial-eps-bearer-configure</entry><entry align="left">boolean</entry><entry align="left">FALSE</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 align="left" id="nm-settings-dbus.property.gsm.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.network-id">network-id</entry><entry align="left">string</entry><entry align="left"/><entry>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.number">number</entry><entry align="left">string</entry><entry align="left"/><entry>Legacy setting that used to help establishing PPP data sessions for GSM-based modems. This property is deprecated since version 1.16.User-provided values for this setting are no longer used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.password">password</entry><entry align="left">string</entry><entry align="left"/><entry>The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.pin">pin</entry><entry align="left">string</entry><entry align="left"/><entry>If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.pin-flags">pin-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "pin" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.sim-id">sim-id</entry><entry align="left">string</entry><entry align="left"/><entry>The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.sim-operator-id">sim-operator-id</entry><entry align="left">string</entry><entry align="left"/><entry>A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.username">username</entry><entry align="left">string</entry><entry align="left"/><entry>The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>infiniband setting</title><para>Infiniband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.infiniband.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.infiniband.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.infiniband.p-key">p-key</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The InfiniBand p-key to use for this device. A value of -1 means to use the default p-key (aka "the p-key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit 0x8000 is set if it is a "full membership" p-key. The values 0 and 0x8000 are not allowed. @@ -161,9 +167,9 @@ With the p-key set, the interface name is always "$parent.$p_key". Setting "conn 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 align="left" id="nm-settings-dbus.property.infiniband.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".</entry></row><row><entry align="left" id="nm-settings-dbus.property.infiniband.transport-mode">transport-mode</entry><entry align="left">string</entry><entry align="left"/><entry>The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ipv4 setting</title><para>IPv4 Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ipv4.address-data">address-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv4 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.addresses">addresses</entry><entry align="left">array of array of uint32</entry><entry align="left"/><entry>Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.auto-route-ext-gw">auto-route-ext-gw</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>VPN connections will default to add the route automatically unless this setting is set to FALSE. -For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dad-timeout">dad-timeout</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. +For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dad-timeout">dad-timeout</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Maximum 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. The property is currently implemented only for IPv4. -The property is currently implemented only for IPv4.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-client-id">dhcp-client-id</entry><entry align="left">string</entry><entry align="left"/><entry>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. +A zero value means that no duplicate address detection is performed, -1 means the default value (either the value configured globally in NetworkManger.conf or 200ms). A value greater than zero is a timeout in milliseconds. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-client-id">dhcp-client-id</entry><entry align="left">string</entry><entry align="left"/><entry>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. 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. @@ -173,11 +179,13 @@ The special value "duid" generates a RFC4361-compliant client identifier based o 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 align="left" id="nm-settings-dbus.property.ipv4.dhcp-fqdn">dhcp-fqdn</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-hostname">dhcp-hostname</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-hostname-flags">dhcp-hostname-flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Flags for the DHCP hostname and FQDN. +The special value "none" prevents any client identifier from being sent. Note that this is normally not recommended. -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. +If unset, a globally configured default from NetworkManager.conf is used. If still unset, the default depends on the DHCP plugin. The internal dhcp client will default to "mac" and the dhclient plugin will try to use one from its config file if present, or won't sent any client-id otherwise.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-fqdn">dhcp-fqdn</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-hostname">dhcp-hostname</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-hostname-flags">dhcp-hostname-flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Flags for the DHCP hostname and FQDN. -When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-iaid">dhcp-iaid</entry><entry align="left">string</entry><entry align="left"/><entry>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or 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". +Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) and 0x4 (fqdn-no-update). When no FQDN flag is set and 0x8 (fqdn-clear-flags) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and 0x8 (fqdn-clear-flags) is not set, the standard FQDN flags are set in the request: 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) for IPv4 and 0x1 (fqdn-serv-update) for IPv6. + +When this property is set to the default value 0x0 (none), a global default is looked up in NetworkManager configuration. If that value is unset or also 0x0 (none), then the standard FQDN flags described above are sent in the DHCP requests.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-iaid">dhcp-iaid</entry><entry align="left">string</entry><entry align="left"/><entry>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or 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. @@ -189,15 +197,17 @@ For DHCPv4, each element must be an IPv4 address, optionally followed by a slash This property is currently not implemented for DHCPv6.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-send-hostname">dhcp-send-hostname</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-timeout">dhcp-timeout</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). -Set to 2147483647 (MAXINT32) for infinity.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-vendor-class-identifier">dhcp-vendor-class-identifier</entry><entry align="left">string</entry><entry align="left"/><entry>The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns">dns</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>Array of IP addresses of DNS servers (as network-byte-order integers)</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns-data">dns-data</entry><entry align="left">array of strings</entry><entry align="left"/><entry>Array of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns-options">dns-options</entry><entry align="left">array of string</entry><entry align="left"/><entry>Array of DNS options as described in man 5 resolv.conf. +Set to 2147483647 (MAXINT32) for infinity.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-vendor-class-identifier">dhcp-vendor-class-identifier</entry><entry align="left">string</entry><entry align="left"/><entry>The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns">dns</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>Array of IP addresses of DNS servers (as network-byte-order integers)</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns-data">dns-data</entry><entry align="left">array of strings</entry><entry align="left"/><entry>Array of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns-options">dns-options</entry><entry align="left">array of string</entry><entry align="left"/><entry>Array of DNS options to be added to 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 following options are directly added to resolv.conf: "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". See the resolv.conf(5) man page for a detailed description of these options. + +In addition, NetworkManager supports the special options "_no-add-edns0" and "_no-add-trust-ad". They are not added to resolv.conf, and can be used to prevent the automatic addition of options "edns0" and "trust-ad" when using caching DNS plugins (see below). 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 align="left" id="nm-settings-dbus.property.ipv4.dns-priority">dns-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>DNS servers priority. +When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added, unless "_no-add-edns0" and "_no-add-trust-ad" are present.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dns-priority">dns-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>DNS servers priority. The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). @@ -244,7 +254,7 @@ If the table setting is left at zero, it is eligible to be overwritten via globa Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.routes">routes</entry><entry align="left">array of array of uint32</entry><entry align="left"/><entry>Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. If the metric is 0, NM will choose an appropriate default metric for the device. (There is no way to explicitly specify an actual metric of 0 with this property.)</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.routing-rules">routing-rules</entry><entry align="left">array of 'a{sv}'</entry><entry align="left"/><entry>Array of dictionaries for routing rules. Each routing rule supports the following options: action (y), dport-end (q), dport-start (q), family (i), from (s), from-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport-end (q), sport-start (q), supress-prefixlength (i), table (u), to (s), tos (y), to-len (y), range-end (u), range-start (u).</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ipv6 setting</title><para>IPv6 Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ipv6.addr-gen-mode">addr-gen-mode</entry><entry align="left">int32</entry><entry align="left">3</entry><entry>Configure 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). +The permitted values are: 0 (eui64), 1 (stable-privacy). 2 (default-or-eui64) or 3 (default). 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. @@ -257,9 +267,9 @@ For libnm, the property defaults to "default" since 1.40. Previously it used to Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.address-data">address-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv6 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.addresses">addresses</entry><entry align="left">array of legacy IPv6 address struct (a(ayuay))</entry><entry align="left"/><entry>Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv6 address structures. Each IPv6 address structure is composed of an IPv6 address, a prefix length (0 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.auto-route-ext-gw">auto-route-ext-gw</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>VPN connections will default to add the route automatically unless this setting is set to FALSE. -For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dad-timeout">dad-timeout</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds. +For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dad-timeout">dad-timeout</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Maximum 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. The property is currently implemented only for IPv4. -The property is currently implemented only for IPv4.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-duid">dhcp-duid</entry><entry align="left">string</entry><entry align="left"/><entry>A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option. +A zero value means that no duplicate address detection is performed, -1 means the default value (either the value configured globally in NetworkManger.conf or 200ms). A value greater than zero is a timeout in milliseconds. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-duid">dhcp-duid</entry><entry align="left">string</entry><entry align="left"/><entry>A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option. 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. @@ -269,9 +279,9 @@ The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a D When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-hostname">dhcp-hostname</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-hostname-flags">dhcp-hostname-flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Flags for the DHCP hostname and FQDN. -Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. +Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) and 0x4 (fqdn-no-update). When no FQDN flag is set and 0x8 (fqdn-clear-flags) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and 0x8 (fqdn-clear-flags) is not set, the standard FQDN flags are set in the request: 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) for IPv4 and 0x1 (fqdn-serv-update) 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 align="left" id="nm-settings-dbus.property.ipv6.dhcp-iaid">dhcp-iaid</entry><entry align="left">string</entry><entry align="left"/><entry>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or 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". +When this property is set to the default value 0x0 (none), a global default is looked up in NetworkManager configuration. If that value is unset or also 0x0 (none), then the standard FQDN flags described above are sent in the DHCP requests.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-iaid">dhcp-iaid</entry><entry align="left">string</entry><entry align="left"/><entry>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or 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. @@ -283,15 +293,17 @@ For DHCPv4, each element must be an IPv4 address, optionally followed by a slash This property is currently not implemented for DHCPv6.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-send-hostname">dhcp-send-hostname</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-timeout">dhcp-timeout</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). -Set to 2147483647 (MAXINT32) for infinity.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns">dns</entry><entry align="left">array of byte array</entry><entry align="left"/><entry>Array of IP addresses of DNS servers (in network byte order)</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns-data">dns-data</entry><entry align="left">array of strings</entry><entry align="left"/><entry>Array of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns-options">dns-options</entry><entry align="left">array of string</entry><entry align="left"/><entry>Array of DNS options as described in man 5 resolv.conf. +Set to 2147483647 (MAXINT32) for infinity.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns">dns</entry><entry align="left">array of byte array</entry><entry align="left"/><entry>Array of IP addresses of DNS servers (in network byte order)</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns-data">dns-data</entry><entry align="left">array of strings</entry><entry align="left"/><entry>Array of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns-options">dns-options</entry><entry align="left">array of string</entry><entry align="left"/><entry>Array of DNS options to be added to 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 following options are directly added to resolv.conf: "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". See the resolv.conf(5) man page for a detailed description of these options. + +In addition, NetworkManager supports the special options "_no-add-edns0" and "_no-add-trust-ad". They are not added to resolv.conf, and can be used to prevent the automatic addition of options "edns0" and "trust-ad" when using caching DNS plugins (see below). 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 align="left" id="nm-settings-dbus.property.ipv6.dns-priority">dns-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>DNS servers priority. +When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added, unless "_no-add-edns0" and "_no-add-trust-ad" are present.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dns-priority">dns-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>DNS servers priority. The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). @@ -344,7 +356,7 @@ If the table setting is left at zero, it is eligible to be overwritten via globa Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.routes">routes</entry><entry align="left">array of legacy IPv6 route struct (a(ayuayu))</entry><entry align="left"/><entry>Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv6 route structures. Each IPv6 route structure is composed of an IPv6 address, a prefix length (0 - 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric. If the metric is 0, NM will choose an appropriate default metric for the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.routing-rules">routing-rules</entry><entry align="left">array of 'a{sv}'</entry><entry align="left"/><entry>Array of dictionaries for routing rules. Each routing rule supports the following options: action (y), dport-end (q), dport-start (q), family (i), from (s), from-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport-end (q), sport-start (q), supress-prefixlength (i), table (u), to (s), tos (y), to-len (y), range-end (u), range-start (u).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.token">token</entry><entry align="left">string</entry><entry align="left"/><entry>Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode. -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></informaltable></refsect2><refsect2><title>ip-tunnel setting</title><para>IP Tunneling Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.encapsulation-limit">encapsulation-limit</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1) to ip-tunnel flags.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.flags">flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.flow-label">flow-label</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.fwmark">fwmark</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.input-key">input-key</entry><entry align="left">string</entry><entry align="left"/><entry>The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.local">local</entry><entry align="left">string</entry><entry align="left"/><entry>The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.mode">mode</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The tunneling mode. Valid values: NM_IP_TUNNEL_MODE_IPIP (1), NM_IP_TUNNEL_MODE_GRE (2), NM_IP_TUNNEL_MODE_SIT (3), NM_IP_TUNNEL_MODE_ISATAP (4), NM_IP_TUNNEL_MODE_VTI (5), NM_IP_TUNNEL_MODE_IP6IP6 (6), NM_IP_TUNNEL_MODE_IPIP6 (7), NM_IP_TUNNEL_MODE_IP6GRE (8), NM_IP_TUNNEL_MODE_VTI6 (9), NM_IP_TUNNEL_MODE_GRETAP (10) and NM_IP_TUNNEL_MODE_IP6GRETAP (11)</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.output-key">output-key</entry><entry align="left">string</entry><entry align="left"/><entry>The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.path-mtu-discovery">path-mtu-discovery</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether to enable Path MTU Discovery on this tunnel.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.remote">remote</entry><entry align="left">string</entry><entry align="left"/><entry>The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.tos">tos</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.ttl">ttl</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>macsec setting</title><para>MACSec Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.macsec.encrypt">encrypt</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether the transmitted traffic must be encrypted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-cak">mka-cak</entry><entry align="left">string</entry><entry align="left"/><entry>The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-cak-flags">mka-cak-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "mka-cak" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-ckn">mka-ckn</entry><entry align="left">string</entry><entry align="left"/><entry>The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mode">mode</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.port">port</entry><entry align="left">int32</entry><entry align="left">1</entry><entry>The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.send-sci">send-sci</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.validation">validation</entry><entry align="left">int32</entry><entry align="left">2</entry><entry>Specifies the validation mode for incoming frames.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>macvlan setting</title><para>MAC VLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.macvlan.mode">mode</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.promiscuous">promiscuous</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether the interface should be put in promiscuous mode.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.tap">tap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Whether the interface should be a MACVTAP.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>match setting</title><para>Match settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.match.driver">driver</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of driver names to match. Each element is a shell wildcard pattern. +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></informaltable></refsect2><refsect2><title>ip-tunnel setting</title><para>IP Tunneling Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.encapsulation-limit">encapsulation-limit</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add 0x1 (ip6-ign-encap-limit) to ip-tunnel flags.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.flags">flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Tunnel flags. Currently, the following values are supported: 0x1 (ip6-ign-encap-limit), 0x2 (ip6-use-orig-tclass), 0x4 (ip6-use-orig-flowlabel), 0x8 (ip6-mip6-dev), 0x10 (ip6-rcv-dscp-copy), 0x20 (ip6-use-orig-fwmark). They are valid only for IPv6 tunnels.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.flow-label">flow-label</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.fwmark">fwmark</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.input-key">input-key</entry><entry align="left">string</entry><entry align="left"/><entry>The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.local">local</entry><entry align="left">string</entry><entry align="left"/><entry>The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.mode">mode</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The tunneling mode. Valid values: 1 (ipip), 2 (gre), 3 (sit), 4 (isatap), 5 (vti), 6 (ip6ip6), 7 (ipip6), 8 (ip6gre), 9 (vti6), 10 (gretap) and 11 (ip6gretap)</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.output-key">output-key</entry><entry align="left">string</entry><entry align="left"/><entry>The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.path-mtu-discovery">path-mtu-discovery</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether to enable Path MTU Discovery on this tunnel.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.remote">remote</entry><entry align="left">string</entry><entry align="left"/><entry>The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.tos">tos</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.ttl">ttl</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>macsec setting</title><para>MACSec Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.macsec.encrypt">encrypt</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether the transmitted traffic must be encrypted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-cak">mka-cak</entry><entry align="left">string</entry><entry align="left"/><entry>The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-cak-flags">mka-cak-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "mka-cak" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-ckn">mka-ckn</entry><entry align="left">string</entry><entry align="left"/><entry>The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mode">mode</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.port">port</entry><entry align="left">int32</entry><entry align="left">1</entry><entry>The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.send-sci">send-sci</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.validation">validation</entry><entry align="left">int32</entry><entry align="left">2</entry><entry>Specifies the validation mode for incoming frames.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>macvlan setting</title><para>MAC VLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.macvlan.mode">mode</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.promiscuous">promiscuous</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether the interface should be put in promiscuous mode.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.tap">tap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Whether the interface should be a MACVTAP.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>match setting</title><para>Match settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.match.driver">driver</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of driver names to match. Each element is a shell wildcard pattern. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</entry></row><row><entry align="left" id="nm-settings-dbus.property.match.interface-name">interface-name</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of interface names to match. Each element is a shell wildcard pattern. @@ -362,13 +374,13 @@ See NMSettingMatch:interface-name for how special characters '|', '&', '!' a This is currently only implemented by dhclient DHCP plugin.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-olpc-mesh.ssid">ssid</entry><entry align="left">byte array</entry><entry align="left"/><entry>SSID of the mesh network to join.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-bridge setting</title><para>OvsBridge Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.datapath-type">datapath-type</entry><entry align="left">string</entry><entry align="left"/><entry>The data path type. One of "system", "netdev" or empty.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.fail-mode">fail-mode</entry><entry align="left">string</entry><entry align="left"/><entry>The bridge failure mode. One of "secure", "standalone" or empty.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.mcast-snooping-enable">mcast-snooping-enable</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Enable or disable multicast snooping.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.rstp-enable">rstp-enable</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Enable or disable RSTP.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-bridge.stp-enable">stp-enable</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Enable or disable STP.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-dpdk setting</title><para>OvsDpdk Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-dpdk.devargs">devargs</entry><entry align="left">string</entry><entry align="left"/><entry>Open vSwitch DPDK device arguments.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-dpdk.n-rxq">n-rxq</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-dpdk.n-rxq-desc">n-rxq-desc</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The rx queue size (number of rx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-dpdk.n-txq-desc">n-txq-desc</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The tx queue size (number of tx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-interface setting</title><para>Open vSwitch Interface Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-interface.ofport-request">ofport-request</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Open vSwitch openflow port number. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network. OpenFlow switches connect logically to each other via their OpenFlow ports.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-interface.type">type</entry><entry align="left">string</entry><entry align="left"/><entry>The interface type. Either "internal", "system", "patch", "dpdk", or empty.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-patch setting</title><para>OvsPatch Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-patch.peer">peer</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-port setting</title><para>OvsPort Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-port.bond-downdelay">bond-downdelay</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The time port must be inactive in order to be considered down.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.bond-mode">bond-mode</entry><entry align="left">string</entry><entry align="left"/><entry>Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.bond-updelay">bond-updelay</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The time port must be active before it starts forwarding traffic.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.lacp">lacp</entry><entry align="left">string</entry><entry align="left"/><entry>LACP mode. One of "active", "off", or "passive".</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.tag">tag</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The VLAN tag in the range 0-4095.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.trunks">trunks</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>A list of VLAN ranges that this port trunks. -The property is valid only for ports with mode "trunk", "native-tagged", or "native-untagged port". If it is empty, the port trunks all VLANs.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.vlan-mode">vlan-mode</entry><entry align="left">string</entry><entry align="left"/><entry>The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ppp setting</title><para>Point-to-Point Protocol Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ppp.baud">baud</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.crtscts">crtscts</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.lcp-echo-failure">lcp-echo-failure</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.lcp-echo-interval">lcp-echo-interval</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.mppe-stateful">mppe-stateful</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.mru">mru</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to send packets no larger than the specified size.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.no-vj-comp">no-vj-comp</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, Van Jacobsen TCP header compression will not be requested.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.noauth">noauth</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.nobsdcomp">nobsdcomp</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, BSD compression will not be requested.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.nodeflate">nodeflate</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, "deflate" compression will not be requested.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-chap">refuse-chap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the CHAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-eap">refuse-eap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the EAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-mschap">refuse-mschap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the MSCHAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-mschapv2">refuse-mschapv2</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the MSCHAPv2 authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-pap">refuse-pap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the PAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.require-mppe">require-mppe</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.require-mppe-128">require-mppe-128</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>pppoe setting</title><para>PPP-over-Ethernet Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.pppoe.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.password">password</entry><entry align="left">string</entry><entry align="left"/><entry>Password used to authenticate with the PPPoE service.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.service">service</entry><entry align="left">string</entry><entry align="left"/><entry>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.username">username</entry><entry align="left">string</entry><entry align="left"/><entry>Username used to authenticate with the PPPoE service.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>proxy setting</title><para>WWW Proxy Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.proxy.browser-only">browser-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Whether the proxy configuration is for browser only.</entry></row><row><entry align="left" id="nm-settings-dbus.property.proxy.method">method</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</entry></row><row><entry align="left" id="nm-settings-dbus.property.proxy.pac-script">pac-script</entry><entry align="left">string</entry><entry align="left"/><entry>PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.</entry></row><row><entry align="left" id="nm-settings-dbus.property.proxy.pac-url">pac-url</entry><entry align="left">string</entry><entry align="left"/><entry>PAC URL for obtaining PAC file.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>serial setting</title><para>Serial Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.serial.baud">baud</entry><entry align="left">uint32</entry><entry align="left">57600</entry><entry>Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.bits">bits</entry><entry align="left">uint32</entry><entry align="left">8</entry><entry>Byte-width of the serial communication. The 8 in "8n1" for example.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.parity">parity</entry><entry align="left">byte</entry><entry align="left"/><entry>The connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.send-delay">send-delay</entry><entry align="left">uint64</entry><entry align="left">0</entry><entry>Time to delay between each byte sent to the modem, in microseconds.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.stopbits">stopbits</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>sriov setting</title><para>SR-IOV settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.sriov.autoprobe-drivers">autoprobe-drivers</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>Whether to autoprobe virtual functions by a compatible driver. +The property is valid only for ports with mode "trunk", "native-tagged", or "native-untagged port". If it is empty, the port trunks all VLANs.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ovs-port.vlan-mode">vlan-mode</entry><entry align="left">string</entry><entry align="left"/><entry>The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ppp setting</title><para>Point-to-Point Protocol Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ppp.baud">baud</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.crtscts">crtscts</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.lcp-echo-failure">lcp-echo-failure</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.lcp-echo-interval">lcp-echo-interval</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.mppe-stateful">mppe-stateful</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.mru">mru</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to send packets no larger than the specified size.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.no-vj-comp">no-vj-comp</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, Van Jacobsen TCP header compression will not be requested.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.noauth">noauth</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.nobsdcomp">nobsdcomp</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, BSD compression will not be requested.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.nodeflate">nodeflate</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, "deflate" compression will not be requested.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-chap">refuse-chap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the CHAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-eap">refuse-eap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the EAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-mschap">refuse-mschap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the MSCHAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-mschapv2">refuse-mschapv2</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the MSCHAPv2 authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.refuse-pap">refuse-pap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the PAP authentication method will not be used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.require-mppe">require-mppe</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ppp.require-mppe-128">require-mppe-128</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>pppoe setting</title><para>PPP-over-Ethernet Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.pppoe.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.password">password</entry><entry align="left">string</entry><entry align="left"/><entry>Password used to authenticate with the PPPoE service.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.service">service</entry><entry align="left">string</entry><entry align="left"/><entry>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</entry></row><row><entry align="left" id="nm-settings-dbus.property.pppoe.username">username</entry><entry align="left">string</entry><entry align="left"/><entry>Username used to authenticate with the PPPoE service.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>proxy setting</title><para>WWW Proxy Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.proxy.browser-only">browser-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Whether the proxy configuration is for browser only.</entry></row><row><entry align="left" id="nm-settings-dbus.property.proxy.method">method</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Method for proxy configuration, Default is 0 (none)</entry></row><row><entry align="left" id="nm-settings-dbus.property.proxy.pac-script">pac-script</entry><entry align="left">string</entry><entry align="left"/><entry>PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.</entry></row><row><entry align="left" id="nm-settings-dbus.property.proxy.pac-url">pac-url</entry><entry align="left">string</entry><entry align="left"/><entry>PAC URL for obtaining PAC file.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>serial setting</title><para>Serial Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.serial.baud">baud</entry><entry align="left">uint32</entry><entry align="left">57600</entry><entry>Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.bits">bits</entry><entry align="left">uint32</entry><entry align="left">8</entry><entry>Byte-width of the serial communication. The 8 in "8n1" for example.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.parity">parity</entry><entry align="left">byte</entry><entry align="left"/><entry>The connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.send-delay">send-delay</entry><entry align="left">uint64</entry><entry align="left">0</entry><entry>Time to delay between each byte sent to the modem, in microseconds.</entry></row><row><entry align="left" id="nm-settings-dbus.property.serial.stopbits">stopbits</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>sriov setting</title><para>SR-IOV settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.sriov.autoprobe-drivers">autoprobe-drivers</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>Whether to autoprobe virtual functions by a compatible driver. -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 1 (true), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF. -If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them. +If set to 0 (false), 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 align="left" id="nm-settings-dbus.property.sriov.total-vfs">total-vfs</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The total number of virtual functions to create. +When set to -1 (default), the global default is used; in case the global default is unspecified it is assumed to be 1 (true).</entry></row><row><entry align="left" id="nm-settings-dbus.property.sriov.total-vfs">total-vfs</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The total number of virtual functions to create. Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.</entry></row><row><entry align="left" id="nm-settings-dbus.property.sriov.vfs">vfs</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of virtual function descriptors. @@ -396,7 +408,7 @@ If the "tc" setting is not present, NetworkManager doesn't touch the qdiscs pres 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></informaltable></refsect2><refsect2><title>team setting</title><para>Teaming Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.team.config">config</entry><entry align="left">string</entry><entry align="left"/><entry>The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.link-watchers">link-watchers</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.mcast-rejoin-count">mcast-rejoin-count</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd mcast_rejoin.count.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.mcast-rejoin-interval">mcast-rejoin-interval</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd mcast_rejoin.interval.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.notify-peers-count">notify-peers-count</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd notify_peers.count.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.notify-peers-interval">notify-peers-interval</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd notify_peers.interval.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner">runner</entry><entry align="left">string</entry><entry align="left"/><entry>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-active">runner-active</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Corresponds to the teamd runner.active.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-agg-select-policy">runner-agg-select-policy</entry><entry align="left">string</entry><entry align="left"/><entry>Corresponds to the teamd runner.agg_select_policy.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-fast-rate">runner-fast-rate</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Corresponds to the teamd runner.fast_rate.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-hwaddr-policy">runner-hwaddr-policy</entry><entry align="left">string</entry><entry align="left"/><entry>Corresponds to the teamd runner.hwaddr_policy.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-min-ports">runner-min-ports</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd runner.min_ports.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-sys-prio">runner-sys-prio</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd runner.sys_prio.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-tx-balancer">runner-tx-balancer</entry><entry align="left">string</entry><entry align="left"/><entry>Corresponds to the teamd runner.tx_balancer.name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-tx-balancer-interval">runner-tx-balancer-interval</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd runner.tx_balancer.interval.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-tx-hash">runner-tx-hash</entry><entry align="left">array of string</entry><entry align="left"/><entry>Corresponds to the teamd runner.tx_hash.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>team-port setting</title><para>Team Port Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.team-port.config">config</entry><entry align="left">string</entry><entry align="left"/><entry>The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.lacp-key">lacp-key</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd ports.PORTIFNAME.lacp_key.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.lacp-prio">lacp-prio</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.link-watchers">link-watchers</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.prio">prio</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Corresponds to the teamd ports.PORTIFNAME.prio.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.queue-id">queue-id</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.sticky">sticky</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Corresponds to the teamd ports.PORTIFNAME.sticky.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>tun setting</title><para>Tunnel Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.tun.group">group</entry><entry align="left">string</entry><entry align="left"/><entry>The group ID which will own the device. If set to NULL everyone will be able to use the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.mode">mode</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.multi-queue">multi-queue</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.owner">owner</entry><entry align="left">string</entry><entry align="left"/><entry>The user ID which will own the device. If set to NULL everyone will be able to use the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.pi">pi</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.vnet-hdr">vnet-hdr</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>user setting</title><para>General User Profile Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.user.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>vlan setting</title><para>VLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.vlan.egress-priority-map">egress-priority-map</entry><entry align="left">array of string</entry><entry align="left"/><entry>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.flags">flags</entry><entry align="left">NMVlanFlags (uint32)</entry><entry align="left"/><entry>One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). +If the "tc" setting is not present, NetworkManager doesn't touch the filters present on the interface.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>team setting</title><para>Teaming Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.team.config">config</entry><entry align="left">string</entry><entry align="left"/><entry>The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.link-watchers">link-watchers</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.mcast-rejoin-count">mcast-rejoin-count</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd mcast_rejoin.count.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.mcast-rejoin-interval">mcast-rejoin-interval</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd mcast_rejoin.interval.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.notify-peers-count">notify-peers-count</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd notify_peers.count.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.notify-peers-interval">notify-peers-interval</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd notify_peers.interval.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner">runner</entry><entry align="left">string</entry><entry align="left"/><entry>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-active">runner-active</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Corresponds to the teamd runner.active.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-agg-select-policy">runner-agg-select-policy</entry><entry align="left">string</entry><entry align="left"/><entry>Corresponds to the teamd runner.agg_select_policy.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-fast-rate">runner-fast-rate</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Corresponds to the teamd runner.fast_rate.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-hwaddr-policy">runner-hwaddr-policy</entry><entry align="left">string</entry><entry align="left"/><entry>Corresponds to the teamd runner.hwaddr_policy.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-min-ports">runner-min-ports</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd runner.min_ports.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-sys-prio">runner-sys-prio</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd runner.sys_prio.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-tx-balancer">runner-tx-balancer</entry><entry align="left">string</entry><entry align="left"/><entry>Corresponds to the teamd runner.tx_balancer.name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-tx-balancer-interval">runner-tx-balancer-interval</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd runner.tx_balancer.interval.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team.runner-tx-hash">runner-tx-hash</entry><entry align="left">array of string</entry><entry align="left"/><entry>Corresponds to the teamd runner.tx_hash.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>team-port setting</title><para>Team Port Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.team-port.config">config</entry><entry align="left">string</entry><entry align="left"/><entry>The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.lacp-key">lacp-key</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd ports.PORTIFNAME.lacp_key.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.lacp-prio">lacp-prio</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.link-watchers">link-watchers</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.prio">prio</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Corresponds to the teamd ports.PORTIFNAME.prio.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.queue-id">queue-id</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</entry></row><row><entry align="left" id="nm-settings-dbus.property.team-port.sticky">sticky</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Corresponds to the teamd ports.PORTIFNAME.sticky.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>tun setting</title><para>Tunnel Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.tun.group">group</entry><entry align="left">string</entry><entry align="left"/><entry>The group ID which will own the device. If set to NULL everyone will be able to use the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.mode">mode</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>The operating mode of the virtual device. Allowed values are 1 (tun) to create a layer 3 device and 2 (tap) to create an Ethernet-like layer 2 one.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.multi-queue">multi-queue</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.owner">owner</entry><entry align="left">string</entry><entry align="left"/><entry>The user ID which will own the device. If set to NULL everyone will be able to use the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.pi">pi</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</entry></row><row><entry align="left" id="nm-settings-dbus.property.tun.vnet-hdr">vnet-hdr</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>user setting</title><para>General User Profile Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.user.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>vlan setting</title><para>VLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.vlan.egress-priority-map">egress-priority-map</entry><entry align="left">array of string</entry><entry align="left"/><entry>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.flags">flags</entry><entry align="left">NMVlanFlags (uint32)</entry><entry align="left"/><entry>One or more flags which control the behavior and features of the VLAN interface. Flags include 0x1 (reorder-headers) (reordering of output packet headers), 0x2 (gvrp) (use of the GVRP protocol), and 0x4 (loose-binding) (loose binding of the interface to its master device's operating state). 0x8 (mvrp) (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 align="left" id="nm-settings-dbus.property.vlan.id">id</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.ingress-priority-map">ingress-priority-map</entry><entry align="left">array of string</entry><entry align="left"/><entry>For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.vlan.protocol">protocol</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the VLAN protocol to use for encapsulation. @@ -418,7 +430,7 @@ If the value contains one additional MAC address after the mask, this address is If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.mac-address-blacklist">mac-address-blacklist</entry><entry align="left">array of string</entry><entry align="left"/><entry>If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.port">port</entry><entry align="left">string</entry><entry align="left"/><entry>Specific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.s390-nettype">s390-nettype</entry><entry align="left">string</entry><entry align="left"/><entry>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.s390-options">s390-options</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). -Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.s390-subchannels">s390-subchannels</entry><entry align="left">array of string</entry><entry align="left"/><entry>Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.speed">speed</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.wake-on-lan">wake-on-lan</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.wake-on-lan-password">wake-on-lan-password</entry><entry align="left">string</entry><entry align="left"/><entry>If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>wireguard setting</title><para>WireGuard Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.wireguard.fwmark">fwmark</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets. +Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.s390-subchannels">s390-subchannels</entry><entry align="left">array of string</entry><entry align="left"/><entry>Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.speed">speed</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.wake-on-lan">wake-on-lan</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of 0x2 (phy), 0x4 (unicast), 0x8 (multicast), 0x10 (broadcast), 0x20 (arp), 0x40 (magic) or the special values 0x1 (default) (to use global settings) and 0x8000 (ignore) (to disable management of Wake-on-LAN in NetworkManager).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-3-ethernet.wake-on-lan-password">wake-on-lan-password</entry><entry align="left">string</entry><entry align="left"/><entry>If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>wireguard setting</title><para>WireGuard Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.wireguard.fwmark">fwmark</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets. Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.ip4-auto-default-route">ip4-auto-default-route</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing". @@ -428,13 +440,13 @@ Leaving this at the default will enable this option automatically if ipv4.never- If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.peer-routes">peer-routes</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively. -Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.peers">peers</entry><entry align="left">array of 'a{sv}'</entry><entry align="left"/><entry>Array of dictionaries for the WireGuard peers.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.private-key">private-key</entry><entry align="left">string</entry><entry align="left"/><entry>The 256 bit private-key in base64 encoding.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.private-key-flags">private-key-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "private-key" property.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-11-wireless setting</title><para>Wi-Fi Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.ap-isolation">ap-isolation</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode. +Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.peers">peers</entry><entry align="left">array of 'a{sv}'</entry><entry align="left"/><entry>Array of dictionaries for the WireGuard peers.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.private-key">private-key</entry><entry align="left">string</entry><entry align="left"/><entry>The 256 bit private-key in base64 encoding.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wireguard.private-key-flags">private-key-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "private-key" property.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-11-wireless setting</title><para>Wi-Fi Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.ap-isolation">ap-isolation</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from -1 (default) 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 1 (true), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. -If set to NM_TERNARY_FALSE (0), devices can talk to each other. +If set to 0 (false), 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 align="left" id="nm-settings-dbus.property.802-11-wireless.assigned-mac-address">assigned-mac-address</entry><entry align="left">string</entry><entry align="left"/><entry>The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.band">band</entry><entry align="left">string</entry><entry align="left"/><entry>802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.bssid">bssid</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future. +When set to -1 (default), the global default is used; in case the global default is unspecified it is assumed to be 0 (false).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.assigned-mac-address">assigned-mac-address</entry><entry align="left">string</entry><entry align="left"/><entry>The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.band">band</entry><entry align="left">string</entry><entry align="left"/><entry>802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.bssid">bssid</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future. Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.channel">channel</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.cloned-mac-address">cloned-mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.generate-mac-address-mask">generate-mac-address-mask</entry><entry align="left">string</entry><entry align="left"/><entry>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. @@ -450,33 +462,33 @@ In infrastructure mode, various workarounds are used for a more reliable discove In AP mode, the created network does not broadcast its SSID. -Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address-blacklist">mac-address-blacklist</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address-randomization">mac-address-randomization</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). +Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address-blacklist">mac-address-blacklist</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address-randomization">mac-address-randomization</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>One of 0 (default) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), 1 (never) (never randomize the MAC address), or 2 (always) (always randomize the MAC address). -This property is deprecated since version 1.4.Use the "cloned-mac-address" property instead.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mode">mode</entry><entry align="left">string</entry><entry align="left"/><entry>Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.powersave">powersave</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.rate">rate</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>This property is not implemented and has no effect. +This property is deprecated since version 1.4.Use the "cloned-mac-address" property instead.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mode">mode</entry><entry align="left">string</entry><entry align="left"/><entry>Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.powersave">powersave</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>One of 2 (disable) (disable Wi-Fi power saving), 3 (enable) (enable Wi-Fi power saving), 1 (ignore) (don't touch currently configure setting) or 0 (default) (use the globally configured value). All other values are reserved.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.rate">rate</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>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.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.security">security</entry><entry align="left"/><entry align="left"/><entry>This property is deprecated 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 align="left" id="nm-settings-dbus.property.802-11-wireless.seen-bssids">seen-bssids</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved. 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 align="left" id="nm-settings-dbus.property.802-11-wireless.ssid">ssid</entry><entry align="left">byte array</entry><entry align="left"/><entry>SSID of the Wi-Fi network. Must be specified.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.tx-power">tx-power</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>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.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.wake-on-wlan">wake-on-wlan</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-11-wireless-security setting</title><para>Wi-Fi Security Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.auth-alg">auth-alg</entry><entry align="left">string</entry><entry align="left"/><entry>When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.fils">fils</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.group">group</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.key-mgmt">key-mgmt</entry><entry align="left">string</entry><entry align="left"/><entry>Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only). +This property is deprecated since version 1.44.This property is not implemented and has no effect.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.wake-on-wlan">wake-on-wlan</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of 0x2 (any), 0x4 (disconnect), 0x8 (magic), 0x10 (gtk-rekey-failure), 0x20 (eap-identity-request), 0x40 (4way-handshake), 0x80 (rfkill-release), 0x100 (tcp) or the special values 0x1 (default) (to use global settings) and 0x8000 (ignore) (to disable management of Wake-on-LAN in NetworkManager).</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-11-wireless-security setting</title><para>Wi-Fi Security Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.auth-alg">auth-alg</entry><entry align="left">string</entry><entry align="left"/><entry>When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.fils">fils</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of 0 (default) (use global default value), 1 (disable) (disable FILS), 2 (optional) (enable FILS if the supplicant and the access point support it) or 3 (required) (enable FILS and fail if not supported). When set to 0 (default) and no global default is set, FILS will be optionally enabled.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.group">group</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.key-mgmt">key-mgmt</entry><entry align="left">string</entry><entry align="left"/><entry>Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only). -This property must be set for any Wi-Fi connection that uses security.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.leap-password">leap-password</entry><entry align="left">string</entry><entry align="left"/><entry>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.leap-password-flags">leap-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "leap-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.leap-username">leap-username</entry><entry align="left">string</entry><entry align="left"/><entry>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.pairwise">pairwise</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp".</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.pmf">pmf</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.proto">proto</entry><entry align="left">array of string</entry><entry align="left"/><entry>List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.psk">psk</entry><entry align="left">string</entry><entry align="left"/><entry>Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.psk-flags">psk-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "psk" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key-flags">wep-key-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key-type">wep-key-type</entry><entry align="left">NMWepKeyType (uint32)</entry><entry align="left"/><entry>Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key0">wep-key0</entry><entry align="left">string</entry><entry align="left"/><entry>Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key1">wep-key1</entry><entry align="left">string</entry><entry align="left"/><entry>Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key2">wep-key2</entry><entry align="left">string</entry><entry align="left"/><entry>Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key3">wep-key3</entry><entry align="left">string</entry><entry align="left"/><entry>Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-tx-keyidx">wep-tx-keyidx</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wps-method">wps-method</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Flags indicating which mode of WPS is to be used if any. +This property must be set for any Wi-Fi connection that uses security.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.leap-password">leap-password</entry><entry align="left">string</entry><entry align="left"/><entry>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.leap-password-flags">leap-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "leap-password" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.leap-username">leap-username</entry><entry align="left">string</entry><entry align="left"/><entry>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.pairwise">pairwise</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp".</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.pmf">pmf</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of 0 (default) (use global default value), 1 (disable) (disable PMF), 2 (optional) (enable PMF if the supplicant and the access point support it) or 3 (required) (enable PMF and fail if not supported). When set to 0 (default) and no global default is set, PMF will be optionally enabled.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.proto">proto</entry><entry align="left">array of string</entry><entry align="left"/><entry>List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.psk">psk</entry><entry align="left">string</entry><entry align="left"/><entry>Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.psk-flags">psk-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "psk" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key-flags">wep-key-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key-type">wep-key-type</entry><entry align="left">NMWepKeyType (uint32)</entry><entry align="left"/><entry>Controls the interpretation of WEP keys. Allowed values are 1 (key), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or 2 (passphrase), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key0">wep-key0</entry><entry align="left">string</entry><entry align="left"/><entry>Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key1">wep-key1</entry><entry align="left">string</entry><entry align="left"/><entry>Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key2">wep-key2</entry><entry align="left">string</entry><entry align="left"/><entry>Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-key3">wep-key3</entry><entry align="left">string</entry><entry align="left"/><entry>Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wep-tx-keyidx">wep-tx-keyidx</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.wps-method">wps-method</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Flags indicating which mode of WPS is to be used if any. There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities. WPS can be disabled by setting this property to a value of 1.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>wpan setting</title><para>IEEE 802.15.4 (WPAN) MAC Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.wpan.channel">channel</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</entry></row><row><entry align="left" id="nm-settings-dbus.property.wpan.mac-address">mac-address</entry><entry align="left">string</entry><entry align="left"/><entry>If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wpan.page">page</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</entry></row><row><entry align="left" id="nm-settings-dbus.property.wpan.pan-id">pan-id</entry><entry align="left">uint32</entry><entry align="left">65535</entry><entry>IEEE 802.15.4 Personal Area Network (PAN) identifier.</entry></row><row><entry align="left" id="nm-settings-dbus.property.wpan.short-address">short-address</entry><entry align="left">uint32</entry><entry align="left">65535</entry><entry>Short IEEE 802.15.4 address to be used within a restricted environment.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>bond-port setting</title><para>Bond Port Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.bond-port.prio">prio</entry><entry align="left">int32</entry><entry align="left">0</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 align="left" id="nm-settings-dbus.property.bond-port.queue-id">queue-id</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>hostname setting</title><para>Hostname settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.hostname.from-dhcp">from-dhcp</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>Whether the system hostname can be determined from DHCP on this connection. -When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).</entry></row><row><entry align="left" id="nm-settings-dbus.property.hostname.from-dns-lookup">from-dns-lookup</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>Whether the system hostname can be determined from reverse DNS lookup of addresses on this device. +When set to -1 (default), 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 1 (true).</entry></row><row><entry align="left" id="nm-settings-dbus.property.hostname.from-dns-lookup">from-dns-lookup</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>Whether the system hostname can be determined from reverse DNS lookup of addresses on this device. -When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).</entry></row><row><entry align="left" id="nm-settings-dbus.property.hostname.only-from-default">only-from-default</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>If set to NM_TERNARY_TRUE (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6). +When set to -1 (default), 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 1 (true).</entry></row><row><entry align="left" id="nm-settings-dbus.property.hostname.only-from-default">only-from-default</entry><entry align="left">NMTernary (int32)</entry><entry align="left"/><entry>If set to 1 (true), 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. +If set to 0 (false), the hostname can be set from this device even if it doesn't have the default route. -When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0).</entry></row><row><entry align="left" id="nm-settings-dbus.property.hostname.priority">priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority. +When set to -1 (default), 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 0 (false).</entry></row><row><entry align="left" id="nm-settings-dbus.property.hostname.priority">priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority. If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100. -Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>link setting</title><para>Link settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.link.gro-max-size">gro-max-size</entry><entry align="left">int64</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.link.gso-max-segments">gso-max-segments</entry><entry align="left">int64</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.link.gso-max-size">gso-max-size</entry><entry align="left">int64</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.link.tx-queue-length">tx-queue-length</entry><entry align="left">int64</entry><entry align="left">-1</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></informaltable></refsect2><refsect2><title>loopback setting</title><para>Loopback Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.loopback.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-external-ids setting</title><para>OVS External IDs Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-external-ids.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>A dictionary of key/value pairs with external-ids for OVS.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-other-config setting</title><para>OVS Other Config Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-other-config.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>A dictionary of key/value pairs with other_config settings for OVS. See also "other_config" in the "ovs-vswitchd.conf.db" manual for the keys that OVS supports.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>veth setting</title><para>Veth Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.veth.peer">peer</entry><entry align="left">string</entry><entry align="left"/><entry>This property specifies the peer interface name of the veth. This property is mandatory.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2 id="secrets-flags"><title>Secret flag types:</title><para> +Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>hsr setting</title><para>HSR/PRP Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.hsr.multicast-spec">multicast-spec</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The last byte of supervision address.</entry></row><row><entry align="left" id="nm-settings-dbus.property.hsr.port1">port1</entry><entry align="left">string</entry><entry align="left"/><entry>The port1 interface name of the HSR. This property is mandatory.</entry></row><row><entry align="left" id="nm-settings-dbus.property.hsr.port2">port2</entry><entry align="left">string</entry><entry align="left"/><entry>The port2 interface name of the HSR. This property is mandatory.</entry></row><row><entry align="left" id="nm-settings-dbus.property.hsr.prp">prp</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>The protocol used by the interface, whether it is PRP or HSR.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>link setting</title><para>Link settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.link.gro-max-size">gro-max-size</entry><entry align="left">int64</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.link.gso-max-segments">gso-max-segments</entry><entry align="left">int64</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.link.gso-max-size">gso-max-size</entry><entry align="left">int64</entry><entry align="left">-1</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 align="left" id="nm-settings-dbus.property.link.tx-queue-length">tx-queue-length</entry><entry align="left">int64</entry><entry align="left">-1</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></informaltable></refsect2><refsect2><title>loopback setting</title><para>Loopback Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.loopback.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-external-ids setting</title><para>OVS External IDs Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-external-ids.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>A dictionary of key/value pairs with external-ids for OVS.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-other-config setting</title><para>OVS Other Config Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-other-config.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>A dictionary of key/value pairs with other_config settings for OVS. See also "other_config" in the "ovs-vswitchd.conf.db" manual for the keys that OVS supports.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>veth setting</title><para>Veth Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.veth.peer">peer</entry><entry align="left">string</entry><entry align="left"/><entry>This property specifies the peer interface name of the veth. This property is mandatory.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2 id="secrets-flags"><title>Secret flag types:</title><para> Each password or secret property in a setting has an associated <emphasis>flags</emphasis> property that describes how to handle that secret. The <emphasis>flags</emphasis> property is a bitfield that contains zero or more of the following values logically OR-ed together. diff --git a/man/nm-settings-ifcfg-rh.5 b/man/nm-settings-ifcfg-rh.5 index 1ae6afbe..8f94a60f 100644 --- a/man/nm-settings-ifcfg-rh.5 +++ b/man/nm-settings-ifcfg-rh.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-ifcfg-rh .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: Configuration -.\" Source: NetworkManager 1.44.2 +.\" Source: NetworkManager 1.45.90 .\" Language: English .\" -.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.44\&.2" "Configuration" +.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.45\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,7 @@ nm-settings-ifcfg-rh \- Description of \fIifcfg\-rh\fR settings plugin .SH "DESCRIPTION" .PP NetworkManager is based on the concept of connection profiles that contain network configuration (see -\fBnm-settings\fR(5) +\fBnm-settings-nmcli\fR(5) for details)\&. The profiles can be stored in various formats\&. NetworkManager uses plugins for reading and writing the data\&. The plugins can be configured in \fBNetworkManager.conf\fR(5)\&. .PP @@ -2528,7 +2528,29 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&13.\ \&infiniband setting +.B Table\ \&13.\ \&hsr setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Ifcfg\-rh Variable +T}:T{ +Default +T}:T{ +Description +T} +.T& +. +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&14.\ \&infiniband setting .TS allbox tab(:); lB lB lB lB. @@ -2605,7 +2627,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&14.\ \&ipv4 setting +.B Table\ \&15.\ \&ipv4 setting .TS allbox tab(:); lB lB lB lB. @@ -2807,7 +2829,7 @@ IPV4_AUTO_ROUTE_EXT_GW\fI(+)\fR T}:T{ yes T}:T{ -VPN connections will default to add the route automatically unless this setting is set to %FALSE\&. For other connection types, adding such an automatic route is currently not supported and setting this to %TRUE has no effect\&. +VPN connections will default to add the route automatically unless this setting is set to FALSE\&. For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect\&. T} T{ replace\-local\-rule @@ -2816,7 +2838,7 @@ IPV4_REPLACE_LOCAL_RULE\fI(+)\fR T}:T{ no T}:T{ -Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to %TRUE\&. +Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. T} T{ dhcp\-client\-id @@ -2902,7 +2924,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&15.\ \&ipv6 setting +.B Table\ \&16.\ \&ipv6 setting .TS allbox tab(:); lB lB lB lB. @@ -3113,7 +3135,7 @@ IPV6_AUTO_ROUTE_EXT_GW\fI(+)\fR T}:T{ yes T}:T{ -VPN connections will default to add the route automatically unless this setting is set to %FALSE\&. For other connection types, adding such an automatic route is currently not supported and setting this to %TRUE has no effect\&. +VPN connections will default to add the route automatically unless this setting is set to FALSE\&. For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect\&. T} T{ replace\-local\-rule @@ -3122,7 +3144,7 @@ IPV6_REPLACE_LOCAL_RULE\fI(+)\fR T}:T{ no T}:T{ -Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to %TRUE\&. +Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. T} T{ ip6\-privacy @@ -3201,7 +3223,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&16.\ \&match setting +.B Table\ \&17.\ \&match setting .TS allbox tab(:); lB lB lB lB. @@ -3234,7 +3256,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&17.\ \&ovs\-external\-ids setting +.B Table\ \&18.\ \&ovs\-external\-ids setting .TS allbox tab(:); lB lB lB lB. @@ -3256,7 +3278,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&18.\ \&ovs\-other\-config setting +.B Table\ \&19.\ \&ovs\-other\-config setting .TS allbox tab(:); lB lB lB lB. @@ -3278,7 +3300,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&19.\ \&proxy setting +.B Table\ \&20.\ \&proxy setting .TS allbox tab(:); lB lB lB lB. @@ -3345,7 +3367,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&20.\ \&sriov setting +.B Table\ \&21.\ \&sriov setting .TS allbox tab(:); lB lB lB lB. @@ -3402,7 +3424,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&21.\ \&tc setting +.B Table\ \&22.\ \&tc setting .TS allbox tab(:); lB lB lB lB. @@ -3447,7 +3469,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&22.\ \&team setting +.B Table\ \&23.\ \&team setting .TS allbox tab(:); lB lB lB lB. @@ -3478,7 +3500,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&23.\ \&team\-port setting +.B Table\ \&24.\ \&team\-port setting .TS allbox tab(:); lB lB lB lB. @@ -3509,7 +3531,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&24.\ \&user setting +.B Table\ \&25.\ \&user setting .TS allbox tab(:); lB lB lB lB. @@ -3542,7 +3564,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&25.\ \&vlan setting +.B Table\ \&26.\ \&vlan setting .TS allbox tab(:); lB lB lB lB. @@ -3702,7 +3724,7 @@ unused /usr/share/doc/initscripts/sysconfig\&.txt .SH "SEE ALSO" .PP -\fBnm-settings\fR(5), +\fBnm-settings-nmcli\fR(5), \fBnm-settings-keyfile\fR(5), \fBNetworkManager\fR(8), \fBNetworkManager.conf\fR(5), diff --git a/man/nm-settings-ifcfg-rh.xml b/man/nm-settings-ifcfg-rh.xml index b19b5daa..46b6d9cf 100644 --- a/man/nm-settings-ifcfg-rh.xml +++ b/man/nm-settings-ifcfg-rh.xml @@ -1,8 +1,8 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-ifcfg-rh"><refentryinfo><title>nm-settings-ifcfg-rh</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-ifcfg-rh</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.44.2</refmiscinfo></refmeta><refnamediv><refname>nm-settings-ifcfg-rh</refname><refpurpose>Description of <emphasis>ifcfg-rh</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> +<refentry id="nm-settings-ifcfg-rh"><refentryinfo><title>nm-settings-ifcfg-rh</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-ifcfg-rh</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.45.90</refmiscinfo></refmeta><refnamediv><refname>nm-settings-ifcfg-rh</refname><refpurpose>Description of <emphasis>ifcfg-rh</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on the concept of connection profiles that contain - network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The profiles can be + network configuration (see <citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing the data. The plugins can be configured in <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. </para><para> @@ -421,7 +421,7 @@ Example: </emphasis>HOSTNAME_FROM_DHCP=0,1</entry></row><row><entry align="left" Example: </emphasis>HOSTNAME_FROM_DNS_LOOKUP=0,1</entry></row><row><entry align="left">only-best-device</entry><entry align="left">HOSTNAME_ONLY_FROM_DEFAULT<emphasis>(+)</emphasis></entry><entry align="left">missing variable means global default or 1</entry><entry align="left">whether the hostname can be determined only from devices with the default route<emphasis role="bold"> -Example: </emphasis>HOSTNAME_ONLY_FROM_DEFAULT=0,1</entry></row></tbody></tgroup></table><table><title>infiniband setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">IBoIP 20-byte hardware address of the device (in traditional hex-digits-and-colons notation). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device.<emphasis role="bold"> +Example: </emphasis>HOSTNAME_ONLY_FROM_DEFAULT=0,1</entry></row></tbody></tgroup></table><table><title>hsr setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>infiniband setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">IBoIP 20-byte hardware address of the device (in traditional hex-digits-and-colons notation). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device.<emphasis role="bold"> Example: </emphasis>HWADDR=01:02:03:04:05:06:07:08:09:0A:01:02:03:04:05:06:07:08:09:11</entry></row><row><entry align="left">mtu</entry><entry align="left">MTU</entry><entry align="left"/><entry align="left">MTU of the interface.</entry></row><row><entry align="left">transport-mode</entry><entry align="left">CONNECTED_MODE</entry><entry align="left">CONNECTED_MODE=no</entry><entry align="left">CONNECTED_MODE=yes for "connected" mode, CONNECTED_MODE=no for "datagram" mode</entry></row><row><entry align="left">p-key</entry><entry align="left">PKEY_ID or PKEY_ID_NM(*) (requires PKEY=yes)</entry><entry align="left">PKEY=no</entry><entry align="left">InfiniBand P_Key. The value can be a hex number prefixed with "0x" or a decimal number. When PKEY_ID is specified, PHYSDEV must be specified. Note that ifcfg-rh format will always automatically set the full membership flag 0x8000 for the PKEY_ID variable. To express IDs without the full membership flag, use PKEY_ID_NM. Note that kernel internally treats the interface as having the full membership flag set, this mainly affects the interface name. For the ifcfg file to be supported by initscripts' ifup-ib, the DEVICE= must always be set. NetworkManager does not require that.<emphasis role="bold"> @@ -439,7 +439,7 @@ Example: </emphasis>GATEWAY=10.5.5.1</entry></row><row><entry align="left">route Example: </emphasis>RES_OPTIONS=ndots:2 timeout:3</entry></row><row><entry align="left">dns-priority</entry><entry align="left">IPV4_DNS_PRIORITY<emphasis>(+)</emphasis></entry><entry align="left">0</entry><entry align="left">The priority for DNS servers of this connection. Lower values have higher priority. If zero, the default value will be used (50 for VPNs, 100 for other connections). A negative value prevents DNS from other connections with greater values to be used.<emphasis role="bold"> -Example: </emphasis>IPV4_DNS_PRIORITY=20</entry></row><row><entry align="left">auto-route-ext-gw</entry><entry align="left">IPV4_AUTO_ROUTE_EXT_GW<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">VPN connections will default to add the route automatically unless this setting is set to %FALSE. For other connection types, adding such an automatic route is currently not supported and setting this to %TRUE has no effect.</entry></row><row><entry align="left">replace-local-rule</entry><entry align="left">IPV4_REPLACE_LOCAL_RULE<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to %TRUE.</entry></row><row><entry align="left">dhcp-client-id</entry><entry align="left">DHCP_CLIENT_ID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A string sent to the DHCP server to identify the local machine. A binary value can be specified using hex notation ('aa:bb:cc').<emphasis role="bold"> +Example: </emphasis>IPV4_DNS_PRIORITY=20</entry></row><row><entry align="left">auto-route-ext-gw</entry><entry align="left">IPV4_AUTO_ROUTE_EXT_GW<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">VPN connections will default to add the route automatically unless this setting is set to FALSE. For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</entry></row><row><entry align="left">replace-local-rule</entry><entry align="left">IPV4_REPLACE_LOCAL_RULE<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</entry></row><row><entry align="left">dhcp-client-id</entry><entry align="left">DHCP_CLIENT_ID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A string sent to the DHCP server to identify the local machine. A binary value can be specified using hex notation ('aa:bb:cc').<emphasis role="bold"> Example: </emphasis>DHCP_CLIENT_ID=ax-srv-1; DHCP_CLIENT_ID=01:44:44:44:44:44:44</entry></row><row><entry align="left">dad-timeout</entry><entry align="left">ACD_TIMEOUT<emphasis>(+)</emphasis>, ARPING_WAIT</entry><entry align="left">missing variable means global default (config override or zero)</entry><entry align="left">Timeout (in milliseconds for ACD_TIMEOUT or in seconds for ARPING_WAIT) for address conflict detection before configuring IPv4 addresses. 0 turns off the ACD completely, -1 means default value.<emphasis role="bold"> @@ -465,7 +465,7 @@ Example: </emphasis>DHCPV6_HOSTNAME_FLAGS=5</entry></row><row><entry align="left Example: </emphasis>IPV6_DNS_PRIORITY=20</entry></row><row><entry align="left">dns-options</entry><entry align="left">IPV6_RES_OPTIONS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">List of DNS options to be added to /etc/resolv.conf<emphasis role="bold"> -Example: </emphasis>IPV6_RES_OPTIONS=ndots:2 timeout:3</entry></row><row><entry align="left">auto-route-ext-gw</entry><entry align="left">IPV6_AUTO_ROUTE_EXT_GW<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">VPN connections will default to add the route automatically unless this setting is set to %FALSE. For other connection types, adding such an automatic route is currently not supported and setting this to %TRUE has no effect.</entry></row><row><entry align="left">replace-local-rule</entry><entry align="left">IPV6_REPLACE_LOCAL_RULE<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to %TRUE.</entry></row><row><entry align="left">ip6-privacy</entry><entry align="left">IPV6_PRIVACY, IPV6_PRIVACY_PREFER_PUBLIC_IP<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Configure IPv6 Privacy Extensions for SLAAC (RFC4941).<emphasis role="bold"> +Example: </emphasis>IPV6_RES_OPTIONS=ndots:2 timeout:3</entry></row><row><entry align="left">auto-route-ext-gw</entry><entry align="left">IPV6_AUTO_ROUTE_EXT_GW<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">VPN connections will default to add the route automatically unless this setting is set to FALSE. For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</entry></row><row><entry align="left">replace-local-rule</entry><entry align="left">IPV6_REPLACE_LOCAL_RULE<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</entry></row><row><entry align="left">ip6-privacy</entry><entry align="left">IPV6_PRIVACY, IPV6_PRIVACY_PREFER_PUBLIC_IP<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Configure IPv6 Privacy Extensions for SLAAC (RFC4941).<emphasis role="bold"> Example: </emphasis>IPV6_PRIVACY=rfc3041 IPV6_PRIVACY_PREFER_PUBLIC_IP=yes<emphasis role="bold"> @@ -522,7 +522,7 @@ Example: </emphasis>PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12</entry></row></t and storing this secret; when it is required, agents will be asked to provide it.</para></listitem><listitem><para><literal>ask</literal> - the associated password is not saved but it will be requested from the user each time it is required.</para></listitem><listitem><para><literal>unused</literal> - in some situations it cannot be automatically determined that a secret is required or not. This flag hints that the secret is not required and should - not be requested from the user.</para></listitem></itemizedlist></refsect2></refsect1><refsect1 id="files"><title>Files</title><para><filename>/etc/sysconfig/network-scripts/ifcfg-*</filename></para><para><filename>/etc/sysconfig/network-scripts/keys-*</filename></para><para><filename>/etc/sysconfig/network-scripts/route-*</filename></para><para><filename>/etc/sysconfig/network-scripts/route6-*</filename></para><para><filename>/usr/share/doc/initscripts/sysconfig.txt</filename></para></refsect1><refsect1 id="see_also"><title>See Also</title><para><link linkend="nm-settings"><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, + not be requested from the user.</para></listitem></itemizedlist></refsect2></refsect1><refsect1 id="files"><title>Files</title><para><filename>/etc/sysconfig/network-scripts/ifcfg-*</filename></para><para><filename>/etc/sysconfig/network-scripts/keys-*</filename></para><para><filename>/etc/sysconfig/network-scripts/route-*</filename></para><para><filename>/etc/sysconfig/network-scripts/route6-*</filename></para><para><filename>/usr/share/doc/initscripts/sysconfig.txt</filename></para></refsect1><refsect1 id="see_also"><title>See Also</title><para><link linkend="nm-settings-nmcli"><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <link linkend="nm-settings-keyfile"><citerefentry><refentrytitle>nm-settings-keyfile</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <link linkend="NetworkManager"><citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>, <link linkend="NetworkManager.conf"><citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, diff --git a/man/nm-settings-ifcfg-rh.xsl b/man/nm-settings-ifcfg-rh.xsl index b389b7e9..7b270e9b 100644 --- a/man/nm-settings-ifcfg-rh.xsl +++ b/man/nm-settings-ifcfg-rh.xsl @@ -36,7 +36,7 @@ <refsect1 id='description'><title>Description</title> <para> NetworkManager is based on the concept of connection profiles that contain - network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle> + network configuration (see <citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle> <manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing the data. The plugins can be configured in <citerefentry> @@ -322,7 +322,7 @@ DEVICETYPE=TeamPort <para><filename>/usr/share/doc/initscripts/sysconfig.txt</filename></para> </refsect1> <refsect1 id='see_also'><title>See Also</title> - <para><link linkend='nm-settings'><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, + <para><link linkend='nm-settings-nmcli'><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <link linkend='nm-settings-keyfile'><citerefentry><refentrytitle>nm-settings-keyfile</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <link linkend='NetworkManager'><citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>, <link linkend='NetworkManager.conf'><citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, diff --git a/man/nm-settings-keyfile.5 b/man/nm-settings-keyfile.5 index 1f13445d..17fc8fd6 100644 --- a/man/nm-settings-keyfile.5 +++ b/man/nm-settings-keyfile.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-keyfile .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: Configuration -.\" Source: NetworkManager 1.44.2 +.\" Source: NetworkManager 1.45.90 .\" Language: English .\" -.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.44\&.2" "Configuration" +.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.45\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -32,7 +32,7 @@ nm-settings-keyfile \- Description of \fIkeyfile\fR settings plugin .SH "DESCRIPTION" .PP NetworkManager is based on the concept of connection profiles that contain network configuration (see -\fBnm-settings\fR(5) +\fBnm-settings-nmcli\fR(5) for details)\&. The profiles can be stored in various formats\&. NetworkManager uses plugins for reading and writing the data\&. The plugins can be configured in \fBNetworkManager.conf\fR(5)\&. .PP @@ -47,14 +47,19 @@ and .PP The \fIkeyfile\fR -config format is a simple \&.ini\-style format\&. It consists of sections (groups) of key\-value pairs\&. Each section corresponds to a setting name as described in the settings specification (\fBnm-settings\fR(5))\&. Each configuration key/value pair in the section is one of the properties listed in the settings specification\&. The majority of properties of the specification is written in the same format into the -\fIkeyfile\fR -too\&. However some values are inconvenient for people to use\&. These are stored in the files in more readable ways\&. These properties are described below\&. An example could be IP addresses that are not written as integer arrays, but more reasonably as "1\&.2\&.3\&.4/12 1\&.2\&.3\&.254"\&. More information of the generic key file format can be found at +config format is a simple \&.ini\-style format\&. It consists of sections (groups) of key\-value pairs\&. More information of the generic key file format can be found at \m[blue]\fBGLib key file format\fR\m[]\&\s-2\u[1]\d\s+2 (Lines beginning with a \*(Aq#\*(Aq are comments, lists are separated by character ; etc\&.)\&. .PP +Each section corresponds to a setting name as described in the settings specification (\fBnm-settings-nmcli\fR(5))\&. Each key/value pair in a section is one of the properties from the specification\&. +.PP +The majority of properties are written in the same format as the specification into the +\fIkeyfile\fR\&. However, some values are inconvenient for people to use so they are stored in the +\fIkeyfile\fR +in more readable ways\&. These properties that differ from the specification are described below\&. An example could be IP addresses that are not written as integer arrays, but more reasonably as "1\&.2\&.3\&.4/12 1\&.2\&.3\&.254"\&. Also, some lists of complex values (addresses, routes, routing\-rules), instead of using a semicolon separated list, use one key\-value pair per list element, with the key being the singular of the property name followed by the numeric index (i\&.e address1, address2, \&.\&.\&.)\&. +.PP Users can create or modify the \fIkeyfile\fR connection files manually, even if that is not the recommended way of managing the profiles\&. However, if they choose to do that, they must inform NetworkManager about their changes (for example via @@ -207,7 +212,7 @@ id=4 plugin variables for the majority of NetworkManager properties have one\-to\-one mapping\&. It means a NetworkManager property is stored in the keyfile as a variable of the same name and in the same format\&. There are several exceptions to this rule, mainly for making keyfile syntax easier for humans\&. The exceptions handled specially by \fIkeyfile\fR plugin are listed below\&. Refer to -\fBnm-settings\fR(5) +\fBnm-settings-nmcli\fR(5) for all available settings and properties and their description\&. .PP \fBName aliases\fR. Some of the NetworkManager setting names are somewhat hard to type or remember\&. Therefore @@ -431,6 +436,8 @@ T} l l l l l l l l l l l l +l l l l +l l l l l l l l. T{ dns @@ -476,6 +483,28 @@ List of IP routes\&.\fB Example: \fRroute1=8\&.8\&.8\&.0/24,10\&.1\&.1\&.1,77 route2=7\&.7\&.0\&.0/16 T} +T{ +routes (attributes) +T}:T{ +route1_options, route2_options, \&.\&.\&. +T}:T{ +key=val[,key=val\&.\&.\&.] +T}:T{ +Attributes defined for the routes, if any\&. The supported attributes are explained in ipv4\&.routes entry in `man nm\-settings\-nmcli`\&.\fB + +Example: \fRroute1_options=mtu=1000,onlink=true +T} +T{ +routing\-rules +T}:T{ +routing\-rule1, routing\-rule2, \&.\&.\&. +T}:T{ +routing rule string +T}:T{ +Routing rules as defined with `ip rule add`, but with mandatory fixed priority\&.\fB + +Example: \fRrouting\-rule1=priority 5 from 192\&.167\&.4\&.0/24 table 45 +T} .TE .sp 1 .sp @@ -500,6 +529,8 @@ T} l l l l l l l l l l l l +l l l l +l l l l l l l l. T{ dns @@ -545,6 +576,28 @@ List of IP routes\&.\fB Example: \fRroute1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403 T} +T{ +routes (attributes) +T}:T{ +route1_options, route2_options, \&.\&.\&. +T}:T{ +key=val[,key=val\&.\&.\&.] +T}:T{ +Attributes defined for the routes, if any\&. The supported attributes are explained in ipv6\&.routes entry in `man nm\-settings\-nmcli`\&.\fB + +Example: \fRroute1_options=mtu=1000,onlink=true +T} +T{ +routing\-rules +T}:T{ +routing\-rule1, routing\-rule2, \&.\&.\&. +T}:T{ +routing rule string +T}:T{ +Routing rules as defined with `ip rule add`, but with mandatory fixed priority\&.\fB + +Example: \fRrouting\-rule1=priority 5 from 2001:4860:4860::/64 table 45 +T} .TE .sp 1 .sp @@ -745,7 +798,7 @@ variable is a decimal number (0 \- 7) defined as a sum of the following values: /etc/NetworkManager/system\-connections/* .SH "SEE ALSO" .PP -\fBnm-settings\fR(5), +\fBnm-settings-nmcli\fR(5), \fBnm-settings-ifcfg-rh\fR(5), \fBNetworkManager\fR(8), \fBNetworkManager.conf\fR(5), diff --git a/man/nm-settings-keyfile.xml b/man/nm-settings-keyfile.xml index 8a249541..3f61aef1 100644 --- a/man/nm-settings-keyfile.xml +++ b/man/nm-settings-keyfile.xml @@ -1,8 +1,8 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-keyfile"><refentryinfo><title>nm-settings-keyfile</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-keyfile</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.44.2</refmiscinfo></refmeta><refnamediv><refname>nm-settings-keyfile</refname><refpurpose>Description of <emphasis>keyfile</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> +<refentry id="nm-settings-keyfile"><refentryinfo><title>nm-settings-keyfile</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-keyfile</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.45.90</refmiscinfo></refmeta><refnamediv><refname>nm-settings-keyfile</refname><refpurpose>Description of <emphasis>keyfile</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on the concept of connection profiles that contain - network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The profiles can be + network configuration (see <citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing the data. The plugins can be configured in <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>. </para><para> @@ -18,21 +18,28 @@ in plaintext inside the file. </para></refsect1><refsect1 id="file_format"><title>File Format</title><para> The <emphasis>keyfile</emphasis> config format is a simple .ini-style - format. It consists of sections (groups) of key-value pairs. Each section - corresponds to a setting name as described in the settings specification - (<citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry>). Each configuration key/value - pair in the section is one of the properties listed in the settings - specification. The majority of properties of the specification is written - in the same format into the <emphasis>keyfile</emphasis> too. However - some values are inconvenient for people to use. These are stored in the - files in more readable ways. These properties are described below. - An example could be IP addresses that are not written as integer arrays, - but more reasonably as "1.2.3.4/12 1.2.3.254". + format. It consists of sections (groups) of key-value pairs. More information of the generic key file format can be found at <ulink url="https://developer.gnome.org/glib/stable/glib-Key-value-file-parser.html#glib-Key-value-file-parser.description"> GLib key file format</ulink> (Lines beginning with a '#' are comments, lists are separated by character <literal>;</literal> etc.). </para><para> + Each section corresponds to a setting name as described in the settings + specification (<citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry>). Each key/value pair in a + section is one of the properties from the specification. + </para><para> + The majority of properties are written in the same format as the + specification into the <emphasis>keyfile</emphasis>. However, some + values are inconvenient for people to use so they are stored in the + <emphasis>keyfile</emphasis> in more readable ways. These properties + that differ from the specification are described below. + An example could be IP addresses that are not written as integer arrays, + but more reasonably as "1.2.3.4/12 1.2.3.254". + Also, some lists of complex values (addresses, routes, routing-rules), + instead of using a semicolon separated list, use one key-value pair + per list element, with the key being the singular of the property name + followed by the numeric index (i.e address1, address2, ...). + </para><para> Users can create or modify the <emphasis>keyfile</emphasis> connection files manually, even if that is not the recommended way of managing the profiles. However, if they choose to do that, they must inform NetworkManager about @@ -129,7 +136,7 @@ id=4 There are several exceptions to this rule, mainly for making keyfile syntax easier for humans. The exceptions handled specially by <emphasis>keyfile</emphasis> plugin are listed below. Refer to - <link linkend="nm-settings"><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> + <link linkend="nm-settings-nmcli"><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> for all available settings and properties and their description. </para><formalpara><title>Name aliases</title><para> Some of the NetworkManager setting names are somewhat hard to type or remember. Therefore @@ -152,7 +159,11 @@ Example: </emphasis>address1=192.168.100.100/24 address2=10.1.1.5/24</entry></ro Example: </emphasis>gateway=192.168.100.1</entry></row><row><entry align="left">routes</entry><entry align="left">route1, route2, ...</entry><entry align="left">route/plen[,gateway,metric]</entry><entry align="left">List of IP routes.<emphasis role="bold"> -Example: </emphasis>route1=8.8.8.0/24,10.1.1.1,77 route2=7.7.0.0/16</entry></row></tbody></tgroup></table><table><title>ipv6 setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">dns</entry><entry align="left"/><entry align="left">list of DNS IP addresses</entry><entry align="left">List of DNS servers.<emphasis role="bold"> +Example: </emphasis>route1=8.8.8.0/24,10.1.1.1,77 route2=7.7.0.0/16</entry></row><row><entry align="left">routes (attributes)</entry><entry align="left">route1_options, route2_options, ...</entry><entry align="left">key=val[,key=val...]</entry><entry align="left">Attributes defined for the routes, if any. The supported attributes are explained in ipv4.routes entry in `man nm-settings-nmcli`.<emphasis role="bold"> + +Example: </emphasis>route1_options=mtu=1000,onlink=true</entry></row><row><entry align="left">routing-rules</entry><entry align="left">routing-rule1, routing-rule2, ...</entry><entry align="left">routing rule string</entry><entry align="left">Routing rules as defined with `ip rule add`, but with mandatory fixed priority.<emphasis role="bold"> + +Example: </emphasis>routing-rule1=priority 5 from 192.167.4.0/24 table 45</entry></row></tbody></tgroup></table><table><title>ipv6 setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">dns</entry><entry align="left"/><entry align="left">list of DNS IP addresses</entry><entry align="left">List of DNS servers.<emphasis role="bold"> Example: </emphasis>dns=2001:4860:4860::8888;2001:4860:4860::8844;</entry></row><row><entry align="left">addresses</entry><entry align="left">address1, address2, ...</entry><entry align="left">address/plen</entry><entry align="left">List of static IP addresses.<emphasis role="bold"> @@ -160,7 +171,11 @@ Example: </emphasis>address1=abbe::cafe/96 address2=2001::1234</entry></row><row Example: </emphasis>gateway=abbe::1</entry></row><row><entry align="left">routes</entry><entry align="left">route1, route2, ...</entry><entry align="left">route/plen[,gateway,metric]</entry><entry align="left">List of IP routes.<emphasis role="bold"> -Example: </emphasis>route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403</entry></row></tbody></tgroup></table><table><title>serial setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">parity</entry><entry align="left"/><entry align="left">'e', 'o', or 'n'</entry><entry align="left">The connection parity; even, odd, or none. Note that older versions of NetworkManager stored this as an integer: 69 ('E') for even, 111 ('o') for odd, or 110 ('n') for none.<emphasis role="bold"> +Example: </emphasis>route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403</entry></row><row><entry align="left">routes (attributes)</entry><entry align="left">route1_options, route2_options, ...</entry><entry align="left">key=val[,key=val...]</entry><entry align="left">Attributes defined for the routes, if any. The supported attributes are explained in ipv6.routes entry in `man nm-settings-nmcli`.<emphasis role="bold"> + +Example: </emphasis>route1_options=mtu=1000,onlink=true</entry></row><row><entry align="left">routing-rules</entry><entry align="left">routing-rule1, routing-rule2, ...</entry><entry align="left">routing rule string</entry><entry align="left">Routing rules as defined with `ip rule add`, but with mandatory fixed priority.<emphasis role="bold"> + +Example: </emphasis>routing-rule1=priority 5 from 2001:4860:4860::/64 table 45</entry></row></tbody></tgroup></table><table><title>serial setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">parity</entry><entry align="left"/><entry align="left">'e', 'o', or 'n'</entry><entry align="left">The connection parity; even, odd, or none. Note that older versions of NetworkManager stored this as an integer: 69 ('E') for even, 111 ('o') for odd, or 110 ('n') for none.<emphasis role="bold"> Example: </emphasis>parity=n</entry></row></tbody></tgroup></table><table><title>vpn setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">data</entry><entry align="left">separate variables named after keys of the dictionary</entry><entry align="left"/><entry align="left">The keys of the data dictionary are used as variable names directly under [vpn] section.<emphasis role="bold"> @@ -175,7 +190,7 @@ Example: </emphasis>password=Popocatepetl</entry></row></tbody></tgroup></table> and storing this secret; when it is required, agents will be asked to provide it.</para></listitem><listitem><para>2 - (not-saved) - this secret should not be saved but should be requested from the user each time it is required.</para></listitem><listitem><para>4 - (not-required) - in some situations it cannot be automatically determined that a secret is required or not. This flag hints that the secret is not required - and should not be requested from the user.</para></listitem></itemizedlist></refsect2></refsect1><refsect1 id="files"><title>Files</title><para><filename>/etc/NetworkManager/system-connections/*</filename></para></refsect1><refsect1 id="see_also"><title>See Also</title><para><link linkend="nm-settings"><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, + and should not be requested from the user.</para></listitem></itemizedlist></refsect2></refsect1><refsect1 id="files"><title>Files</title><para><filename>/etc/NetworkManager/system-connections/*</filename></para></refsect1><refsect1 id="see_also"><title>See Also</title><para><link linkend="nm-settings-nmcli"><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <link linkend="nm-settings-ifcfg-rh"><citerefentry><refentrytitle>nm-settings-ifcfg-rh</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <link linkend="NetworkManager"><citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>, <link linkend="NetworkManager.conf"><citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, diff --git a/man/nm-settings-keyfile.xsl b/man/nm-settings-keyfile.xsl index d63abf0f..450cc6fd 100644 --- a/man/nm-settings-keyfile.xsl +++ b/man/nm-settings-keyfile.xsl @@ -32,7 +32,7 @@ <refsect1 id='description'><title>Description</title> <para> NetworkManager is based on the concept of connection profiles that contain - network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle> + network configuration (see <citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle> <manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing the data. The plugins can be configured in <citerefentry> @@ -54,23 +54,32 @@ <refsect1 id='file_format'><title>File Format</title> <para> The <emphasis>keyfile</emphasis> config format is a simple .ini-style - format. It consists of sections (groups) of key-value pairs. Each section - corresponds to a setting name as described in the settings specification - (<citerefentry><refentrytitle>nm-settings</refentrytitle> - <manvolnum>5</manvolnum></citerefentry>). Each configuration key/value - pair in the section is one of the properties listed in the settings - specification. The majority of properties of the specification is written - in the same format into the <emphasis>keyfile</emphasis> too. However - some values are inconvenient for people to use. These are stored in the - files in more readable ways. These properties are described below. - An example could be IP addresses that are not written as integer arrays, - but more reasonably as "1.2.3.4/12 1.2.3.254". + format. It consists of sections (groups) of key-value pairs. More information of the generic key file format can be found at <ulink url="https://developer.gnome.org/glib/stable/glib-Key-value-file-parser.html#glib-Key-value-file-parser.description"> GLib key file format</ulink> (Lines beginning with a '#' are comments, lists are separated by character <literal>;</literal> etc.). </para> <para> + Each section corresponds to a setting name as described in the settings + specification (<citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle> + <manvolnum>5</manvolnum></citerefentry>). Each key/value pair in a + section is one of the properties from the specification. + </para> + <para> + The majority of properties are written in the same format as the + specification into the <emphasis>keyfile</emphasis>. However, some + values are inconvenient for people to use so they are stored in the + <emphasis>keyfile</emphasis> in more readable ways. These properties + that differ from the specification are described below. + An example could be IP addresses that are not written as integer arrays, + but more reasonably as "1.2.3.4/12 1.2.3.254". + Also, some lists of complex values (addresses, routes, routing-rules), + instead of using a semicolon separated list, use one key-value pair + per list element, with the key being the singular of the property name + followed by the numeric index (i.e address1, address2, ...). + </para> + <para> Users can create or modify the <emphasis>keyfile</emphasis> connection files manually, even if that is not the recommended way of managing the profiles. However, if they choose to do that, they must inform NetworkManager about @@ -195,7 +204,7 @@ id=4 There are several exceptions to this rule, mainly for making keyfile syntax easier for humans. The exceptions handled specially by <emphasis>keyfile</emphasis> plugin are listed below. Refer to - <link linkend='nm-settings'><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> + <link linkend='nm-settings-nmcli'><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> for all available settings and properties and their description. </para> <formalpara><title>Name aliases</title> @@ -246,7 +255,7 @@ id=4 </refsect1> <refsect1 id='see_also'><title>See Also</title> - <para><link linkend='nm-settings'><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, + <para><link linkend='nm-settings-nmcli'><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <link linkend='nm-settings-ifcfg-rh'><citerefentry><refentrytitle>nm-settings-ifcfg-rh</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <link linkend='NetworkManager'><citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>, <link linkend='NetworkManager.conf'><citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, diff --git a/man/nm-settings-nmcli.5 b/man/nm-settings-nmcli.5 index 30a3bf2f..174cf43a 100644 --- a/man/nm-settings-nmcli.5 +++ b/man/nm-settings-nmcli.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-nmcli .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: Configuration -.\" Source: NetworkManager 1.44.2 +.\" Source: NetworkManager 1.45.90 .\" Language: English .\" -.TH "NM\-SETTINGS\-NMCLI" "5" "" "NetworkManager 1\&.44\&.2" "Configuration" +.TH "NM\-SETTINGS\-NMCLI" "5" "" "NetworkManager 1\&.45\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -74,7 +74,9 @@ The number of retries for the authentication\&. Zero means to try indefinitely; .sp Currently, this only applies to 802\-1x authentication\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-1 \- 2147483647 .RE .PP \fBconnection\&.autoconnect\fR @@ -92,27 +94,46 @@ If multiple profiles are ready to autoconnect on the same device, the one with t Depending on "connection\&.multi\-connect", a profile can (auto)connect only once at a time or multiple times\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBconnection\&.autoconnect\-priority\fR .RS 4 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\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-999 \- 999 .RE .PP \fBconnection\&.autoconnect\-retries\fR .RS 4 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\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-1 \- 2147483647 +.sp +Special values: default (\-1), forever (0) .RE .PP \fBconnection\&.autoconnect\-slaves\fR .RS 4 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\&. .sp -Format: NMSettingConnectionAutoconnectSlaves (int32) +Format: choice (NMSettingConnectionAutoconnectSlaves) +.sp +Valid values: default (\-1), no (0), yes (1) +.RE +.PP +\fBconnection\&.controller\fR +.RS 4 +Alias: controller +.sp +Interface name of the controller device or UUID of the controller connection\&. +.sp +Format: string .RE .PP \fBconnection\&.dns\-over\-tls\fR @@ -123,14 +144,18 @@ The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "oppor .sp This feature requires a plugin which supports DNSOverTls\&. Otherwise, the setting has no effect\&. One such plugin is dns\-systemd\-resolved\&. .sp -Format: int32 +Format: choice (NMSettingConnectionDnsOverTls) +.sp +Valid values: default (\-1), no (0), opportunistic (1), yes (2) .RE .PP \fBconnection\&.gateway\-ping\-timeout\fR .RS 4 If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 600 .RE .PP \fBconnection\&.id\fR @@ -159,7 +184,9 @@ Format: string .RS 4 Whether LLDP is enabled for the connection\&. .sp -Format: int32 +Format: choice (NMSettingConnectionLldp) +.sp +Valid values: default (\-1), disable (0), enable\-rx/enable (1) .RE .PP \fBconnection\&.llmnr\fR @@ -170,7 +197,9 @@ The permitted values are: "yes" (2) register hostname and resolving for the conn .sp This feature requires a plugin which supports LLMNR\&. Otherwise, the setting has no effect\&. One such plugin is dns\-systemd\-resolved\&. .sp -Format: int32 +Format: choice (NMSettingConnectionLlmnr) +.sp +Valid values: default (\-1), no (0), resolve (1), yes (2) .RE .PP \fBconnection\&.master\fR @@ -179,6 +208,8 @@ Alias: master .sp Interface name of the master device or UUID of the master connection\&. .sp +Deprecated 1\&.46\&. Use "controller" instead, this is just an alias\&. +.sp Format: string .RE .PP @@ -190,7 +221,9 @@ The permitted values are: "yes" (2) register hostname and resolving for the conn .sp This feature requires a plugin which supports mDNS\&. Otherwise, the setting has no effect\&. One such plugin is dns\-systemd\-resolved\&. .sp -Format: int32 +Format: choice (NMSettingConnectionMdns) +.sp +Valid values: default (\-1), no (0), resolve (1), yes (2) .RE .PP \fBconnection\&.metered\fR @@ -199,7 +232,9 @@ Whether the connection is metered\&. .sp When updating this property on a currently activated connection, the change takes effect immediately\&. .sp -Format: NMMetered (int32) +Format: ternary +.sp +Valid values: true/yes/on, false/no/off, default/unknown .RE .PP \fBconnection\&.mptcp\-flags\fR @@ -222,7 +257,9 @@ NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/ .sp 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)\&. .sp -Format: uint32 +Format: flags (NMMptcpFlags) +.sp +Valid values: none/default (0x0), disabled (0x1), enabled (0x2), also\-without\-sysctl (0x4), also\-without\-default\-route (0x8), signal (0x10), subflow (0x20), backup (0x40), fullmesh (0x80) .RE .PP \fBconnection\&.mud\-url\fR @@ -240,7 +277,9 @@ Format: string .RS 4 Specifies whether the profile can be active multiple times at a particular moment\&. The value is of type NMConnectionMultiConnect\&. .sp -Format: int32 +Format: choice (NMConnectionMultiConnect) +.sp +Valid values: default (0), single (1), manual\-multiple (2), multiple (3) .RE .PP \fBconnection\&.permissions\fR @@ -249,14 +288,25 @@ An array of strings defining what access a given user has to this connection\&. .sp 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\&. .sp -Format: array of string +Format: list of strings +.RE +.PP +\fBconnection\&.port\-type\fR +.RS 4 +Alias: port\-type +.sp +Setting name of the device type of this port\*(Aqs controller connection (eg, "bond"), or NULL if this connection is not a port\&. +.sp +Format: string +.sp +Valid values: bond, bridge, ovs\-bridge, ovs\-port, team, vrf .RE .PP \fBconnection\&.secondaries\fR .RS 4 List of connection UUIDs that should be activated when the base connection itself is activated\&. Currently, only VPN connections are supported\&. .sp -Format: array of string +Format: list of strings .RE .PP \fBconnection\&.slave\-type\fR @@ -265,7 +315,11 @@ Alias: slave\-type .sp Setting name of the device type of this slave\*(Aqs master connection (eg, "bond"), or NULL if this connection is not a slave\&. .sp +Deprecated 1\&.46\&. Use "port\-type" instead, this is just an alias\&. +.sp Format: string +.sp +Valid values: bond, bridge, ovs\-bridge, ovs\-port, team, vrf .RE .PP \fBconnection\&.stable\-id\fR @@ -276,7 +330,7 @@ The stable\-id is used for generating IPv6 stable private addresses with ipv6\&. .sp Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm\&. For example, a per\-host key is commonly also included, so that different systems end up generating different IDs\&. Or with ipv6\&.addr\-gen\-mode=stable\-privacy, also the device\*(Aqs name is included, so that different interfaces yield different addresses\&. The per\-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key\&. See NetworkManager(8) manual about the secret\-key and the host identity\&. .sp -The \*(Aq$\*(Aq 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\*(Aqs connection\&.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}\-${BOOT}\-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates\&. +The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at activation time\&. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${NETWORK_SSID}", "${BOOT}", "${RANDOM}"\&. These effectively create unique IDs per\-connection, per\-device, per\-SSID, per\-boot, or every time\&. The "${CONNECTION}" uses the profile\*(Aqs connection\&.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device\&. "${NETWORK_SSID}" uses the SSID for Wi\-Fi networks and falls back to "${CONNECTION}" on other networks\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}\-${BOOT}\-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates\&. .sp 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\&. .sp @@ -289,7 +343,7 @@ The time, in seconds since the Unix Epoch, that the connection was last _success .sp 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)\&. .sp -Format: uint64 +Format: read only .RE .PP \fBconnection\&.type\fR @@ -299,6 +353,8 @@ Alias: type 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)\&. .sp Format: string +.sp +Valid values: 6lowpan, 802\-11\-olpc\-mesh, 802\-11\-wireless, 802\-3\-ethernet, adsl, bluetooth, bond, bridge, cdma, dummy, generic, gsm, hsr, infiniband, ip\-tunnel, loopback, macsec, macvlan, ovs\-bridge, ovs\-dpdk, ovs\-interface, ovs\-patch, ovs\-port, pppoe, team, tun, veth, vlan, vpn, vrf, vxlan, wifi\-p2p, wimax, wireguard, wpan .RE .PP \fBconnection\&.uuid\fR @@ -307,7 +363,7 @@ The connection\&.uuid is the real identifier of a profile\&. It cannot change an .sp 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\&. .sp -Format: a valid RFC4122 universally unique identifier (UUID)\&. +Format: string .RE .PP \fBconnection\&.wait\-activation\-delay\fR @@ -316,7 +372,9 @@ Time in milliseconds to wait for connection to be considered activated\&. The wa .sp The value 0 means no wait time\&. The default value is \-1, which currently has the same meaning as no wait time\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-1 \- 2147483647 .RE .PP \fBconnection\&.wait\-device\-timeout\fR @@ -325,7 +383,9 @@ Timeout in milliseconds to wait for device at startup\&. During boot, devices ma .sp The value 0 means no wait time\&. The default value is \-1, which currently has the same meaning as no wait time\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-1 \- 2147483647 .RE .PP \fBconnection\&.zone\fR @@ -360,7 +420,7 @@ Properties: .RS 4 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\*(Aqs altSubjectName is performed\&. .sp -Format: array of string +Format: list of strings .RE .PP \fB802\-1x\&.anonymous\-identity\fR @@ -374,7 +434,9 @@ Format: string .RS 4 A timeout for the authentication\&. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds\&. .sp -Format: int32 +Format: integer +.sp +Valid values: 0 \- 2147483647 .RE .PP \fB802\-1x\&.ca\-cert\fR @@ -385,7 +447,7 @@ Certificate data is specified using a "scheme"; three are currently supported: b .sp 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\&. .sp -Format: byte array +Format: filesystem path .RE .PP \fB802\-1x\&.ca\-cert\-password\fR @@ -399,11 +461,9 @@ Format: string .RS 4 Flags indicating how to handle the "ca\-cert\-password" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fB802\-1x\&.ca\-path\fR @@ -421,7 +481,7 @@ Contains the client certificate if used by the EAP method specified in the "eap" .sp Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. .sp -Format: byte array +Format: filesystem path .RE .PP \fB802\-1x\&.client\-cert\-password\fR @@ -435,11 +495,9 @@ Format: string .RS 4 Flags indicating how to handle the "client\-cert\-password" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fB802\-1x\&.domain\-match\fR @@ -460,7 +518,9 @@ Format: string .RS 4 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\&. .sp -Format: array of string +Format: list of strings +.sp +Valid values: leap, md5, tls, peap, ttls, sim, fast, pwd .RE .PP \fB802\-1x\&.identity\fR @@ -475,6 +535,8 @@ Format: string 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fB802\-1x\&.pac\-file\fR @@ -495,36 +557,34 @@ Format: string .RS 4 Flags indicating how to handle the "password" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fB802\-1x\&.password\-raw\fR .RS 4 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\&. .sp -Format: byte array +Format: bytes .RE .PP \fB802\-1x\&.password\-raw\-flags\fR .RS 4 Flags indicating how to handle the "password\-raw" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fB802\-1x\&.phase1\-auth\-flags\fR .RS 4 Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options\&. The individual TLS versions can be explicitly disabled\&. TLS time checks can be also disabled\&. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it\&. The TLS options map to tls_disable_tlsv1_x and tls_disable_time_checks settings\&. See the wpa_supplicant documentation for more details\&. .sp -Format: uint32 +Format: flags (NMSetting8021xAuthFlags) +.sp +Valid values: none (0x0), tls\-1\-0\-disable (0x1), tls\-1\-1\-disable (0x2), tls\-1\-2\-disable (0x4), tls\-disable\-time\-checks (0x8), tls\-1\-3\-disable (0x10), tls\-1\-0\-enable (0x20), tls\-1\-1\-enable (0x40), tls\-1\-2\-enable (0x80), tls\-1\-3\-enable (0x100), all (0x1ff) .RE .PP \fB802\-1x\&.phase1\-fast\-provisioning\fR @@ -532,6 +592,8 @@ Format: uint32 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\&. .sp Format: string +.sp +Valid values: 0, 1, 2, 3 .RE .PP \fB802\-1x\&.phase1\-peaplabel\fR @@ -539,6 +601,8 @@ Format: string 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\&. .sp Format: string +.sp +Valid values: 0, 1 .RE .PP \fB802\-1x\&.phase1\-peapver\fR @@ -546,13 +610,15 @@ Format: string 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\&. .sp Format: string +.sp +Valid values: 0, 1 .RE .PP \fB802\-1x\&.phase2\-altsubject\-matches\fR .RS 4 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\*(Aqs altSubjectName is performed\&. .sp -Format: array of string +Format: list of strings .RE .PP \fB802\-1x\&.phase2\-auth\fR @@ -560,6 +626,8 @@ Format: array of string 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\&. .sp Format: string +.sp +Valid values: pap, chap, mschap, mschapv2, gtc, otp, md5, tls .RE .PP \fB802\-1x\&.phase2\-autheap\fR @@ -567,6 +635,8 @@ Format: string 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\&. .sp Format: string +.sp +Valid values: md5, mschapv2, otp, gtc, tls .RE .PP \fB802\-1x\&.phase2\-ca\-cert\fR @@ -577,7 +647,7 @@ Certificate data is specified using a "scheme"; three are currently supported: b .sp 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\&. .sp -Format: byte array +Format: filesystem path .RE .PP \fB802\-1x\&.phase2\-ca\-cert\-password\fR @@ -591,11 +661,9 @@ Format: string .RS 4 Flags indicating how to handle the "phase2\-ca\-cert\-password" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fB802\-1x\&.phase2\-ca\-path\fR @@ -604,7 +672,7 @@ UTF\-8 encoded path to a directory containing PEM or DER formatted certificates .sp If NMSetting8021x:system\-ca\-certs is enabled and the built\-in CA path is an existing directory, then this setting is ignored\&. .sp -Format: string +Format: filesystem path .RE .PP \fB802\-1x\&.phase2\-client\-cert\fR @@ -613,7 +681,7 @@ Contains the "phase 2" client certificate if used by the EAP method specified in .sp Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. .sp -Format: byte array +Format: filesystem path .RE .PP \fB802\-1x\&.phase2\-client\-cert\-password\fR @@ -627,11 +695,9 @@ Format: string .RS 4 Flags indicating how to handle the "phase2\-client\-cert\-password" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fB802\-1x\&.phase2\-domain\-match\fR @@ -654,7 +720,7 @@ Contains the "phase 2" inner private key when the "phase2\-auth" or "phase2\-aut .sp Key data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme and private keys, this property should be set to the key\*(Aqs encrypted PEM encoded data\&. When using private keys with the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2\-private\-key\-password" property must be set to password used to decrypt the PKCS#12 certificate and key\&. When using PKCS#12 files and the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2\-private\-key\-password" property must be set to the password used to decode the PKCS#12 private key and certificate\&. .sp -Format: byte array +Format: filesystem path .RE .PP \fB802\-1x\&.phase2\-private\-key\-password\fR @@ -668,11 +734,9 @@ Format: string .RS 4 Flags indicating how to handle the "phase2\-private\-key\-password" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fB802\-1x\&.phase2\-subject\-match\fR @@ -695,11 +759,9 @@ Format: string .RS 4 Flags indicating how to handle the "pin" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fB802\-1x\&.private\-key\fR @@ -710,7 +772,7 @@ Key data is specified using a "scheme"; two are currently supported: blob and pa .sp 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\&. .sp -Format: byte array +Format: filesystem path .RE .PP \fB802\-1x\&.private\-key\-password\fR @@ -724,11 +786,9 @@ Format: string .RS 4 Flags indicating how to handle the "private\-key\-password" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fB802\-1x\&.subject\-match\fR @@ -745,6 +805,8 @@ Format: string 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)\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .SS "adsl setting" .PP @@ -759,6 +821,8 @@ Alias: encapsulation Encapsulation of ADSL connection\&. Can be "vcmux" or "llc"\&. .sp Format: string +.sp +Valid values: vcmux, llc .RE .PP \fBadsl\&.password\fR @@ -774,11 +838,9 @@ Format: string .RS 4 Flags indicating how to handle the "password" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fBadsl\&.protocol\fR @@ -788,6 +850,8 @@ Alias: protocol ADSL connection protocol\&. Can be "pppoa", "pppoe" or "ipoatm"\&. .sp Format: string +.sp +Valid values: pppoa, pppoe, ipoatm .RE .PP \fBadsl\&.username\fR @@ -803,14 +867,18 @@ Format: string .RS 4 VCI of ADSL connection .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 65536 .RE .PP \fBadsl\&.vpi\fR .RS 4 VPI of ADSL connection .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 65536 .RE .SS "bluetooth setting" .PP @@ -824,7 +892,7 @@ Alias: addr .sp The Bluetooth address of the device\&. .sp -Format: byte array +Format: MAC address .RE .PP \fBbluetooth\&.type\fR @@ -834,6 +902,8 @@ Alias: bt\-type Either "dun" for Dial\-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile\&. .sp Format: string +.sp +Valid values: dun, panu, nap .RE .SS "bond setting" .PP @@ -845,7 +915,7 @@ Properties: .RS 4 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])\&. .sp -Format: dict of string to string +Format: list of key/value options .RE .SS "bridge setting" .PP @@ -859,7 +929,9 @@ Alias: ageing\-time .sp The Ethernet MAC address aging time, in seconds\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 1000000 .RE .PP \fBbridge\&.forward\-delay\fR @@ -868,7 +940,9 @@ Alias: forward\-delay .sp The Spanning Tree Protocol (STP) forwarding delay, in seconds\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 30 .RE .PP \fBbridge\&.group\-address\fR @@ -877,7 +951,7 @@ If specified, The MAC address of the multicast group this bridge uses for STP\&. .sp 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\&. .sp -Format: byte array +Format: MAC address .RE .PP \fBbridge\&.group\-forward\-mask\fR @@ -886,7 +960,9 @@ Alias: group\-forward\-mask .sp 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\*(Aqt have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 65535 .RE .PP \fBbridge\&.hello\-time\fR @@ -895,7 +971,9 @@ Alias: hello\-time .sp The Spanning Tree Protocol (STP) hello time, in seconds\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 10 .RE .PP \fBbridge\&.mac\-address\fR @@ -908,7 +986,7 @@ If this field is left unspecified, the "ethernet\&.cloned\-mac\-address" is refe .sp This property is deprecated since version 1\&.12\&. Use the "cloned\-mac\-address" property instead\&. .sp -Format: byte array +Format: MAC address .RE .PP \fBbridge\&.max\-age\fR @@ -917,35 +995,45 @@ Alias: max\-age .sp The Spanning Tree Protocol (STP) maximum message age, in seconds\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 40 .RE .PP \fBbridge\&.multicast\-hash\-max\fR .RS 4 Set maximum size of multicast hash table (value must be a power of 2)\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 1 \- 4294967295 .RE .PP \fBbridge\&.multicast\-last\-member\-count\fR .RS 4 Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBbridge\&.multicast\-last\-member\-interval\fR .RS 4 Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received\&. .sp -Format: uint64 +Format: integer +.sp +Valid values: 0 \- 18446744073709551615 .RE .PP \fBbridge\&.multicast\-membership\-interval\fR .RS 4 Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received\&. .sp -Format: uint64 +Format: integer +.sp +Valid values: 0 \- 18446744073709551615 .RE .PP \fBbridge\&.multicast\-querier\fR @@ -953,27 +1041,35 @@ Format: uint64 Enable or disable sending of multicast queries by the bridge\&. If not specified the option is disabled\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBbridge\&.multicast\-querier\-interval\fR .RS 4 If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries\&. .sp -Format: uint64 +Format: integer +.sp +Valid values: 0 \- 18446744073709551615 .RE .PP \fBbridge\&.multicast\-query\-interval\fR .RS 4 Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase\&. .sp -Format: uint64 +Format: integer +.sp +Valid values: 0 \- 18446744073709551615 .RE .PP \fBbridge\&.multicast\-query\-response\-interval\fR .RS 4 Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge\&. .sp -Format: uint64 +Format: integer +.sp +Valid values: 0 \- 18446744073709551615 .RE .PP \fBbridge\&.multicast\-query\-use\-ifaddr\fR @@ -981,6 +1077,8 @@ Format: uint64 If enabled the bridge\*(Aqs own IP address is used as the source address for IGMP queries otherwise the default of 0\&.0\&.0\&.0 is used\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBbridge\&.multicast\-router\fR @@ -990,6 +1088,8 @@ Sets bridge\*(Aqs multicast router\&. Multicast\-snooping must be enabled for th Supported values are: \*(Aqauto\*(Aq, \*(Aqdisabled\*(Aq, \*(Aqenabled\*(Aq to which kernel assigns the numbers 1, 0, and 2, respectively\&. If not specified the default value is \*(Aqauto\*(Aq (1)\&. .sp Format: string +.sp +Valid values: auto, disabled, enabled .RE .PP \fBbridge\&.multicast\-snooping\fR @@ -999,20 +1099,26 @@ Alias: multicast\-snooping 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBbridge\&.multicast\-startup\-query\-count\fR .RS 4 Set the number of IGMP queries to send during startup phase\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBbridge\&.multicast\-startup\-query\-interval\fR .RS 4 Sets the time (in deciseconds) between queries sent out at startup to determine membership information\&. .sp -Format: uint64 +Format: integer +.sp +Valid values: 0 \- 18446744073709551615 .RE .PP \fBbridge\&.priority\fR @@ -1021,7 +1127,9 @@ Alias: priority .sp Sets the Spanning Tree Protocol (STP) priority for this bridge\&. Lower values are "better"; the lowest priority bridge will be elected the root bridge\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 65535 .RE .PP \fBbridge\&.stp\fR @@ -1031,13 +1139,17 @@ Alias: stp Controls whether Spanning Tree Protocol (STP) is enabled for this bridge\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBbridge\&.vlan\-default\-pvid\fR .RS 4 The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4094 .RE .PP \fBbridge\&.vlan\-filtering\fR @@ -1045,6 +1157,8 @@ Format: uint32 Control whether VLAN filtering is enabled on the bridge\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBbridge\&.vlan\-protocol\fR @@ -1054,6 +1168,8 @@ If specified, the protocol used for VLAN filtering\&. Supported values are: \*(Aq802\&.1Q\*(Aq, \*(Aq802\&.1ad\*(Aq\&. If not specified the default value is \*(Aq802\&.1Q\*(Aq\&. .sp Format: string +.sp +Valid values: 802\&.1Q, 802\&.1ad .RE .PP \fBbridge\&.vlan\-stats\-enabled\fR @@ -1061,6 +1177,8 @@ Format: string Controls whether per\-VLAN stats accounting is enabled\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBbridge\&.vlans\fR @@ -1073,7 +1191,7 @@ $vid [pvid] [untagged] [, $vid [pvid] [untagged]]\&.\&.\&. .sp where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash\&. .sp -Format: array of vardict +Format: list of bridge\&.vlans objects .RE .SS "bridge\-port setting" .PP @@ -1088,6 +1206,8 @@ Alias: hairpin Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBbridge\-port\&.path\-cost\fR @@ -1096,7 +1216,9 @@ Alias: path\-cost .sp The Spanning Tree Protocol (STP) port cost for destinations via this port\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 65535 .RE .PP \fBbridge\-port\&.priority\fR @@ -1105,7 +1227,9 @@ Alias: priority .sp The Spanning Tree Protocol (STP) priority of this bridge port\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 63 .RE .PP \fBbridge\-port\&.vlans\fR @@ -1118,7 +1242,7 @@ $vid [pvid] [untagged] [, $vid [pvid] [untagged]]\&.\&.\&. .sp where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash\&. .sp -Format: array of vardict +Format: list of bridge\-port\&.vlans objects .RE .SS "cdma setting" .PP @@ -1130,7 +1254,9 @@ Properties: .RS 4 If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. .sp -Format: uint32 +Format: integer +.sp +Special values: auto .RE .PP \fBcdma\&.number\fR @@ -1153,11 +1279,9 @@ Format: string .RS 4 Flags indicating how to handle the "password" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fBcdma\&.username\fR @@ -1176,9 +1300,11 @@ Properties: .PP \fBdcb\&.app\-fcoe\-flags\fR .RS 4 -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)\&. +Specifies the NMSettingDcbFlags for the DCB FCoE application\&. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4)\&. .sp -Format: NMSettingDcbFlags (uint32) +Format: flags (NMSettingDcbFlags) +.sp +Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4) .RE .PP \fBdcb\&.app\-fcoe\-mode\fR @@ -1188,97 +1314,131 @@ 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"\&. .sp Format: string +.sp +Valid values: fabric, vn2vn .RE .PP \fBdcb\&.app\-fcoe\-priority\fR .RS 4 -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\&. +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 "enable" (0x1) flag\&. +.sp +Format: integer .sp -Format: int32 +Valid values: \-1 \- 7 +.sp +Special values: unset (\-1) .RE .PP \fBdcb\&.app\-fip\-flags\fR .RS 4 -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)\&. +Specifies the NMSettingDcbFlags for the DCB FIP application\&. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4)\&. +.sp +Format: flags (NMSettingDcbFlags) .sp -Format: NMSettingDcbFlags (uint32) +Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4) .RE .PP \fBdcb\&.app\-fip\-priority\fR .RS 4 -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\&. +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 "enable" (0x1) flag\&. +.sp +Format: integer +.sp +Valid values: \-1 \- 7 .sp -Format: int32 +Special values: unset (\-1) .RE .PP \fBdcb\&.app\-iscsi\-flags\fR .RS 4 -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)\&. +Specifies the NMSettingDcbFlags for the DCB iSCSI application\&. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4)\&. .sp -Format: NMSettingDcbFlags (uint32) +Format: flags (NMSettingDcbFlags) +.sp +Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4) .RE .PP \fBdcb\&.app\-iscsi\-priority\fR .RS 4 -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\&. +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 "enable" (0x1) flag\&. +.sp +Format: integer +.sp +Valid values: \-1 \- 7 .sp -Format: int32 +Special values: unset (\-1) .RE .PP \fBdcb\&.priority\-bandwidth\fR .RS 4 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\*(Aqs assigned group that the priority may use\&. The sum of all percentages for priorities which belong to the same group must total 100 percents\&. .sp -Format: array of uint32 +Format: list of integers +.sp +Valid values: 0 \- 100 .RE .PP \fBdcb\&.priority\-flow\-control\fR .RS 4 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\&. .sp -Format: array of uint32 +Format: list of booleans +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBdcb\&.priority\-flow\-control\-flags\fR .RS 4 -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)\&. +Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC)\&. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4)\&. .sp -Format: NMSettingDcbFlags (uint32) +Format: flags (NMSettingDcbFlags) +.sp +Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4) .RE .PP \fBdcb\&.priority\-group\-bandwidth\fR .RS 4 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\&. .sp -Format: array of uint32 +Format: list of integers +.sp +Valid values: 0 \- 100 .RE .PP \fBdcb\&.priority\-group\-flags\fR .RS 4 -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)\&. +Specifies the NMSettingDcbFlags for DCB Priority Groups\&. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4)\&. .sp -Format: NMSettingDcbFlags (uint32) +Format: flags (NMSettingDcbFlags) +.sp +Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4) .RE .PP \fBdcb\&.priority\-group\-id\fR .RS 4 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\&. .sp -Format: array of uint32 +Format: list of integers +.sp +Valid values: 0 \- 7, 15 .RE .PP \fBdcb\&.priority\-strict\-bandwidth\fR .RS 4 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\&. .sp -Format: array of uint32 +Format: list of booleans +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBdcb\&.priority\-traffic\-class\fR .RS 4 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\&. .sp -Format: array of uint32 +Format: list of integers +.sp +Valid values: 0 \- 7 .RE .SS "ethtool setting" .PP @@ -1286,352 +1446,648 @@ Ethtool Ethernet Settings\&. .PP Properties: .PP +\fBethtool\&.channels\-combined\fR +.RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 +.RE +.PP +\fBethtool\&.channels\-other\fR +.RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 +.RE +.PP +\fBethtool\&.channels\-rx\fR +.RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 +.RE +.PP +\fBethtool\&.channels\-tx\fR +.RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 +.RE +.PP \fBethtool\&.coalesce\-adaptive\-rx\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-adaptive\-tx\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-pkt\-rate\-high\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-pkt\-rate\-low\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-rx\-frames\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-rx\-frames\-high\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-rx\-frames\-irq\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-rx\-frames\-low\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-rx\-usecs\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-rx\-usecs\-high\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-rx\-usecs\-irq\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-rx\-usecs\-low\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-sample\-interval\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-stats\-block\-usecs\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-tx\-frames\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-tx\-frames\-high\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-tx\-frames\-irq\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-tx\-frames\-low\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-tx\-usecs\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-tx\-usecs\-high\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-tx\-usecs\-irq\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.coalesce\-tx\-usecs\-low\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 +.RE +.PP +\fBethtool\&.eee\-enabled\fR +.RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-esp\-hw\-offload\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-esp\-tx\-csum\-hw\-offload\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-fcoe\-mtu\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-gro\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-gso\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-highdma\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-hw\-tc\-offload\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-l2\-fwd\-offload\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-loopback\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-lro\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-macsec\-hw\-offload\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-ntuple\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-rx\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-rx\-all\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-rx\-fcs\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-rx\-gro\-hw\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-rx\-gro\-list\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-rx\-udp\-gro\-forwarding\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-rx\-udp_tunnel\-port\-offload\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-rx\-vlan\-filter\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-rx\-vlan\-stag\-filter\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-rx\-vlan\-stag\-hw\-parse\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-rxhash\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-rxvlan\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-sg\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tls\-hw\-record\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tls\-hw\-rx\-offload\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tls\-hw\-tx\-offload\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tso\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-checksum\-fcoe\-crc\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-checksum\-ip\-generic\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-checksum\-ipv4\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-checksum\-ipv6\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-checksum\-sctp\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-esp\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-fcoe\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-gre\-csum\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-gre\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-gso\-list\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-gso\-partial\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-gso\-robust\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-ipxip4\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-ipxip6\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-nocache\-copy\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-scatter\-gather\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-scatter\-gather\-fraglist\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-sctp\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-tcp\-ecn\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-tcp\-mangleid\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-tcp\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-tcp6\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-tunnel\-remcsum\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-udp\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-udp_tnl\-csum\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-udp_tnl\-segmentation\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-tx\-vlan\-stag\-hw\-insert\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.feature\-txvlan\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.pause\-autoneg\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.pause\-rx\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.pause\-tx\fR .RS 4 +Format: ternary +.sp +Valid values: on, off, ignore .RE .PP \fBethtool\&.ring\-rx\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.ring\-rx\-jumbo\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.ring\-rx\-mini\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBethtool\&.ring\-tx\fR .RS 4 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .SS "gsm setting" .PP @@ -1645,6 +2101,8 @@ Alias: apn .sp 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\*(Aqs mobile broadband plan\&. The APN may only be composed of the characters a\-z, 0\-9, \&., and \- per GSM 03\&.60 Section 14\&.9\&. .sp +If the APN is unset (the default) then it may be detected based on "auto\-config" setting\&. The property can be explicitly set to the empty string to prevent that and use no APN\&. +.sp Format: string .RE .PP @@ -1653,6 +2111,8 @@ Format: string 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBgsm\&.device\-id\fR @@ -1667,6 +2127,8 @@ Format: string When TRUE, only connections to the home network will be allowed\&. Connections to roaming networks will not be made\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBgsm\&.initial\-eps\-bearer\-apn\fR @@ -1681,13 +2143,17 @@ Format: string 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBgsm\&.mtu\fR .RS 4 If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. .sp -Format: uint32 +Format: integer +.sp +Special values: auto .RE .PP \fBgsm\&.network\-id\fR @@ -1719,11 +2185,9 @@ Format: string .RS 4 Flags indicating how to handle the "password" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fBgsm\&.pin\fR @@ -1737,11 +2201,9 @@ Format: string .RS 4 Flags indicating how to handle the "pin" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fBgsm\&.sim\-id\fR @@ -1778,7 +2240,7 @@ Alias: mac .sp 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)\&. .sp -Format: byte array +Format: Infiniband MAC address .RE .PP \fBinfiniband\&.mtu\fR @@ -1787,7 +2249,9 @@ Alias: mtu .sp If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. .sp -Format: uint32 +Format: integer +.sp +Special values: auto .RE .PP \fBinfiniband\&.p\-key\fR @@ -1800,7 +2264,11 @@ With the p\-key set, the interface name is always "$parent\&.$p_key"\&. Setting .sp 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\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-1 \- 65535 +.sp +Special values: default (\-1) .RE .PP \fBinfiniband\&.parent\fR @@ -1819,6 +2287,8 @@ Alias: transport\-mode The IP\-over\-InfiniBand transport mode\&. Either "datagram" or "connected"\&. .sp Format: string +.sp +Valid values: datagram, connected .RE .SS "ipv4 setting" .PP @@ -1832,7 +2302,7 @@ Alias: ip4 .sp 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\&. .sp -Format: a comma separated list of addresses +Format: list of ipv4\&.addresses objects .RE .PP \fBipv4\&.auto\-route\-ext\-gw\fR @@ -1841,16 +2311,22 @@ VPN connections will default to add the route automatically unless this setting .sp For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect\&. .sp -Format: NMTernary (int32) +Format: ternary +.sp +Valid values: true/yes/on, false/no/off, default/unknown .RE .PP \fBipv4\&.dad\-timeout\fR .RS 4 -Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network\&. If an address conflict is detected, the activation will fail\&. A zero value means that no duplicate address detection is performed, \-1 means the default value (either configuration ipvx\&.dad\-timeout override or zero)\&. A value greater than zero is a timeout in milliseconds\&. +Maximum 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\&. The property is currently implemented only for IPv4\&. +.sp +A zero value means that no duplicate address detection is performed, \-1 means the default value (either the value configured globally in NetworkManger\&.conf or 200ms)\&. A value greater than zero is a timeout in milliseconds\&. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property\&. .sp -The property is currently implemented only for IPv4\&. +Format: integer .sp -Format: int32 +Valid values: \-1 \- 30000 +.sp +Special values: default (\-1), off (0) .RE .PP \fBipv4\&.dhcp\-client\-id\fR @@ -1865,9 +2341,13 @@ The special value "duid" generates a RFC4361\-compliant client identifier based .sp 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\&. .sp -If unset, a globally configured default is used\&. If still unset, the default depends on the DHCP plugin\&. +The special value "none" prevents any client identifier from being sent\&. Note that this is normally not recommended\&. +.sp +If unset, a globally configured default from NetworkManager\&.conf is used\&. If still unset, the default depends on the DHCP plugin\&. The internal dhcp client will default to "mac" and the dhclient plugin will try to use one from its config file if present, or won\*(Aqt sent any client\-id otherwise\&. .sp Format: string +.sp +Special values: mac, perm\-mac, duid, ipv6\-duid, stable, none .RE .PP \fBipv4\&.dhcp\-fqdn\fR @@ -1888,11 +2368,13 @@ Format: string .RS 4 Flags for the DHCP hostname and FQDN\&. .sp -Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4)\&. When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6\&. +Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are "fqdn\-serv\-update" (0x1), "fqdn\-encoded" (0x2) and "fqdn\-no\-update" (0x4)\&. When no FQDN flag is set and "fqdn\-clear\-flags" (0x8) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and "fqdn\-clear\-flags" (0x8) is not set, the standard FQDN flags are set in the request: "fqdn\-serv\-update" (0x1), "fqdn\-encoded" (0x2) for IPv4 and "fqdn\-serv\-update" (0x1) for IPv6\&. +.sp +When this property is set to the default value "none" (0x0), a global default is looked up in NetworkManager configuration\&. If that value is unset or also "none" (0x0), then the standard FQDN flags described above are sent in the DHCP requests\&. .sp -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\&. +Format: flags (NMDhcpHostnameFlags) .sp -Format: uint32 +Valid values: none (0x0), fqdn\-serv\-update (0x1), fqdn\-encoded (0x2), fqdn\-no\-update (0x4), fqdn\-clear\-flags (0x8) .RE .PP \fBipv4\&.dhcp\-iaid\fR @@ -1916,7 +2398,7 @@ For DHCPv4, each element must be an IPv4 address, optionally followed by a slash .sp This property is currently not implemented for DHCPv6\&. .sp -Format: array of string +Format: list of IPv4 addresses .RE .PP \fBipv4\&.dhcp\-send\-hostname\fR @@ -1924,6 +2406,8 @@ Format: array of string 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBipv4\&.dhcp\-timeout\fR @@ -1932,7 +2416,11 @@ A timeout for a DHCP transaction in seconds\&. If zero (the default), a globally .sp Set to 2147483647 (MAXINT32) for infinity\&. .sp -Format: int32 +Format: integer +.sp +Valid values: 0 \- 2147483647 +.sp +Special values: default (0), infinity (2147483647) .RE .PP \fBipv4\&.dhcp\-vendor\-class\-identifier\fR @@ -1948,7 +2436,7 @@ Array of IP addresses of DNS servers\&. .sp For DoT (DNS over TLS), the SNI server name can be specified by appending "#example\&.com" to the IP address of the DNS server\&. This currently only has effect when using systemd\-resolved\&. .sp -Format: array of uint32 +Format: list of IPv4 addresses .RE .PP \fBipv4\&.dns\-options\fR @@ -1965,7 +2453,7 @@ When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\ .sp The valid "ipv4\&.dns\-options" and "ipv6\&.dns\-options" get merged together\&. .sp -Format: a comma separated list of DNS options +Format: list of strings .RE .PP \fBipv4\&.dns\-priority\fR @@ -1986,7 +2474,9 @@ When using dns=default, servers with higher priority will be on top of resolv\&. .sp When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd\-resolved settings), each connection is used to query domains in its search list\&. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain\&. Queries for domains not present in any search list are routed through connections having the \*(Aq~\&.\*(Aq special wildcard domain, which is added automatically to connections with the default route (or can be added manually)\&. When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins\&. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed\&. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 .RE .PP \fBipv4\&.dns\-search\fR @@ -1997,7 +2487,7 @@ When using a DNS plugin that supports Conditional Forwarding or Split DNS, then .sp 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)\&. .sp -Format: array of string +Format: list of strings .RE .PP \fBipv4\&.gateway\fR @@ -2010,7 +2500,7 @@ Setting the gateway causes NetworkManager to configure a standard default route .sp 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"\&. .sp -Format: string +Format: IPv4 address .RE .PP \fBipv4\&.ignore\-auto\-dns\fR @@ -2018,6 +2508,8 @@ Format: string 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBipv4\&.ignore\-auto\-routes\fR @@ -2025,6 +2517,8 @@ Format: boolean 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBipv4\&.link\-local\fR @@ -2033,7 +2527,9 @@ Enable and disable the IPv4 link\-local configuration independently of the ipv4\ .sp 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"\&. .sp -Format: int32 +Format: choice (NMSettingIP4LinkLocal) +.sp +Valid values: default (0), auto (1), disabled (2), enabled (3) .RE .PP \fBipv4\&.may\-fail\fR @@ -2041,6 +2537,8 @@ Format: int32 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBipv4\&.method\fR @@ -2108,6 +2606,8 @@ Sets the IPv4 connection method\&. You can set one of the following values: .RE .sp Format: string +.sp +Valid values: auto, link\-local, manual, shared, disabled .RE .PP \fBipv4\&.never\-default\fR @@ -2115,13 +2615,17 @@ Format: string 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBipv4\&.replace\-local\-rule\fR .RS 4 Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. .sp -Format: NMTernary (int32) +Format: ternary +.sp +Valid values: true/yes/on, false/no/off, default/unknown .RE .PP \fBipv4\&.required\-timeout\fR @@ -2134,14 +2638,20 @@ Note that if "may\-fail" is FALSE for the same address family, this property has .sp A zero value means that no required timeout is present, \-1 means the default value (either configuration ipvx\&.required\-timeout override or zero)\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-1 \- 2147483647 +.sp +Special values: default (\-1), infinity (2147483647) .RE .PP \fBipv4\&.route\-metric\fR .RS 4 The default metric for routes that don\*(Aqt 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\*(Aqt 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\&. .sp -Format: int64 +Format: integer +.sp +Valid values: \-1 \- 4294967295 .RE .PP \fBipv4\&.route\-table\fR @@ -2154,7 +2664,11 @@ If the table setting is left at zero, it is eligible to be overwritten via globa .sp 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\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 +.sp +Special values: unspec (0), main (254) .RE .PP \fBipv4\&.routes\fR @@ -2426,7 +2940,7 @@ Note that in NetworkManager, currently all nexthops of a ECMP route must share t .sp For details see also `man ip\-route`\&. .sp -Format: a comma separated list of routes +Format: list of ipv4\&.routes objects .RE .PP \fBipv4\&.routing\-rules\fR @@ -2438,7 +2952,7 @@ syntax and mostly compatible\&. One difference is that routing rules in NetworkM Example: priority 5 from 192\&.167\&.4\&.0/24 table 45 .sp -Format: a comma separated list of routing rules +Format: list of ipv4\&.routing\-rules objects .RE .SS "ipv6 setting" .PP @@ -2462,7 +2976,9 @@ If not specified, when creating a new profile the default is "default"\&. .sp 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\&. .sp -Format: one of "eui64" (0), "stable\-privacy" (1), "default" (3) or "default\-or\-eui64" (2) +Format: choice (NMSettingIP6ConfigAddrGenMode) +.sp +Valid values: eui64 (0), stable\-privacy (1), default\-or\-eui64 (2), default (3) .RE .PP \fBipv6\&.addresses\fR @@ -2471,7 +2987,7 @@ Alias: ip6 .sp 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)\&. .sp -Format: a comma separated list of addresses +Format: list of ipv6\&.addresses objects .RE .PP \fBipv6\&.auto\-route\-ext\-gw\fR @@ -2480,7 +2996,9 @@ VPN connections will default to add the route automatically unless this setting .sp For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect\&. .sp -Format: NMTernary (int32) +Format: ternary +.sp +Valid values: true/yes/on, false/no/off, default/unknown .RE .PP \fBipv6\&.dhcp\-duid\fR @@ -2509,11 +3027,13 @@ Format: string .RS 4 Flags for the DHCP hostname and FQDN\&. .sp -Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4)\&. When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6\&. +Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are "fqdn\-serv\-update" (0x1), "fqdn\-encoded" (0x2) and "fqdn\-no\-update" (0x4)\&. When no FQDN flag is set and "fqdn\-clear\-flags" (0x8) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and "fqdn\-clear\-flags" (0x8) is not set, the standard FQDN flags are set in the request: "fqdn\-serv\-update" (0x1), "fqdn\-encoded" (0x2) for IPv4 and "fqdn\-serv\-update" (0x1) for IPv6\&. .sp -When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration\&. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests\&. +When this property is set to the default value "none" (0x0), a global default is looked up in NetworkManager configuration\&. If that value is unset or also "none" (0x0), then the standard FQDN flags described above are sent in the DHCP requests\&. .sp -Format: uint32 +Format: flags (NMDhcpHostnameFlags) +.sp +Valid values: none (0x0), fqdn\-serv\-update (0x1), fqdn\-encoded (0x2), fqdn\-no\-update (0x4), fqdn\-clear\-flags (0x8) .RE .PP \fBipv6\&.dhcp\-iaid\fR @@ -2541,6 +3061,8 @@ Format: string 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBipv6\&.dhcp\-timeout\fR @@ -2549,7 +3071,11 @@ A timeout for a DHCP transaction in seconds\&. If zero (the default), a globally .sp Set to 2147483647 (MAXINT32) for infinity\&. .sp -Format: int32 +Format: integer +.sp +Valid values: 0 \- 2147483647 +.sp +Special values: default (0), infinity (2147483647) .RE .PP \fBipv6\&.dns\fR @@ -2558,7 +3084,7 @@ Array of IP addresses of DNS servers\&. .sp For DoT (DNS over TLS), the SNI server name can be specified by appending "#example\&.com" to the IP address of the DNS server\&. This currently only has effect when using systemd\-resolved\&. .sp -Format: array of byte array +Format: list of IPv6 addresses .RE .PP \fBipv6\&.dns\-options\fR @@ -2575,7 +3101,7 @@ When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\ .sp The valid "ipv4\&.dns\-options" and "ipv6\&.dns\-options" get merged together\&. .sp -Format: a comma separated list of DNS options +Format: list of strings .RE .PP \fBipv6\&.dns\-priority\fR @@ -2596,7 +3122,9 @@ When using dns=default, servers with higher priority will be on top of resolv\&. .sp When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd\-resolved settings), each connection is used to query domains in its search list\&. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain\&. Queries for domains not present in any search list are routed through connections having the \*(Aq~\&.\*(Aq special wildcard domain, which is added automatically to connections with the default route (or can be added manually)\&. When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins\&. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed\&. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 .RE .PP \fBipv6\&.dns\-search\fR @@ -2607,7 +3135,7 @@ When using a DNS plugin that supports Conditional Forwarding or Split DNS, then .sp 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)\&. .sp -Format: array of string +Format: list of strings .RE .PP \fBipv6\&.gateway\fR @@ -2620,7 +3148,7 @@ Setting the gateway causes NetworkManager to configure a standard default route .sp 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"\&. .sp -Format: string +Format: IPv6 address .RE .PP \fBipv6\&.ignore\-auto\-dns\fR @@ -2628,6 +3156,8 @@ Format: string 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBipv6\&.ignore\-auto\-routes\fR @@ -2635,6 +3165,8 @@ Format: boolean 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBipv6\&.ip6\-privacy\fR @@ -2647,7 +3179,9 @@ If also global configuration is unspecified or set to "\-1", fallback to read "/ .sp Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr\-gen\-mode" property\*(Aqs "stable\-privacy" setting as another way of avoiding host tracking with IPv6 addresses\&. .sp -Format: NMSettingIP6ConfigPrivacy (int32) +Format: choice (NMSettingIP6ConfigPrivacy) +.sp +Valid values: unknown (\-1), disabled (0), prefer\-public\-addr (1), prefer\-temp\-addr (2) .RE .PP \fBipv6\&.may\-fail\fR @@ -2655,6 +3189,8 @@ Format: NMSettingIP6ConfigPrivacy (int32) 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBipv6\&.method\fR @@ -2749,13 +3285,17 @@ Sets the IPv6 connection method\&. You can set one of the following values: If you set "auto", "dhcp", "manual", "ignore", or "shared", NetworkManager assigns, in addition to the global address, an IPv6 link\-local address to the interface\&. This is compliant with RFC 4291\&. .sp Format: string +.sp +Valid values: ignore, auto, dhcp, link\-local, manual, shared, disabled .RE .PP \fBipv6\&.mtu\fR .RS 4 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\&. .sp -Format: uint32 +Format: integer +.sp +Special values: auto .RE .PP \fBipv6\&.never\-default\fR @@ -2763,6 +3303,8 @@ Format: uint32 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBipv6\&.ra\-timeout\fR @@ -2771,14 +3313,20 @@ A timeout for waiting Router Advertisements in seconds\&. If zero (the default), .sp Set to 2147483647 (MAXINT32) for infinity\&. .sp -Format: int32 +Format: integer +.sp +Valid values: 0 \- 2147483647 +.sp +Special values: default (0), infinity (2147483647) .RE .PP \fBipv6\&.replace\-local\-rule\fR .RS 4 Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. .sp -Format: NMTernary (int32) +Format: ternary +.sp +Valid values: true/yes/on, false/no/off, default/unknown .RE .PP \fBipv6\&.required\-timeout\fR @@ -2791,14 +3339,20 @@ Note that if "may\-fail" is FALSE for the same address family, this property has .sp A zero value means that no required timeout is present, \-1 means the default value (either configuration ipvx\&.required\-timeout override or zero)\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-1 \- 2147483647 +.sp +Special values: default (\-1), infinity (2147483647) .RE .PP \fBipv6\&.route\-metric\fR .RS 4 The default metric for routes that don\*(Aqt 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\*(Aqt 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\&. .sp -Format: int64 +Format: integer +.sp +Valid values: \-1 \- 4294967295 .RE .PP \fBipv6\&.route\-table\fR @@ -2811,7 +3365,11 @@ If the table setting is left at zero, it is eligible to be overwritten via globa .sp 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\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 +.sp +Special values: unspec (0), main (254) .RE .PP \fBipv6\&.routes\fR @@ -3057,7 +3615,7 @@ unicast\&. .sp For details see also `man ip\-route`\&. .sp -Format: a comma separated list of routes +Format: list of ipv6\&.routes objects .RE .PP \fBipv6\&.routing\-rules\fR @@ -3069,7 +3627,7 @@ syntax and mostly compatible\&. One difference is that routing rules in NetworkM Example: priority 5 from 1:2:3::5/128 table 45 .sp -Format: a comma separated list of routing rules +Format: list of ipv6\&.routing\-rules objects .RE .PP \fBipv6\&.token\fR @@ -3090,28 +3648,36 @@ Properties: .RS 4 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 0x1 (ip6\-ign\-encap\-limit) to ip\-tunnel flags\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 255 .RE .PP \fBip\-tunnel\&.flags\fR .RS 4 Tunnel flags\&. Currently, the following values are supported: 0x1 (ip6\-ign\-encap\-limit), 0x2 (ip6\-use\-orig\-tclass), 0x4 (ip6\-use\-orig\-flowlabel), 0x8 (ip6\-mip6\-dev), 0x10 (ip6\-rcv\-dscp\-copy) and 0x20 (ip6\-use\-orig\-fwmark)\&. They are valid only for IPv6 tunnels\&. .sp -Format: uint32 +Format: flags (NMIPTunnelFlags) +.sp +Valid values: none (0x0), ip6\-ign\-encap\-limit (0x1), ip6\-use\-orig\-tclass (0x2), ip6\-use\-orig\-flowlabel (0x4), ip6\-mip6\-dev (0x8), ip6\-rcv\-dscp\-copy (0x10), ip6\-use\-orig\-fwmark (0x20) .RE .PP \fBip\-tunnel\&.flow\-label\fR .RS 4 The flow label to assign to tunnel packets\&. This property applies only to IPv6 tunnels\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 1048575 .RE .PP \fBip\-tunnel\&.fwmark\fR .RS 4 The fwmark value to assign to tunnel packets\&. This property can be set to a non zero value only on VTI and VTI6 tunnels\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBip\-tunnel\&.input\-key\fR @@ -3136,14 +3702,18 @@ Alias: mode .sp The tunneling mode\&. Valid values: ipip (1), gre (2), sit (3), isatap (4), vti (5), ip6ip6 (6), ipip6 (7), ip6gre (8), vti6 (9), gretap (10) and ip6gretap (11) .sp -Format: uint32 +Format: choice (NMIPTunnelMode) +.sp +Valid values: ipip (1), gre (2), sit (3), isatap (4), vti (5), ip6ip6 (6), ipip6 (7), ip6gre (8), vti6 (9), gretap (10), ip6gretap (11) .RE .PP \fBip\-tunnel\&.mtu\fR .RS 4 If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments\&. .sp -Format: uint32 +Format: integer +.sp +Special values: auto .RE .PP \fBip\-tunnel\&.output\-key\fR @@ -3167,6 +3737,8 @@ Format: string Whether to enable Path MTU Discovery on this tunnel\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBip\-tunnel\&.remote\fR @@ -3182,14 +3754,18 @@ Format: string .RS 4 The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 255 .RE .PP \fBip\-tunnel\&.ttl\fR .RS 4 The TTL to assign to tunneled packets\&. 0 is a special value meaning that packets inherit the TTL value\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 255 .RE .SS "macsec setting" .PP @@ -3204,6 +3780,8 @@ Alias: encrypt Whether the transmitted traffic must be encrypted\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBmacsec\&.mka\-cak\fR @@ -3219,11 +3797,9 @@ Format: string .RS 4 Flags indicating how to handle the "mka\-cak" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fBmacsec\&.mka\-ckn\fR @@ -3241,7 +3817,9 @@ Alias: mode .sp Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained\&. .sp -Format: int32 +Format: choice (NMSettingMacsecMode) +.sp +Valid values: psk (0), eap (1) .RE .PP \fBmacsec\&.parent\fR @@ -3259,7 +3837,9 @@ Alias: port .sp The port component of the SCI (Secure Channel Identifier), between 1 and 65534\&. .sp -Format: int32 +Format: integer +.sp +Valid values: 1 \- 65534 .RE .PP \fBmacsec\&.send\-sci\fR @@ -3267,13 +3847,17 @@ Format: int32 Specifies whether the SCI (Secure Channel Identifier) is included in every packet\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBmacsec\&.validation\fR .RS 4 Specifies the validation mode for incoming frames\&. .sp -Format: int32 +Format: choice (NMSettingMacsecValidation) +.sp +Valid values: disable (0), check (1), strict (2) .RE .SS "macvlan setting" .PP @@ -3287,7 +3871,9 @@ Alias: mode .sp The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device\&. .sp -Format: uint32 +Format: choice (NMSettingMacvlanMode) +.sp +Valid values: vepa (1), bridge (2), private (3), passthru (4), source (5) .RE .PP \fBmacvlan\&.parent\fR @@ -3304,6 +3890,8 @@ Format: string Whether the interface should be put in promiscuous mode\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBmacvlan\&.tap\fR @@ -3313,6 +3901,8 @@ Alias: tap Whether the interface should be a MACVTAP\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .SS "match setting" .PP @@ -3326,7 +3916,7 @@ A list of driver names to match\&. Each element is a shell wildcard pattern\&. .sp See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the pattern\&. .sp -Format: array of string +Format: list of strings .RE .PP \fBmatch\&.interface\-name\fR @@ -3335,7 +3925,7 @@ A list of interface names to match\&. Each element is a shell wildcard pattern\& .sp An element can be prefixed with a pipe symbol (|) or an ampersand (&)\&. The former means that the element is optional and the latter means that it is mandatory\&. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR)\&. If there are any mandatory elements, then they all must match (logical AND)\&. By default, an element is optional\&. This means that an element "foo" behaves the same as "|foo"\&. An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern\&. Note that "!foo" is a shortcut for the mandatory match "&!foo"\&. Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern\&. For example, "&\e\e!a" is an mandatory match for literally "!a"\&. .sp -Format: array of string +Format: list of strings .RE .PP \fBmatch\&.kernel\-command\-line\fR @@ -3344,7 +3934,7 @@ A list of kernel command line arguments to match\&. This may be used to check wh .sp See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the match\&. .sp -Format: array of string +Format: list of strings .RE .PP \fBmatch\&.path\fR @@ -3359,7 +3949,7 @@ Each element of the list is a shell wildcard pattern\&. .sp See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the pattern\&. .sp -Format: array of string +Format: list of strings .RE .SS "802\-11\-olpc\-mesh setting" .PP @@ -3375,7 +3965,9 @@ Alias: channel .sp Channel on which the mesh network to join is located\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fB802\-11\-olpc\-mesh\&.dhcp\-anycast\-address\fR @@ -3386,7 +3978,7 @@ Anycast DHCP MAC address used when requesting an IP address via DHCP\&. The spec .sp This is currently only implemented by dhclient DHCP plugin\&. .sp -Format: byte array +Format: MAC address .RE .PP \fB802\-11\-olpc\-mesh\&.ssid\fR @@ -3395,7 +3987,7 @@ Alias: ssid .sp SSID of the mesh network to join\&. .sp -Format: byte array +Format: string .RE .SS "ovs\-bridge setting" .PP @@ -3408,6 +4000,8 @@ Properties: The data path type\&. One of "system", "netdev" or empty\&. .sp Format: string +.sp +Valid values: system, netdev .RE .PP \fBovs\-bridge\&.fail\-mode\fR @@ -3415,6 +4009,8 @@ Format: string The bridge failure mode\&. One of "secure", "standalone" or empty\&. .sp Format: string +.sp +Valid values: secure, standalone .RE .PP \fBovs\-bridge\&.mcast\-snooping\-enable\fR @@ -3422,6 +4018,8 @@ Format: string Enable or disable multicast snooping\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBovs\-bridge\&.rstp\-enable\fR @@ -3429,6 +4027,8 @@ Format: boolean Enable or disable RSTP\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBovs\-bridge\&.stp\-enable\fR @@ -3436,6 +4036,8 @@ Format: boolean Enable or disable STP\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .SS "ovs\-dpdk setting" .PP @@ -3454,21 +4056,27 @@ Format: string .RS 4 Open vSwitch DPDK number of rx queues\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBovs\-dpdk\&.n\-rxq\-desc\fR .RS 4 The rx queue size (number of rx descriptors) for DPDK ports\&. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4096 .RE .PP \fBovs\-dpdk\&.n\-txq\-desc\fR .RS 4 The tx queue size (number of tx descriptors) for DPDK ports\&. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4096 .RE .SS "ovs\-interface setting" .PP @@ -3480,7 +4088,9 @@ Properties: .RS 4 Open vSwitch openflow port number\&. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs\&. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network\&. OpenFlow switches connect logically to each other via their OpenFlow ports\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 65279 .RE .PP \fBovs\-interface\&.type\fR @@ -3488,6 +4098,8 @@ Format: uint32 The interface type\&. Either "internal", "system", "patch", "dpdk", or empty\&. .sp Format: string +.sp +Valid values: internal, system, patch, dpdk .RE .SS "ovs\-patch setting" .PP @@ -3511,7 +4123,9 @@ Properties: .RS 4 The time port must be inactive in order to be considered down\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBovs\-port\&.bond\-mode\fR @@ -3519,13 +4133,17 @@ Format: uint32 Bonding mode\&. One of "active\-backup", "balance\-slb", or "balance\-tcp"\&. .sp Format: string +.sp +Valid values: active\-backup, balance\-slb, balance\-tcp .RE .PP \fBovs\-port\&.bond\-updelay\fR .RS 4 The time port must be active before it starts forwarding traffic\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBovs\-port\&.lacp\fR @@ -3533,13 +4151,17 @@ Format: uint32 LACP mode\&. One of "active", "off", or "passive"\&. .sp Format: string +.sp +Valid values: active, off, passive .RE .PP \fBovs\-port\&.tag\fR .RS 4 The VLAN tag in the range 0\-4095\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4095 .RE .PP \fBovs\-port\&.trunks\fR @@ -3548,7 +4170,7 @@ A list of VLAN ranges that this port trunks\&. .sp The property is valid only for ports with mode "trunk", "native\-tagged", or "native\-untagged port"\&. If it is empty, the port trunks all VLANs\&. .sp -Format: array of vardict +Format: list of ovs\-port\&.trunks objects .RE .PP \fBovs\-port\&.vlan\-mode\fR @@ -3556,6 +4178,8 @@ Format: array of vardict The VLAN mode\&. One of "access", "native\-tagged", "native\-untagged", "trunk", "dot1q\-tunnel" or unset\&. .sp Format: string +.sp +Valid values: access, native\-tagged, native\-untagged, trunk, dot1q\-tunnel .RE .SS "ppp setting" .PP @@ -3567,7 +4191,9 @@ Properties: .RS 4 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\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBppp\&.crtscts\fR @@ -3575,20 +4201,26 @@ Format: uint32 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBppp\&.lcp\-echo\-failure\fR .RS 4 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\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBppp\&.lcp\-echo\-interval\fR .RS 4 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\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBppp\&.mppe\-stateful\fR @@ -3596,20 +4228,26 @@ Format: uint32 If TRUE, stateful MPPE is used\&. See pppd documentation for more information on stateful MPPE\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBppp\&.mru\fR .RS 4 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\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 16384 .RE .PP \fBppp\&.mtu\fR .RS 4 If non\-zero, instruct pppd to send packets no larger than the specified size\&. .sp -Format: uint32 +Format: integer +.sp +Special values: auto .RE .PP \fBppp\&.no\-vj\-comp\fR @@ -3617,6 +4255,8 @@ Format: uint32 If TRUE, Van Jacobsen TCP header compression will not be requested\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBppp\&.noauth\fR @@ -3624,6 +4264,8 @@ Format: boolean 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBppp\&.nobsdcomp\fR @@ -3631,6 +4273,8 @@ Format: boolean If TRUE, BSD compression will not be requested\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBppp\&.nodeflate\fR @@ -3638,6 +4282,8 @@ Format: boolean If TRUE, "deflate" compression will not be requested\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBppp\&.refuse\-chap\fR @@ -3645,6 +4291,8 @@ Format: boolean If TRUE, the CHAP authentication method will not be used\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBppp\&.refuse\-eap\fR @@ -3652,6 +4300,8 @@ Format: boolean If TRUE, the EAP authentication method will not be used\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBppp\&.refuse\-mschap\fR @@ -3659,6 +4309,8 @@ Format: boolean If TRUE, the MSCHAP authentication method will not be used\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBppp\&.refuse\-mschapv2\fR @@ -3666,6 +4318,8 @@ Format: boolean If TRUE, the MSCHAPv2 authentication method will not be used\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBppp\&.refuse\-pap\fR @@ -3673,6 +4327,8 @@ Format: boolean If TRUE, the PAP authentication method will not be used\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBppp\&.require\-mppe\fR @@ -3680,6 +4336,8 @@ Format: boolean 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBppp\&.require\-mppe\-128\fR @@ -3687,6 +4345,8 @@ Format: boolean 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .SS "pppoe setting" .PP @@ -3716,11 +4376,9 @@ Format: string .RS 4 Flags indicating how to handle the "password" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fBpppoe\&.service\fR @@ -3753,15 +4411,19 @@ Alias: browser\-only Whether the proxy configuration is for browser only\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBproxy\&.method\fR .RS 4 Alias: method .sp -Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0) +Method for proxy configuration, Default is "none" (0) +.sp +Format: choice (NMSettingProxyMethod) .sp -Format: int32 +Valid values: none (0), auto (1) .RE .PP \fBproxy\&.pac\-script\fR @@ -3791,35 +4453,45 @@ Properties: .RS 4 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\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBserial\&.bits\fR .RS 4 Byte\-width of the serial communication\&. The 8 in "8n1" for example\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 5 \- 8 .RE .PP \fBserial\&.parity\fR .RS 4 Parity setting of the serial port\&. .sp -Format: NMSettingSerialParity (byte) +Format: choice (NMSettingSerialParity) +.sp +Valid values: none/N/n (0), even/E/e (1), odd/O/o (2) .RE .PP \fBserial\&.send\-delay\fR .RS 4 Time to delay between each byte sent to the modem, in microseconds\&. .sp -Format: uint64 +Format: integer +.sp +Valid values: 0 \- 18446744073709551615 .RE .PP \fBserial\&.stopbits\fR .RS 4 Number of stop bits for communication on the serial port\&. Either 1 or 2\&. The 1 in "8n1" for example\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 1 \- 2 .RE .SS "sriov setting" .PP @@ -3831,13 +4503,15 @@ Properties: .RS 4 Whether to autoprobe virtual functions by a compatible driver\&. .sp -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 "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\&. +.sp +If set to "false" (0), VFs will not be claimed and no network interfaces will be created for them\&. .sp -If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them\&. +When set to "default" (\-1), the global default is used; in case the global default is unspecified it is assumed to be "true" (1)\&. .sp -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)\&. +Format: ternary .sp -Format: NMTernary (int32) +Valid values: true/yes/on, false/no/off, default/unknown .RE .PP \fBsriov\&.total\-vfs\fR @@ -3846,7 +4520,9 @@ The total number of virtual functions to create\&. .sp Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation\&. To prevent any changes to SR\-IOV parameters don\*(Aqt add a sriov setting to the connection\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBsriov\&.vfs\fR @@ -3871,7 +4547,7 @@ The "vlans" attribute is represented as a semicolon\-separated list of VLAN desc .sp PROTO can be either \*(Aqq\*(Aq for 802\&.1Q (the default) or \*(Aqad\*(Aq for 802\&.1ad\&. .sp -Format: array of vardict +Format: list of sriov\&.vfs objects .RE .SS "tc setting" .PP @@ -4005,7 +4681,7 @@ Limit is the number of bytes that can be queued waiting for tokens to become ava specifies the maximum amount of time a packet can sit in the TBF\&. The latency calculation takes into account the size of the bucket, the rate and possibly the peakrate (if set)\&. The latency and limit are mutually exclusive\&. .RE .sp -Format: GPtrArray(NMTCQdisc) +Format: list of tc\&.qdiscs objects .RE .PP \fBtc\&.tfilters\fR @@ -4063,7 +4739,7 @@ Action for \*(Aqsimple\*(Aq: The actual string to print\&. .RE .sp -Format: GPtrArray(NMTCTfilter) +Format: list of tc\&.tfilters objects .RE .SS "team setting" .PP @@ -4084,35 +4760,51 @@ Format: string .RS 4 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 \*(Aqethtool\*(Aq, \*(Aqnsna_ping\*(Aq and \*(Aqarp_ping\*(Aq and it is specified in the dictionary with the key \*(Aqname\*(Aq\&. Available keys are: ethtool: \*(Aqdelay\-up\*(Aq, \*(Aqdelay\-down\*(Aq, \*(Aqinit\-wait\*(Aq; nsna_ping: \*(Aqinit\-wait\*(Aq, \*(Aqinterval\*(Aq, \*(Aqmissed\-max\*(Aq, \*(Aqtarget\-host\*(Aq; arp_ping: all the ones in nsna_ping and \*(Aqsource\-host\*(Aq, \*(Aqvalidate\-active\*(Aq, \*(Aqvalidate\-inactive\*(Aq, \*(Aqsend\-always\*(Aq\&. See teamd\&.conf man for more details\&. .sp -Format: array of vardict +Format: list of team\&.link\-watchers objects .RE .PP \fBteam\&.mcast\-rejoin\-count\fR .RS 4 Corresponds to the teamd mcast_rejoin\&.count\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 +.sp +Special values: unset (\-1), disabled (0) .RE .PP \fBteam\&.mcast\-rejoin\-interval\fR .RS 4 Corresponds to the teamd mcast_rejoin\&.interval\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 +.sp +Special values: unset (\-1), default (0) .RE .PP \fBteam\&.notify\-peers\-count\fR .RS 4 Corresponds to the teamd notify_peers\&.count\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 +.sp +Special values: unset (\-1), disabled (0) .RE .PP \fBteam\&.notify\-peers\-interval\fR .RS 4 Corresponds to the teamd notify_peers\&.interval\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 +.sp +Special values: unset (\-1), default (0) .RE .PP \fBteam\&.runner\fR @@ -4120,6 +4812,8 @@ Format: int32 Corresponds to the teamd runner\&.name\&. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random"\&. .sp Format: string +.sp +Valid values: broadcast, roundrobin, random, activebackup, loadbalance, lacp .RE .PP \fBteam\&.runner\-active\fR @@ -4127,6 +4821,8 @@ Format: string Corresponds to the teamd runner\&.active\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBteam\&.runner\-agg\-select\-policy\fR @@ -4134,6 +4830,8 @@ Format: boolean Corresponds to the teamd runner\&.agg_select_policy\&. .sp Format: string +.sp +Valid values: lacp_prio, lacp_prio_stable, bandwidth, count, port_config .RE .PP \fBteam\&.runner\-fast\-rate\fR @@ -4141,6 +4839,8 @@ Format: string Corresponds to the teamd runner\&.fast_rate\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBteam\&.runner\-hwaddr\-policy\fR @@ -4148,20 +4848,30 @@ Format: boolean Corresponds to the teamd runner\&.hwaddr_policy\&. .sp Format: string +.sp +Valid values: same_all, by_active, only_active .RE .PP \fBteam\&.runner\-min\-ports\fR .RS 4 Corresponds to the teamd runner\&.min_ports\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 +.sp +Special values: unset (\-1), default (1) .RE .PP \fBteam\&.runner\-sys\-prio\fR .RS 4 Corresponds to the teamd runner\&.sys_prio\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 +.sp +Special values: unset (\-1), default (65535) .RE .PP \fBteam\&.runner\-tx\-balancer\fR @@ -4169,20 +4879,28 @@ Format: int32 Corresponds to the teamd runner\&.tx_balancer\&.name\&. .sp Format: string +.sp +Valid values: basic .RE .PP \fBteam\&.runner\-tx\-balancer\-interval\fR .RS 4 Corresponds to the teamd runner\&.tx_balancer\&.interval\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 +.sp +Special values: unset (\-1), default (50) .RE .PP \fBteam\&.runner\-tx\-hash\fR .RS 4 Corresponds to the teamd runner\&.tx_hash\&. .sp -Format: array of string +Format: list of strings +.sp +Valid values: eth, vlan, ipv4, ipv6, ip, l3, tcp, udp, sctp, l4 .RE .SS "team\-port setting" .PP @@ -4203,35 +4921,51 @@ Format: string .RS 4 Corresponds to the teamd ports\&.PORTIFNAME\&.lacp_key\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 +.sp +Special values: unset (\-1), default (0) .RE .PP \fBteam\-port\&.lacp\-prio\fR .RS 4 Corresponds to the teamd ports\&.PORTIFNAME\&.lacp_prio\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 +.sp +Special values: unset (\-1), default (255) .RE .PP \fBteam\-port\&.link\-watchers\fR .RS 4 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 \*(Aqethtool\*(Aq, \*(Aqnsna_ping\*(Aq and \*(Aqarp_ping\*(Aq and it is specified in the dictionary with the key \*(Aqname\*(Aq\&. Available keys are: ethtool: \*(Aqdelay\-up\*(Aq, \*(Aqdelay\-down\*(Aq, \*(Aqinit\-wait\*(Aq; nsna_ping: \*(Aqinit\-wait\*(Aq, \*(Aqinterval\*(Aq, \*(Aqmissed\-max\*(Aq, \*(Aqtarget\-host\*(Aq; arp_ping: all the ones in nsna_ping and \*(Aqsource\-host\*(Aq, \*(Aqvalidate\-active\*(Aq, \*(Aqvalidate\-inactive\*(Aq, \*(Aqsend\-always\*(Aq\&. See teamd\&.conf man for more details\&. .sp -Format: array of vardict +Format: list of team\-port\&.link\-watchers objects .RE .PP \fBteam\-port\&.prio\fR .RS 4 Corresponds to the teamd ports\&.PORTIFNAME\&.prio\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 +.sp +Special values: unset (0), default (0) .RE .PP \fBteam\-port\&.queue\-id\fR .RS 4 Corresponds to the teamd ports\&.PORTIFNAME\&.queue_id\&. When set to \-1 means the parameter is skipped from the json config\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 +.sp +Special values: unset (\-1), default (0) .RE .PP \fBteam\-port\&.sticky\fR @@ -4239,6 +4973,8 @@ Format: int32 Corresponds to the teamd ports\&.PORTIFNAME\&.sticky\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .SS "tun setting" .PP @@ -4259,9 +4995,11 @@ Format: string .RS 4 Alias: mode .sp -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\&. +The operating mode of the virtual device\&. Allowed values are "tun" (1) to create a layer 3 device and "tap" (2) to create an Ethernet\-like layer 2 one\&. +.sp +Format: choice (NMSettingTunMode) .sp -Format: uint32 +Valid values: tun (1), tap (2) .RE .PP \fBtun\&.multi\-queue\fR @@ -4271,6 +5009,8 @@ Alias: multi\-queue 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBtun\&.owner\fR @@ -4289,6 +5029,8 @@ Alias: pi If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBtun\&.vnet\-hdr\fR @@ -4298,6 +5040,8 @@ Alias: vnet\-hdr If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .SS "vlan setting" .PP @@ -4311,18 +5055,20 @@ Alias: egress .sp 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"\&. .sp -Format: array of string +Format: list of vlan\&.egress\-priority\-map objects .RE .PP \fBvlan\&.flags\fR .RS 4 Alias: flags .sp -One or more flags which control the behavior and features of the VLAN interface\&. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device\*(Aqs operating state)\&. NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol)\&. +One or more flags which control the behavior and features of the VLAN interface\&. Flags include "reorder\-headers" (0x1) (reordering of output packet headers), "gvrp" (0x2) (use of the GVRP protocol), and "loose\-binding" (0x4) (loose binding of the interface to its master device\*(Aqs operating state)\&. "mvrp" (0x8) (use of the MVRP protocol)\&. .sp 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\&. .sp -Format: NMVlanFlags (uint32) +Format: flags (NMVlanFlags) +.sp +Valid values: reorder\-headers (0x1), gvrp (0x2), loose\-binding (0x4), mvrp (0x8) .RE .PP \fBvlan\&.id\fR @@ -4331,7 +5077,9 @@ Alias: id .sp 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\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4095 .RE .PP \fBvlan\&.ingress\-priority\-map\fR @@ -4340,7 +5088,7 @@ Alias: ingress .sp 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"\&. .sp -Format: array of string +Format: list of vlan\&.ingress\-priority\-map objects .RE .PP \fBvlan\&.parent\fR @@ -4359,6 +5107,8 @@ Specifies the VLAN protocol to use for encapsulation\&. Supported values are: \*(Aq802\&.1Q\*(Aq, \*(Aq802\&.1ad\*(Aq\&. If not specified the default value is \*(Aq802\&.1Q\*(Aq\&. .sp Format: string +.sp +Valid values: 802\&.1Q, 802\&.1ad .RE .SS "vpn setting" .PP @@ -4370,7 +5120,7 @@ Properties: .RS 4 Dictionary of key/value pairs of VPN plugin specific data\&. Both keys and values must be strings\&. .sp -Format: dict of string to string +Format: list of key/value options .RE .PP \fBvpn\&.persistent\fR @@ -4378,13 +5128,15 @@ Format: dict of string to string 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBvpn\&.secrets\fR .RS 4 Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys\&. Both keys and values must be strings\&. .sp -Format: dict of string to string +Format: list of key/value options .RE .PP \fBvpn\&.service\-type\fR @@ -4400,7 +5152,9 @@ Format: string .RS 4 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\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBvpn\&.user\-name\fR @@ -4423,7 +5177,9 @@ Alias: table .sp The routing table for this VRF\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .SS "vxlan setting" .PP @@ -4435,7 +5191,9 @@ Properties: .RS 4 Specifies the lifetime in seconds of FDB entries learnt by the kernel\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBvxlan\&.destination\-port\fR @@ -4444,7 +5202,9 @@ Alias: destination\-port .sp Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 65535 .RE .PP \fBvxlan\&.id\fR @@ -4453,7 +5213,9 @@ Alias: id .sp Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 16777215 .RE .PP \fBvxlan\&.l2\-miss\fR @@ -4461,6 +5223,8 @@ Format: uint32 Specifies whether netlink LL ADDR miss notifications are generated\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBvxlan\&.l3\-miss\fR @@ -4468,6 +5232,8 @@ Format: boolean Specifies whether netlink IP ADDR miss notifications are generated\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBvxlan\&.learning\fR @@ -4475,13 +5241,17 @@ Format: boolean Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBvxlan\&.limit\fR .RS 4 Specifies the maximum number of FDB entries\&. A value of zero means that the kernel will store unlimited entries\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBvxlan\&.local\fR @@ -4507,6 +5277,8 @@ Format: string Specifies whether ARP proxy is turned on\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBvxlan\&.remote\fR @@ -4523,6 +5295,8 @@ Format: string Specifies whether route short circuit is turned on\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBvxlan\&.source\-port\-max\fR @@ -4531,7 +5305,9 @@ Alias: source\-port\-max .sp Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 65535 .RE .PP \fBvxlan\&.source\-port\-min\fR @@ -4540,21 +5316,27 @@ Alias: source\-port\-min .sp Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 65535 .RE .PP \fBvxlan\&.tos\fR .RS 4 Specifies the TOS value to use in outgoing packets\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 255 .RE .PP \fBvxlan\&.ttl\fR .RS 4 Specifies the time\-to\-live value to use in outgoing packets\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 255 .RE .SS "wifi\-p2p setting" .PP @@ -4568,7 +5350,7 @@ Alias: peer .sp The P2P device that should be connected to\&. Currently, this is the only way to create or join a group\&. .sp -Format: string +Format: MAC address .RE .PP \fBwifi\-p2p\&.wfd\-ies\fR @@ -4577,7 +5359,7 @@ The Wi\-Fi Display (WFD) Information Elements (IEs) to set\&. .sp 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\&. .sp -Format: byte array +Format: bytes .RE .PP \fBwifi\-p2p\&.wps\-method\fR @@ -4586,7 +5368,9 @@ Flags indicating which mode of WPS is to be used\&. .sp There\*(Aqs little point in changing the default setting as NetworkManager will automatically determine the best method to use\&. .sp -Format: uint32 +Format: flags (NMSettingWirelessSecurityWpsMethod) +.sp +Valid values: default (0x0), disabled (0x1), auto (0x2), pbc (0x4), pin (0x8) .RE .SS "wimax setting" .PP @@ -4602,7 +5386,7 @@ If specified, this connection will only apply to the WiMAX device whose MAC addr .sp This property is deprecated since version 1\&.2\&. WiMAX is no longer supported\&. .sp -Format: byte array +Format: string .RE .PP \fBwimax\&.network\-name\fR @@ -4613,7 +5397,7 @@ Network Service Provider (NSP) name of the WiMAX network this connection should .sp This property is deprecated since version 1\&.2\&. WiMAX is no longer supported\&. .sp -Format: string +Format: MAC address .RE .SS "802\-3\-ethernet setting" .PP @@ -4627,7 +5411,9 @@ Properties: .RS 4 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\&. .sp -Format: NMTernary (int32) +Format: ternary +.sp +Valid values: true/yes/on, false/no/off, default/unknown .RE .PP \fB802\-3\-ethernet\&.auto\-negotiate\fR @@ -4635,6 +5421,8 @@ Format: NMTernary (int32) 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fB802\-3\-ethernet\&.cloned\-mac\-address\fR @@ -4649,7 +5437,9 @@ If unspecified, the value can be overwritten via global defaults, see manual of .sp On D\-Bus, this field is expressed as "assigned\-mac\-address" or the deprecated "cloned\-mac\-address"\&. .sp -Format: byte array +Format: MAC address +.sp +Special values: preserve, permanent, random, stable .RE .PP \fB802\-3\-ethernet\&.duplex\fR @@ -4657,6 +5447,8 @@ Format: byte array 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\&. .sp Format: string +.sp +Valid values: half, full .RE .PP \fB802\-3\-ethernet\&.generate\-mac\-address\-mask\fR @@ -4680,14 +5472,14 @@ Alias: mac .sp 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)\&. .sp -Format: byte array +Format: MAC address .RE .PP \fB802\-3\-ethernet\&.mac\-address\-blacklist\fR .RS 4 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)\&. .sp -Format: array of string +Format: list of MAC addresses .RE .PP \fB802\-3\-ethernet\&.mtu\fR @@ -4696,14 +5488,16 @@ Alias: mtu .sp If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. .sp -Format: uint32 +Format: integer +.sp +Special values: auto .RE .PP \fB802\-3\-ethernet\&.port\fR .RS 4 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\&. .sp -Format: string +Format: read only .RE .PP \fB802\-3\-ethernet\&.s390\-nettype\fR @@ -4711,6 +5505,8 @@ Format: string s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems\&. .sp Format: string +.sp +Valid values: qeth, lcs, ctc .RE .PP \fB802\-3\-ethernet\&.s390\-options\fR @@ -4719,35 +5515,39 @@ Dictionary of key/value pairs of s390\-specific device options\&. Both keys and .sp Currently, NetworkManager itself does nothing with this information\&. However, s390utils ships a udev rule which parses this information and applies it to the interface\&. .sp -Format: dict of string to string +Format: list of key/value options .RE .PP \fB802\-3\-ethernet\&.s390\-subchannels\fR .RS 4 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\&. .sp -Format: array of string +Format: list of 802\-3\-ethernet\&.s390\-subchannels objects .RE .PP \fB802\-3\-ethernet\&.speed\fR .RS 4 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\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fB802\-3\-ethernet\&.wake\-on\-lan\fR .RS 4 -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)\&. +The NMSettingWiredWakeOnLan options to enable\&. Not all devices support all options\&. May be any combination of "phy" (0x2), "unicast" (0x4), "multicast" (0x8), "broadcast" (0x10), "arp" (0x20), "magic" (0x40) or the special values "default" (0x1) (to use global settings) and "ignore" (0x8000) (to disable management of Wake\-on\-LAN in NetworkManager)\&. +.sp +Format: flags (NMSettingWiredWakeOnLan) .sp -Format: uint32 +Valid values: phy (0x2), unicast (0x4), multicast (0x8), broadcast (0x10), arp (0x20), magic (0x40), default (0x1), ignore (0x8000) .RE .PP \fB802\-3\-ethernet\&.wake\-on\-lan\-password\fR .RS 4 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\&. .sp -Format: string +Format: MAC address .RE .SS "wireguard setting" .PP @@ -4761,7 +5561,9 @@ The use of fwmark is optional and is by default off\&. Setting it to 0 disables .sp Note that "ip4\-auto\-default\-route" or "ip6\-auto\-default\-route" enabled, implies to automatically choose a fwmark\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fBwireguard\&.ip4\-auto\-default\-route\fR @@ -4772,21 +5574,27 @@ Note that for this automatism to work, you usually don\*(Aqt want to set ipv4\&. .sp 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\&. .sp -Format: NMTernary (int32) +Format: ternary +.sp +Valid values: true/yes/on, false/no/off, default/unknown .RE .PP \fBwireguard\&.ip6\-auto\-default\-route\fR .RS 4 Like ip4\-auto\-default\-route, but for the IPv6 default route\&. .sp -Format: NMTernary (int32) +Format: ternary +.sp +Valid values: true/yes/on, false/no/off, default/unknown .RE .PP \fBwireguard\&.listen\-port\fR .RS 4 The listen\-port\&. If listen\-port is not specified, the port will be chosen randomly when the interface comes up\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 65535 .RE .PP \fBwireguard\&.mtu\fR @@ -4795,7 +5603,9 @@ If non\-zero, only transmit packets of the specified size or smaller, breaking l .sp If zero a default MTU is used\&. Note that contrary to wg\-quick\*(Aqs MTU setting, this does not take into account the current routes at the time of activation\&. .sp -Format: uint32 +Format: integer +.sp +Special values: auto .RE .PP \fBwireguard\&.peer\-routes\fR @@ -4805,6 +5615,8 @@ Whether to automatically add routes for the AllowedIPs ranges of the peers\&. If Note that if the peer\*(Aqs AllowedIPs is "0\&.0\&.0\&.0/0" or "::/0" and the profile\*(Aqs ipv4\&.never\-default or ipv6\&.never\-default setting is enabled, the peer route for this peer won\*(Aqt be added automatically\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fBwireguard\&.private\-key\fR @@ -4818,11 +5630,9 @@ Format: string .RS 4 Flags indicating how to handle the "private\-key" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .SS "802\-11\-wireless setting" .PP @@ -4834,15 +5644,17 @@ Properties: .PP \fB802\-11\-wireless\&.ap\-isolation\fR .RS 4 -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\&. +Configures AP isolation, which prevents communication between wireless devices connected to this AP\&. This property can be set to a value different from "default" (\-1) only when the interface is configured in AP mode\&. .sp -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 "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\&. .sp -If set to NM_TERNARY_FALSE (0), devices can talk to each other\&. +If set to "false" (0), devices can talk to each other\&. .sp -When set to NM_TERNARY_DEFAULT (\-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_FALSE (0)\&. +When set to "default" (\-1), the global default is used; in case the global default is unspecified it is assumed to be "false" (0)\&. .sp -Format: NMTernary (int32) +Format: ternary +.sp +Valid values: true/yes/on, false/no/off, default/unknown .RE .PP \fB802\-11\-wireless\&.band\fR @@ -4850,6 +5662,8 @@ Format: NMTernary (int32) 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\*(Aqs settings are compatible\&. This setting depends on specific driver capability and may not work with all drivers\&. .sp Format: string +.sp +Valid values: a, bg .RE .PP \fB802\-11\-wireless\&.bssid\fR @@ -4858,14 +5672,16 @@ If specified, directs the device to only associate with the given access point\& .sp 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\&. .sp -Format: byte array +Format: MAC address .RE .PP \fB802\-11\-wireless\&.channel\fR .RS 4 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\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 4294967295 .RE .PP \fB802\-11\-wireless\&.cloned\-mac\-address\fR @@ -4874,13 +5690,15 @@ Alias: cloned\-mac .sp If specified, request that the device use this MAC address instead\&. This is known as MAC cloning or spoofing\&. .sp -Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported\&. "preserve" means not to touch the MAC address on activation\&. "permanent" means to use the permanent hardware address of the device\&. "random" creates a random MAC address on each connect\&. "stable" creates a hashed MAC address based on connection\&.stable\-id and a machine dependent key\&. +Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random", "stable" and "stable\-ssid" are supported\&. "preserve" means not to touch the MAC address on activation\&. "permanent" means to use the permanent hardware address of the device\&. "random" creates a random MAC address on each connect\&. "stable" creates a hashed MAC address based on connection\&.stable\-id and a machine dependent key\&. "stable\-ssid" creates a hashed MAC address based on the SSID, the same as setting the stable\-id to "${NETWORK_SSID}"\&. .sp If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager\&.conf\&. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value)\&. .sp On D\-Bus, this field is expressed as "assigned\-mac\-address" or the deprecated "cloned\-mac\-address"\&. .sp -Format: byte array +Format: MAC address +.sp +Special values: preserve, permanent, random, stable, stable\-ssid .RE .PP \fB802\-11\-wireless\&.generate\-mac\-address\-mask\fR @@ -4909,6 +5727,8 @@ 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\&. .sp Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .PP \fB802\-11\-wireless\&.mac\-address\fR @@ -4917,23 +5737,25 @@ Alias: mac .sp 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)\&. .sp -Format: byte array +Format: MAC address .RE .PP \fB802\-11\-wireless\&.mac\-address\-blacklist\fR .RS 4 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")\&. .sp -Format: array of string +Format: list of MAC addresses .RE .PP \fB802\-11\-wireless\&.mac\-address\-randomization\fR .RS 4 -One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address)\&. +One of "default" (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), "never" (1) (never randomize the MAC address), or "always" (2) (always randomize the MAC address)\&. .sp This property is deprecated since version 1\&.4\&. Use the "cloned\-mac\-address" property instead\&. .sp -Format: uint32 +Format: choice (NMSettingMacRandomization) +.sp +Valid values: default (0), never (1), always (2) .RE .PP \fB802\-11\-wireless\&.mode\fR @@ -4943,6 +5765,8 @@ Alias: mode Wi\-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap"\&. If blank, infrastructure is assumed\&. .sp Format: string +.sp +Valid values: infrastructure, adhoc, ap, mesh .RE .PP \fB802\-11\-wireless\&.mtu\fR @@ -4951,14 +5775,18 @@ Alias: mtu .sp If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. .sp -Format: uint32 +Format: integer +.sp +Special values: auto .RE .PP \fB802\-11\-wireless\&.powersave\fR .RS 4 -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\*(Aqt touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value)\&. All other values are reserved\&. +One of "disable" (2) (disable Wi\-Fi power saving), "enable" (3) (enable Wi\-Fi power saving), "ignore" (1) (don\*(Aqt touch currently configure setting) or "default" (0) (use the globally configured value)\&. All other values are reserved\&. +.sp +Format: choice (NMSettingWirelessPowersave) .sp -Format: uint32 +Valid values: default (0), ignore (1), disable (2), enable (3) .RE .PP \fB802\-11\-wireless\&.seen\-bssids\fR @@ -4967,7 +5795,7 @@ A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55" .sp 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\&. .sp -Format: array of string +Format: read only .RE .PP \fB802\-11\-wireless\&.ssid\fR @@ -4976,14 +5804,16 @@ Alias: ssid .sp SSID of the Wi\-Fi network\&. Must be specified\&. .sp -Format: byte array +Format: string .RE .PP \fB802\-11\-wireless\&.wake\-on\-wlan\fR .RS 4 -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)\&. +The NMSettingWirelessWakeOnWLan options to enable\&. Not all devices support all options\&. May be any combination of "any" (0x2), "disconnect" (0x4), "magic" (0x8), "gtk\-rekey\-failure" (0x10), "eap\-identity\-request" (0x20), "4way\-handshake" (0x40), "rfkill\-release" (0x80), "tcp" (0x100) or the special values "default" (0x1) (to use global settings) and "ignore" (0x8000) (to disable management of Wake\-on\-LAN in NetworkManager)\&. +.sp +Format: flags (NMSettingWirelessWakeOnWLan) .sp -Format: uint32 +Valid values: any (0x2), disconnect (0x4), magic (0x8), gtk\-rekey\-failure (0x10), eap\-identity\-request (0x20), 4way\-handshake (0x40), rfkill\-release (0x80), tcp (0x100), all (0x1fe), default (0x1), ignore (0x8000) .RE .SS "802\-11\-wireless\-security setting" .PP @@ -4998,20 +5828,26 @@ Properties: 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\&. .sp Format: string +.sp +Valid values: open, shared, leap .RE .PP \fB802\-11\-wireless\-security\&.fils\fR .RS 4 -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\&. +Indicates whether Fast Initial Link Setup (802\&.11ai) must be enabled for the connection\&. One of "default" (0) (use global default value), "disable" (1) (disable FILS), "optional" (2) (enable FILS if the supplicant and the access point support it) or "required" (3) (enable FILS and fail if not supported)\&. When set to "default" (0) and no global default is set, FILS will be optionally enabled\&. +.sp +Format: choice (NMSettingWirelessSecurityFils) .sp -Format: int32 +Valid values: default (0), disable (1), optional (2), required (3) .RE .PP \fB802\-11\-wireless\-security\&.group\fR .RS 4 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"\&. .sp -Format: array of string +Format: list of strings +.sp +Valid values: wep40, wep104, tkip, ccmp .RE .PP \fB802\-11\-wireless\-security\&.key\-mgmt\fR @@ -5021,6 +5857,8 @@ Key management used for the connection\&. One of "none" (WEP or no password prot This property must be set for any Wi\-Fi connection that uses security\&. .sp Format: string +.sp +Valid values: none, ieee8021x, wpa\-psk, wpa\-eap, wpa\-eap\-suite\-b\-192, sae, owe .RE .PP \fB802\-11\-wireless\-security\&.leap\-password\fR @@ -5034,11 +5872,9 @@ Format: string .RS 4 Flags indicating how to handle the "leap\-password" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fB802\-11\-wireless\-security\&.leap\-username\fR @@ -5052,21 +5888,27 @@ Format: string .RS 4 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"\&. .sp -Format: array of string +Format: list of strings +.sp +Valid values: tkip, ccmp .RE .PP \fB802\-11\-wireless\-security\&.pmf\fR .RS 4 -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\&. +Indicates whether Protected Management Frames (802\&.11w) must be enabled for the connection\&. One of "default" (0) (use global default value), "disable" (1) (disable PMF), "optional" (2) (enable PMF if the supplicant and the access point support it) or "required" (3) (enable PMF and fail if not supported)\&. When set to "default" (0) and no global default is set, PMF will be optionally enabled\&. .sp -Format: int32 +Format: choice (NMSettingWirelessSecurityPmf) +.sp +Valid values: default (0), disable (1), optional (2), required (3) .RE .PP \fB802\-11\-wireless\-security\&.proto\fR .RS 4 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\&. .sp -Format: array of string +Format: list of strings +.sp +Valid values: wpa, rsn .RE .PP \fB802\-11\-wireless\-security\&.psk\fR @@ -5080,29 +5922,27 @@ Format: string .RS 4 Flags indicating how to handle the "psk" property\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fB802\-11\-wireless\-security\&.wep\-key\-flags\fR .RS 4 Flags indicating how to handle the "wep\-key0", "wep\-key1", "wep\-key2", and "wep\-key3" properties\&. .sp -See -the section called \(lqSecret flag types:\(rq -for flag values\&. +Format: flags (NMSettingSecretFlags) .sp -Format: NMSettingSecretFlags (uint32) +Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) .RE .PP \fB802\-11\-wireless\-security\&.wep\-key\-type\fR .RS 4 -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\&. +Controls the interpretation of WEP keys\&. Allowed values are "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 "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\&. .sp -Format: NMWepKeyType (uint32) +Format: choice (NMWepKeyType) +.sp +Valid values: unknown (0), key (1), passphrase (2) .RE .PP \fB802\-11\-wireless\-security\&.wep\-key0\fR @@ -5137,7 +5977,9 @@ Format: string .RS 4 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\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 3 .RE .PP \fB802\-11\-wireless\-security\&.wps\-method\fR @@ -5148,7 +5990,9 @@ There\*(Aqs little point in changing the default setting as NetworkManager will .sp WPS can be disabled by setting this property to a value of 1\&. .sp -Format: uint32 +Format: flags (NMSettingWirelessSecurityWpsMethod) +.sp +Valid values: default (0x0), disabled (0x1), auto (0x2), pbc (0x4), pin (0x8) .RE .SS "wpan setting" .PP @@ -5162,7 +6006,11 @@ Alias: channel .sp IEEE 802\&.15\&.4 channel\&. A positive integer or \-1, meaning "do not set, use whatever the device is already set to"\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-32768 \- 32767 +.sp +Special values: default (\-1) .RE .PP \fBwpan\&.mac\-address\fR @@ -5171,7 +6019,7 @@ Alias: mac .sp If specified, this connection will only apply to the IEEE 802\&.15\&.4 (WPAN) MAC layer device whose permanent MAC address matches\&. .sp -Format: string +Format: WPAN MAC address .RE .PP \fBwpan\&.page\fR @@ -5180,7 +6028,11 @@ Alias: page .sp IEEE 802\&.15\&.4 channel page\&. A positive integer or \-1, meaning "do not set, use whatever the device is already set to"\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-32768 \- 32767 +.sp +Special values: default (\-1) .RE .PP \fBwpan\&.pan\-id\fR @@ -5189,7 +6041,11 @@ Alias: pan\-id .sp IEEE 802\&.15\&.4 Personal Area Network (PAN) identifier\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 65535 +.sp +Special values: unset (0xffff) .RE .PP \fBwpan\&.short\-address\fR @@ -5198,7 +6054,11 @@ Alias: short\-addr .sp Short IEEE 802\&.15\&.4 address to be used within a restricted environment\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 65535 +.sp +Special values: unset (0xffff) .RE .SS "bond\-port setting" .PP @@ -5212,7 +6072,9 @@ Alias: prio .sp 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\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 .RE .PP \fBbond\-port\&.queue\-id\fR @@ -5221,7 +6083,9 @@ Alias: queue\-id .sp The queue ID of this bond port\&. The maximum value of queue ID is the number of TX queues currently active in device\&. .sp -Format: uint32 +Format: integer +.sp +Valid values: 0 \- 65535 .RE .SS "hostname setting" .PP @@ -5233,29 +6097,35 @@ Properties: .RS 4 Whether the system hostname can be determined from DHCP on this connection\&. .sp -When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1)\&. +When set to "default" (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be "true" (1)\&. +.sp +Format: ternary .sp -Format: NMTernary (int32) +Valid values: true/yes/on, false/no/off, default/unknown .RE .PP \fBhostname\&.from\-dns\-lookup\fR .RS 4 Whether the system hostname can be determined from reverse DNS lookup of addresses on this device\&. .sp -When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1)\&. +When set to "default" (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be "true" (1)\&. .sp -Format: NMTernary (int32) +Format: ternary +.sp +Valid values: true/yes/on, false/no/off, default/unknown .RE .PP \fBhostname\&.only\-from\-default\fR .RS 4 -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 "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)\&. +.sp +If set to "false" (0), the hostname can be set from this device even if it doesn\*(Aqt have the default route\&. .sp -If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn\*(Aqt have the default route\&. +When set to "default" (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be "false" (0)\&. .sp -When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0)\&. +Format: ternary .sp -Format: NMTernary (int32) +Valid values: true/yes/on, false/no/off, default/unknown .RE .PP \fBhostname\&.priority\fR @@ -5266,7 +6136,52 @@ If the value is zero, it can be overridden by a global value from NetworkManager .sp 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\&. .sp -Format: int32 +Format: integer +.sp +Valid values: \-2147483648 \- 2147483647 +.RE +.SS "hsr setting" +.PP +HSR/PRP Settings\&. +.PP +Properties: +.PP +\fBhsr\&.multicast\-spec\fR +.RS 4 +Alias: multicast\-spec +.sp +The last byte of supervision address\&. +.sp +Format: integer +.sp +Valid values: 0 \- 255 +.RE +.PP +\fBhsr\&.port1\fR +.RS 4 +Alias: port1 +.sp +The port1 interface name of the HSR\&. This property is mandatory\&. +.sp +Format: string +.RE +.PP +\fBhsr\&.port2\fR +.RS 4 +Alias: port2 +.sp +The port2 interface name of the HSR\&. This property is mandatory\&. +.sp +Format: string +.RE +.PP +\fBhsr\&.prp\fR +.RS 4 +The protocol used by the interface, whether it is PRP or HSR\&. +.sp +Format: boolean +.sp +Valid values: true/yes/on, false/no/off .RE .SS "link setting" .PP @@ -5278,28 +6193,44 @@ Properties: .RS 4 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\&. .sp -Format: int64 +Format: integer +.sp +Valid values: \-1 \- 4294967295 +.sp +Special values: default (\-1) .RE .PP \fBlink\&.gso\-max\-segments\fR .RS 4 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\&. .sp -Format: int64 +Format: integer +.sp +Valid values: \-1 \- 4294967295 +.sp +Special values: default (\-1) .RE .PP \fBlink\&.gso\-max\-size\fR .RS 4 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\&. .sp -Format: int64 +Format: integer +.sp +Valid values: \-1 \- 4294967295 +.sp +Special values: default (\-1) .RE .PP \fBlink\&.tx\-queue\-length\fR .RS 4 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\&. .sp -Format: int64 +Format: integer +.sp +Valid values: \-1 \- 4294967295 +.sp +Special values: default (\-1) .RE .SS "loopback setting" .PP @@ -5313,7 +6244,9 @@ Alias: mtu .sp If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. .sp -Format: uint32 +Format: integer +.sp +Special values: auto .RE .SS "veth setting" .PP diff --git a/man/nm-settings-nmcli.xml b/man/nm-settings-nmcli.xml index b0a03a3b..a5475e71 100644 --- a/man/nm-settings-nmcli.xml +++ b/man/nm-settings-nmcli.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-nmcli"><refentryinfo><title>nm-settings-nmcli</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.44.2</refmiscinfo></refmeta><refnamediv><refname>nm-settings-nmcli</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles for nmcli</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> +<refentry id="nm-settings-nmcli"><refentryinfo><title>nm-settings-nmcli</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.45.90</refmiscinfo></refmeta><refnamediv><refname>nm-settings-nmcli</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles for nmcli</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on a concept of connection profiles, sometimes referred to as connections only. These connection profiles contain a network configuration. When NetworkManager activates a connection profile on a network device the configuration will @@ -34,38 +34,61 @@ </para><refsect2><title>connection setting</title><para>General Connection Profile Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.connection.auth-retries">connection.auth-retries</option></term><listitem><para>The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection.</para><para>Currently, this only applies to 802-1x authentication.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect">connection.autoconnect</option></term><listitem><para> + Format: integer</para><para> + Valid values: -1 - 2147483647</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect">connection.autoconnect</option></term><listitem><para> Alias: autoconnect</para><para>Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection.</para><para>Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile.</para><para>Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.</para><para>If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined.</para><para>Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-priority">connection.autoconnect-priority</option></term><listitem><para>The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-retries">connection.autoconnect-retries</option></term><listitem><para>The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-slaves">connection.autoconnect-slaves</option></term><listitem><para>Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.</para><para> - Format: NMSettingConnectionAutoconnectSlaves (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.dns-over-tls">connection.dns-over-tls</option></term><listitem><para>Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic.</para><para>The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting.</para><para>This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.gateway-ping-timeout">connection.gateway-ping-timeout</option></term><listitem><para>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.id">connection.id</option></term><listitem><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-priority">connection.autoconnect-priority</option></term><listitem><para>The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.</para><para> + Format: integer</para><para> + Valid values: -999 - 999</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-retries">connection.autoconnect-retries</option></term><listitem><para>The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.</para><para> + Format: integer</para><para> + Valid values: -1 - 2147483647</para><para> + Special values: default (-1), forever (0)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-slaves">connection.autoconnect-slaves</option></term><listitem><para>Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.</para><para> + Format: choice (NMSettingConnectionAutoconnectSlaves)</para><para> + Valid values: default (-1), no (0), yes (1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.controller">connection.controller</option></term><listitem><para> + Alias: controller</para><para>Interface name of the controller device or UUID of the controller connection.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.dns-over-tls">connection.dns-over-tls</option></term><listitem><para>Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic.</para><para>The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting.</para><para>This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para><para> + Format: choice (NMSettingConnectionDnsOverTls)</para><para> + Valid values: default (-1), no (0), opportunistic (1), yes (2)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.gateway-ping-timeout">connection.gateway-ping-timeout</option></term><listitem><para>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</para><para> + Format: integer</para><para> + Valid values: 0 - 600</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.id">connection.id</option></term><listitem><para> Alias: con-name</para><para>A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.interface-name">connection.interface-name</option></term><listitem><para> Alias: ifname</para><para>The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings).</para><para>For software devices this specifies the name of the created device.</para><para>For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.lldp">connection.lldp</option></term><listitem><para>Whether LLDP is enabled for the connection.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.llmnr">connection.llmnr</option></term><listitem><para>Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link.</para><para>The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes").</para><para>This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.master">connection.master</option></term><listitem><para> - Alias: master</para><para>Interface name of the master device or UUID of the master connection.</para><para> + Format: choice (NMSettingConnectionLldp)</para><para> + Valid values: default (-1), disable (0), enable-rx/enable (1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.llmnr">connection.llmnr</option></term><listitem><para>Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link.</para><para>The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes").</para><para>This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para><para> + Format: choice (NMSettingConnectionLlmnr)</para><para> + Valid values: default (-1), no (0), resolve (1), yes (2)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.master">connection.master</option></term><listitem><para> + Alias: master</para><para>Interface name of the master device or UUID of the master connection.</para><para>Deprecated 1.46. Use "controller" instead, this is just an alias.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.mdns">connection.mdns</option></term><listitem><para>Whether mDNS is enabled for the connection.</para><para>The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no").</para><para>This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.metered">connection.metered</option></term><listitem><para>Whether the connection is metered.</para><para>When updating this property on a currently activated connection, the change takes effect immediately.</para><para> - Format: NMMetered (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.mptcp-flags">connection.mptcp-flags</option></term><listitem><para>Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints.</para><para>If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.</para><para>The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags.</para><para>Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless.</para><para>Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that.</para><para>When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.</para><para>If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl.</para><para>NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.</para><para>Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.mud-url">connection.mud-url</option></term><listitem><para>If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://".</para><para>The special value "none" is allowed to indicate that no MUD URL is used.</para><para>If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".</para><para> + Format: choice (NMSettingConnectionMdns)</para><para> + Valid values: default (-1), no (0), resolve (1), yes (2)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.metered">connection.metered</option></term><listitem><para>Whether the connection is metered.</para><para>When updating this property on a currently activated connection, the change takes effect immediately.</para><para> + Format: ternary</para><para> + Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.mptcp-flags">connection.mptcp-flags</option></term><listitem><para>Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints.</para><para>If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.</para><para>The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags.</para><para>Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless.</para><para>Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that.</para><para>When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.</para><para>If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl.</para><para>NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.</para><para>Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).</para><para> + Format: flags (NMMptcpFlags)</para><para> + Valid values: none/default (0x0), disabled (0x1), enabled (0x2), also-without-sysctl (0x4), also-without-default-route (0x8), signal (0x10), subflow (0x20), backup (0x40), fullmesh (0x80)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.mud-url">connection.mud-url</option></term><listitem><para>If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://".</para><para>The special value "none" is allowed to indicate that no MUD URL is used.</para><para>If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.multi-connect">connection.multi-connect</option></term><listitem><para>Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.permissions">connection.permissions</option></term><listitem><para>An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah".</para><para>At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.secondaries">connection.secondaries</option></term><listitem><para>List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.slave-type">connection.slave-type</option></term><listitem><para> - Alias: slave-type</para><para>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.stable-id">connection.stable-id</option></term><listitem><para>This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context.</para><para>The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used 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.</para><para>Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity.</para><para>The '$' character is treated special to perform dynamic substitutions at 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.</para><para>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.</para><para> + Format: choice (NMConnectionMultiConnect)</para><para> + Valid values: default (0), single (1), manual-multiple (2), multiple (3)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.permissions">connection.permissions</option></term><listitem><para>An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah".</para><para>At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</para><para> + Format: list of strings</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.port-type">connection.port-type</option></term><listitem><para> + Alias: port-type</para><para>Setting name of the device type of this port's controller connection (eg, "bond"), or NULL if this connection is not a port.</para><para> + Format: string</para><para> + Valid values: bond, bridge, ovs-bridge, ovs-port, team, vrf</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.secondaries">connection.secondaries</option></term><listitem><para>List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</para><para> + Format: list of strings</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.slave-type">connection.slave-type</option></term><listitem><para> + Alias: slave-type</para><para>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</para><para>Deprecated 1.46. Use "port-type" instead, this is just an alias.</para><para> + Format: string</para><para> + Valid values: bond, bridge, ovs-bridge, ovs-port, team, vrf</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.stable-id">connection.stable-id</option></term><listitem><para>This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context.</para><para>The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used 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.</para><para>Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity.</para><para>The '$' character is treated special to perform dynamic substitutions at activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${NETWORK_SSID}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-SSID, 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. "${NETWORK_SSID}" uses the SSID for Wi-Fi networks and falls back to "${CONNECTION}" on other networks. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates.</para><para>If the value is unset, a global connection default is consulted. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.timestamp">connection.timestamp</option></term><listitem><para>The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated.</para><para>NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.type">connection.type</option></term><listitem><para> + Format: read only</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.type">connection.type</option></term><listitem><para> Alias: type</para><para>Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.uuid">connection.uuid</option></term><listitem><para>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`.</para><para>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.</para><para> - Format: a valid RFC4122 universally unique identifier (UUID).</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.wait-activation-delay">connection.wait-activation-delay</option></term><listitem><para>Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event.</para><para>The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.wait-device-timeout">connection.wait-device-timeout</option></term><listitem><para>Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed.</para><para>The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.zone">connection.zone</option></term><listitem><para>The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.</para><para>When updating this property on a currently activated connection, the change takes effect immediately.</para><para> + Format: string</para><para> + Valid values: 6lowpan, 802-11-olpc-mesh, 802-11-wireless, 802-3-ethernet, adsl, bluetooth, bond, bridge, cdma, dummy, generic, gsm, hsr, infiniband, ip-tunnel, loopback, macsec, macvlan, ovs-bridge, ovs-dpdk, ovs-interface, ovs-patch, ovs-port, pppoe, team, tun, veth, vlan, vpn, vrf, vxlan, wifi-p2p, wimax, wireguard, wpan</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.uuid">connection.uuid</option></term><listitem><para>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`.</para><para>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.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.wait-activation-delay">connection.wait-activation-delay</option></term><listitem><para>Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event.</para><para>The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</para><para> + Format: integer</para><para> + Valid values: -1 - 2147483647</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.wait-device-timeout">connection.wait-device-timeout</option></term><listitem><para>Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed.</para><para>The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</para><para> + Format: integer</para><para> + Valid values: -1 - 2147483647</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.zone">connection.zone</option></term><listitem><para>The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.</para><para>When updating this property on a currently activated connection, the change takes effect immediately.</para><para> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>6lowpan setting</title><para>6LoWPAN Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.6lowpan.parent">6lowpan.parent</option></term><listitem><para> @@ -73,201 +96,437 @@ Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-1x setting</title><para>IEEE 802.1x Authentication Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.altsubject-matches">802-1x.altsubject-matches</option></term><listitem><para>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.anonymous-identity">802-1x.anonymous-identity</option></term><listitem><para>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</para><para> + Format: list of strings</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.anonymous-identity">802-1x.anonymous-identity</option></term><listitem><para>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.auth-timeout">802-1x.auth-timeout</option></term><listitem><para>A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-cert">802-1x.ca-cert</option></term><listitem><para>Contains the CA certificate if used by the EAP method specified in the "eap" property.</para><para>Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</para><para>Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-cert-password">802-1x.ca-cert-password</option></term><listitem><para>The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> + Format: integer</para><para> + Valid values: 0 - 2147483647</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-cert">802-1x.ca-cert</option></term><listitem><para>Contains the CA certificate if used by the EAP method specified in the "eap" property.</para><para>Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</para><para>Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</para><para> + Format: filesystem path</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-cert-password">802-1x.ca-cert-password</option></term><listitem><para>The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-cert-password-flags">802-1x.ca-cert-password-flags</option></term><listitem><para>Flags indicating how to handle the "ca-cert-password" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-path">802-1x.ca-path</option></term><listitem><para>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property.</para><para>If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</para><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-path">802-1x.ca-path</option></term><listitem><para>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property.</para><para>If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.client-cert">802-1x.client-cert</option></term><listitem><para>Contains the client certificate if used by the EAP method specified in the "eap" property.</para><para>Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.client-cert-password">802-1x.client-cert-password</option></term><listitem><para>The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> + Format: filesystem path</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.client-cert-password">802-1x.client-cert-password</option></term><listitem><para>The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.client-cert-password-flags">802-1x.client-cert-password-flags</option></term><listitem><para>Flags indicating how to handle the "client-cert-password" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.domain-match">802-1x.domain-match</option></term><listitem><para>Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.</para><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.domain-match">802-1x.domain-match</option></term><listitem><para>Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.domain-suffix-match">802-1x.domain-suffix-match</option></term><listitem><para>Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.eap">802-1x.eap</option></term><listitem><para>The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.identity">802-1x.identity</option></term><listitem><para>Identity string for EAP authentication methods. Often the user's user or login name.</para><para> + Format: list of strings</para><para> + Valid values: leap, md5, tls, peap, ttls, sim, fast, pwd</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.identity">802-1x.identity</option></term><listitem><para>Identity string for EAP authentication methods. Often the user's user or login name.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.optional">802-1x.optional</option></term><listitem><para>Whether the 802.1X authentication is optional. If TRUE, the activation will continue even after a timeout or an authentication failure. Setting the property to TRUE is currently allowed only for Ethernet connections. If set to FALSE, the activation can continue only after a successful authentication.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.pac-file">802-1x.pac-file</option></term><listitem><para>UTF-8 encoded file path containing PAC for EAP-FAST.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.pac-file">802-1x.pac-file</option></term><listitem><para>UTF-8 encoded file path containing PAC for EAP-FAST.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password">802-1x.password</option></term><listitem><para>UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password-flags">802-1x.password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password-raw">802-1x.password-raw</option></term><listitem><para>Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password-raw-flags">802-1x.password-raw-flags</option></term><listitem><para>Flags indicating how to handle the "password-raw" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-auth-flags">802-1x.phase1-auth-flags</option></term><listitem><para>Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. TLS time checks can be also disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x and tls_disable_time_checks settings. See the wpa_supplicant documentation for more details.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-fast-provisioning">802-1x.phase1-fast-provisioning</option></term><listitem><para>Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-peaplabel">802-1x.phase1-peaplabel</option></term><listitem><para>Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-peapver">802-1x.phase1-peapver</option></term><listitem><para>Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-altsubject-matches">802-1x.phase2-altsubject-matches</option></term><listitem><para>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-auth">802-1x.phase2-auth</option></term><listitem><para>Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-autheap">802-1x.phase2-autheap</option></term><listitem><para>Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-cert">802-1x.phase2-ca-cert</option></term><listitem><para>Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</para><para>Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</para><para>Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-cert-password">802-1x.phase2-ca-cert-password</option></term><listitem><para>The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password-raw">802-1x.password-raw</option></term><listitem><para>Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</para><para> + Format: bytes</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password-raw-flags">802-1x.password-raw-flags</option></term><listitem><para>Flags indicating how to handle the "password-raw" property.</para><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-auth-flags">802-1x.phase1-auth-flags</option></term><listitem><para>Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. TLS time checks can be also disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x and tls_disable_time_checks settings. See the wpa_supplicant documentation for more details.</para><para> + Format: flags (NMSetting8021xAuthFlags)</para><para> + Valid values: none (0x0), tls-1-0-disable (0x1), tls-1-1-disable (0x2), tls-1-2-disable (0x4), tls-disable-time-checks (0x8), tls-1-3-disable (0x10), tls-1-0-enable (0x20), tls-1-1-enable (0x40), tls-1-2-enable (0x80), tls-1-3-enable (0x100), all (0x1ff)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-fast-provisioning">802-1x.phase1-fast-provisioning</option></term><listitem><para>Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.</para><para> + Format: string</para><para> + Valid values: 0, 1, 2, 3</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-peaplabel">802-1x.phase1-peaplabel</option></term><listitem><para>Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</para><para> + Format: string</para><para> + Valid values: 0, 1</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-peapver">802-1x.phase1-peapver</option></term><listitem><para>Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.</para><para> + Format: string</para><para> + Valid values: 0, 1</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-altsubject-matches">802-1x.phase2-altsubject-matches</option></term><listitem><para>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</para><para> + Format: list of strings</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-auth">802-1x.phase2-auth</option></term><listitem><para>Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.</para><para> + Format: string</para><para> + Valid values: pap, chap, mschap, mschapv2, gtc, otp, md5, tls</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-autheap">802-1x.phase2-autheap</option></term><listitem><para>Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</para><para> + Format: string</para><para> + Valid values: md5, mschapv2, otp, gtc, tls</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-cert">802-1x.phase2-ca-cert</option></term><listitem><para>Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</para><para>Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</para><para>Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</para><para> + Format: filesystem path</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-cert-password">802-1x.phase2-ca-cert-password</option></term><listitem><para>The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-cert-password-flags">802-1x.phase2-ca-cert-password-flags</option></term><listitem><para>Flags indicating how to handle the "phase2-ca-cert-password" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-path">802-1x.phase2-ca-path</option></term><listitem><para>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property.</para><para>If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-client-cert">802-1x.phase2-client-cert</option></term><listitem><para>Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</para><para>Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-client-cert-password">802-1x.phase2-client-cert-password</option></term><listitem><para>The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-path">802-1x.phase2-ca-path</option></term><listitem><para>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property.</para><para>If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</para><para> + Format: filesystem path</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-client-cert">802-1x.phase2-client-cert</option></term><listitem><para>Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</para><para>Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</para><para> + Format: filesystem path</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-client-cert-password">802-1x.phase2-client-cert-password</option></term><listitem><para>The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-client-cert-password-flags">802-1x.phase2-client-cert-password-flags</option></term><listitem><para>Flags indicating how to handle the "phase2-client-cert-password" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-domain-match">802-1x.phase2-domain-match</option></term><listitem><para>Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.</para><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-domain-match">802-1x.phase2-domain-match</option></term><listitem><para>Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-domain-suffix-match">802-1x.phase2-domain-suffix-match</option></term><listitem><para>Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-private-key">802-1x.phase2-private-key</option></term><listitem><para>Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls".</para><para>Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-private-key-password">802-1x.phase2-private-key-password</option></term><listitem><para>The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.</para><para> + Format: filesystem path</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-private-key-password">802-1x.phase2-private-key-password</option></term><listitem><para>The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-private-key-password-flags">802-1x.phase2-private-key-password-flags</option></term><listitem><para>Flags indicating how to handle the "phase2-private-key-password" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-subject-match">802-1x.phase2-subject-match</option></term><listitem><para>Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.</para><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-subject-match">802-1x.phase2-subject-match</option></term><listitem><para>Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.</para><para> This property is deprecated since version 1.2. Use "phase2-domain-suffix-match" instead.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.pin">802-1x.pin</option></term><listitem><para>PIN used for EAP authentication methods.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.pin-flags">802-1x.pin-flags</option></term><listitem><para>Flags indicating how to handle the "pin" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.private-key">802-1x.private-key</option></term><listitem><para>Contains the private key when the "eap" property is set to "tls".</para><para>Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</para><para>WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.private-key-password">802-1x.private-key-password</option></term><listitem><para>The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</para><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.private-key">802-1x.private-key</option></term><listitem><para>Contains the private key when the "eap" property is set to "tls".</para><para>Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</para><para>WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.</para><para> + Format: filesystem path</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.private-key-password">802-1x.private-key-password</option></term><listitem><para>The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.private-key-password-flags">802-1x.private-key-password-flags</option></term><listitem><para>Flags indicating how to handle the "private-key-password" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.subject-match">802-1x.subject-match</option></term><listitem><para>Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.</para><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.subject-match">802-1x.subject-match</option></term><listitem><para>Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.</para><para> This property is deprecated since version 1.2. Use "phase2-domain-suffix-match" instead.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.system-ca-certs">802-1x.system-ca-certs</option></term><listitem><para>When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).</para><para> - Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>adsl setting</title><para>ADSL Settings.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>adsl setting</title><para>ADSL Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.adsl.encapsulation">adsl.encapsulation</option></term><listitem><para> Alias: encapsulation</para><para>Encapsulation of ADSL connection. Can be "vcmux" or "llc".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.password">adsl.password</option></term><listitem><para> + Format: string</para><para> + Valid values: vcmux, llc</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.password">adsl.password</option></term><listitem><para> Alias: password</para><para>Password used to authenticate with the ADSL service.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.password-flags">adsl.password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.protocol">adsl.protocol</option></term><listitem><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.protocol">adsl.protocol</option></term><listitem><para> Alias: protocol</para><para>ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.username">adsl.username</option></term><listitem><para> + Format: string</para><para> + Valid values: pppoa, pppoe, ipoatm</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.username">adsl.username</option></term><listitem><para> Alias: username</para><para>Username used to authenticate with the ADSL service.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.vci">adsl.vci</option></term><listitem><para>VCI of ADSL connection</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.vpi">adsl.vpi</option></term><listitem><para>VPI of ADSL connection</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bluetooth setting</title><para>Bluetooth Settings.</para><para> + Format: integer</para><para> + Valid values: 0 - 65536</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.vpi">adsl.vpi</option></term><listitem><para>VPI of ADSL connection</para><para> + Format: integer</para><para> + Valid values: 0 - 65536</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bluetooth setting</title><para>Bluetooth Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bluetooth.bdaddr">bluetooth.bdaddr</option></term><listitem><para> Alias: addr</para><para>The Bluetooth address of the device.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bluetooth.type">bluetooth.type</option></term><listitem><para> + Format: MAC address</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bluetooth.type">bluetooth.type</option></term><listitem><para> Alias: bt-type</para><para>Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bond setting</title><para>Bonding Settings.</para><para> + Format: string</para><para> + Valid values: dun, panu, nap</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bond setting</title><para>Bonding Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bond.options">bond.options</option></term><listitem><para>Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</para><para> - Format: dict of string to string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bridge setting</title><para>Bridging Settings.</para><para> + Format: list of key/value options</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bridge setting</title><para>Bridging Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bridge.ageing-time">bridge.ageing-time</option></term><listitem><para> Alias: ageing-time</para><para>The Ethernet MAC address aging time, in seconds.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.forward-delay">bridge.forward-delay</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 1000000</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.forward-delay">bridge.forward-delay</option></term><listitem><para> Alias: forward-delay</para><para>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.group-address">bridge.group-address</option></term><listitem><para>If specified, The MAC address of the multicast group this bridge uses for STP.</para><para>The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.group-forward-mask">bridge.group-forward-mask</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 30</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.group-address">bridge.group-address</option></term><listitem><para>If specified, The MAC address of the multicast group this bridge uses for STP.</para><para>The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.</para><para> + Format: MAC address</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.group-forward-mask">bridge.group-forward-mask</option></term><listitem><para> Alias: group-forward-mask</para><para>A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.hello-time">bridge.hello-time</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 65535</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.hello-time">bridge.hello-time</option></term><listitem><para> Alias: hello-time</para><para>The Spanning Tree Protocol (STP) hello time, in seconds.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.mac-address">bridge.mac-address</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 10</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.mac-address">bridge.mac-address</option></term><listitem><para> Alias: mac</para><para>If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set.</para><para>If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge.</para><para> This property is deprecated since version 1.12. Use the "cloned-mac-address" property instead.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.max-age">bridge.max-age</option></term><listitem><para> + Format: MAC address</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.max-age">bridge.max-age</option></term><listitem><para> Alias: max-age</para><para>The Spanning Tree Protocol (STP) maximum message age, in seconds.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-hash-max">bridge.multicast-hash-max</option></term><listitem><para>Set maximum size of multicast hash table (value must be a power of 2).</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-last-member-count">bridge.multicast-last-member-count</option></term><listitem><para>Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-last-member-interval">bridge.multicast-last-member-interval</option></term><listitem><para>Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-membership-interval">bridge.multicast-membership-interval</option></term><listitem><para>Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-querier">bridge.multicast-querier</option></term><listitem><para>Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-querier-interval">bridge.multicast-querier-interval</option></term><listitem><para>If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-interval">bridge.multicast-query-interval</option></term><listitem><para>Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-response-interval">bridge.multicast-query-response-interval</option></term><listitem><para>Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-use-ifaddr">bridge.multicast-query-use-ifaddr</option></term><listitem><para>If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-router">bridge.multicast-router</option></term><listitem><para>Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work.</para><para>Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-snooping">bridge.multicast-snooping</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 40</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-hash-max">bridge.multicast-hash-max</option></term><listitem><para>Set maximum size of multicast hash table (value must be a power of 2).</para><para> + Format: integer</para><para> + Valid values: 1 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-last-member-count">bridge.multicast-last-member-count</option></term><listitem><para>Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-last-member-interval">bridge.multicast-last-member-interval</option></term><listitem><para>Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.</para><para> + Format: integer</para><para> + Valid values: 0 - 18446744073709551615</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-membership-interval">bridge.multicast-membership-interval</option></term><listitem><para>Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.</para><para> + Format: integer</para><para> + Valid values: 0 - 18446744073709551615</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-querier">bridge.multicast-querier</option></term><listitem><para>Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-querier-interval">bridge.multicast-querier-interval</option></term><listitem><para>If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.</para><para> + Format: integer</para><para> + Valid values: 0 - 18446744073709551615</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-interval">bridge.multicast-query-interval</option></term><listitem><para>Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</para><para> + Format: integer</para><para> + Valid values: 0 - 18446744073709551615</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-response-interval">bridge.multicast-query-response-interval</option></term><listitem><para>Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</para><para> + Format: integer</para><para> + Valid values: 0 - 18446744073709551615</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-use-ifaddr">bridge.multicast-query-use-ifaddr</option></term><listitem><para>If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-router">bridge.multicast-router</option></term><listitem><para>Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work.</para><para>Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).</para><para> + Format: string</para><para> + Valid values: auto, disabled, enabled</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-snooping">bridge.multicast-snooping</option></term><listitem><para> Alias: multicast-snooping</para><para>Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-startup-query-count">bridge.multicast-startup-query-count</option></term><listitem><para>Set the number of IGMP queries to send during startup phase.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-startup-query-interval">bridge.multicast-startup-query-interval</option></term><listitem><para>Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.priority">bridge.priority</option></term><listitem><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-startup-query-count">bridge.multicast-startup-query-count</option></term><listitem><para>Set the number of IGMP queries to send during startup phase.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-startup-query-interval">bridge.multicast-startup-query-interval</option></term><listitem><para>Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</para><para> + Format: integer</para><para> + Valid values: 0 - 18446744073709551615</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.priority">bridge.priority</option></term><listitem><para> Alias: priority</para><para>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.stp">bridge.stp</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 65535</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.stp">bridge.stp</option></term><listitem><para> Alias: stp</para><para>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-default-pvid">bridge.vlan-default-pvid</option></term><listitem><para>The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-filtering">bridge.vlan-filtering</option></term><listitem><para>Control whether VLAN filtering is enabled on the bridge.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-protocol">bridge.vlan-protocol</option></term><listitem><para>If specified, the protocol used for VLAN filtering.</para><para>Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-stats-enabled">bridge.vlan-stats-enabled</option></term><listitem><para>Controls whether per-VLAN stats accounting is enabled.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlans">bridge.vlans</option></term><listitem><para>Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property.</para><para>In nmcli the VLAN list can be specified with the following syntax:</para><para>$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</para><para>where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</para><para> - Format: array of vardict</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bridge-port setting</title><para>Bridge Port Settings.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-default-pvid">bridge.vlan-default-pvid</option></term><listitem><para>The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.</para><para> + Format: integer</para><para> + Valid values: 0 - 4094</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-filtering">bridge.vlan-filtering</option></term><listitem><para>Control whether VLAN filtering is enabled on the bridge.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-protocol">bridge.vlan-protocol</option></term><listitem><para>If specified, the protocol used for VLAN filtering.</para><para>Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</para><para> + Format: string</para><para> + Valid values: 802.1Q, 802.1ad</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-stats-enabled">bridge.vlan-stats-enabled</option></term><listitem><para>Controls whether per-VLAN stats accounting is enabled.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlans">bridge.vlans</option></term><listitem><para>Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property.</para><para>In nmcli the VLAN list can be specified with the following syntax:</para><para>$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</para><para>where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</para><para> + Format: list of bridge.vlans objects</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bridge-port setting</title><para>Bridge Port Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bridge-port.hairpin-mode">bridge-port.hairpin-mode</option></term><listitem><para> Alias: hairpin</para><para>Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge-port.path-cost">bridge-port.path-cost</option></term><listitem><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge-port.path-cost">bridge-port.path-cost</option></term><listitem><para> Alias: path-cost</para><para>The Spanning Tree Protocol (STP) port cost for destinations via this port.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge-port.priority">bridge-port.priority</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 65535</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge-port.priority">bridge-port.priority</option></term><listitem><para> Alias: priority</para><para>The Spanning Tree Protocol (STP) priority of this bridge port.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge-port.vlans">bridge-port.vlans</option></term><listitem><para>Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property.</para><para>In nmcli the VLAN list can be specified with the following syntax:</para><para>$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</para><para>where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</para><para> - Format: array of vardict</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>cdma setting</title><para>CDMA-based Mobile Broadband Settings.</para><para> + Format: integer</para><para> + Valid values: 0 - 63</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge-port.vlans">bridge-port.vlans</option></term><listitem><para>Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property.</para><para>In nmcli the VLAN list can be specified with the following syntax:</para><para>$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</para><para>where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</para><para> + Format: list of bridge-port.vlans objects</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>cdma setting</title><para>CDMA-based Mobile Broadband Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.cdma.mtu">cdma.mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.number">cdma.number</option></term><listitem><para>The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.</para><para> + Format: integer</para><para> + Special values: auto</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.number">cdma.number</option></term><listitem><para>The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.password">cdma.password</option></term><listitem><para> Alias: password</para><para>The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.password-flags">cdma.password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.username">cdma.username</option></term><listitem><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.username">cdma.username</option></term><listitem><para> Alias: user</para><para>The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.</para><para> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>dcb setting</title><para>Data Center Bridging Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-flags">dcb.app-fcoe-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-mode">dcb.app-fcoe-mode</option></term><listitem><para>The FCoE controller mode; either "fabric" or "vn2vn".</para><para>Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-priority">dcb.app-fcoe-priority</option></term><listitem><para>The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fip-flags">dcb.app-fip-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fip-priority">dcb.app-fip-priority</option></term><listitem><para>The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-iscsi-flags">dcb.app-iscsi-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-iscsi-priority">dcb.app-iscsi-priority</option></term><listitem><para>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-bandwidth">dcb.priority-bandwidth</option></term><listitem><para>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-flow-control">dcb.priority-flow-control</option></term><listitem><para>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-flow-control-flags">dcb.priority-flow-control-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-bandwidth">dcb.priority-group-bandwidth</option></term><listitem><para>An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-flags">dcb.priority-group-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-id">dcb.priority-group-id</option></term><listitem><para>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-strict-bandwidth">dcb.priority-strict-bandwidth</option></term><listitem><para>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-traffic-class">dcb.priority-traffic-class</option></term><listitem><para>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.</para><para> - Format: array of uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ethtool setting</title><para>Ethtool Ethernet Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-flags">dcb.app-fcoe-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).</para><para> + Format: flags (NMSettingDcbFlags)</para><para> + Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-mode">dcb.app-fcoe-mode</option></term><listitem><para>The FCoE controller mode; either "fabric" or "vn2vn".</para><para>Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".</para><para> + Format: string</para><para> + Valid values: fabric, vn2vn</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-priority">dcb.app-fcoe-priority</option></term><listitem><para>The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the "enable" (0x1) flag.</para><para> + Format: integer</para><para> + Valid values: -1 - 7</para><para> + Special values: unset (-1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fip-flags">dcb.app-fip-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).</para><para> + Format: flags (NMSettingDcbFlags)</para><para> + Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fip-priority">dcb.app-fip-priority</option></term><listitem><para>The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the "enable" (0x1) flag.</para><para> + Format: integer</para><para> + Valid values: -1 - 7</para><para> + Special values: unset (-1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-iscsi-flags">dcb.app-iscsi-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).</para><para> + Format: flags (NMSettingDcbFlags)</para><para> + Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-iscsi-priority">dcb.app-iscsi-priority</option></term><listitem><para>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the "enable" (0x1) flag.</para><para> + Format: integer</para><para> + Valid values: -1 - 7</para><para> + Special values: unset (-1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-bandwidth">dcb.priority-bandwidth</option></term><listitem><para>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.</para><para> + Format: list of integers</para><para> + Valid values: 0 - 100</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-flow-control">dcb.priority-flow-control</option></term><listitem><para>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.</para><para> + Format: list of booleans</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-flow-control-flags">dcb.priority-flow-control-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).</para><para> + Format: flags (NMSettingDcbFlags)</para><para> + Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-bandwidth">dcb.priority-group-bandwidth</option></term><listitem><para>An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.</para><para> + Format: list of integers</para><para> + Valid values: 0 - 100</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-flags">dcb.priority-group-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).</para><para> + Format: flags (NMSettingDcbFlags)</para><para> + Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-id">dcb.priority-group-id</option></term><listitem><para>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.</para><para> + Format: list of integers</para><para> + Valid values: 0 - 7, 15</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-strict-bandwidth">dcb.priority-strict-bandwidth</option></term><listitem><para>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.</para><para> + Format: list of booleans</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-traffic-class">dcb.priority-traffic-class</option></term><listitem><para>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.</para><para> + Format: list of integers</para><para> + Valid values: 0 - 7</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ethtool setting</title><para>Ethtool Ethernet Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-adaptive-rx">ethtool.coalesce-adaptive-rx</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-adaptive-tx">ethtool.coalesce-adaptive-tx</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-high">ethtool.coalesce-pkt-rate-high</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-low">ethtool.coalesce-pkt-rate-low</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames">ethtool.coalesce-rx-frames</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-high">ethtool.coalesce-rx-frames-high</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-irq">ethtool.coalesce-rx-frames-irq</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-low">ethtool.coalesce-rx-frames-low</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs">ethtool.coalesce-rx-usecs</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-high">ethtool.coalesce-rx-usecs-high</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-irq">ethtool.coalesce-rx-usecs-irq</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-low">ethtool.coalesce-rx-usecs-low</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-sample-interval">ethtool.coalesce-sample-interval</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-stats-block-usecs">ethtool.coalesce-stats-block-usecs</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames">ethtool.coalesce-tx-frames</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-high">ethtool.coalesce-tx-frames-high</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-irq">ethtool.coalesce-tx-frames-irq</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-low">ethtool.coalesce-tx-frames-low</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs">ethtool.coalesce-tx-usecs</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-high">ethtool.coalesce-tx-usecs-high</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-irq">ethtool.coalesce-tx-usecs-irq</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-low">ethtool.coalesce-tx-usecs-low</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-esp-hw-offload">ethtool.feature-esp-hw-offload</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-esp-tx-csum-hw-offload">ethtool.feature-esp-tx-csum-hw-offload</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-fcoe-mtu">ethtool.feature-fcoe-mtu</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-gro">ethtool.feature-gro</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-gso">ethtool.feature-gso</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-highdma">ethtool.feature-highdma</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-hw-tc-offload">ethtool.feature-hw-tc-offload</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-l2-fwd-offload">ethtool.feature-l2-fwd-offload</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-loopback">ethtool.feature-loopback</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-lro">ethtool.feature-lro</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-macsec-hw-offload">ethtool.feature-macsec-hw-offload</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-ntuple">ethtool.feature-ntuple</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx">ethtool.feature-rx</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-all">ethtool.feature-rx-all</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-fcs">ethtool.feature-rx-fcs</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-gro-hw">ethtool.feature-rx-gro-hw</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-gro-list">ethtool.feature-rx-gro-list</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-udp-gro-forwarding">ethtool.feature-rx-udp-gro-forwarding</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-udp_tunnel-port-offload">ethtool.feature-rx-udp_tunnel-port-offload</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-filter">ethtool.feature-rx-vlan-filter</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-filter">ethtool.feature-rx-vlan-stag-filter</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-hw-parse">ethtool.feature-rx-vlan-stag-hw-parse</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rxhash">ethtool.feature-rxhash</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rxvlan">ethtool.feature-rxvlan</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-sg">ethtool.feature-sg</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-record">ethtool.feature-tls-hw-record</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-rx-offload">ethtool.feature-tls-hw-rx-offload</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-tx-offload">ethtool.feature-tls-hw-tx-offload</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tso">ethtool.feature-tso</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx">ethtool.feature-tx</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-fcoe-crc">ethtool.feature-tx-checksum-fcoe-crc</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ip-generic">ethtool.feature-tx-checksum-ip-generic</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv4">ethtool.feature-tx-checksum-ipv4</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv6">ethtool.feature-tx-checksum-ipv6</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-sctp">ethtool.feature-tx-checksum-sctp</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-esp-segmentation">ethtool.feature-tx-esp-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-fcoe-segmentation">ethtool.feature-tx-fcoe-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gre-csum-segmentation">ethtool.feature-tx-gre-csum-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gre-segmentation">ethtool.feature-tx-gre-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-list">ethtool.feature-tx-gso-list</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-partial">ethtool.feature-tx-gso-partial</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-robust">ethtool.feature-tx-gso-robust</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-ipxip4-segmentation">ethtool.feature-tx-ipxip4-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-ipxip6-segmentation">ethtool.feature-tx-ipxip6-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-nocache-copy">ethtool.feature-tx-nocache-copy</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather">ethtool.feature-tx-scatter-gather</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather-fraglist">ethtool.feature-tx-scatter-gather-fraglist</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-sctp-segmentation">ethtool.feature-tx-sctp-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-ecn-segmentation">ethtool.feature-tx-tcp-ecn-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-mangleid-segmentation">ethtool.feature-tx-tcp-mangleid-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-segmentation">ethtool.feature-tx-tcp-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp6-segmentation">ethtool.feature-tx-tcp6-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tunnel-remcsum-segmentation">ethtool.feature-tx-tunnel-remcsum-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp-segmentation">ethtool.feature-tx-udp-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-csum-segmentation">ethtool.feature-tx-udp_tnl-csum-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-segmentation">ethtool.feature-tx-udp_tnl-segmentation</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-vlan-stag-hw-insert">ethtool.feature-tx-vlan-stag-hw-insert</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-txvlan">ethtool.feature-txvlan</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-autoneg">ethtool.pause-autoneg</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-rx">ethtool.pause-rx</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-tx">ethtool.pause-tx</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx">ethtool.ring-rx</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx-jumbo">ethtool.ring-rx-jumbo</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx-mini">ethtool.ring-rx-mini</option></term><listitem/></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-tx">ethtool.ring-tx</option></term><listitem/></varlistentry></variablelist></para></refsect2><refsect2><title>gsm setting</title><para>GSM-based Mobile Broadband Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.channels-combined">ethtool.channels-combined</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.channels-other">ethtool.channels-other</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.channels-rx">ethtool.channels-rx</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.channels-tx">ethtool.channels-tx</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-adaptive-rx">ethtool.coalesce-adaptive-rx</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-adaptive-tx">ethtool.coalesce-adaptive-tx</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-high">ethtool.coalesce-pkt-rate-high</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-low">ethtool.coalesce-pkt-rate-low</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames">ethtool.coalesce-rx-frames</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-high">ethtool.coalesce-rx-frames-high</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-irq">ethtool.coalesce-rx-frames-irq</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-low">ethtool.coalesce-rx-frames-low</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs">ethtool.coalesce-rx-usecs</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-high">ethtool.coalesce-rx-usecs-high</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-irq">ethtool.coalesce-rx-usecs-irq</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-low">ethtool.coalesce-rx-usecs-low</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-sample-interval">ethtool.coalesce-sample-interval</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-stats-block-usecs">ethtool.coalesce-stats-block-usecs</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames">ethtool.coalesce-tx-frames</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-high">ethtool.coalesce-tx-frames-high</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-irq">ethtool.coalesce-tx-frames-irq</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-low">ethtool.coalesce-tx-frames-low</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs">ethtool.coalesce-tx-usecs</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-high">ethtool.coalesce-tx-usecs-high</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-irq">ethtool.coalesce-tx-usecs-irq</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-low">ethtool.coalesce-tx-usecs-low</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.eee-enabled">ethtool.eee-enabled</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-esp-hw-offload">ethtool.feature-esp-hw-offload</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-esp-tx-csum-hw-offload">ethtool.feature-esp-tx-csum-hw-offload</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-fcoe-mtu">ethtool.feature-fcoe-mtu</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-gro">ethtool.feature-gro</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-gso">ethtool.feature-gso</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-highdma">ethtool.feature-highdma</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-hw-tc-offload">ethtool.feature-hw-tc-offload</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-l2-fwd-offload">ethtool.feature-l2-fwd-offload</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-loopback">ethtool.feature-loopback</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-lro">ethtool.feature-lro</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-macsec-hw-offload">ethtool.feature-macsec-hw-offload</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-ntuple">ethtool.feature-ntuple</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx">ethtool.feature-rx</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-all">ethtool.feature-rx-all</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-fcs">ethtool.feature-rx-fcs</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-gro-hw">ethtool.feature-rx-gro-hw</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-gro-list">ethtool.feature-rx-gro-list</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-udp-gro-forwarding">ethtool.feature-rx-udp-gro-forwarding</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-udp_tunnel-port-offload">ethtool.feature-rx-udp_tunnel-port-offload</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-filter">ethtool.feature-rx-vlan-filter</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-filter">ethtool.feature-rx-vlan-stag-filter</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-hw-parse">ethtool.feature-rx-vlan-stag-hw-parse</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rxhash">ethtool.feature-rxhash</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rxvlan">ethtool.feature-rxvlan</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-sg">ethtool.feature-sg</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-record">ethtool.feature-tls-hw-record</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-rx-offload">ethtool.feature-tls-hw-rx-offload</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-tx-offload">ethtool.feature-tls-hw-tx-offload</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tso">ethtool.feature-tso</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx">ethtool.feature-tx</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-fcoe-crc">ethtool.feature-tx-checksum-fcoe-crc</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ip-generic">ethtool.feature-tx-checksum-ip-generic</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv4">ethtool.feature-tx-checksum-ipv4</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv6">ethtool.feature-tx-checksum-ipv6</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-sctp">ethtool.feature-tx-checksum-sctp</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-esp-segmentation">ethtool.feature-tx-esp-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-fcoe-segmentation">ethtool.feature-tx-fcoe-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gre-csum-segmentation">ethtool.feature-tx-gre-csum-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gre-segmentation">ethtool.feature-tx-gre-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-list">ethtool.feature-tx-gso-list</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-partial">ethtool.feature-tx-gso-partial</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-robust">ethtool.feature-tx-gso-robust</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-ipxip4-segmentation">ethtool.feature-tx-ipxip4-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-ipxip6-segmentation">ethtool.feature-tx-ipxip6-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-nocache-copy">ethtool.feature-tx-nocache-copy</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather">ethtool.feature-tx-scatter-gather</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather-fraglist">ethtool.feature-tx-scatter-gather-fraglist</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-sctp-segmentation">ethtool.feature-tx-sctp-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-ecn-segmentation">ethtool.feature-tx-tcp-ecn-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-mangleid-segmentation">ethtool.feature-tx-tcp-mangleid-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-segmentation">ethtool.feature-tx-tcp-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp6-segmentation">ethtool.feature-tx-tcp6-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tunnel-remcsum-segmentation">ethtool.feature-tx-tunnel-remcsum-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp-segmentation">ethtool.feature-tx-udp-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-csum-segmentation">ethtool.feature-tx-udp_tnl-csum-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-segmentation">ethtool.feature-tx-udp_tnl-segmentation</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-vlan-stag-hw-insert">ethtool.feature-tx-vlan-stag-hw-insert</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-txvlan">ethtool.feature-txvlan</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-autoneg">ethtool.pause-autoneg</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-rx">ethtool.pause-rx</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-tx">ethtool.pause-tx</option></term><listitem><para> + Format: ternary</para><para> + Valid values: on, off, ignore</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx">ethtool.ring-rx</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx-jumbo">ethtool.ring-rx-jumbo</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx-mini">ethtool.ring-rx-mini</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-tx">ethtool.ring-tx</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>gsm setting</title><para>GSM-based Mobile Broadband Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.gsm.apn">gsm.apn</option></term><listitem><para> - Alias: apn</para><para>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</para><para> + Alias: apn</para><para>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</para><para>If the APN is unset (the default) then it may be detected based on "auto-config" setting. The property can be explicitly set to the empty string to prevent that and use no APN.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.auto-config">gsm.auto-config</option></term><listitem><para>When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.device-id">gsm.device-id</option></term><listitem><para>The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.device-id">gsm.device-id</option></term><listitem><para>The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.home-only">gsm.home-only</option></term><listitem><para>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.initial-eps-bearer-apn">gsm.initial-eps-bearer-apn</option></term><listitem><para>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.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.initial-eps-bearer-apn">gsm.initial-eps-bearer-apn</option></term><listitem><para>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.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.initial-eps-bearer-configure">gsm.initial-eps-bearer-configure</option></term><listitem><para>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.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.mtu">gsm.mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.network-id">gsm.network-id</option></term><listitem><para>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.mtu">gsm.mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para><para> + Format: integer</para><para> + Special values: auto</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.network-id">gsm.network-id</option></term><listitem><para>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.number">gsm.number</option></term><listitem><para>Legacy setting that used to help establishing PPP data sessions for GSM-based modems.</para><para> This property is deprecated since version 1.16. User-provided values for this setting are no longer used.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.password">gsm.password</option></term><listitem><para> Alias: password</para><para>The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.password-flags">gsm.password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.pin">gsm.pin</option></term><listitem><para>If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</para><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.pin">gsm.pin</option></term><listitem><para>If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.pin-flags">gsm.pin-flags</option></term><listitem><para>Flags indicating how to handle the "pin" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.sim-id">gsm.sim-id</option></term><listitem><para>The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.</para><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.sim-id">gsm.sim-id</option></term><listitem><para>The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.sim-operator-id">gsm.sim-operator-id</option></term><listitem><para>A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.username">gsm.username</option></term><listitem><para> Alias: user</para><para>The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.</para><para> @@ -275,40 +534,57 @@ Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.infiniband.mac-address">infiniband.mac-address</option></term><listitem><para> Alias: mac</para><para>If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.infiniband.mtu">infiniband.mtu</option></term><listitem><para> + Format: Infiniband MAC address</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.infiniband.mtu">infiniband.mtu</option></term><listitem><para> Alias: mtu</para><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.infiniband.p-key">infiniband.p-key</option></term><listitem><para> + Format: integer</para><para> + Special values: auto</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.infiniband.p-key">infiniband.p-key</option></term><listitem><para> Alias: p-key</para><para>The InfiniBand p-key to use for this device. A value of -1 means to use the default p-key (aka "the p-key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit 0x8000 is set if it is a "full membership" p-key. The values 0 and 0x8000 are not allowed.</para><para>With the p-key set, the interface name is always "$parent.$p_key". Setting "connection.interface-name" to another name is not supported.</para><para>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.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.infiniband.parent">infiniband.parent</option></term><listitem><para> + Format: integer</para><para> + Valid values: -1 - 65535</para><para> + Special values: default (-1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.infiniband.parent">infiniband.parent</option></term><listitem><para> Alias: parent</para><para>The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.infiniband.transport-mode">infiniband.transport-mode</option></term><listitem><para> Alias: transport-mode</para><para>The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ipv4 setting</title><para>IPv4 Settings.</para><para> + Format: string</para><para> + Valid values: datagram, connected</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ipv4 setting</title><para>IPv4 Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.addresses">ipv4.addresses</option></term><listitem><para> Alias: ip4</para><para>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.</para><para> - Format: a comma separated list of addresses</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.auto-route-ext-gw">ipv4.auto-route-ext-gw</option></term><listitem><para>VPN connections will default to add the route automatically unless this setting is set to FALSE.</para><para>For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dad-timeout">ipv4.dad-timeout</option></term><listitem><para>Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds.</para><para>The property is currently implemented only for IPv4.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-client-id">ipv4.dhcp-client-id</option></term><listitem><para>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0.</para><para>The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links.</para><para>The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset.</para><para>The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id.</para><para>The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key.</para><para>If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-fqdn">ipv4.dhcp-fqdn</option></term><listitem><para>If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</para><para> + Format: list of ipv4.addresses objects</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.auto-route-ext-gw">ipv4.auto-route-ext-gw</option></term><listitem><para>VPN connections will default to add the route automatically unless this setting is set to FALSE.</para><para>For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</para><para> + Format: ternary</para><para> + Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dad-timeout">ipv4.dad-timeout</option></term><listitem><para>Maximum 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. The property is currently implemented only for IPv4.</para><para>A zero value means that no duplicate address detection is performed, -1 means the default value (either the value configured globally in NetworkManger.conf or 200ms). A value greater than zero is a timeout in milliseconds. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property.</para><para> + Format: integer</para><para> + Valid values: -1 - 30000</para><para> + Special values: default (-1), off (0)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-client-id">ipv4.dhcp-client-id</option></term><listitem><para>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0.</para><para>The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links.</para><para>The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset.</para><para>The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id.</para><para>The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key.</para><para>The special value "none" prevents any client identifier from being sent. Note that this is normally not recommended.</para><para>If unset, a globally configured default from NetworkManager.conf is used. If still unset, the default depends on the DHCP plugin. The internal dhcp client will default to "mac" and the dhclient plugin will try to use one from its config file if present, or won't sent any client-id otherwise.</para><para> + Format: string</para><para> + Special values: mac, perm-mac, duid, ipv6-duid, stable, none</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-fqdn">ipv4.dhcp-fqdn</option></term><listitem><para>If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-hostname">ipv4.dhcp-hostname</option></term><listitem><para>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-hostname-flags">ipv4.dhcp-hostname-flags</option></term><listitem><para>Flags for the DHCP hostname and FQDN.</para><para>Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.</para><para>When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-iaid">ipv4.dhcp-iaid</option></term><listitem><para>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname".</para><para>For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.</para><para>For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address.</para><para>The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-hostname-flags">ipv4.dhcp-hostname-flags</option></term><listitem><para>Flags for the DHCP hostname and FQDN.</para><para>Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) and "fqdn-no-update" (0x4). When no FQDN flag is set and "fqdn-clear-flags" (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and "fqdn-clear-flags" (0x8) is not set, the standard FQDN flags are set in the request: "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) for IPv4 and "fqdn-serv-update" (0x1) for IPv6.</para><para>When this property is set to the default value "none" (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also "none" (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</para><para> + Format: flags (NMDhcpHostnameFlags)</para><para> + Valid values: none (0x0), fqdn-serv-update (0x1), fqdn-encoded (0x2), fqdn-no-update (0x4), fqdn-clear-flags (0x8)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-iaid">ipv4.dhcp-iaid</option></term><listitem><para>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname".</para><para>For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.</para><para>For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address.</para><para>The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-reject-servers">ipv4.dhcp-reject-servers</option></term><listitem><para>Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers.</para><para>For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24").</para><para>This property is currently not implemented for DHCPv6.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-send-hostname">ipv4.dhcp-send-hostname</option></term><listitem><para>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-timeout">ipv4.dhcp-timeout</option></term><listitem><para>A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds).</para><para>Set to 2147483647 (MAXINT32) for infinity.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-vendor-class-identifier">ipv4.dhcp-vendor-class-identifier</option></term><listitem><para>The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</para><para> + Format: list of IPv4 addresses</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-send-hostname">ipv4.dhcp-send-hostname</option></term><listitem><para>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-timeout">ipv4.dhcp-timeout</option></term><listitem><para>A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds).</para><para>Set to 2147483647 (MAXINT32) for infinity.</para><para> + Format: integer</para><para> + Valid values: 0 - 2147483647</para><para> + Special values: default (0), infinity (2147483647)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-vendor-class-identifier">ipv4.dhcp-vendor-class-identifier</option></term><listitem><para>The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns">ipv4.dns</option></term><listitem><para>Array of IP addresses of DNS servers.</para><para>For DoT (DNS over TLS), the SNI server name can be specified by appending "#example.com" to the IP address of the DNS server. This currently only has effect when using systemd-resolved.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-options">ipv4.dns-options</option></term><listitem><para>DNS options for /etc/resolv.conf as described in resolv.conf(5) manual.</para><para>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.</para><para>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.</para><para>The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.</para><para>When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</para><para>The valid "ipv4.dns-options" and "ipv6.dns-options" get merged together.</para><para> - Format: a comma separated list of DNS options</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-priority">ipv4.dns-priority</option></term><listitem><para>DNS servers priority.</para><para>The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</para><para>Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.</para><para>Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections.</para><para>Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile.</para><para>When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices.</para><para>When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</para><para>When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-search">ipv4.dns-search</option></term><listitem><para>List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.</para><para>When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</para><para>When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.gateway">ipv4.gateway</option></term><listitem><para> + Format: list of IPv4 addresses</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-options">ipv4.dns-options</option></term><listitem><para>DNS options for /etc/resolv.conf as described in resolv.conf(5) manual.</para><para>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.</para><para>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.</para><para>The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.</para><para>When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</para><para>The valid "ipv4.dns-options" and "ipv6.dns-options" get merged together.</para><para> + Format: list of strings</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-priority">ipv4.dns-priority</option></term><listitem><para>DNS servers priority.</para><para>The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</para><para>Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.</para><para>Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections.</para><para>Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile.</para><para>When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices.</para><para>When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</para><para>When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</para><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-search">ipv4.dns-search</option></term><listitem><para>List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.</para><para>When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</para><para>When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</para><para> + Format: list of strings</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.gateway">ipv4.gateway</option></term><listitem><para> Alias: gw4</para><para>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</para><para>Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</para><para>Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.ignore-auto-dns">ipv4.ignore-auto-dns</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.ignore-auto-routes">ipv4.ignore-auto-routes</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.link-local">ipv4.link-local</option></term><listitem><para>Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server.</para><para>When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.may-fail">ipv4.may-fail</option></term><listitem><para>If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.method">ipv4.method</option></term><listitem><para> + Format: IPv4 address</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.ignore-auto-dns">ipv4.ignore-auto-dns</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.ignore-auto-routes">ipv4.ignore-auto-routes</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.link-local">ipv4.link-local</option></term><listitem><para>Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server.</para><para>When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".</para><para> + Format: choice (NMSettingIP4LinkLocal)</para><para> + Valid values: default (0), auto (1), disabled (2), enabled (3)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.may-fail">ipv4.may-fail</option></term><listitem><para>If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.method">ipv4.method</option></term><listitem><para> Sets the IPv4 connection method. You can set one of the following values: </para><para> <itemizedlist> @@ -329,12 +605,20 @@ </listitem> </itemizedlist> </para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.never-default">ipv4.never-default</option></term><listitem><para>If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.replace-local-rule">ipv4.replace-local-rule</option></term><listitem><para>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.required-timeout">ipv4.required-timeout</option></term><listitem><para>The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</para><para>This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.</para><para>Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</para><para>A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.route-metric">ipv4.route-metric</option></term><listitem><para>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</para><para> - Format: int64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.route-table">ipv4.route-table</option></term><listitem><para>Enable policy routing (source routing) and set the routing table used when adding routes.</para><para>This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para>If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para>Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.routes">ipv4.routes</option></term><listitem><para> + Format: string</para><para> + Valid values: auto, link-local, manual, shared, disabled</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.never-default">ipv4.never-default</option></term><listitem><para>If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.replace-local-rule">ipv4.replace-local-rule</option></term><listitem><para>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</para><para> + Format: ternary</para><para> + Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.required-timeout">ipv4.required-timeout</option></term><listitem><para>The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</para><para>This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.</para><para>Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</para><para>A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</para><para> + Format: integer</para><para> + Valid values: -1 - 2147483647</para><para> + Special values: default (-1), infinity (2147483647)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.route-metric">ipv4.route-metric</option></term><listitem><para>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</para><para> + Format: integer</para><para> + Valid values: -1 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.route-table">ipv4.route-table</option></term><listitem><para>Enable policy routing (source routing) and set the routing table used when adding routes.</para><para>This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para>If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para>Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para><para> + Special values: unspec (0), main (254)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.routes">ipv4.routes</option></term><listitem><para> A list of IPv4 destination addresses, prefix length, optional IPv4 next hop addresses, optional route metric, optional attribute. The valid syntax is: "ip[/prefix] [next-hop] [metric] [attribute=val]...[,ip[/prefix]...]". @@ -424,7 +708,7 @@ </para><para> For details see also `man ip-route`. </para><para> - Format: a comma separated list of routes</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.routing-rules">ipv4.routing-rules</option></term><listitem><para> + Format: list of ipv4.routes objects</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.routing-rules">ipv4.routing-rules</option></term><listitem><para> A comma separated list of routing rules for policy routing. The format is based on <command>ip rule add</command> syntax and mostly compatible. One difference is that routing rules in NetworkManager always need a @@ -432,30 +716,41 @@ fixed priority. </para><para> Example: <literal>priority 5 from 192.167.4.0/24 table 45</literal> </para><para> - Format: a comma separated list of routing rules</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ipv6 setting</title><para>IPv6 Settings.</para><para> + Format: list of ipv4.routing-rules objects</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ipv6 setting</title><para>IPv6 Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.addr-gen-mode">ipv6.addr-gen-mode</option></term><listitem><para>Configure method for creating the IPv6 interface identifer of addresses with RFC4862 IPv6 Stateless Address Autoconfiguration and Link Local addresses.</para><para>The permitted values are: "eui64" (0), "stable-privacy" (1), "default" (3) or "default-or-eui64" (2).</para><para>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.</para><para>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.</para><para>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.</para><para>If not specified, when creating a new profile the default is "default".</para><para>Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</para><para> - Format: one of "eui64" (0), "stable-privacy" (1), "default" (3) or "default-or-eui64" (2)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.addresses">ipv6.addresses</option></term><listitem><para> + Format: choice (NMSettingIP6ConfigAddrGenMode)</para><para> + Valid values: eui64 (0), stable-privacy (1), default-or-eui64 (2), default (3)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.addresses">ipv6.addresses</option></term><listitem><para> Alias: ip6</para><para>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).</para><para> - Format: a comma separated list of addresses</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.auto-route-ext-gw">ipv6.auto-route-ext-gw</option></term><listitem><para>VPN connections will default to add the route automatically unless this setting is set to FALSE.</para><para>For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-duid">ipv6.dhcp-duid</option></term><listitem><para>A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option.</para><para>The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id.</para><para>The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk.</para><para>The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt").</para><para>When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.</para><para> + Format: list of ipv6.addresses objects</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.auto-route-ext-gw">ipv6.auto-route-ext-gw</option></term><listitem><para>VPN connections will default to add the route automatically unless this setting is set to FALSE.</para><para>For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</para><para> + Format: ternary</para><para> + Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-duid">ipv6.dhcp-duid</option></term><listitem><para>A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option.</para><para>The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id.</para><para>The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk.</para><para>The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt").</para><para>When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-hostname">ipv6.dhcp-hostname</option></term><listitem><para>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-hostname-flags">ipv6.dhcp-hostname-flags</option></term><listitem><para>Flags for the DHCP hostname and FQDN.</para><para>Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.</para><para>When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-iaid">ipv6.dhcp-iaid</option></term><listitem><para>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname".</para><para>For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.</para><para>For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address.</para><para>The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-hostname-flags">ipv6.dhcp-hostname-flags</option></term><listitem><para>Flags for the DHCP hostname and FQDN.</para><para>Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) and "fqdn-no-update" (0x4). When no FQDN flag is set and "fqdn-clear-flags" (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and "fqdn-clear-flags" (0x8) is not set, the standard FQDN flags are set in the request: "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) for IPv4 and "fqdn-serv-update" (0x1) for IPv6.</para><para>When this property is set to the default value "none" (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also "none" (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</para><para> + Format: flags (NMDhcpHostnameFlags)</para><para> + Valid values: none (0x0), fqdn-serv-update (0x1), fqdn-encoded (0x2), fqdn-no-update (0x4), fqdn-clear-flags (0x8)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-iaid">ipv6.dhcp-iaid</option></term><listitem><para>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname".</para><para>For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.</para><para>For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address.</para><para>The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-pd-hint">ipv6.dhcp-pd-hint</option></term><listitem><para>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").</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-send-hostname">ipv6.dhcp-send-hostname</option></term><listitem><para>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-timeout">ipv6.dhcp-timeout</option></term><listitem><para>A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds).</para><para>Set to 2147483647 (MAXINT32) for infinity.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns">ipv6.dns</option></term><listitem><para>Array of IP addresses of DNS servers.</para><para>For DoT (DNS over TLS), the SNI server name can be specified by appending "#example.com" to the IP address of the DNS server. This currently only has effect when using systemd-resolved.</para><para> - Format: array of byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-options">ipv6.dns-options</option></term><listitem><para>DNS options for /etc/resolv.conf as described in resolv.conf(5) manual.</para><para>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.</para><para>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.</para><para>The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.</para><para>When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</para><para>The valid "ipv4.dns-options" and "ipv6.dns-options" get merged together.</para><para> - Format: a comma separated list of DNS options</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-priority">ipv6.dns-priority</option></term><listitem><para>DNS servers priority.</para><para>The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</para><para>Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.</para><para>Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections.</para><para>Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile.</para><para>When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices.</para><para>When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</para><para>When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-search">ipv6.dns-search</option></term><listitem><para>List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.</para><para>When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</para><para>When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.gateway">ipv6.gateway</option></term><listitem><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-timeout">ipv6.dhcp-timeout</option></term><listitem><para>A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds).</para><para>Set to 2147483647 (MAXINT32) for infinity.</para><para> + Format: integer</para><para> + Valid values: 0 - 2147483647</para><para> + Special values: default (0), infinity (2147483647)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns">ipv6.dns</option></term><listitem><para>Array of IP addresses of DNS servers.</para><para>For DoT (DNS over TLS), the SNI server name can be specified by appending "#example.com" to the IP address of the DNS server. This currently only has effect when using systemd-resolved.</para><para> + Format: list of IPv6 addresses</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-options">ipv6.dns-options</option></term><listitem><para>DNS options for /etc/resolv.conf as described in resolv.conf(5) manual.</para><para>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.</para><para>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.</para><para>The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.</para><para>When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</para><para>The valid "ipv4.dns-options" and "ipv6.dns-options" get merged together.</para><para> + Format: list of strings</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-priority">ipv6.dns-priority</option></term><listitem><para>DNS servers priority.</para><para>The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</para><para>Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.</para><para>Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections.</para><para>Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile.</para><para>When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices.</para><para>When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</para><para>When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</para><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-search">ipv6.dns-search</option></term><listitem><para>List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.</para><para>When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</para><para>When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</para><para> + Format: list of strings</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.gateway">ipv6.gateway</option></term><listitem><para> Alias: gw6</para><para>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</para><para>Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</para><para>Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ignore-auto-dns">ipv6.ignore-auto-dns</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ignore-auto-routes">ipv6.ignore-auto-routes</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ip6-privacy">ipv6.ip6-privacy</option></term><listitem><para>Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).</para><para>Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy".</para><para>If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr".</para><para>Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.</para><para> - Format: NMSettingIP6ConfigPrivacy (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.may-fail">ipv6.may-fail</option></term><listitem><para>If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.method">ipv6.method</option></term><listitem><para> + Format: IPv6 address</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ignore-auto-dns">ipv6.ignore-auto-dns</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ignore-auto-routes">ipv6.ignore-auto-routes</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ip6-privacy">ipv6.ip6-privacy</option></term><listitem><para>Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).</para><para>Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy".</para><para>If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr".</para><para>Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.</para><para> + Format: choice (NMSettingIP6ConfigPrivacy)</para><para> + Valid values: unknown (-1), disabled (0), prefer-public-addr (1), prefer-temp-addr (2)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.may-fail">ipv6.may-fail</option></term><listitem><para>If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.method">ipv6.method</option></term><listitem><para> Sets the IPv6 connection method. You can set one of the following values: </para><para> <itemizedlist> @@ -485,14 +780,25 @@ Example: <literal>priority 5 from 192.167.4.0/24 table 45</literal> If you set <literal>"auto"</literal>, <literal>"dhcp"</literal>, <literal>"manual"</literal>, <literal>"ignore"</literal>, or <literal>"shared"</literal>, NetworkManager assigns, in addition to the global address, an IPv6 link-local address to the interface. This is compliant with RFC 4291. </para> </para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.mtu">ipv6.mtu</option></term><listitem><para>Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.never-default">ipv6.never-default</option></term><listitem><para>If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ra-timeout">ipv6.ra-timeout</option></term><listitem><para>A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device.</para><para>Set to 2147483647 (MAXINT32) for infinity.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.replace-local-rule">ipv6.replace-local-rule</option></term><listitem><para>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.required-timeout">ipv6.required-timeout</option></term><listitem><para>The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</para><para>This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.</para><para>Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</para><para>A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.route-metric">ipv6.route-metric</option></term><listitem><para>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</para><para> - Format: int64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.route-table">ipv6.route-table</option></term><listitem><para>Enable policy routing (source routing) and set the routing table used when adding routes.</para><para>This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para>If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para>Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.routes">ipv6.routes</option></term><listitem><para> + Format: string</para><para> + Valid values: ignore, auto, dhcp, link-local, manual, shared, disabled</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.mtu">ipv6.mtu</option></term><listitem><para>Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.</para><para> + Format: integer</para><para> + Special values: auto</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.never-default">ipv6.never-default</option></term><listitem><para>If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ra-timeout">ipv6.ra-timeout</option></term><listitem><para>A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device.</para><para>Set to 2147483647 (MAXINT32) for infinity.</para><para> + Format: integer</para><para> + Valid values: 0 - 2147483647</para><para> + Special values: default (0), infinity (2147483647)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.replace-local-rule">ipv6.replace-local-rule</option></term><listitem><para>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</para><para> + Format: ternary</para><para> + Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.required-timeout">ipv6.required-timeout</option></term><listitem><para>The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</para><para>This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.</para><para>Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</para><para>A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</para><para> + Format: integer</para><para> + Valid values: -1 - 2147483647</para><para> + Special values: default (-1), infinity (2147483647)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.route-metric">ipv6.route-metric</option></term><listitem><para>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</para><para> + Format: integer</para><para> + Valid values: -1 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.route-table">ipv6.route-table</option></term><listitem><para>Enable policy routing (source routing) and set the routing table used when adding routes.</para><para>This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para>If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para>Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para><para> + Special values: unspec (0), main (254)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.routes">ipv6.routes</option></term><listitem><para> A list of IPv6 destination addresses, prefix length, optional IPv6 next hop addresses, optional route metric, optional attribute. The valid syntax is: "ip[/prefix] [next-hop] [metric] [attribute=val]...[,ip[/prefix]...]". @@ -563,7 +869,7 @@ Example: <literal>priority 5 from 192.167.4.0/24 table 45</literal> </para><para> For details see also `man ip-route`. </para><para> - Format: a comma separated list of routes</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.routing-rules">ipv6.routing-rules</option></term><listitem><para> + Format: list of ipv6.routes objects</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.routing-rules">ipv6.routing-rules</option></term><listitem><para> A comma separated list of routing rules for policy routing. The format is based on <command>ip rule add</command> syntax and mostly compatible. One difference is that routing rules in NetworkManager always need a @@ -571,129 +877,179 @@ fixed priority. </para><para> Example: <literal>priority 5 from 1:2:3::5/128 table 45</literal> </para><para> - Format: a comma separated list of routing rules</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.token">ipv6.token</option></term><listitem><para>Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</para><para>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.</para><para> + Format: list of ipv6.routing-rules objects</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.token">ipv6.token</option></term><listitem><para>Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</para><para>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.</para><para> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ip-tunnel setting</title><para>IP Tunneling Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.encapsulation-limit">ip-tunnel.encapsulation-limit</option></term><listitem><para>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add 0x1 (ip6-ign-encap-limit) to ip-tunnel flags.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.flags">ip-tunnel.flags</option></term><listitem><para>Tunnel flags. Currently, the following values are supported: 0x1 (ip6-ign-encap-limit), 0x2 (ip6-use-orig-tclass), 0x4 (ip6-use-orig-flowlabel), 0x8 (ip6-mip6-dev), 0x10 (ip6-rcv-dscp-copy) and 0x20 (ip6-use-orig-fwmark). They are valid only for IPv6 tunnels.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.flow-label">ip-tunnel.flow-label</option></term><listitem><para>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.fwmark">ip-tunnel.fwmark</option></term><listitem><para>The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.input-key">ip-tunnel.input-key</option></term><listitem><para>The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para><para> + Format: integer</para><para> + Valid values: 0 - 255</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.flags">ip-tunnel.flags</option></term><listitem><para>Tunnel flags. Currently, the following values are supported: 0x1 (ip6-ign-encap-limit), 0x2 (ip6-use-orig-tclass), 0x4 (ip6-use-orig-flowlabel), 0x8 (ip6-mip6-dev), 0x10 (ip6-rcv-dscp-copy) and 0x20 (ip6-use-orig-fwmark). They are valid only for IPv6 tunnels.</para><para> + Format: flags (NMIPTunnelFlags)</para><para> + Valid values: none (0x0), ip6-ign-encap-limit (0x1), ip6-use-orig-tclass (0x2), ip6-use-orig-flowlabel (0x4), ip6-mip6-dev (0x8), ip6-rcv-dscp-copy (0x10), ip6-use-orig-fwmark (0x20)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.flow-label">ip-tunnel.flow-label</option></term><listitem><para>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</para><para> + Format: integer</para><para> + Valid values: 0 - 1048575</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.fwmark">ip-tunnel.fwmark</option></term><listitem><para>The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.input-key">ip-tunnel.input-key</option></term><listitem><para>The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.local">ip-tunnel.local</option></term><listitem><para> Alias: local</para><para>The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.mode">ip-tunnel.mode</option></term><listitem><para> Alias: mode</para><para>The tunneling mode. Valid values: ipip (1), gre (2), sit (3), isatap (4), vti (5), ip6ip6 (6), ipip6 (7), ip6gre (8), vti6 (9), gretap (10) and ip6gretap (11)</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.mtu">ip-tunnel.mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.output-key">ip-tunnel.output-key</option></term><listitem><para>The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para><para> + Format: choice (NMIPTunnelMode)</para><para> + Valid values: ipip (1), gre (2), sit (3), isatap (4), vti (5), ip6ip6 (6), ipip6 (7), ip6gre (8), vti6 (9), gretap (10), ip6gretap (11)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.mtu">ip-tunnel.mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para><para> + Format: integer</para><para> + Special values: auto</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.output-key">ip-tunnel.output-key</option></term><listitem><para>The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.parent">ip-tunnel.parent</option></term><listitem><para> Alias: dev</para><para>If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.path-mtu-discovery">ip-tunnel.path-mtu-discovery</option></term><listitem><para>Whether to enable Path MTU Discovery on this tunnel.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.remote">ip-tunnel.remote</option></term><listitem><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.remote">ip-tunnel.remote</option></term><listitem><para> Alias: remote</para><para>The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.tos">ip-tunnel.tos</option></term><listitem><para>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.ttl">ip-tunnel.ttl</option></term><listitem><para>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>macsec setting</title><para>MACSec Settings.</para><para> + Format: integer</para><para> + Valid values: 0 - 255</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.ttl">ip-tunnel.ttl</option></term><listitem><para>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</para><para> + Format: integer</para><para> + Valid values: 0 - 255</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>macsec setting</title><para>MACSec Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.macsec.encrypt">macsec.encrypt</option></term><listitem><para> Alias: encrypt</para><para>Whether the transmitted traffic must be encrypted.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.mka-cak">macsec.mka-cak</option></term><listitem><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.mka-cak">macsec.mka-cak</option></term><listitem><para> Alias: cak</para><para>The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.mka-cak-flags">macsec.mka-cak-flags</option></term><listitem><para>Flags indicating how to handle the "mka-cak" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.mka-ckn">macsec.mka-ckn</option></term><listitem><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.mka-ckn">macsec.mka-ckn</option></term><listitem><para> Alias: ckn</para><para>The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.mode">macsec.mode</option></term><listitem><para> Alias: mode</para><para>Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.parent">macsec.parent</option></term><listitem><para> + Format: choice (NMSettingMacsecMode)</para><para> + Valid values: psk (0), eap (1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.parent">macsec.parent</option></term><listitem><para> Alias: dev</para><para>If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.port">macsec.port</option></term><listitem><para> Alias: port</para><para>The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.send-sci">macsec.send-sci</option></term><listitem><para>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.validation">macsec.validation</option></term><listitem><para>Specifies the validation mode for incoming frames.</para><para> - Format: int32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>macvlan setting</title><para>MAC VLAN Settings.</para><para> + Format: integer</para><para> + Valid values: 1 - 65534</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.send-sci">macsec.send-sci</option></term><listitem><para>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.validation">macsec.validation</option></term><listitem><para>Specifies the validation mode for incoming frames.</para><para> + Format: choice (NMSettingMacsecValidation)</para><para> + Valid values: disable (0), check (1), strict (2)</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>macvlan setting</title><para>MAC VLAN Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.macvlan.mode">macvlan.mode</option></term><listitem><para> Alias: mode</para><para>The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macvlan.parent">macvlan.parent</option></term><listitem><para> + Format: choice (NMSettingMacvlanMode)</para><para> + Valid values: vepa (1), bridge (2), private (3), passthru (4), source (5)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macvlan.parent">macvlan.parent</option></term><listitem><para> Alias: dev</para><para>If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macvlan.promiscuous">macvlan.promiscuous</option></term><listitem><para>Whether the interface should be put in promiscuous mode.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macvlan.tap">macvlan.tap</option></term><listitem><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macvlan.tap">macvlan.tap</option></term><listitem><para> Alias: tap</para><para>Whether the interface should be a MACVTAP.</para><para> - Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>match setting</title><para>Match settings.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>match setting</title><para>Match settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.match.driver">match.driver</option></term><listitem><para>A list of driver names to match. Each element is a shell wildcard pattern.</para><para>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.interface-name">match.interface-name</option></term><listitem><para>A list of interface names to match. Each element is a shell wildcard pattern.</para><para>An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.kernel-command-line">match.kernel-command-line</option></term><listitem><para>A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported.</para><para>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.path">match.path</option></term><listitem><para>A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier.</para><para>For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0".</para><para>The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev").</para><para>Each element of the list is a shell wildcard pattern.</para><para>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</para><para> - Format: array of string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-11-olpc-mesh setting</title><para> + Format: list of strings</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.interface-name">match.interface-name</option></term><listitem><para>A list of interface names to match. Each element is a shell wildcard pattern.</para><para>An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".</para><para> + Format: list of strings</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.kernel-command-line">match.kernel-command-line</option></term><listitem><para>A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported.</para><para>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.</para><para> + Format: list of strings</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.path">match.path</option></term><listitem><para>A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier.</para><para>For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0".</para><para>The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev").</para><para>Each element of the list is a shell wildcard pattern.</para><para>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</para><para> + Format: list of strings</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-11-olpc-mesh setting</title><para> Alias: olpc-mesh</para><para>OLPC Wireless Mesh Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-11-olpc-mesh.channel">802-11-olpc-mesh.channel</option></term><listitem><para> Alias: channel</para><para>Channel on which the mesh network to join is located.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-olpc-mesh.dhcp-anycast-address">802-11-olpc-mesh.dhcp-anycast-address</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-olpc-mesh.dhcp-anycast-address">802-11-olpc-mesh.dhcp-anycast-address</option></term><listitem><para> Alias: dhcp-anycast</para><para>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.</para><para>This is currently only implemented by dhclient DHCP plugin.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-olpc-mesh.ssid">802-11-olpc-mesh.ssid</option></term><listitem><para> + Format: MAC address</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-olpc-mesh.ssid">802-11-olpc-mesh.ssid</option></term><listitem><para> Alias: ssid</para><para>SSID of the mesh network to join.</para><para> - Format: byte array</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-bridge setting</title><para>OvsBridge Link Settings.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-bridge setting</title><para>OvsBridge Link Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.datapath-type">ovs-bridge.datapath-type</option></term><listitem><para>The data path type. One of "system", "netdev" or empty.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.fail-mode">ovs-bridge.fail-mode</option></term><listitem><para>The bridge failure mode. One of "secure", "standalone" or empty.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.mcast-snooping-enable">ovs-bridge.mcast-snooping-enable</option></term><listitem><para>Enable or disable multicast snooping.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.rstp-enable">ovs-bridge.rstp-enable</option></term><listitem><para>Enable or disable RSTP.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.stp-enable">ovs-bridge.stp-enable</option></term><listitem><para>Enable or disable STP.</para><para> - Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-dpdk setting</title><para>OvsDpdk Link Settings.</para><para> + Format: string</para><para> + Valid values: system, netdev</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.fail-mode">ovs-bridge.fail-mode</option></term><listitem><para>The bridge failure mode. One of "secure", "standalone" or empty.</para><para> + Format: string</para><para> + Valid values: secure, standalone</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.mcast-snooping-enable">ovs-bridge.mcast-snooping-enable</option></term><listitem><para>Enable or disable multicast snooping.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.rstp-enable">ovs-bridge.rstp-enable</option></term><listitem><para>Enable or disable RSTP.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.stp-enable">ovs-bridge.stp-enable</option></term><listitem><para>Enable or disable STP.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-dpdk setting</title><para>OvsDpdk Link Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.devargs">ovs-dpdk.devargs</option></term><listitem><para>Open vSwitch DPDK device arguments.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.n-rxq">ovs-dpdk.n-rxq</option></term><listitem><para>Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.n-rxq-desc">ovs-dpdk.n-rxq-desc</option></term><listitem><para>The rx queue size (number of rx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.n-txq-desc">ovs-dpdk.n-txq-desc</option></term><listitem><para>The tx queue size (number of tx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-interface setting</title><para>Open vSwitch Interface Settings.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.n-rxq-desc">ovs-dpdk.n-rxq-desc</option></term><listitem><para>The rx queue size (number of rx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.</para><para> + Format: integer</para><para> + Valid values: 0 - 4096</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.n-txq-desc">ovs-dpdk.n-txq-desc</option></term><listitem><para>The tx queue size (number of tx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.</para><para> + Format: integer</para><para> + Valid values: 0 - 4096</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-interface setting</title><para>Open vSwitch Interface Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-interface.ofport-request">ovs-interface.ofport-request</option></term><listitem><para>Open vSwitch openflow port number. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network. OpenFlow switches connect logically to each other via their OpenFlow ports.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-interface.type">ovs-interface.type</option></term><listitem><para>The interface type. Either "internal", "system", "patch", "dpdk", or empty.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-patch setting</title><para>OvsPatch Link Settings.</para><para> + Format: integer</para><para> + Valid values: 0 - 65279</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-interface.type">ovs-interface.type</option></term><listitem><para>The interface type. Either "internal", "system", "patch", "dpdk", or empty.</para><para> + Format: string</para><para> + Valid values: internal, system, patch, dpdk</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-patch setting</title><para>OvsPatch Link Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-patch.peer">ovs-patch.peer</option></term><listitem><para>Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.</para><para> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-port setting</title><para>OvsPort Link Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.bond-downdelay">ovs-port.bond-downdelay</option></term><listitem><para>The time port must be inactive in order to be considered down.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.bond-mode">ovs-port.bond-mode</option></term><listitem><para>Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.bond-updelay">ovs-port.bond-updelay</option></term><listitem><para>The time port must be active before it starts forwarding traffic.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.lacp">ovs-port.lacp</option></term><listitem><para>LACP mode. One of "active", "off", or "passive".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.tag">ovs-port.tag</option></term><listitem><para>The VLAN tag in the range 0-4095.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.trunks">ovs-port.trunks</option></term><listitem><para>A list of VLAN ranges that this port trunks.</para><para>The property is valid only for ports with mode "trunk", "native-tagged", or "native-untagged port". If it is empty, the port trunks all VLANs.</para><para> - Format: array of vardict</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.vlan-mode">ovs-port.vlan-mode</option></term><listitem><para>The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ppp setting</title><para>Point-to-Point Protocol Settings.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.bond-mode">ovs-port.bond-mode</option></term><listitem><para>Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</para><para> + Format: string</para><para> + Valid values: active-backup, balance-slb, balance-tcp</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.bond-updelay">ovs-port.bond-updelay</option></term><listitem><para>The time port must be active before it starts forwarding traffic.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.lacp">ovs-port.lacp</option></term><listitem><para>LACP mode. One of "active", "off", or "passive".</para><para> + Format: string</para><para> + Valid values: active, off, passive</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.tag">ovs-port.tag</option></term><listitem><para>The VLAN tag in the range 0-4095.</para><para> + Format: integer</para><para> + Valid values: 0 - 4095</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.trunks">ovs-port.trunks</option></term><listitem><para>A list of VLAN ranges that this port trunks.</para><para>The property is valid only for ports with mode "trunk", "native-tagged", or "native-untagged port". If it is empty, the port trunks all VLANs.</para><para> + Format: list of ovs-port.trunks objects</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.vlan-mode">ovs-port.vlan-mode</option></term><listitem><para>The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.</para><para> + Format: string</para><para> + Valid values: access, native-tagged, native-untagged, trunk, dot1q-tunnel</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ppp setting</title><para>Point-to-Point Protocol Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ppp.baud">ppp.baud</option></term><listitem><para>If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.crtscts">ppp.crtscts</option></term><listitem><para>If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.lcp-echo-failure">ppp.lcp-echo-failure</option></term><listitem><para>If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.lcp-echo-interval">ppp.lcp-echo-interval</option></term><listitem><para>If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mppe-stateful">ppp.mppe-stateful</option></term><listitem><para>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mru">ppp.mru</option></term><listitem><para>If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mtu">ppp.mtu</option></term><listitem><para>If non-zero, instruct pppd to send packets no larger than the specified size.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.no-vj-comp">ppp.no-vj-comp</option></term><listitem><para>If TRUE, Van Jacobsen TCP header compression will not be requested.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.noauth">ppp.noauth</option></term><listitem><para>If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.nobsdcomp">ppp.nobsdcomp</option></term><listitem><para>If TRUE, BSD compression will not be requested.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.nodeflate">ppp.nodeflate</option></term><listitem><para>If TRUE, "deflate" compression will not be requested.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-chap">ppp.refuse-chap</option></term><listitem><para>If TRUE, the CHAP authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-eap">ppp.refuse-eap</option></term><listitem><para>If TRUE, the EAP authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-mschap">ppp.refuse-mschap</option></term><listitem><para>If TRUE, the MSCHAP authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-mschapv2">ppp.refuse-mschapv2</option></term><listitem><para>If TRUE, the MSCHAPv2 authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-pap">ppp.refuse-pap</option></term><listitem><para>If TRUE, the PAP authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.require-mppe">ppp.require-mppe</option></term><listitem><para>If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.require-mppe-128">ppp.require-mppe-128</option></term><listitem><para>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</para><para> - Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>pppoe setting</title><para>PPP-over-Ethernet Settings.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.crtscts">ppp.crtscts</option></term><listitem><para>If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.lcp-echo-failure">ppp.lcp-echo-failure</option></term><listitem><para>If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.lcp-echo-interval">ppp.lcp-echo-interval</option></term><listitem><para>If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mppe-stateful">ppp.mppe-stateful</option></term><listitem><para>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mru">ppp.mru</option></term><listitem><para>If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</para><para> + Format: integer</para><para> + Valid values: 0 - 16384</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mtu">ppp.mtu</option></term><listitem><para>If non-zero, instruct pppd to send packets no larger than the specified size.</para><para> + Format: integer</para><para> + Special values: auto</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.no-vj-comp">ppp.no-vj-comp</option></term><listitem><para>If TRUE, Van Jacobsen TCP header compression will not be requested.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.noauth">ppp.noauth</option></term><listitem><para>If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.nobsdcomp">ppp.nobsdcomp</option></term><listitem><para>If TRUE, BSD compression will not be requested.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.nodeflate">ppp.nodeflate</option></term><listitem><para>If TRUE, "deflate" compression will not be requested.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-chap">ppp.refuse-chap</option></term><listitem><para>If TRUE, the CHAP authentication method will not be used.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-eap">ppp.refuse-eap</option></term><listitem><para>If TRUE, the EAP authentication method will not be used.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-mschap">ppp.refuse-mschap</option></term><listitem><para>If TRUE, the MSCHAP authentication method will not be used.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-mschapv2">ppp.refuse-mschapv2</option></term><listitem><para>If TRUE, the MSCHAPv2 authentication method will not be used.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-pap">ppp.refuse-pap</option></term><listitem><para>If TRUE, the PAP authentication method will not be used.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.require-mppe">ppp.require-mppe</option></term><listitem><para>If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.require-mppe-128">ppp.require-mppe-128</option></term><listitem><para>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>pppoe setting</title><para>PPP-over-Ethernet Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.parent">pppoe.parent</option></term><listitem><para> Alias: parent</para><para>If given, specifies the parent interface name on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.password">pppoe.password</option></term><listitem><para> Alias: password</para><para>Password used to authenticate with the PPPoE service.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.password-flags">pppoe.password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.service">pppoe.service</option></term><listitem><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.service">pppoe.service</option></term><listitem><para> Alias: service</para><para>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.username">pppoe.username</option></term><listitem><para> Alias: username</para><para>Username used to authenticate with the PPPoE service.</para><para> @@ -701,25 +1057,34 @@ Example: <literal>priority 5 from 1:2:3::5/128 table 45</literal> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.proxy.browser-only">proxy.browser-only</option></term><listitem><para> Alias: browser-only</para><para>Whether the proxy configuration is for browser only.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.proxy.method">proxy.method</option></term><listitem><para> - Alias: method</para><para>Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.proxy.pac-script">proxy.pac-script</option></term><listitem><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.proxy.method">proxy.method</option></term><listitem><para> + Alias: method</para><para>Method for proxy configuration, Default is "none" (0)</para><para> + Format: choice (NMSettingProxyMethod)</para><para> + Valid values: none (0), auto (1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.proxy.pac-script">proxy.pac-script</option></term><listitem><para> Alias: pac-script</para><para>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.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.proxy.pac-url">proxy.pac-url</option></term><listitem><para> Alias: pac-url</para><para>PAC URL for obtaining PAC file.</para><para> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>serial setting</title><para>Serial Link Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.serial.baud">serial.baud</option></term><listitem><para>Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.bits">serial.bits</option></term><listitem><para>Byte-width of the serial communication. The 8 in "8n1" for example.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.parity">serial.parity</option></term><listitem><para>Parity setting of the serial port.</para><para> - Format: NMSettingSerialParity (byte)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.send-delay">serial.send-delay</option></term><listitem><para>Time to delay between each byte sent to the modem, in microseconds.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.stopbits">serial.stopbits</option></term><listitem><para>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>sriov setting</title><para>SR-IOV settings.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.bits">serial.bits</option></term><listitem><para>Byte-width of the serial communication. The 8 in "8n1" for example.</para><para> + Format: integer</para><para> + Valid values: 5 - 8</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.parity">serial.parity</option></term><listitem><para>Parity setting of the serial port.</para><para> + Format: choice (NMSettingSerialParity)</para><para> + Valid values: none/N/n (0), even/E/e (1), odd/O/o (2)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.send-delay">serial.send-delay</option></term><listitem><para>Time to delay between each byte sent to the modem, in microseconds.</para><para> + Format: integer</para><para> + Valid values: 0 - 18446744073709551615</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.stopbits">serial.stopbits</option></term><listitem><para>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</para><para> + Format: integer</para><para> + Valid values: 1 - 2</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>sriov setting</title><para>SR-IOV settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.sriov.autoprobe-drivers">sriov.autoprobe-drivers</option></term><listitem><para>Whether to autoprobe virtual functions by a compatible driver.</para><para>If set to NM_TERNARY_TRUE (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF.</para><para>If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them.</para><para>When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_TRUE (1).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.total-vfs">sriov.total-vfs</option></term><listitem><para>The total number of virtual functions to create.</para><para>Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.vfs">sriov.vfs</option></term><listitem><para>Array of virtual function descriptors.</para><para>Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF.</para><para>When represented as string a VF is in the form:</para><para>"INDEX [ATTR=VALUE[ ATTR=VALUE]...]".</para><para>for example:</para><para>"2 mac=00:11:22:33:44:55 spoof-check=true".</para><para>Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans.</para><para>The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form</para><para>"ID[.PRIORITY[.PROTO]]".</para><para>PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.</para><para> - Format: array of vardict</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>tc setting</title><para>Linux Traffic Control Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.sriov.autoprobe-drivers">sriov.autoprobe-drivers</option></term><listitem><para>Whether to autoprobe virtual functions by a compatible driver.</para><para>If set to "true" (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF.</para><para>If set to "false" (0), VFs will not be claimed and no network interfaces will be created for them.</para><para>When set to "default" (-1), the global default is used; in case the global default is unspecified it is assumed to be "true" (1).</para><para> + Format: ternary</para><para> + Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.total-vfs">sriov.total-vfs</option></term><listitem><para>The total number of virtual functions to create.</para><para>Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.vfs">sriov.vfs</option></term><listitem><para>Array of virtual function descriptors.</para><para>Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF.</para><para>When represented as string a VF is in the form:</para><para>"INDEX [ATTR=VALUE[ ATTR=VALUE]...]".</para><para>for example:</para><para>"2 mac=00:11:22:33:44:55 spoof-check=true".</para><para>Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans.</para><para>The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form</para><para>"ID[.PRIORITY[.PROTO]]".</para><para>PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.</para><para> + Format: list of sriov.vfs objects</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>tc setting</title><para>Linux Traffic Control Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.tc.qdiscs">tc.qdiscs</option></term><listitem><para> Array of TC queueing disciplines. qdisc is a basic block in the @@ -983,7 +1348,7 @@ Linux traffic control subsystem </listitem> </varlistentry> </variablelist><para> - Format: GPtrArray(NMTCQdisc)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tc.tfilters">tc.tfilters</option></term><listitem><para> + Format: list of tc.qdiscs objects</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tc.tfilters">tc.tfilters</option></term><listitem><para> Array of TC traffic filters. Traffic control can manage the packet content during classification by using filters. </para><para> @@ -1074,240 +1439,358 @@ Linux traffic control subsystem </listitem> </varlistentry> </variablelist><para> - Format: GPtrArray(NMTCTfilter)</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>team setting</title><para>Teaming Settings.</para><para> + Format: list of tc.tfilters objects</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>team setting</title><para>Teaming Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.team.config">team.config</option></term><listitem><para> Alias: config</para><para>The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.link-watchers">team.link-watchers</option></term><listitem><para>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</para><para> - Format: array of vardict</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.mcast-rejoin-count">team.mcast-rejoin-count</option></term><listitem><para>Corresponds to the teamd mcast_rejoin.count.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.mcast-rejoin-interval">team.mcast-rejoin-interval</option></term><listitem><para>Corresponds to the teamd mcast_rejoin.interval.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.notify-peers-count">team.notify-peers-count</option></term><listitem><para>Corresponds to the teamd notify_peers.count.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.notify-peers-interval">team.notify-peers-interval</option></term><listitem><para>Corresponds to the teamd notify_peers.interval.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner">team.runner</option></term><listitem><para>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-active">team.runner-active</option></term><listitem><para>Corresponds to the teamd runner.active.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-agg-select-policy">team.runner-agg-select-policy</option></term><listitem><para>Corresponds to the teamd runner.agg_select_policy.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-fast-rate">team.runner-fast-rate</option></term><listitem><para>Corresponds to the teamd runner.fast_rate.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-hwaddr-policy">team.runner-hwaddr-policy</option></term><listitem><para>Corresponds to the teamd runner.hwaddr_policy.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-min-ports">team.runner-min-ports</option></term><listitem><para>Corresponds to the teamd runner.min_ports.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-sys-prio">team.runner-sys-prio</option></term><listitem><para>Corresponds to the teamd runner.sys_prio.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-balancer">team.runner-tx-balancer</option></term><listitem><para>Corresponds to the teamd runner.tx_balancer.name.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-balancer-interval">team.runner-tx-balancer-interval</option></term><listitem><para>Corresponds to the teamd runner.tx_balancer.interval.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-hash">team.runner-tx-hash</option></term><listitem><para>Corresponds to the teamd runner.tx_hash.</para><para> - Format: array of string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>team-port setting</title><para>Team Port Settings.</para><para> + Format: list of team.link-watchers objects</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.mcast-rejoin-count">team.mcast-rejoin-count</option></term><listitem><para>Corresponds to the teamd mcast_rejoin.count.</para><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para><para> + Special values: unset (-1), disabled (0)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.mcast-rejoin-interval">team.mcast-rejoin-interval</option></term><listitem><para>Corresponds to the teamd mcast_rejoin.interval.</para><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para><para> + Special values: unset (-1), default (0)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.notify-peers-count">team.notify-peers-count</option></term><listitem><para>Corresponds to the teamd notify_peers.count.</para><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para><para> + Special values: unset (-1), disabled (0)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.notify-peers-interval">team.notify-peers-interval</option></term><listitem><para>Corresponds to the teamd notify_peers.interval.</para><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para><para> + Special values: unset (-1), default (0)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner">team.runner</option></term><listitem><para>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</para><para> + Format: string</para><para> + Valid values: broadcast, roundrobin, random, activebackup, loadbalance, lacp</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-active">team.runner-active</option></term><listitem><para>Corresponds to the teamd runner.active.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-agg-select-policy">team.runner-agg-select-policy</option></term><listitem><para>Corresponds to the teamd runner.agg_select_policy.</para><para> + Format: string</para><para> + Valid values: lacp_prio, lacp_prio_stable, bandwidth, count, port_config</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-fast-rate">team.runner-fast-rate</option></term><listitem><para>Corresponds to the teamd runner.fast_rate.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-hwaddr-policy">team.runner-hwaddr-policy</option></term><listitem><para>Corresponds to the teamd runner.hwaddr_policy.</para><para> + Format: string</para><para> + Valid values: same_all, by_active, only_active</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-min-ports">team.runner-min-ports</option></term><listitem><para>Corresponds to the teamd runner.min_ports.</para><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para><para> + Special values: unset (-1), default (1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-sys-prio">team.runner-sys-prio</option></term><listitem><para>Corresponds to the teamd runner.sys_prio.</para><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para><para> + Special values: unset (-1), default (65535)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-balancer">team.runner-tx-balancer</option></term><listitem><para>Corresponds to the teamd runner.tx_balancer.name.</para><para> + Format: string</para><para> + Valid values: basic</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-balancer-interval">team.runner-tx-balancer-interval</option></term><listitem><para>Corresponds to the teamd runner.tx_balancer.interval.</para><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para><para> + Special values: unset (-1), default (50)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-hash">team.runner-tx-hash</option></term><listitem><para>Corresponds to the teamd runner.tx_hash.</para><para> + Format: list of strings</para><para> + Valid values: eth, vlan, ipv4, ipv6, ip, l3, tcp, udp, sctp, l4</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>team-port setting</title><para>Team Port Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.team-port.config">team-port.config</option></term><listitem><para> Alias: config</para><para>The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.lacp-key">team-port.lacp-key</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.lacp_key.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.lacp-prio">team-port.lacp-prio</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.link-watchers">team-port.link-watchers</option></term><listitem><para>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</para><para> - Format: array of vardict</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.prio">team-port.prio</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.prio.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.queue-id">team-port.queue-id</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.sticky">team-port.sticky</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.sticky.</para><para> - Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>tun setting</title><para>Tunnel Settings.</para><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para><para> + Special values: unset (-1), default (0)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.lacp-prio">team-port.lacp-prio</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</para><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para><para> + Special values: unset (-1), default (255)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.link-watchers">team-port.link-watchers</option></term><listitem><para>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</para><para> + Format: list of team-port.link-watchers objects</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.prio">team-port.prio</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.prio.</para><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para><para> + Special values: unset (0), default (0)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.queue-id">team-port.queue-id</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</para><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para><para> + Special values: unset (-1), default (0)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.sticky">team-port.sticky</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.sticky.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>tun setting</title><para>Tunnel Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.tun.group">tun.group</option></term><listitem><para> Alias: group</para><para>The group ID which will own the device. If set to NULL everyone will be able to use the device.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tun.mode">tun.mode</option></term><listitem><para> - Alias: mode</para><para>The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tun.multi-queue">tun.multi-queue</option></term><listitem><para> + Alias: mode</para><para>The operating mode of the virtual device. Allowed values are "tun" (1) to create a layer 3 device and "tap" (2) to create an Ethernet-like layer 2 one.</para><para> + Format: choice (NMSettingTunMode)</para><para> + Valid values: tun (1), tap (2)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tun.multi-queue">tun.multi-queue</option></term><listitem><para> Alias: multi-queue</para><para>If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tun.owner">tun.owner</option></term><listitem><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tun.owner">tun.owner</option></term><listitem><para> Alias: owner</para><para>The user ID which will own the device. If set to NULL everyone will be able to use the device.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tun.pi">tun.pi</option></term><listitem><para> Alias: pi</para><para>If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tun.vnet-hdr">tun.vnet-hdr</option></term><listitem><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tun.vnet-hdr">tun.vnet-hdr</option></term><listitem><para> Alias: vnet-hdr</para><para>If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</para><para> - Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vlan setting</title><para>VLAN Settings.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vlan setting</title><para>VLAN Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.vlan.egress-priority-map">vlan.egress-priority-map</option></term><listitem><para> Alias: egress</para><para>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.flags">vlan.flags</option></term><listitem><para> - Alias: flags</para><para>One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol).</para><para>The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.</para><para> - Format: NMVlanFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.id">vlan.id</option></term><listitem><para> + Format: list of vlan.egress-priority-map objects</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.flags">vlan.flags</option></term><listitem><para> + Alias: flags</para><para>One or more flags which control the behavior and features of the VLAN interface. Flags include "reorder-headers" (0x1) (reordering of output packet headers), "gvrp" (0x2) (use of the GVRP protocol), and "loose-binding" (0x4) (loose binding of the interface to its master device's operating state). "mvrp" (0x8) (use of the MVRP protocol).</para><para>The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.</para><para> + Format: flags (NMVlanFlags)</para><para> + Valid values: reorder-headers (0x1), gvrp (0x2), loose-binding (0x4), mvrp (0x8)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.id">vlan.id</option></term><listitem><para> Alias: id</para><para>The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.ingress-priority-map">vlan.ingress-priority-map</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4095</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.ingress-priority-map">vlan.ingress-priority-map</option></term><listitem><para> Alias: ingress</para><para>For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.parent">vlan.parent</option></term><listitem><para> + Format: list of vlan.ingress-priority-map objects</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.parent">vlan.parent</option></term><listitem><para> Alias: dev</para><para>If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.protocol">vlan.protocol</option></term><listitem><para>Specifies the VLAN protocol to use for encapsulation.</para><para>Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vpn setting</title><para>VPN Settings.</para><para> + Format: string</para><para> + Valid values: 802.1Q, 802.1ad</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vpn setting</title><para>VPN Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.vpn.data">vpn.data</option></term><listitem><para>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</para><para> - Format: dict of string to string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.persistent">vpn.persistent</option></term><listitem><para>If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.secrets">vpn.secrets</option></term><listitem><para>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</para><para> - Format: dict of string to string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.service-type">vpn.service-type</option></term><listitem><para> + Format: list of key/value options</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.persistent">vpn.persistent</option></term><listitem><para>If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.secrets">vpn.secrets</option></term><listitem><para>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</para><para> + Format: list of key/value options</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.service-type">vpn.service-type</option></term><listitem><para> Alias: vpn-type</para><para>D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.timeout">vpn.timeout</option></term><listitem><para>Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.user-name">vpn.user-name</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.user-name">vpn.user-name</option></term><listitem><para> Alias: user</para><para>If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.</para><para> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vrf setting</title><para>VRF settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.vrf.table">vrf.table</option></term><listitem><para> Alias: table</para><para>The routing table for this VRF.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vxlan setting</title><para>VXLAN Settings.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vxlan setting</title><para>VXLAN Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.ageing">vxlan.ageing</option></term><listitem><para>Specifies the lifetime in seconds of FDB entries learnt by the kernel.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.destination-port">vxlan.destination-port</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.destination-port">vxlan.destination-port</option></term><listitem><para> Alias: destination-port</para><para>Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.id">vxlan.id</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 65535</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.id">vxlan.id</option></term><listitem><para> Alias: id</para><para>Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.l2-miss">vxlan.l2-miss</option></term><listitem><para>Specifies whether netlink LL ADDR miss notifications are generated.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.l3-miss">vxlan.l3-miss</option></term><listitem><para>Specifies whether netlink IP ADDR miss notifications are generated.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.learning">vxlan.learning</option></term><listitem><para>Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.limit">vxlan.limit</option></term><listitem><para>Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.local">vxlan.local</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 16777215</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.l2-miss">vxlan.l2-miss</option></term><listitem><para>Specifies whether netlink LL ADDR miss notifications are generated.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.l3-miss">vxlan.l3-miss</option></term><listitem><para>Specifies whether netlink IP ADDR miss notifications are generated.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.learning">vxlan.learning</option></term><listitem><para>Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.limit">vxlan.limit</option></term><listitem><para>Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.local">vxlan.local</option></term><listitem><para> Alias: local</para><para>If given, specifies the source IP address to use in outgoing packets.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.parent">vxlan.parent</option></term><listitem><para> Alias: dev</para><para>If given, specifies the parent interface name or parent connection UUID.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.proxy">vxlan.proxy</option></term><listitem><para>Specifies whether ARP proxy is turned on.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.remote">vxlan.remote</option></term><listitem><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.remote">vxlan.remote</option></term><listitem><para> Alias: remote</para><para>Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.rsc">vxlan.rsc</option></term><listitem><para>Specifies whether route short circuit is turned on.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.source-port-max">vxlan.source-port-max</option></term><listitem><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.source-port-max">vxlan.source-port-max</option></term><listitem><para> Alias: source-port-max</para><para>Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.source-port-min">vxlan.source-port-min</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 65535</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.source-port-min">vxlan.source-port-min</option></term><listitem><para> Alias: source-port-min</para><para>Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.tos">vxlan.tos</option></term><listitem><para>Specifies the TOS value to use in outgoing packets.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.ttl">vxlan.ttl</option></term><listitem><para>Specifies the time-to-live value to use in outgoing packets.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wifi-p2p setting</title><para>Wi-Fi P2P Settings.</para><para> + Format: integer</para><para> + Valid values: 0 - 65535</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.tos">vxlan.tos</option></term><listitem><para>Specifies the TOS value to use in outgoing packets.</para><para> + Format: integer</para><para> + Valid values: 0 - 255</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.ttl">vxlan.ttl</option></term><listitem><para>Specifies the time-to-live value to use in outgoing packets.</para><para> + Format: integer</para><para> + Valid values: 0 - 255</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wifi-p2p setting</title><para>Wi-Fi P2P Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.wifi-p2p.peer">wifi-p2p.peer</option></term><listitem><para> Alias: peer</para><para>The P2P device that should be connected to. Currently, this is the only way to create or join a group.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wifi-p2p.wfd-ies">wifi-p2p.wfd-ies</option></term><listitem><para>The Wi-Fi Display (WFD) Information Elements (IEs) to set.</para><para>Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wifi-p2p.wps-method">wifi-p2p.wps-method</option></term><listitem><para>Flags indicating which mode of WPS is to be used.</para><para>There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wimax setting</title><para>WiMax Settings.</para><para> + Format: MAC address</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wifi-p2p.wfd-ies">wifi-p2p.wfd-ies</option></term><listitem><para>The Wi-Fi Display (WFD) Information Elements (IEs) to set.</para><para>Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.</para><para> + Format: bytes</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wifi-p2p.wps-method">wifi-p2p.wps-method</option></term><listitem><para>Flags indicating which mode of WPS is to be used.</para><para>There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.</para><para> + Format: flags (NMSettingWirelessSecurityWpsMethod)</para><para> + Valid values: default (0x0), disabled (0x1), auto (0x2), pbc (0x4), pin (0x8)</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wimax setting</title><para>WiMax Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.wimax.mac-address">wimax.mac-address</option></term><listitem><para> Alias: mac</para><para>If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing).</para><para> This property is deprecated since version 1.2. WiMAX is no longer supported.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wimax.network-name">wimax.network-name</option></term><listitem><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wimax.network-name">wimax.network-name</option></term><listitem><para> Alias: nsp</para><para>Network Service Provider (NSP) name of the WiMAX network this connection should use.</para><para> This property is deprecated since version 1.2. WiMAX is no longer supported.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-3-ethernet setting</title><para> + Format: MAC address</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-3-ethernet setting</title><para> Alias: ethernet</para><para>Wired Ethernet Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.accept-all-mac-addresses">802-3-ethernet.accept-all-mac-addresses</option></term><listitem><para>When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.auto-negotiate">802-3-ethernet.auto-negotiate</option></term><listitem><para>When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.cloned-mac-address">802-3-ethernet.cloned-mac-address</option></term><listitem><para> + Format: ternary</para><para> + Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.auto-negotiate">802-3-ethernet.auto-negotiate</option></term><listitem><para>When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.cloned-mac-address">802-3-ethernet.cloned-mac-address</option></term><listitem><para> Alias: cloned-mac</para><para>If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.</para><para>Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address if the device has one (otherwise this is treated as "preserve"). "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.</para><para>If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).</para><para>On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.duplex">802-3-ethernet.duplex</option></term><listitem><para>When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.generate-mac-address-mask">802-3-ethernet.generate-mac-address-mask</option></term><listitem><para>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.</para><para>If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.</para><para>If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.</para><para>If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.</para><para>If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</para><para> + Format: MAC address</para><para> + Special values: preserve, permanent, random, stable</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.duplex">802-3-ethernet.duplex</option></term><listitem><para>When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.</para><para> + Format: string</para><para> + Valid values: half, full</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.generate-mac-address-mask">802-3-ethernet.generate-mac-address-mask</option></term><listitem><para>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.</para><para>If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.</para><para>If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.</para><para>If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.</para><para>If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.mac-address">802-3-ethernet.mac-address</option></term><listitem><para> Alias: mac</para><para>If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.mac-address-blacklist">802-3-ethernet.mac-address-blacklist</option></term><listitem><para>If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.mtu">802-3-ethernet.mtu</option></term><listitem><para> + Format: MAC address</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.mac-address-blacklist">802-3-ethernet.mac-address-blacklist</option></term><listitem><para>If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</para><para> + Format: list of MAC addresses</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.mtu">802-3-ethernet.mtu</option></term><listitem><para> Alias: mtu</para><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.port">802-3-ethernet.port</option></term><listitem><para>Specific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-nettype">802-3-ethernet.s390-nettype</option></term><listitem><para>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-options">802-3-ethernet.s390-options</option></term><listitem><para>Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</para><para>Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.</para><para> - Format: dict of string to string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-subchannels">802-3-ethernet.s390-subchannels</option></term><listitem><para>Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.speed">802-3-ethernet.speed</option></term><listitem><para>When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan">802-3-ethernet.wake-on-lan</option></term><listitem><para>The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan-password">802-3-ethernet.wake-on-lan-password</option></term><listitem><para>If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.</para><para> - Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wireguard setting</title><para>WireGuard Settings.</para><para> + Format: integer</para><para> + Special values: auto</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.port">802-3-ethernet.port</option></term><listitem><para>Specific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.</para><para> + Format: read only</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-nettype">802-3-ethernet.s390-nettype</option></term><listitem><para>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</para><para> + Format: string</para><para> + Valid values: qeth, lcs, ctc</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-options">802-3-ethernet.s390-options</option></term><listitem><para>Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</para><para>Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.</para><para> + Format: list of key/value options</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-subchannels">802-3-ethernet.s390-subchannels</option></term><listitem><para>Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</para><para> + Format: list of 802-3-ethernet.s390-subchannels objects</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.speed">802-3-ethernet.speed</option></term><listitem><para>When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan">802-3-ethernet.wake-on-lan</option></term><listitem><para>The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of "phy" (0x2), "unicast" (0x4), "multicast" (0x8), "broadcast" (0x10), "arp" (0x20), "magic" (0x40) or the special values "default" (0x1) (to use global settings) and "ignore" (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</para><para> + Format: flags (NMSettingWiredWakeOnLan)</para><para> + Valid values: phy (0x2), unicast (0x4), multicast (0x8), broadcast (0x10), arp (0x20), magic (0x40), default (0x1), ignore (0x8000)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan-password">802-3-ethernet.wake-on-lan-password</option></term><listitem><para>If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.</para><para> + Format: MAC address</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wireguard setting</title><para>WireGuard Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.fwmark">wireguard.fwmark</option></term><listitem><para>The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets.</para><para>Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.ip4-auto-default-route">wireguard.ip4-auto-default-route</option></term><listitem><para>Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing".</para><para>Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route.</para><para>Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.ip6-auto-default-route">wireguard.ip6-auto-default-route</option></term><listitem><para>Like ip4-auto-default-route, but for the IPv6 default route.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.listen-port">wireguard.listen-port</option></term><listitem><para>The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.mtu">wireguard.mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para><para>If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.peer-routes">wireguard.peer-routes</option></term><listitem><para>Whether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively.</para><para>Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.private-key">wireguard.private-key</option></term><listitem><para>The 256 bit private-key in base64 encoding.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.ip4-auto-default-route">wireguard.ip4-auto-default-route</option></term><listitem><para>Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing".</para><para>Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route.</para><para>Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.</para><para> + Format: ternary</para><para> + Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.ip6-auto-default-route">wireguard.ip6-auto-default-route</option></term><listitem><para>Like ip4-auto-default-route, but for the IPv6 default route.</para><para> + Format: ternary</para><para> + Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.listen-port">wireguard.listen-port</option></term><listitem><para>The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</para><para> + Format: integer</para><para> + Valid values: 0 - 65535</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.mtu">wireguard.mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para><para>If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.</para><para> + Format: integer</para><para> + Special values: auto</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.peer-routes">wireguard.peer-routes</option></term><listitem><para>Whether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively.</para><para>Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.private-key">wireguard.private-key</option></term><listitem><para>The 256 bit private-key in base64 encoding.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.private-key-flags">wireguard.private-key-flags</option></term><listitem><para>Flags indicating how to handle the "private-key" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-11-wireless setting</title><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-11-wireless setting</title><para> Alias: wifi</para><para>Wi-Fi Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.ap-isolation">802-11-wireless.ap-isolation</option></term><listitem><para>Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode.</para><para>If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.</para><para>If set to NM_TERNARY_FALSE (0), devices can talk to each other.</para><para>When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_FALSE (0).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.band">802-11-wireless.band</option></term><listitem><para>802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.bssid">802-11-wireless.bssid</option></term><listitem><para>If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.</para><para>Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.channel">802-11-wireless.channel</option></term><listitem><para>Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.cloned-mac-address">802-11-wireless.cloned-mac-address</option></term><listitem><para> - Alias: cloned-mac</para><para>If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.</para><para>Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.</para><para>If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).</para><para>On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.generate-mac-address-mask">802-11-wireless.generate-mac-address-mask</option></term><listitem><para>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.</para><para>If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.</para><para>If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.</para><para>If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.</para><para>If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.ap-isolation">802-11-wireless.ap-isolation</option></term><listitem><para>Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from "default" (-1) only when the interface is configured in AP mode.</para><para>If set to "true" (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.</para><para>If set to "false" (0), devices can talk to each other.</para><para>When set to "default" (-1), the global default is used; in case the global default is unspecified it is assumed to be "false" (0).</para><para> + Format: ternary</para><para> + Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.band">802-11-wireless.band</option></term><listitem><para>802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</para><para> + Format: string</para><para> + Valid values: a, bg</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.bssid">802-11-wireless.bssid</option></term><listitem><para>If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.</para><para>Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.</para><para> + Format: MAC address</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.channel">802-11-wireless.channel</option></term><listitem><para>Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.</para><para> + Format: integer</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.cloned-mac-address">802-11-wireless.cloned-mac-address</option></term><listitem><para> + Alias: cloned-mac</para><para>If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.</para><para>Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random", "stable" and "stable-ssid" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key. "stable-ssid" creates a hashed MAC address based on the SSID, the same as setting the stable-id to "${NETWORK_SSID}".</para><para>If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).</para><para>On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</para><para> + Format: MAC address</para><para> + Special values: preserve, permanent, random, stable, stable-ssid</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.generate-mac-address-mask">802-11-wireless.generate-mac-address-mask</option></term><listitem><para>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.</para><para>If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.</para><para>If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.</para><para>If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.</para><para>If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.hidden">802-11-wireless.hidden</option></term><listitem><para>If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.</para><para>In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.</para><para>In AP mode, the created network does not broadcast its SSID.</para><para>Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mac-address">802-11-wireless.mac-address</option></term><listitem><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mac-address">802-11-wireless.mac-address</option></term><listitem><para> Alias: mac</para><para>If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mac-address-blacklist">802-11-wireless.mac-address-blacklist</option></term><listitem><para>A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mac-address-randomization">802-11-wireless.mac-address-randomization</option></term><listitem><para>One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address).</para><para> + Format: MAC address</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mac-address-blacklist">802-11-wireless.mac-address-blacklist</option></term><listitem><para>A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</para><para> + Format: list of MAC addresses</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mac-address-randomization">802-11-wireless.mac-address-randomization</option></term><listitem><para>One of "default" (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), "never" (1) (never randomize the MAC address), or "always" (2) (always randomize the MAC address).</para><para> This property is deprecated since version 1.4. Use the "cloned-mac-address" property instead.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mode">802-11-wireless.mode</option></term><listitem><para> + Format: choice (NMSettingMacRandomization)</para><para> + Valid values: default (0), never (1), always (2)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mode">802-11-wireless.mode</option></term><listitem><para> Alias: mode</para><para>Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mtu">802-11-wireless.mtu</option></term><listitem><para> + Format: string</para><para> + Valid values: infrastructure, adhoc, ap, mesh</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mtu">802-11-wireless.mtu</option></term><listitem><para> Alias: mtu</para><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.powersave">802-11-wireless.powersave</option></term><listitem><para>One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.seen-bssids">802-11-wireless.seen-bssids</option></term><listitem><para>A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</para><para>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.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.ssid">802-11-wireless.ssid</option></term><listitem><para> + Format: integer</para><para> + Special values: auto</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.powersave">802-11-wireless.powersave</option></term><listitem><para>One of "disable" (2) (disable Wi-Fi power saving), "enable" (3) (enable Wi-Fi power saving), "ignore" (1) (don't touch currently configure setting) or "default" (0) (use the globally configured value). All other values are reserved.</para><para> + Format: choice (NMSettingWirelessPowersave)</para><para> + Valid values: default (0), ignore (1), disable (2), enable (3)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.seen-bssids">802-11-wireless.seen-bssids</option></term><listitem><para>A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</para><para>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.</para><para> + Format: read only</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.ssid">802-11-wireless.ssid</option></term><listitem><para> Alias: ssid</para><para>SSID of the Wi-Fi network. Must be specified.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.wake-on-wlan">802-11-wireless.wake-on-wlan</option></term><listitem><para>The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-11-wireless-security setting</title><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.wake-on-wlan">802-11-wireless.wake-on-wlan</option></term><listitem><para>The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of "any" (0x2), "disconnect" (0x4), "magic" (0x8), "gtk-rekey-failure" (0x10), "eap-identity-request" (0x20), "4way-handshake" (0x40), "rfkill-release" (0x80), "tcp" (0x100) or the special values "default" (0x1) (to use global settings) and "ignore" (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</para><para> + Format: flags (NMSettingWirelessWakeOnWLan)</para><para> + Valid values: any (0x2), disconnect (0x4), magic (0x8), gtk-rekey-failure (0x10), eap-identity-request (0x20), 4way-handshake (0x40), rfkill-release (0x80), tcp (0x100), all (0x1fe), default (0x1), ignore (0x8000)</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-11-wireless-security setting</title><para> Alias: wifi-sec</para><para>Wi-Fi Security Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.auth-alg">802-11-wireless-security.auth-alg</option></term><listitem><para>When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.fils">802-11-wireless-security.fils</option></term><listitem><para>Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.group">802-11-wireless-security.group</option></term><listitem><para>A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.key-mgmt">802-11-wireless-security.key-mgmt</option></term><listitem><para>Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only).</para><para>This property must be set for any Wi-Fi connection that uses security.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.leap-password">802-11-wireless-security.leap-password</option></term><listitem><para>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</para><para> + Format: string</para><para> + Valid values: open, shared, leap</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.fils">802-11-wireless-security.fils</option></term><listitem><para>Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of "default" (0) (use global default value), "disable" (1) (disable FILS), "optional" (2) (enable FILS if the supplicant and the access point support it) or "required" (3) (enable FILS and fail if not supported). When set to "default" (0) and no global default is set, FILS will be optionally enabled.</para><para> + Format: choice (NMSettingWirelessSecurityFils)</para><para> + Valid values: default (0), disable (1), optional (2), required (3)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.group">802-11-wireless-security.group</option></term><listitem><para>A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".</para><para> + Format: list of strings</para><para> + Valid values: wep40, wep104, tkip, ccmp</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.key-mgmt">802-11-wireless-security.key-mgmt</option></term><listitem><para>Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only).</para><para>This property must be set for any Wi-Fi connection that uses security.</para><para> + Format: string</para><para> + Valid values: none, ieee8021x, wpa-psk, wpa-eap, wpa-eap-suite-b-192, sae, owe</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.leap-password">802-11-wireless-security.leap-password</option></term><listitem><para>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.leap-password-flags">802-11-wireless-security.leap-password-flags</option></term><listitem><para>Flags indicating how to handle the "leap-password" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.leap-username">802-11-wireless-security.leap-username</option></term><listitem><para>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</para><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.leap-username">802-11-wireless-security.leap-username</option></term><listitem><para>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.pairwise">802-11-wireless-security.pairwise</option></term><listitem><para>A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp".</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.pmf">802-11-wireless-security.pmf</option></term><listitem><para>Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.proto">802-11-wireless-security.proto</option></term><listitem><para>List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.psk">802-11-wireless-security.psk</option></term><listitem><para>Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.</para><para> + Format: list of strings</para><para> + Valid values: tkip, ccmp</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.pmf">802-11-wireless-security.pmf</option></term><listitem><para>Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of "default" (0) (use global default value), "disable" (1) (disable PMF), "optional" (2) (enable PMF if the supplicant and the access point support it) or "required" (3) (enable PMF and fail if not supported). When set to "default" (0) and no global default is set, PMF will be optionally enabled.</para><para> + Format: choice (NMSettingWirelessSecurityPmf)</para><para> + Valid values: default (0), disable (1), optional (2), required (3)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.proto">802-11-wireless-security.proto</option></term><listitem><para>List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.</para><para> + Format: list of strings</para><para> + Valid values: wpa, rsn</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.psk">802-11-wireless-security.psk</option></term><listitem><para>Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.psk-flags">802-11-wireless-security.psk-flags</option></term><listitem><para>Flags indicating how to handle the "psk" property.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key-flags">802-11-wireless-security.wep-key-flags</option></term><listitem><para>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</para><para> - See <xref linkend="secrets-flags"/> for flag values. - </para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key-type">802-11-wireless-security.wep-key-type</option></term><listitem><para>Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.</para><para> - Format: NMWepKeyType (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key0">802-11-wireless-security.wep-key0</option></term><listitem><para>Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.</para><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key-flags">802-11-wireless-security.wep-key-flags</option></term><listitem><para>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</para><para> + Format: flags (NMSettingSecretFlags)</para><para> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key-type">802-11-wireless-security.wep-key-type</option></term><listitem><para>Controls the interpretation of WEP keys. Allowed values are "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 "passphrase" (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.</para><para> + Format: choice (NMWepKeyType)</para><para> + Valid values: unknown (0), key (1), passphrase (2)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key0">802-11-wireless-security.wep-key0</option></term><listitem><para>Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key1">802-11-wireless-security.wep-key1</option></term><listitem><para>Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key2">802-11-wireless-security.wep-key2</option></term><listitem><para>Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key3">802-11-wireless-security.wep-key3</option></term><listitem><para>Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-tx-keyidx">802-11-wireless-security.wep-tx-keyidx</option></term><listitem><para>When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wps-method">802-11-wireless-security.wps-method</option></term><listitem><para>Flags indicating which mode of WPS is to be used if any.</para><para>There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities.</para><para>WPS can be disabled by setting this property to a value of 1.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wpan setting</title><para>IEEE 802.15.4 (WPAN) MAC Settings.</para><para> + Format: integer</para><para> + Valid values: 0 - 3</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wps-method">802-11-wireless-security.wps-method</option></term><listitem><para>Flags indicating which mode of WPS is to be used if any.</para><para>There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities.</para><para>WPS can be disabled by setting this property to a value of 1.</para><para> + Format: flags (NMSettingWirelessSecurityWpsMethod)</para><para> + Valid values: default (0x0), disabled (0x1), auto (0x2), pbc (0x4), pin (0x8)</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>wpan setting</title><para>IEEE 802.15.4 (WPAN) MAC Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.wpan.channel">wpan.channel</option></term><listitem><para> Alias: channel</para><para>IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wpan.mac-address">wpan.mac-address</option></term><listitem><para> + Format: integer</para><para> + Valid values: -32768 - 32767</para><para> + Special values: default (-1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wpan.mac-address">wpan.mac-address</option></term><listitem><para> Alias: mac</para><para>If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wpan.page">wpan.page</option></term><listitem><para> + Format: WPAN MAC address</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wpan.page">wpan.page</option></term><listitem><para> Alias: page</para><para>IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wpan.pan-id">wpan.pan-id</option></term><listitem><para> + Format: integer</para><para> + Valid values: -32768 - 32767</para><para> + Special values: default (-1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wpan.pan-id">wpan.pan-id</option></term><listitem><para> Alias: pan-id</para><para>IEEE 802.15.4 Personal Area Network (PAN) identifier.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wpan.short-address">wpan.short-address</option></term><listitem><para> + Format: integer</para><para> + Valid values: 0 - 65535</para><para> + Special values: unset (0xffff)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wpan.short-address">wpan.short-address</option></term><listitem><para> Alias: short-addr</para><para>Short IEEE 802.15.4 address to be used within a restricted environment.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bond-port setting</title><para>Bond Port Settings.</para><para> + Format: integer</para><para> + Valid values: 0 - 65535</para><para> + Special values: unset (0xffff)</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>bond-port setting</title><para>Bond Port Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bond-port.prio">bond-port.prio</option></term><listitem><para> Alias: prio</para><para>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.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bond-port.queue-id">bond-port.queue-id</option></term><listitem><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bond-port.queue-id">bond-port.queue-id</option></term><listitem><para> Alias: queue-id</para><para>The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>hostname setting</title><para>Hostname settings.</para><para> + Format: integer</para><para> + Valid values: 0 - 65535</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>hostname setting</title><para>Hostname settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.hostname.from-dhcp">hostname.from-dhcp</option></term><listitem><para>Whether the system hostname can be determined from DHCP on this connection.</para><para>When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.from-dns-lookup">hostname.from-dns-lookup</option></term><listitem><para>Whether the system hostname can be determined from reverse DNS lookup of addresses on this device.</para><para>When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.only-from-default">hostname.only-from-default</option></term><listitem><para>If set to NM_TERNARY_TRUE (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6).</para><para>If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route.</para><para>When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.priority">hostname.priority</option></term><listitem><para>The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority.</para><para>If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100.</para><para>Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.</para><para> - Format: int32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>link setting</title><para>Link settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.hostname.from-dhcp">hostname.from-dhcp</option></term><listitem><para>Whether the system hostname can be determined from DHCP on this connection.</para><para>When set to "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 "true" (1).</para><para> + Format: ternary</para><para> + Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.from-dns-lookup">hostname.from-dns-lookup</option></term><listitem><para>Whether the system hostname can be determined from reverse DNS lookup of addresses on this device.</para><para>When set to "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 "true" (1).</para><para> + Format: ternary</para><para> + Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.only-from-default">hostname.only-from-default</option></term><listitem><para>If set to "true" (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6).</para><para>If set to "false" (0), the hostname can be set from this device even if it doesn't have the default route.</para><para>When set to "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 "false" (0).</para><para> + Format: ternary</para><para> + Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.priority">hostname.priority</option></term><listitem><para>The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority.</para><para>If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100.</para><para>Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.</para><para> + Format: integer</para><para> + Valid values: -2147483648 - 2147483647</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>hsr setting</title><para>HSR/PRP Settings.</para><para> + Properties: + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.hsr.multicast-spec">hsr.multicast-spec</option></term><listitem><para> + Alias: multicast-spec</para><para>The last byte of supervision address.</para><para> + Format: integer</para><para> + Valid values: 0 - 255</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hsr.port1">hsr.port1</option></term><listitem><para> + Alias: port1</para><para>The port1 interface name of the HSR. This property is mandatory.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hsr.port2">hsr.port2</option></term><listitem><para> + Alias: port2</para><para>The port2 interface name of the HSR. This property is mandatory.</para><para> + Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hsr.prp">hsr.prp</option></term><listitem><para>The protocol used by the interface, whether it is PRP or HSR.</para><para> + Format: boolean</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>link setting</title><para>Link settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.link.gro-max-size">link.gro-max-size</option></term><listitem><para>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.</para><para> - Format: int64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.link.gso-max-segments">link.gso-max-segments</option></term><listitem><para>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.</para><para> - Format: int64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.link.gso-max-size">link.gso-max-size</option></term><listitem><para>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.</para><para> - Format: int64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.link.tx-queue-length">link.tx-queue-length</option></term><listitem><para>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.</para><para> - Format: int64</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>loopback setting</title><para>Loopback Link Settings.</para><para> + Format: integer</para><para> + Valid values: -1 - 4294967295</para><para> + Special values: default (-1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.link.gso-max-segments">link.gso-max-segments</option></term><listitem><para>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.</para><para> + Format: integer</para><para> + Valid values: -1 - 4294967295</para><para> + Special values: default (-1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.link.gso-max-size">link.gso-max-size</option></term><listitem><para>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.</para><para> + Format: integer</para><para> + Valid values: -1 - 4294967295</para><para> + Special values: default (-1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.link.tx-queue-length">link.tx-queue-length</option></term><listitem><para>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.</para><para> + Format: integer</para><para> + Valid values: -1 - 4294967295</para><para> + Special values: default (-1)</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>loopback setting</title><para>Loopback Link Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.loopback.mtu">loopback.mtu</option></term><listitem><para> Alias: mtu</para><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</para><para> - Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>veth setting</title><para>Veth Settings.</para><para> + Format: integer</para><para> + Special values: auto</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>veth setting</title><para>Veth Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.veth.peer">veth.peer</option></term><listitem><para> Alias: peer</para><para>This property specifies the peer interface name of the veth. This property is mandatory.</para><para> diff --git a/man/nm-settings-nmcli.xsl b/man/nm-settings-nmcli.xsl index 5817e8e2..794ee507 100644 --- a/man/nm-settings-nmcli.xsl +++ b/man/nm-settings-nmcli.xsl @@ -176,6 +176,16 @@ Format: <xsl:value-of select="@type"/> </para> </xsl:if> + <xsl:if test="@values"> + <para> + Valid values: <xsl:value-of select="@values"/> + </para> + </xsl:if> + <xsl:if test="@special-values"> + <para> + Special values: <xsl:value-of select="@special-values"/> + </para> + </xsl:if> </listitem> </varlistentry> </xsl:template> diff --git a/man/nmcli-examples.7 b/man/nmcli-examples.7 index a7dc8642..76b64fe4 100644 --- a/man/nmcli-examples.7 +++ b/man/nmcli-examples.7 @@ -2,12 +2,12 @@ .\" Title: nmcli-examples .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: Examples -.\" Source: NetworkManager 1.44.2 +.\" Source: NetworkManager 1.45.90 .\" Language: English .\" -.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.44\&.2" "Examples" +.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.45\&.90" "Examples" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -237,7 +237,7 @@ $ \fBnmcli \-\-ask con up my\-vpn\-con\fR This command activates a VPN connection profile enabling nmcli to interact with the user (\*(Aq\-\-ask\*(Aq): this will allow nmcli to prompt for the VPN password on the command line when the \fIpassword\-flags\fR are set to \*(Aq0x02\*(Aq (\*(Aqalways ask\*(Aq, see -\fBnm-settings\fR(5) +\fBnm-settings-nmcli\fR(5) )\&. This is particularly useful for OTP based VPNs, as the user needs to be prompted for the password each time the connection is activated\&. .PP \fBExample\ \&8.\ \&Adding a bonding master and two slave connection profiles\fR @@ -829,7 +829,7 @@ Type "Yes" to commit the changes: \fBYes\fR \fBnmcli\fR(1), \fBNetworkManager\fR(8), \fBNetworkManager.conf\fR(5), -\fBnm-settings\fR(5), +\fBnm-settings-nmcli\fR(5), \fBnm-online\fR(1), \fBnm-applet\fR(1), \fBnm-connection-editor\fR(1) diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml index 1fd7b766..2c7e16ab 100644 --- a/man/nmcli-examples.xml +++ b/man/nmcli-examples.xml @@ -7,20 +7,11 @@ ]> <!-- + SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later + nmcli-examples(7) manual page Copyright 2005 - 2022 Red Hat, Inc. - - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. You may obtain a copy of the GNU Free Documentation License - from the Free Software Foundation by visiting their Web site or by - writing to: - - Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. --> <refentry id="nmcli-examples"> @@ -189,7 +180,7 @@ B,DISPATCH</screen> This command activates a VPN connection profile enabling nmcli to interact with the user ('--ask'): this will allow nmcli to prompt for the VPN password on the command line when the <emphasis>password-flags</emphasis> are set to '0x02' ('always ask', see - <link linkend='nm-settings'><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> + <link linkend='nm-settings-nmcli'><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> ). This is particularly useful for OTP based VPNs, as the user needs to be prompted for the password each time the connection is activated. @@ -675,7 +666,7 @@ Type "Yes" to commit the changes: <userinput>Yes</userinput></screen> <link linkend='nmcli'><citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <link linkend='NetworkManager'><citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry></link>, <link linkend='NetworkManager.conf'><citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, - <link linkend='nm-settings'><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, + <link linkend='nm-settings-nmcli'><citerefentry><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <link linkend='nm-online'><citerefentry><refentrytitle>nm-online</refentrytitle><manvolnum>1</manvolnum></citerefentry></link>, <citerefentry><refentrytitle>nm-applet</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>nm-connection-editor</refentrytitle><manvolnum>1</manvolnum></citerefentry> diff --git a/man/nmcli.1 b/man/nmcli.1 index b5df1750..10775351 100644 --- a/man/nmcli.1 +++ b/man/nmcli.1 @@ -2,12 +2,12 @@ .\" Title: nmcli .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.44.2 +.\" Source: NetworkManager 1.45.90 .\" Language: English .\" -.TH "NMCLI" "1" "" "NetworkManager 1\&.44\&.2" "General Commands Manual" +.TH "NMCLI" "1" "" "NetworkManager 1\&.45\&.90" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nmcli.xml b/man/nmcli.xml index 9bda9db0..6b3054c3 100644 --- a/man/nmcli.xml +++ b/man/nmcli.xml @@ -7,20 +7,11 @@ ]> <!-- + SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later + nmcli(1) manual page Copyright 2010 - 2022 Red Hat, Inc. - - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. You may obtain a copy of the GNU Free Documentation License - from the Free Software Foundation by visiting their Web site or by - writing to: - - Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. --> <refentry id='nmcli'> diff --git a/man/nmtui.1 b/man/nmtui.1 index 287488c8..d6e89157 100644 --- a/man/nmtui.1 +++ b/man/nmtui.1 @@ -2,12 +2,12 @@ .\" Title: nmtui .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/03/2023 +.\" Date: 01/25/2024 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.44.2 +.\" Source: NetworkManager 1.45.90 .\" Language: English .\" -.TH "NMTUI" "1" "" "NetworkManager 1\&.44\&.2" "General Commands Manual" +.TH "NMTUI" "1" "" "NetworkManager 1\&.45\&.90" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nmtui.xml b/man/nmtui.xml index 8bf6dd58..f610be9d 100644 --- a/man/nmtui.xml +++ b/man/nmtui.xml @@ -7,20 +7,11 @@ ]> <!-- + SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later + nmtui(1) manual page Copyright 2010 - 2016 Red Hat, Inc. - - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.1 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. You may obtain a copy of the GNU Free Documentation License - from the Free Software Foundation by visiting their Web site or by - writing to: - - Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. --> <refentry id='nmtui'> |