diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/NetworkManager-dispatcher.8 | 4 | ||||
| -rw-r--r-- | man/NetworkManager-wait-online.service.8 | 4 | ||||
| -rw-r--r-- | man/NetworkManager.8 | 6 | ||||
| -rw-r--r-- | man/NetworkManager.conf.5 | 39 | ||||
| -rw-r--r-- | man/NetworkManager.conf.xml | 49 | ||||
| -rw-r--r-- | man/common.ent.in | 1 | ||||
| -rw-r--r-- | man/meson.build | 3 | ||||
| -rw-r--r-- | man/nm-cloud-setup.8 | 26 | ||||
| -rw-r--r-- | man/nm-cloud-setup.xml | 14 | ||||
| -rw-r--r-- | man/nm-initrd-generator.8 | 6 | ||||
| -rw-r--r-- | man/nm-online.1 | 6 | ||||
| -rw-r--r-- | man/nm-openvswitch.7 | 6 | ||||
| -rw-r--r-- | man/nm-settings-dbus.5 | 134 | ||||
| -rw-r--r-- | man/nm-settings-dbus.xml | 46 | ||||
| -rw-r--r-- | man/nm-settings-ifcfg-rh.5 | 347 | ||||
| -rw-r--r-- | man/nm-settings-ifcfg-rh.xml | 18 | ||||
| -rw-r--r-- | man/nm-settings-ifcfg-rh.xsl | 4 | ||||
| -rw-r--r-- | man/nm-settings-keyfile.5 | 6 | ||||
| -rw-r--r-- | man/nm-settings-keyfile.xml | 2 | ||||
| -rw-r--r-- | man/nm-settings-keyfile.xsl | 2 | ||||
| -rw-r--r-- | man/nm-settings-nmcli.5 | 1416 | ||||
| -rw-r--r-- | man/nm-settings-nmcli.xml | 987 | ||||
| -rw-r--r-- | man/nm-settings-nmcli.xsl | 18 | ||||
| -rw-r--r-- | man/nmcli-examples.7 | 6 | ||||
| -rw-r--r-- | man/nmcli.1 | 6 | ||||
| -rw-r--r-- | man/nmtui.1 | 6 |
26 files changed, 1706 insertions, 1456 deletions
diff --git a/man/NetworkManager-dispatcher.8 b/man/NetworkManager-dispatcher.8 index 41b3945d..94fcad0b 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: Network management daemons -.\" Source: NetworkManager-dispatcher 1.42.8 +.\" Source: NetworkManager-dispatcher 1.44.0 .\" Language: English .\" .TH "NETWORKMANAGER\-DISPATCHER" "8" "" "NetworkManager\-dispatcher 1\&" "Network management daemons" diff --git a/man/NetworkManager-wait-online.service.8 b/man/NetworkManager-wait-online.service.8 index d4ee3288..11bdc195 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: Network management daemons -.\" Source: NetworkManager-wait-online.service 1.42.8 +.\" Source: NetworkManager-wait-online.service 1.44.0 .\" Language: English .\" .TH "NETWORKMANAGER\-WAIT\-ONLINE\&" "8" "" "NetworkManager\-wait\-online\&" "Network management daemons" diff --git a/man/NetworkManager.8 b/man/NetworkManager.8 index 7e9e2964..6d95498e 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: Network management daemons -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.42\&.8" "Network management daemons" +.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.44\&.0" "Network management daemons" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5 index 800874d7..67b99523 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: Configuration -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.42\&.8" "Configuration" +.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.44\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -280,8 +280,7 @@ that contains the original name servers pushed to the DNS plugin\&. When using dnsmasq and -systemd\-resolved -per\-connection added dns servers will always be queried using the device the connection has been activated on\&. +systemd\-resolved, per\-connection added dns servers will always be queried using the device the connection has been activated on\&. .RE .PP \fIrc\-manager\fR @@ -341,22 +340,17 @@ symlink\&. .PP \fIsystemd\-resolved\fR .RS 4 -Send the connection DNS configuration to +Additionally, send the connection DNS configuration to systemd\-resolved\&. Defaults to "true"\&. .sp -Note that this setting is complementary to the -\fIdns\fR -setting\&. You can keep this enabled while using +Note that this setting has no effect if the main \fIdns\fR -set to another DNS plugin alongside -systemd\-resolved, or +plugin is already +systemd\-resolved\&. It is complementary to the \fIdns\fR -set to -systemd\-resolved -to configure the system resolver to use -systemd\-resolved\&. +setting to configure systemd\-resolved alongside the main plugin\&. .sp -If systemd\-resolved is enabled, the connectivity check resolves the hostname per\-device\&. +If systemd\-resolved is enabled, either via this setting or the main DNS plugin, the connectivity check resolves the hostname per\-device\&. .RE .PP \fIdebug\fR @@ -412,6 +406,12 @@ The path can also be overriden by pointing to a specific existing and writable d .sp This mechanism allows editing connection profile settings such as the 802\&.1x configuration using NetworkManager clients\&. Without it such changes have no effect in IWD\&. .RE +.PP +\fImigrate\-ifcfg\-rh\fR +.RS 4 +Whether NetworkManager tries to automatically convert any connection profile stored in ifcfg\-rh format to the keyfile format\&. Support for ifcfg\-rh is deprecated and will be eventually removed\&. If enabled, the migration is performed at every startup of the daemon\&. The default value is +false\&. +.RE .SH "KEYFILE SECTION" .PP This section contains keyfile\-plugin\-specific options, and is normally only used when you are not using any other distro\-specific plugin\&. @@ -429,6 +429,11 @@ or other system configuration files according to build options\&. The location where keyfiles are read and stored\&. This defaults to "/etc/NetworkManager/system\-connections"\&. .RE .PP +\fIrename\fR +.RS 4 +NetworkManager automatically chooses a filename when storing a new profile to disk\&. That name depends on the profile\*(Aqs name (connection\&.id)\&. When updating a profile\*(Aqs name, the file is not renamed to not break scripts that rely on the filename for the profile\&. By setting this option to "true", NetworkManager renames the keyfile on update of the profile, to follow the profile\*(Aqs name\&. This defaults to "false"\&. +.RE +.PP \fIunmanaged\-devices\fR .RS 4 Set devices that should be ignored by NetworkManager\&. @@ -1429,7 +1434,7 @@ This plugin is always active, and will automatically be used to store any connec .PP \fIifcfg\-rh\fR .RS 4 -This plugin is used on the Fedora and Red Hat Enterprise Linux distributions to read and write configuration from the standard +This plugin is now deprecated; it can be used on the Fedora and Red Hat Enterprise Linux distributions to read and write configuration from the standard /etc/sysconfig/network\-scripts/ifcfg\-* files\&. It currently supports reading Ethernet, Wi\-Fi, InfiniBand, VLAN, Bond, Bridge, and Team connections\&. Enabling ifcfg\-rh diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml index 3ee942b2..a21ff9df 100644 --- a/man/NetworkManager.conf.xml +++ b/man/NetworkManager.conf.xml @@ -357,7 +357,7 @@ no-auto-default=* NetworkManager also writes a file <filename>&nmrundir;/no-stub-resolv.conf</filename> that contains the original name servers pushed to the DNS plugin.</para> - <para>When using <literal>dnsmasq</literal> and <literal>systemd-resolved</literal> + <para>When using <literal>dnsmasq</literal> and <literal>systemd-resolved</literal>, per-connection added dns servers will always be queried using the device the connection has been activated on.</para> </listitem> @@ -421,16 +421,15 @@ no-auto-default=* <varlistentry> <term><varname>systemd-resolved</varname></term> - <listitem><para>Send the connection DNS configuration to + <listitem><para>Additionally, send the connection DNS configuration to <literal>systemd-resolved</literal>. Defaults to "<literal>true</literal>". </para> - <para>Note that this setting is complementary to the - <varname>dns</varname> setting. You can keep this enabled while using - <varname>dns</varname> set to another DNS plugin alongside - <literal>systemd-resolved</literal>, or <varname>dns</varname> set to - <literal>systemd-resolved</literal> to configure the system resolver to use - <literal>systemd-resolved</literal>.</para> - <para>If systemd-resolved is enabled, the connectivity check resolves the + <para>Note that this setting has no effect if the main <varname>dns</varname> + plugin is already <literal>systemd-resolved</literal>. It is complementary to the + <varname>dns</varname> setting to configure systemd-resolved alongside the + main plugin.</para> + <para>If systemd-resolved is enabled, either via this setting or the main + DNS plugin, the connectivity check resolves the hostname per-device.</para> </listitem> </varlistentry> @@ -528,6 +527,17 @@ no-auto-default=* </para> </listitem> </varlistentry> + + <varlistentry> + <term><varname>migrate-ifcfg-rh</varname></term> + <listitem><para>Whether NetworkManager tries to automatically convert + any connection profile stored in ifcfg-rh format to the keyfile format. + Support for ifcfg-rh is deprecated and will be eventually removed. If + enabled, the migration is performed at every startup of the daemon. + The default value is <literal>&NM_CONFIG_DEFAULT_MAIN_MIGRATE_IFCFG_RH_TEXT;</literal>. + </para></listitem> + </varlistentry> + </variablelist> </refsect1> @@ -555,6 +565,21 @@ no-auto-default=* </listitem> </varlistentry> <varlistentry> + <term><varname>rename</varname></term> + <listitem> + <para> + NetworkManager automatically chooses a filename when storing + a new profile to disk. That name depends on the profile's name + (connection.id). When updating a profile's name, the file is + not renamed to not break scripts that rely on the filename + for the profile. + By setting this option to "true", NetworkManager renames + the keyfile on update of the profile, to follow the profile's + name. This defaults to "false". + </para> + </listitem> + </varlistentry> + <varlistentry> <term><varname>unmanaged-devices</varname></term> <listitem> <para>Set devices that should be ignored by NetworkManager. @@ -1646,9 +1671,9 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16 <term><varname>ifcfg-rh</varname></term> <listitem> <para> - This plugin is used on the Fedora and Red Hat Enterprise - Linux distributions to read and write configuration from - the standard + This plugin is now deprecated; it can be used on the + Fedora and Red Hat Enterprise Linux distributions to read + and write configuration from the standard <filename>/etc/sysconfig/network-scripts/ifcfg-*</filename> files. It currently supports reading Ethernet, Wi-Fi, InfiniBand, VLAN, Bond, Bridge, and Team connections. diff --git a/man/common.ent.in b/man/common.ent.in index ae792f25..71a47f42 100644 --- a/man/common.ent.in +++ b/man/common.ent.in @@ -8,4 +8,5 @@ <!ENTITY NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT "@NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT@"> <!ENTITY NM_CONFIG_DEFAULT_MAIN_RC_MANAGER "@NM_CONFIG_DEFAULT_MAIN_RC_MANAGER@"> <!ENTITY NM_CONFIG_DEFAULT_MAIN_DHCP "@NM_CONFIG_DEFAULT_MAIN_DHCP@"> +<!ENTITY NM_CONFIG_DEFAULT_MAIN_MIGRATE_IFCFG_RH_TEXT "@NM_CONFIG_DEFAULT_MAIN_MIGRATE_IFCFG_RH_TEXT@"> <!ENTITY NM_CONFIG_DEFAULT_WIFI_BACKEND_TEXT "@NM_CONFIG_DEFAULT_WIFI_BACKEND_TEXT@"> diff --git a/man/meson.build b/man/meson.build index 356759ba..a2e1de83 100644 --- a/man/meson.build +++ b/man/meson.build @@ -85,10 +85,11 @@ if enable_introspection command: [ python.path(), join_paths(meson.source_root(), 'tools', 'generate-docs-nm-settings-docs-merge.py'), - '--only-from-first', '@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, ], ) diff --git a/man/nm-cloud-setup.8 b/man/nm-cloud-setup.8 index da7d1712..3ddd93eb 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: Automatic Network Configuration in Cloud with NetworkManager -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NM\-CLOUD\-SETUP" "8" "" "NetworkManager 1\&.42\&.8" "Automatic Network Configuratio" +.TH "NM\-CLOUD\-SETUP" "8" "" "NetworkManager 1\&.44\&.0" "Automatic Network Configuratio" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -119,7 +119,8 @@ WARN, ERR or OFF\&. The program will print message on stdout and the default level is -WARN\&. +WARN\&. When run as systemd service, the log will be collected by journald can can be seen with +\fBjournalctl\fR\&. .RE .sp .RS 4 @@ -169,6 +170,23 @@ no\&. NM_CLOUD_SETUP_ALIYUN: boolean, whether Alibaba Cloud (Aliyun) support is enabled\&. Defaults to no\&. .RE +.SH "DEBUGGING" +.PP +Enable debug logging by setting +NM_CLOUD_SETUP_LOG +environment variable to +TRACE\&. +.PP +In the common case where nm\-cloud\-setup is running as systemd service, this can be done via +\fBsystemctl edit nm\-cloud\-setup\&.service\fR +and add +Environment=NM_CLOUD_SETUP_LOG=TRACE +to the +[Service] +section\&. Afterwards, the log can be found in syslog via +journalctl\&. You may also want to enable debug logging in NetworkManager as descibed in the DEBUGGING section in +\fBNetworkManager\fR(5) +manual\&. When sharing logs, it\*(Aqs best to share complete logs and not preemptively filter for NetworkManager or nm\-cloud\-setup logs\&. .SH "EXAMPLE SETUP FOR CONFIGURING AND PREDEPLOYING NM\-CLOUD\-SETUP" .PP As detailed before, nm\-cloud\-setup needs to be explicitly enabled\&. As it runs as a systemd service and timer, that basically means to enable and configure those\&. This can be done by dropping the correct files and symlinks to disk\&. diff --git a/man/nm-cloud-setup.xml b/man/nm-cloud-setup.xml index 976fc647..74ec0400 100644 --- a/man/nm-cloud-setup.xml +++ b/man/nm-cloud-setup.xml @@ -173,7 +173,9 @@ <para><literal>NM_CLOUD_SETUP_LOG</literal>: control the logging verbosity. Set it to one of <literal>TRACE</literal>, <literal>DEBUG</literal>, <literal>INFO</literal>, <literal>WARN</literal>, <literal>ERR</literal> or <literal>OFF</literal>. The program - will print message on stdout and the default level is <literal>WARN</literal>.</para> + will print message on stdout and the default level is <literal>WARN</literal>. When + run as systemd service, the log will be collected by journald can can be seen with + <command>journalctl</command>.</para> </listitem> <listitem> <para><literal>NM_CLOUD_SETUP_AZURE</literal>: boolean, whether Microsoft Azure support is enabled. Defaults @@ -195,6 +197,16 @@ </refsect1> + <refsect1 id="debugging"> + <title>Debugging</title> + <para>Enable debug logging by setting <literal>NM_CLOUD_SETUP_LOG</literal> environment variable to <literal>TRACE</literal>.</para> + <para>In the common case where nm-cloud-setup is running as systemd service, this can be done via <command>systemctl edit nm-cloud-setup.service</command> + and add <literal>Environment=NM_CLOUD_SETUP_LOG=TRACE</literal> to the <literal>[Service]</literal> section. Afterwards, the log can + be found in syslog via <literal>journalctl</literal>. You may also want to enable debug logging in NetworkManager as descibed + in the DEBUGGING section in <link linkend='NetworkManager'><citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> + manual. When sharing logs, it's best to share complete logs and not preemptively filter for NetworkManager or nm-cloud-setup logs.</para> + </refsect1> + <refsect1 id="deploy"> <title>Example Setup for Configuring and Predeploying nm-cloud-setup</title> diff --git a/man/nm-initrd-generator.8 b/man/nm-initrd-generator.8 index 314636b0..abcde80f 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: System Administration -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NM\-INITRD\-GENERATOR" "8" "" "NetworkManager 1\&.42\&.8" "System Administration" +.TH "NM\-INITRD\-GENERATOR" "8" "" "NetworkManager 1\&.44\&.0" "System Administration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-online.1 b/man/nm-online.1 index e3e934c3..e15eb0c9 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.42\&.8" "General Commands Manual" +.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.44\&.0" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-openvswitch.7 b/man/nm-openvswitch.7 index dcffc550..b9934375 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: Open vSwitch support overview -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NM\-OPENVSWITCH" "7" "" "NetworkManager 1\&.42\&.8" "Open vSwitch support overview" +.TH "NM\-OPENVSWITCH" "7" "" "NetworkManager 1\&.44\&.0" "Open vSwitch support overview" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-settings-dbus.5 b/man/nm-settings-dbus.5 index c6038e9f..8aea6de6 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: Configuration -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NM\-SETTINGS\-DBUS" "5" "" "NetworkManager 1\&.42\&.8" "Configuration" +.TH "NM\-SETTINGS\-DBUS" "5" "" "NetworkManager 1\&.44\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -321,7 +321,9 @@ boolean T}:T{ FALSE T}:T{ -FALSE if the connection can be modified using the provided settings service\*(Aqs D\-Bus interface with the right privileges, or TRUE if the connection is read\-only and cannot be modified\&. +This property is deprecated and has no meaning\&. + +This property is deprecated since version 1\&.44\&.This property is deprecated and has no meaning\&. T} T{ secondaries @@ -350,13 +352,13 @@ T}:T{ T}:T{ This represents the identity of the connection used for various purposes\&. It allows to configure multiple profiles to share the identity\&. Also, the stable\-id can contain placeholders that are substituted dynamically and deterministically depending on the context\&. -The stable\-id is used for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. It is also used as DHCP client identifier with ipv4\&.dhcp\-client\-id=stable and to derive the DHCP DUID with ipv6\&.dhcp\-duid=stable\-[llt,ll,uuid]\&. +The stable\-id is used for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. It is also used 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\*(Aqs name is included, so that different interfaces yield different addresses\&. The per\-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key\&. See NetworkManager(8) manual about the secret\-key and the host identity\&. -The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at runtime\&. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}"\&. These effectively create unique IDs per\-connection, per\-device, per\-boot, or every time\&. Note that "${DEVICE}" corresponds to the interface name of the device and "${MAC}" is the permanent MAC address of the device\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}\-${BOOT}\-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates\&. +The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at 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\&. -If the value is unset, a global connection default is consulted\&. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection\&. +If the value is unset, a global connection default is consulted\&. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile\&. T} T{ timestamp @@ -1832,6 +1834,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{ apn @@ -1870,6 +1874,24 @@ T}:T{ When TRUE, only connections to the home network will be allowed\&. Connections to roaming networks will not be made\&. T} T{ +initial\-eps\-bearer\-apn +T}:T{ +string +T}:T{ +\ \& +T}:T{ +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\&. +T} +T{ +initial\-eps\-bearer\-configure +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +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\&. +T} +T{ mtu T}:T{ uint32 @@ -2181,7 +2203,7 @@ string T}:T{ \ \& T}:T{ -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. +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\&. @@ -2506,6 +2528,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ addr\-gen\-mode @@ -2514,15 +2537,17 @@ int32 T}:T{ 3 T}:T{ -Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration\&. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1)\&. NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3)\&. +Configure the method for creating the IPv6 interface identifier of addresses for RFC4862 IPv6 Stateless Address Autoconfiguration and IPv6 Link Local\&. -If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address\&. This makes the host part of the address to stay constant, making it possible to track host\*(Aqs presence when it changes networks\&. The address changes when the interface hardware is replaced\&. +The 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 value of stable\-privacy enables use of cryptographically secure hash of a secret host\-specific key along with the connection\*(Aqs stable\-id and the network address as specified by RFC7217\&. This makes it impossible to use the address track host\*(Aqs presence, and makes the address stable when the network interface hardware is replaced\&. +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\&. -The special values "default" and "default\-or\-eui64" will fallback to the global connection default in as documented in NetworkManager\&.conf(5) manual\&. If the global default is not specified, the fallback value is "stable\-privacy" or "eui64", respectively\&. +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\*(Aqs "connection\&.stable\-id" property and the address prefix\&. This improves privacy by making it harder to use the address to track the host\*(Aqs presence as every prefix and network has a different identifier\&. Also, the address is stable when the network interface hardware is replaced\&. -For libnm, the property defaults to "default" since 1\&.40\&. Previously it defaulted to "stable\-privacy"\&. On D\-Bus, the absence of an addr\-gen\-mode setting equals "default"\&. For keyfile plugin, the absence of the setting on disk means "default\-or\-eui64" so that the property doesn\*(Aqt change on upgrade from older versions\&. +The special values "default" and "default\-or\-eui64" will fallback to the global connection default as documented in the NetworkManager\&.conf(5) manual\&. If the global default is not specified, the fallback value is "stable\-privacy" or "eui64", respectively\&. + +For libnm, the property defaults to "default" since 1\&.40\&. Previously it used to default to "stable\-privacy"\&. On D\-Bus, the absence of an addr\-gen\-mode setting equals "default"\&. For keyfile plugin, the absence of the setting on disk means "default\-or\-eui64" so that the property doesn\*(Aqt change on upgrade from older versions\&. Note that this setting is distinct from the Privacy Extensions as configured by "ip6\-privacy" property and it does not affect the temporary addresses configured with this option\&. T} @@ -2613,7 +2638,7 @@ string T}:T{ \ \& T}:T{ -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. +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\&. @@ -2622,6 +2647,15 @@ For DHCPv6, note that at the moment this property is only supported by the "inte The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device\&. T} T{ +dhcp\-pd\-hint +T}:T{ +string +T}:T{ +\ \& +T}:T{ +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")\&. +T} +T{ dhcp\-reject\-servers T}:T{ array of string @@ -2910,6 +2944,8 @@ T}:T{ \ \& T}:T{ 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\&. T} .TE .sp 1 @@ -5504,7 +5540,9 @@ uint32 T}:T{ 0 T}:T{ -If non\-zero, directs the device to only use the specified bitrate for communication with the access point\&. Units are in Kb/s, ie 5500 = 5\&.5 Mbit/s\&. This property is highly driver dependent and not all devices support setting a static bitrate\&. +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\&. T} T{ security @@ -5513,7 +5551,7 @@ T}:T{ T}:T{ \ \& T}:T{ -This property is deprecated, but can be set to the value \*(Aq802\-11\-wireless\-security\*(Aq when a wireless security setting is also present in the connection dictionary, for compatibility with very old NetworkManager daemons\&. +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\&. T} T{ seen\-bssids @@ -5523,6 +5561,8 @@ T}:T{ \ \& T}:T{ 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\&. T} T{ ssid @@ -5540,7 +5580,9 @@ uint32 T}:T{ 0 T}:T{ -If non\-zero, directs the device to use the specified transmit power\&. Units are dBm\&. This property is highly driver dependent and not all devices support setting a static transmit power\&. +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\&. T} T{ wake\-on\-wlan @@ -5953,6 +5995,64 @@ Negative values have the special effect of excluding other connections with a gr T} .TE .sp 1 +.SS "link setting" +.PP +Link settings\&. +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l +l l l l +l l l l +l l l l. +T{ +gro\-max\-size +T}:T{ +int64 +T}:T{ +\-1 +T}:T{ +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\&. +T} +T{ +gso\-max\-segments +T}:T{ +int64 +T}:T{ +\-1 +T}:T{ +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\&. +T} +T{ +gso\-max\-size +T}:T{ +int64 +T}:T{ +\-1 +T}:T{ +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\&. +T} +T{ +tx\-queue\-length +T}:T{ +int64 +T}:T{ +\-1 +T}:T{ +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\&. +T} +.TE +.sp 1 .SS "loopback setting" .PP Loopback Link Settings\&. diff --git a/man/nm-settings-dbus.xml b/man/nm-settings-dbus.xml index 93b6f2c4..9eb902a0 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.42.8</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.44.0</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 @@ -82,15 +82,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>FALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.secondaries">secondaries</entry><entry align="left">array of string</entry><entry align="left"/><entry>List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.slave-type">slave-type</entry><entry align="left">string</entry><entry align="left"/><entry>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.stable-id">stable-id</entry><entry align="left">string</entry><entry align="left"/><entry>This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context. +At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.read-only">read-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>This property is deprecated and has no meaning. -The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used as DHCP client identifier with ipv4.dhcp-client-id=stable and to derive the DHCP DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid]. +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. + +The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used to derive the DHCP client identifier with ipv4.dhcp-client-id=stable, the DHCPv6 DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid] and the DHCP IAID with ipv4.iaid=stable and ipv6.iaid=stable. Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity. -The '$' character is treated special to perform dynamic substitutions at runtime. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. Note that "${DEVICE}" corresponds to the interface name of the device and "${MAC}" is the permanent MAC address of the device. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates. +The '$' character is treated special to perform dynamic substitutions at activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. The "${CONNECTION}" uses the profile's connection.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates. -If the value is unset, a global connection default is consulted. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection.</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.timestamp">timestamp</entry><entry align="left">uint64</entry><entry align="left">0</entry><entry>The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. +If the value is unset, a global connection default is consulted. If the value is still unset, the default is "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. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.type">type</entry><entry align="left">string</entry><entry align="left"/><entry>Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).</entry></row><row><entry align="left" id="nm-settings-dbus.property.connection.uuid">uuid</entry><entry align="left">string</entry><entry align="left"/><entry>A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. @@ -150,7 +152,7 @@ $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". -Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fcoe-priority">app-fcoe-priority</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fip-flags">app-fip-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-fip-priority">app-fip-priority</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-iscsi-flags">app-iscsi-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.app-iscsi-priority">app-iscsi-priority</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-bandwidth">priority-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-flow-control">priority-flow-control</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-flow-control-flags">priority-flow-control-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-group-bandwidth">priority-group-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-group-flags">priority-group-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-group-id">priority-group-id</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-strict-bandwidth">priority-strict-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.</entry></row><row><entry align="left" id="nm-settings-dbus.property.dcb.priority-traffic-class">priority-traffic-class</entry><entry align="left">array of uint32</entry><entry align="left"/><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>dummy setting</title><para>Dummy Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody/></tgroup></informaltable></refsect2><refsect2><title>ethtool setting</title><para>Ethtool Ethernet Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody/></tgroup></informaltable></refsect2><refsect2><title>generic setting</title><para>Generic Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody/></tgroup></informaltable></refsect2><refsect2><title>gsm setting</title><para>GSM-based Mobile Broadband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.gsm.apn">apn</entry><entry align="left">string</entry><entry align="left"/><entry>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.auto-config">auto-config</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.device-id">device-id</entry><entry align="left">string</entry><entry align="left"/><entry>The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.home-only">home-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.network-id">network-id</entry><entry align="left">string</entry><entry align="left"/><entry>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</entry></row><row><entry align="left" id="nm-settings-dbus.property.gsm.number">number</entry><entry align="left">string</entry><entry align="left"/><entry>Legacy setting that used to help establishing PPP data sessions for GSM-based modems. +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. 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. @@ -175,7 +177,7 @@ If unset, a globally configured default is used. If still unset, the default dep Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. -When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.dhcp-iaid">dhcp-iaid</entry><entry align="left">string</entry><entry align="left"/><entry>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". +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". For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id. @@ -240,15 +242,17 @@ This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-r If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.routes">routes</entry><entry align="left">array of array of uint32</entry><entry align="left"/><entry>Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. -Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. If the metric is 0, NM will choose an appropriate default metric for the device. (There is no way to explicitly specify an actual metric of 0 with this property.)</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv4.routing-rules">routing-rules</entry><entry align="left">array of 'a{sv}'</entry><entry align="left"/><entry>Array of dictionaries for routing rules. Each routing rule supports the following options: action (y), dport-end (q), dport-start (q), family (i), from (s), from-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport-end (q), sport-start (q), supress-prefixlength (i), table (u), to (s), tos (y), to-len (y), range-end (u), range-start (u).</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ipv6 setting</title><para>IPv6 Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ipv6.addr-gen-mode">addr-gen-mode</entry><entry align="left">int32</entry><entry align="left">3</entry><entry>Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3). +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). -If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. +If the property is set to "eui64", the addresses will be generated using the interface token derived from the hardware address. This makes the host part of the address constant, making it possible to track the host's presence when it changes networks. The address changes when the interface hardware is replaced. If a duplicate address is detected, there is no fallback to generate another address. When configured, the "ipv6.token" is used instead of the MAC address to generate addresses for stateless autoconfiguration. -The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. +If the property is set to "stable-privacy", the interface identifier is generated as specified by RFC7217. This works by hashing a host specific key (see NetworkManager(8) manual), the interface name, the connection's "connection.stable-id" property and the address prefix. This improves privacy by making it harder to use the address to track the host's presence as every prefix and network has a different identifier. Also, the address is stable when the network interface hardware is replaced. -The special values "default" and "default-or-eui64" will fallback to the global connection default in as documented in NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively. +The special values "default" and "default-or-eui64" will fallback to the global connection default as documented in the NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively. -For libnm, the property defaults to "default" since 1.40. Previously it defaulted to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions. +For libnm, the property defaults to "default" since 1.40. Previously it used to default to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions. Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</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. @@ -267,13 +271,13 @@ When the property is unset, the global value provided for "ipv6.dhcp-duid" is us Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. -When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-iaid">dhcp-iaid</entry><entry align="left">string</entry><entry align="left"/><entry>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". +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". For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id. For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address. -The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-reject-servers">dhcp-reject-servers</entry><entry align="left">array of string</entry><entry align="left"/><entry>Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. +The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-pd-hint">dhcp-pd-hint</entry><entry align="left">string</entry><entry align="left"/><entry>A IPv6 address followed by a slash and a prefix length. If set, the value is sent to the DHCPv6 server as hint indicating the prefix delegation (IA_PD) we want to receive. To only hint a prefix length without prefix, set the address part to the zero address (for example "::/60").</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.dhcp-reject-servers">dhcp-reject-servers</entry><entry align="left">array of string</entry><entry align="left"/><entry>Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). @@ -338,7 +342,9 @@ This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-r If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.routes">routes</entry><entry align="left">array of legacy IPv6 route struct (a(ayuayu))</entry><entry align="left"/><entry>Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. -Array of IPv6 route structures. Each IPv6 route structure is composed of an IPv6 address, a prefix length (0 - 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric. If the metric is 0, NM will choose an appropriate default metric for the device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.routing-rules">routing-rules</entry><entry align="left">array of 'a{sv}'</entry><entry align="left"/><entry>Array of dictionaries for routing rules. Each routing rule supports the following options: action (y), dport-end (q), dport-start (q), family (i), from (s), from-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport-end (q), sport-start (q), supress-prefixlength (i), table (u), to (s), tos (y), to-len (y), range-end (u), range-start (u).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ipv6.token">token</entry><entry align="left">string</entry><entry align="left"/><entry>Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ip-tunnel setting</title><para>IP Tunneling Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.encapsulation-limit">encapsulation-limit</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. 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, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.output-key">output-key</entry><entry align="left">string</entry><entry align="left"/><entry>The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.path-mtu-discovery">path-mtu-discovery</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether to enable Path MTU Discovery on this tunnel.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.remote">remote</entry><entry align="left">string</entry><entry align="left"/><entry>The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.tos">tos</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.ttl">ttl</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>macsec setting</title><para>MACSec Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.macsec.encrypt">encrypt</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether the transmitted traffic must be encrypted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-cak">mka-cak</entry><entry align="left">string</entry><entry align="left"/><entry>The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-cak-flags">mka-cak-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "mka-cak" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-ckn">mka-ckn</entry><entry align="left">string</entry><entry align="left"/><entry>The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mode">mode</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.port">port</entry><entry align="left">int32</entry><entry align="left">1</entry><entry>The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.send-sci">send-sci</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.validation">validation</entry><entry align="left">int32</entry><entry align="left">2</entry><entry>Specifies the validation mode for incoming frames.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>macvlan setting</title><para>MAC VLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.macvlan.mode">mode</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.promiscuous">promiscuous</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether the interface should be put in promiscuous mode.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.tap">tap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Whether the interface should be a MACVTAP.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>match setting</title><para>Match settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.match.driver">driver</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of driver names to match. Each element is a shell wildcard pattern. +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, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.output-key">output-key</entry><entry align="left">string</entry><entry align="left"/><entry>The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.path-mtu-discovery">path-mtu-discovery</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether to enable Path MTU Discovery on this tunnel.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.remote">remote</entry><entry align="left">string</entry><entry align="left"/><entry>The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.tos">tos</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</entry></row><row><entry align="left" id="nm-settings-dbus.property.ip-tunnel.ttl">ttl</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>macsec setting</title><para>MACSec Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.macsec.encrypt">encrypt</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether the transmitted traffic must be encrypted.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-cak">mka-cak</entry><entry align="left">string</entry><entry align="left"/><entry>The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-cak-flags">mka-cak-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "mka-cak" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mka-ckn">mka-ckn</entry><entry align="left">string</entry><entry align="left"/><entry>The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.mode">mode</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.port">port</entry><entry align="left">int32</entry><entry align="left">1</entry><entry>The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.send-sci">send-sci</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macsec.validation">validation</entry><entry align="left">int32</entry><entry align="left">2</entry><entry>Specifies the validation mode for incoming frames.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>macvlan setting</title><para>MAC VLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.macvlan.mode">mode</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.promiscuous">promiscuous</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether the interface should be put in promiscuous mode.</entry></row><row><entry align="left" id="nm-settings-dbus.property.macvlan.tap">tap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Whether the interface should be a MACVTAP.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>match setting</title><para>Match settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.match.driver">driver</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of driver names to match. Each element is a shell wildcard pattern. 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. @@ -446,7 +452,13 @@ In AP mode, the created network does not broadcast its SSID. Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address-blacklist">mac-address-blacklist</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mac-address-randomization">mac-address-randomization</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). -This property is deprecated since version 1.4.Use the "cloned-mac-address" property instead.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mode">mode</entry><entry align="left">string</entry><entry align="left"/><entry>Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.powersave">powersave</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.rate">rate</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.security">security</entry><entry align="left"/><entry align="left"/><entry>This property is deprecated, but can be set to the value '802-11-wireless-security' when a wireless security setting is also present in the connection dictionary, for compatibility with very old NetworkManager daemons.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.seen-bssids">seen-bssids</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.ssid">ssid</entry><entry align="left">byte array</entry><entry align="left"/><entry>SSID of the Wi-Fi network. Must be specified.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.tx-power">tx-power</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless.wake-on-wlan">wake-on-wlan</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>802-11-wireless-security setting</title><para>Wi-Fi Security Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.auth-alg">auth-alg</entry><entry align="left">string</entry><entry align="left"/><entry>When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.fils">fils</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled.</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.group">group</entry><entry align="left">array of string</entry><entry align="left"/><entry>A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".</entry></row><row><entry align="left" id="nm-settings-dbus.property.802-11-wireless-security.key-mgmt">key-mgmt</entry><entry align="left">string</entry><entry align="left"/><entry>Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only). +This property 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.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 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. @@ -464,7 +476,7 @@ When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100. -Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>loopback setting</title><para>Loopback Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.loopback.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-external-ids setting</title><para>OVS External IDs Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-external-ids.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>A dictionary of key/value pairs with external-ids for OVS.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>ovs-other-config setting</title><para>OVS Other Config Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.ovs-other-config.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>A dictionary of key/value pairs with other_config settings for OVS. See also "other_config" in the "ovs-vswitchd.conf.db" manual for the keys that OVS supports.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2><title>veth setting</title><para>Veth Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry align="left" id="nm-settings-dbus.property.veth.peer">peer</entry><entry align="left">string</entry><entry align="left"/><entry>This property specifies the peer interface name of the veth. This property is mandatory.</entry></row></tbody></tgroup></informaltable></refsect2><refsect2 id="secrets-flags"><title>Secret flag types:</title><para> +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> 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 1364260b..3f4d95e0 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: Configuration -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.42\&.8" "Configuration" +.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.44\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -347,7 +347,7 @@ are NetworkManager specific extensions not understood by traditional initscripts .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&1.\ \&6lowpan setting +.B Table\ \&1.\ \&802\-11\-wireless setting .TS allbox tab(:); lB lB lB lB. @@ -361,29 +361,6 @@ 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\ \&2.\ \&802\-11\-wireless setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l l l l l l l l l l l l l @@ -465,7 +442,7 @@ T}:T{ T}:T{ \ \& T}:T{ -This property is not handled by ifcfg\-rh plugin\&. +This property is deprecated and not handled by ifcfg\-rh plugin\&. T} T{ tx\-power @@ -474,7 +451,7 @@ T}:T{ T}:T{ \ \& T}:T{ -This property is not handled by ifcfg\-rh plugin\&. +This property is deprecated and not handled by ifcfg\-rh plugin\&. T} T{ mac\-address @@ -519,7 +496,7 @@ T}:T{ T}:T{ \ \& T}:T{ -This property is not handled by ifcfg\-rh plugin\&. +This is not a regular property that would be configured by the user\&. It is not handled by ifcfg\-rh plugin\&. T} T{ mtu @@ -566,15 +543,6 @@ Example: \fRMAC_ADDRESS_RANDOMIZATION=always\fB Allowed values: \fRdefault, never, always T} T{ -security -T}:T{ -(none) -T}:T{ -\ \& -T}:T{ -This property is deprecated and not handled by ifcfg\-rh\-plugin\&. -T} -T{ ap\-isolation T}:T{ AP_ISOLATION\fI(+)\fR @@ -592,7 +560,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&3.\ \&802\-11\-wireless\-security setting +.B Table\ \&2.\ \&802\-11\-wireless\-security setting .TS allbox tab(:); lB lB lB lB. @@ -839,7 +807,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&4.\ \&802\-1x setting +.B Table\ \&3.\ \&802\-1x setting .TS allbox tab(:); lB lB lB lB. @@ -1284,7 +1252,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&5.\ \&802\-3\-ethernet setting +.B Table\ \&4.\ \&802\-3\-ethernet setting .TS allbox tab(:); lB lB lB lB. @@ -1465,7 +1433,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&6.\ \&bond setting +.B Table\ \&5.\ \&bond setting .TS allbox tab(:); lB lB lB lB. @@ -1498,7 +1466,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&7.\ \&bond\-port setting +.B Table\ \&6.\ \&bond\-port setting .TS allbox tab(:); lB lB lB lB. @@ -1543,7 +1511,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&8.\ \&bridge setting +.B Table\ \&7.\ \&bridge setting .TS allbox tab(:); lB lB lB lB. @@ -1874,7 +1842,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&9.\ \&bridge\-port setting +.B Table\ \&8.\ \&bridge\-port setting .TS allbox tab(:); lB lB lB lB. @@ -1941,7 +1909,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&10.\ \&connection setting +.B Table\ \&9.\ \&connection setting .TS allbox tab(:); lB lB lB lB. @@ -2274,7 +2242,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&11.\ \&dcb setting +.B Table\ \&10.\ \&dcb setting .TS allbox tab(:); lB lB lB lB. @@ -2469,7 +2437,7 @@ All DCB related configuration is a NetworkManager extension\&. DCB=yes must be u .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&12.\ \ðtool setting +.B Table\ \&11.\ \ðtool setting .TS allbox tab(:); lB lB lB lB. @@ -2491,7 +2459,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&13.\ \&hostname setting +.B Table\ \&12.\ \&hostname setting .TS allbox tab(:); lB lB lB lB. @@ -2560,7 +2528,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&14.\ \&infiniband setting +.B Table\ \&13.\ \&infiniband setting .TS allbox tab(:); lB lB lB lB. @@ -2637,7 +2605,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&15.\ \&ipv4 setting +.B Table\ \&14.\ \&ipv4 setting .TS allbox tab(:); lB lB lB lB. @@ -2934,7 +2902,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&16.\ \&ipv6 setting +.B Table\ \&15.\ \&ipv6 setting .TS allbox tab(:); lB lB lB lB. @@ -2971,6 +2939,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ method @@ -3214,36 +3183,16 @@ A string sent to the DHCPv6 server to identify the local machine\&. Apart from t Example: \fRDHCPV6_DUID=LL; DHCPV6_DUID=0301deadbeef0001; DHCPV6_DUID=03:01:de:ad:be:ef:00:01 T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&17.\ \&loopback setting -.TS -allbox tab(:); -lB lB lB lB. T{ -Property -T}:T{ -Ifcfg\-rh Variable +dhcp\-pd\-hint T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l. -T{ -mtu -T}:T{ -MTU +DHCPV6_PD_HINT\fI(+)\fR T}:T{ \ \& T}:T{ -MTU of the interface\&. +Hint for DHCPv6 prefix delegation\fB + +Example: \fRDHCPV6_PD_HINT=2001:db8:1111:2220::/60 DHCPV6_PD_HINT=::/60 T} .TE .sp 1 @@ -3252,7 +3201,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&18.\ \&match setting +.B Table\ \&16.\ \&match setting .TS allbox tab(:); lB lB lB lB. @@ -3285,7 +3234,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&19.\ \&ovs\-bridge setting +.B Table\ \&17.\ \&ovs\-external\-ids setting .TS allbox tab(:); lB lB lB lB. @@ -3307,7 +3256,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&20.\ \&ovs\-dpdk setting +.B Table\ \&18.\ \&ovs\-other\-config setting .TS allbox tab(:); lB lB lB lB. @@ -3329,117 +3278,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&21.\ \&ovs\-external\-ids 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\ \&22.\ \&ovs\-interface 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\ \&23.\ \&ovs\-other\-config 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\ \&24.\ \&ovs\-patch 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\ \&25.\ \&ovs\-port setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -. -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&26.\ \&proxy setting +.B Table\ \&19.\ \&proxy setting .TS allbox tab(:); lB lB lB lB. @@ -3506,7 +3345,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&27.\ \&sriov setting +.B Table\ \&20.\ \&sriov setting .TS allbox tab(:); lB lB lB lB. @@ -3563,7 +3402,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&28.\ \&tc setting +.B Table\ \&21.\ \&tc setting .TS allbox tab(:); lB lB lB lB. @@ -3608,7 +3447,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&29.\ \&team setting +.B Table\ \&22.\ \&team setting .TS allbox tab(:); lB lB lB lB. @@ -3639,7 +3478,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&30.\ \&team\-port setting +.B Table\ \&23.\ \&team\-port setting .TS allbox tab(:); lB lB lB lB. @@ -3670,7 +3509,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&31.\ \&user setting +.B Table\ \&24.\ \&user setting .TS allbox tab(:); lB lB lB lB. @@ -3703,29 +3542,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&32.\ \&veth 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\ \&33.\ \&vlan setting +.B Table\ \&25.\ \&vlan setting .TS allbox tab(:); lB lB lB lB. @@ -3821,100 +3638,12 @@ Example: \fRPHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0\&.12 T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&34.\ \&vrf 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\ \&35.\ \&wifi\-p2p 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\ \&36.\ \&wireguard 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\ \&37.\ \&wpan 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 .PP The following settings are not supported by \fIifcfg\-rh\fR plugin: .PP -802\-11\-olpc\-mesh, adsl, bluetooth, cdma, dummy, generic, gsm, ip\-tunnel, macsec, macvlan, ppp, pppoe, serial, tun, vpn, vxlan, wimax +6lowpan, 802\-11\-olpc\-mesh, adsl, bluetooth, cdma, dummy, generic, gsm, ip\-tunnel, link, loopback, macsec, macvlan, ovs\-bridge, ovs\-dpdk, ovs\-interface, ovs\-patch, ovs\-port, ppp, pppoe, serial, tun, veth, vpn, vrf, vxlan, wifi\-p2p, wimax, wireguard, wpan .SS "Secret flags" .PP Each secret property in a NetworkManager setting has an associated diff --git a/man/nm-settings-ifcfg-rh.xml b/man/nm-settings-ifcfg-rh.xml index 5f95e129..68445740 100644 --- a/man/nm-settings-ifcfg-rh.xml +++ b/man/nm-settings-ifcfg-rh.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-ifcfg-rh"><refentryinfo><title>nm-settings-ifcfg-rh</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-ifcfg-rh</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.42.8</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.44.0</refmiscinfo></refmeta><refnamediv><refname>nm-settings-ifcfg-rh</refname><refpurpose>Description of <emphasis>ifcfg-rh</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on the concept of connection profiles that contain network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing @@ -172,7 +172,7 @@ DEVICETYPE=TeamPort differences in NetworkManager and initscripts are documented in the tables below. </para></refsect1><refsect1 id="details"><title>Details</title><para><emphasis>ifcfg-rh</emphasis> plugin variables marked with <emphasis>(+)</emphasis> are NetworkManager specific extensions not understood by traditional initscripts. - </para><table><title>6lowpan setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>802-11-wireless setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">ssid</entry><entry align="left">ESSID</entry><entry align="left"/><entry align="left">SSID of Wi-Fi network.<emphasis role="bold"> + </para><table><title>802-11-wireless setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">ssid</entry><entry align="left">ESSID</entry><entry align="left"/><entry align="left">SSID of Wi-Fi network.<emphasis role="bold"> Example: </emphasis>ESSID="Quick Net"</entry></row><row><entry align="left">mode</entry><entry align="left">MODE</entry><entry align="left"/><entry align="left">Wi-Fi network mode.<emphasis role="bold"> @@ -184,7 +184,7 @@ Allowed values: </emphasis>a, bg</entry></row><row><entry align="left">channel</ Example: </emphasis>CHANNEL=6</entry></row><row><entry align="left">bssid</entry><entry align="left">BSSID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Restricts association only to a single AP.<emphasis role="bold"> -Example: </emphasis>BSSID=00:1E:BD:64:83:21</entry></row><row><entry align="left">rate</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">tx-power</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device.</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left">MACADDR</entry><entry align="left"/><entry align="left">Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).</entry></row><row><entry align="left">generate-mac-address-mask</entry><entry align="left">GENERATE_MAC_ADDRESS_MASK<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">the MAC address mask for generating randomized and stable cloned-mac-address.</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left">HWADDR_BLACKLIST<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">It denies usage of the connection for any device whose address is listed.</entry></row><row><entry align="left">seen-bssids</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">mtu</entry><entry align="left">MTU</entry><entry align="left"/><entry align="left">MTU of the wireless interface.</entry></row><row><entry align="left">hidden</entry><entry align="left">SSID_HIDDEN<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Whether the network hides the SSID.</entry></row><row><entry align="left">powersave</entry><entry align="left">POWERSAVE<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Enables or disables Wi-Fi power saving.<emphasis role="bold"> +Example: </emphasis>BSSID=00:1E:BD:64:83:21</entry></row><row><entry align="left">rate</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is deprecated and not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">tx-power</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is deprecated and not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device.</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left">MACADDR</entry><entry align="left"/><entry align="left">Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).</entry></row><row><entry align="left">generate-mac-address-mask</entry><entry align="left">GENERATE_MAC_ADDRESS_MASK<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">the MAC address mask for generating randomized and stable cloned-mac-address.</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left">HWADDR_BLACKLIST<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">It denies usage of the connection for any device whose address is listed.</entry></row><row><entry align="left">seen-bssids</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This is not a regular property that would be configured by the user. It is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">mtu</entry><entry align="left">MTU</entry><entry align="left"/><entry align="left">MTU of the wireless interface.</entry></row><row><entry align="left">hidden</entry><entry align="left">SSID_HIDDEN<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Whether the network hides the SSID.</entry></row><row><entry align="left">powersave</entry><entry align="left">POWERSAVE<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Enables or disables Wi-Fi power saving.<emphasis role="bold"> Example: </emphasis>POWERSAVE=enable<emphasis role="bold"> @@ -192,7 +192,7 @@ Allowed values: </emphasis>default, ignore, enable, disable</entry></row><row><e Example: </emphasis>MAC_ADDRESS_RANDOMIZATION=always<emphasis role="bold"> -Allowed values: </emphasis>default, never, always</entry></row><row><entry align="left">security</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is deprecated and not handled by ifcfg-rh-plugin.</entry></row><row><entry align="left">ap-isolation</entry><entry align="left">AP_ISOLATION<emphasis>(+)</emphasis></entry><entry align="left">missing variable means global default</entry><entry align="left">Whether AP isolation is enabled<emphasis role="bold"> +Allowed values: </emphasis>default, never, always</entry></row><row><entry align="left">ap-isolation</entry><entry align="left">AP_ISOLATION<emphasis>(+)</emphasis></entry><entry align="left">missing variable means global default</entry><entry align="left">Whether AP isolation is enabled<emphasis role="bold"> Allowed values: </emphasis>"yes", "no"</entry></row></tbody></tgroup></table><table><title>802-11-wireless-security setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">key-mgmt</entry><entry align="left">KEY_MGMT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Key management method.<emphasis role="bold"> @@ -479,9 +479,11 @@ Example: </emphasis>IPV6_TOKEN=::53</entry></row><row><entry align="left">ra-tim Example: </emphasis>IPV6_RA_TIMEOUT=10</entry></row><row><entry align="left">dhcp-duid</entry><entry align="left">DHCPV6_DUID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A string sent to the DHCPv6 server to identify the local machine. Apart from the special values "lease", "stable-llt", "stable-ll", "stable-uuid", "llt" and "ll" a binary value in hex format is expected. An hex string where each octet is separated by a colon is also accepted.<emphasis role="bold"> -Example: </emphasis>DHCPV6_DUID=LL; DHCPV6_DUID=0301deadbeef0001; DHCPV6_DUID=03:01:de:ad:be:ef:00:01</entry></row></tbody></tgroup></table><table><title>loopback setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">mtu</entry><entry align="left">MTU</entry><entry align="left"/><entry align="left">MTU of the interface.</entry></row></tbody></tgroup></table><table><title>match setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">path</entry><entry align="left">MATCH_PATH</entry><entry align="left"/><entry align="left">space-separated list of paths to match against the udev property ID_PATHS of devices<emphasis role="bold"> +Example: </emphasis>DHCPV6_DUID=LL; DHCPV6_DUID=0301deadbeef0001; DHCPV6_DUID=03:01:de:ad:be:ef:00:01</entry></row><row><entry align="left">dhcp-pd-hint</entry><entry align="left">DHCPV6_PD_HINT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Hint for DHCPv6 prefix delegation<emphasis role="bold"> -Example: </emphasis>MATCH_PATH="pci-0000:01:00.0 pci-0000:0c:00.0"</entry></row></tbody></tgroup></table><table><title>ovs-bridge setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-dpdk setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-external-ids setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-interface setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-other-config setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-patch setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>proxy setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">method</entry><entry align="left">PROXY_METHOD<emphasis>(+)</emphasis></entry><entry align="left">none</entry><entry align="left">Method for proxy configuration. For "auto", WPAD is used for proxy configuration, or set the PAC file via PAC_URL or PAC_SCRIPT.<emphasis role="bold"> +Example: </emphasis>DHCPV6_PD_HINT=2001:db8:1111:2220::/60 DHCPV6_PD_HINT=::/60</entry></row></tbody></tgroup></table><table><title>match setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">path</entry><entry align="left">MATCH_PATH</entry><entry align="left"/><entry align="left">space-separated list of paths to match against the udev property ID_PATHS of devices<emphasis role="bold"> + +Example: </emphasis>MATCH_PATH="pci-0000:01:00.0 pci-0000:0c:00.0"</entry></row></tbody></tgroup></table><table><title>ovs-external-ids setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ovs-other-config setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>proxy setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">method</entry><entry align="left">PROXY_METHOD<emphasis>(+)</emphasis></entry><entry align="left">none</entry><entry align="left">Method for proxy configuration. For "auto", WPAD is used for proxy configuration, or set the PAC file via PAC_URL or PAC_SCRIPT.<emphasis role="bold"> Allowed values: </emphasis>none, auto</entry></row><row><entry align="left">browser-only</entry><entry align="left">BROWSER_ONLY<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Whether the proxy configuration is for browser only.</entry></row><row><entry align="left">pac-url</entry><entry align="left">PAC_URL<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">URL for PAC file.<emphasis role="bold"> @@ -499,7 +501,7 @@ Example: </emphasis>QDISC1=ingress, QDISC2="root handle 1234: fq_codel"</entry>< Example: </emphasis>FILTER1="parent ffff: matchall action simple sdata Input", ...</entry></row></tbody></tgroup></table><table><title>team setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">config</entry><entry align="left">TEAM_CONFIG</entry><entry align="left"/><entry align="left">Team configuration in JSON. See man teamd.conf for details.</entry></row></tbody></tgroup></table><table><title>team-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">config</entry><entry align="left">TEAM_PORT_CONFIG</entry><entry align="left"/><entry align="left">Team port configuration in JSON. See man teamd.conf for details.</entry></row></tbody></tgroup></table><table><title>user setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">data</entry><entry align="left">NM_USER_*</entry><entry align="left"/><entry align="left">each key/value pair is stored as a separate variable with name composed by concatenating NM_USER_ with the encoded key. The key is encoded by substituting lowercase letters with uppercase and prepending uppercase letters with an underscore. A dot is encoded as a double underscore. Remaining characters are encoded as underscore followed by a 3 digit octal representation of the character.<emphasis role="bold"> -Example: </emphasis>NM_USER_FOO__BAR=something</entry></row></tbody></tgroup></table><table><title>veth setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>vlan setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">parent</entry><entry align="left">DEVICE or PHYSDEV</entry><entry align="left"/><entry align="left">Parent interface of the VLAN.</entry></row><row><entry align="left">id</entry><entry align="left">VLAN_ID, DEVICE.</entry><entry align="left"/><entry align="left">VLAN identifier. If VLAN_ID is not set, it is attempted to be detected from the suffix of DEVICE=. Note that older versions of NetworkManager had a bug where they would prefer the detected ID from the DEVICE over VLAN_ID.</entry></row><row><entry align="left">flags</entry><entry align="left">GVRP, MVRP, VLAN_FLAGS</entry><entry align="left"/><entry align="left">VLAN flags.<emphasis role="bold"> +Example: </emphasis>NM_USER_FOO__BAR=something</entry></row></tbody></tgroup></table><table><title>vlan setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">parent</entry><entry align="left">DEVICE or PHYSDEV</entry><entry align="left"/><entry align="left">Parent interface of the VLAN.</entry></row><row><entry align="left">id</entry><entry align="left">VLAN_ID, DEVICE.</entry><entry align="left"/><entry align="left">VLAN identifier. If VLAN_ID is not set, it is attempted to be detected from the suffix of DEVICE=. Note that older versions of NetworkManager had a bug where they would prefer the detected ID from the DEVICE over VLAN_ID.</entry></row><row><entry align="left">flags</entry><entry align="left">GVRP, MVRP, VLAN_FLAGS</entry><entry align="left"/><entry align="left">VLAN flags.<emphasis role="bold"> Allowed values: </emphasis>"yes or "no" for GVRP and MVRP; "LOOSE_BINDING" and "NO_REORDER_HDR" for VLAN_FLAGS</entry></row><row><entry align="left">protocol</entry><entry align="left">VLAN_PROTOCOL</entry><entry align="left"/><entry align="left">VLAN protocol.<emphasis role="bold"> @@ -509,7 +511,7 @@ Example: </emphasis>VLAN_INGRESS_PRIORITY_MAP=4:2,3:5</entry></row><row><entry a Example: </emphasis>VLAN_EGRESS_PRIORITY_MAP=5:4,4:1,3:7</entry></row><row><entry align="left">interface-name</entry><entry align="left">PHYSDEV and VLAN_ID, or DEVICE</entry><entry align="left"/><entry align="left">VLAN interface name. If all variables are set, parent device from PHYSDEV takes precedence over DEVICE, but VLAN id from DEVICE takes precedence over VLAN_ID.<emphasis role="bold"> -Example: </emphasis>PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12</entry></row></tbody></tgroup></table><table><title>vrf setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>wifi-p2p setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>wireguard setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>wpan setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><para>The following settings are not supported by <emphasis>ifcfg-rh</emphasis> plugin:</para><para>802-11-olpc-mesh, adsl, bluetooth, cdma, dummy, generic, gsm, ip-tunnel, macsec, macvlan, ppp, pppoe, serial, tun, vpn, vxlan, wimax</para><refsect2 id="secrets-flags"><title>Secret flags</title><para> +Example: </emphasis>PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12</entry></row></tbody></tgroup></table><para>The following settings are not supported by <emphasis>ifcfg-rh</emphasis> plugin:</para><para>6lowpan, 802-11-olpc-mesh, adsl, bluetooth, cdma, dummy, generic, gsm, ip-tunnel, link, loopback, macsec, macvlan, ovs-bridge, ovs-dpdk, ovs-interface, ovs-patch, ovs-port, ppp, pppoe, serial, tun, veth, vpn, vrf, vxlan, wifi-p2p, wimax, wireguard, wpan</para><refsect2 id="secrets-flags"><title>Secret flags</title><para> Each secret property in a NetworkManager setting has an associated <emphasis>flags</emphasis> property that describes how to handle that secret. In the <emphasis>ifcfg-rh</emphasis> plugin variables for secret flags have a diff --git a/man/nm-settings-ifcfg-rh.xsl b/man/nm-settings-ifcfg-rh.xsl index 2aa44489..b389b7e9 100644 --- a/man/nm-settings-ifcfg-rh.xsl +++ b/man/nm-settings-ifcfg-rh.xsl @@ -334,7 +334,7 @@ DEVICETYPE=TeamPort <xsl:template match="setting"> <xsl:variable name="setting_name" select="../@name"/> - <xsl:variable name="unsupported" select="'802-11-olpc-mesh, adsl, bluetooth, cdma, dummy, generic, gsm, ip-tunnel, macsec, macvlan, ppp, pppoe, serial, tun, vpn, vxlan, wimax'"/> + <xsl:variable name="unsupported" select="'6lowpan, 802-11-olpc-mesh, adsl, bluetooth, cdma, dummy, generic, gsm, ip-tunnel, link, loopback, macsec, macvlan, ovs-bridge, ovs-dpdk, ovs-interface, ovs-patch, ovs-port, ppp, pppoe, serial, tun, veth, vpn, vrf, vxlan, wifi-p2p, wimax, wireguard, wpan'"/> <xsl:if test="not (contains(concat(' ', $unsupported, ','), concat(' ', @name, ',')))"> <table> <title><xsl:value-of select="@name"/> setting</title> @@ -381,7 +381,7 @@ DEVICETYPE=TeamPort </entry> <entry align="left"><xsl:value-of select="@default"/></entry> <entry align="left"> - <xsl:value-of select="@description"/><xsl:if test="@format = 'NMSettingSecretFlags'"> (see <xref linkend="secrets-flags"/> for _FLAGS values)</xsl:if> + <xsl:value-of select="description"/><xsl:if test="@format = 'NMSettingSecretFlags'"> (see <xref linkend="secrets-flags"/> for _FLAGS values)</xsl:if> <xsl:if test="string-length(@example)"> <emphasis role="bold"> diff --git a/man/nm-settings-keyfile.5 b/man/nm-settings-keyfile.5 index 6a412e2f..a57c802f 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: Configuration -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.42\&.8" "Configuration" +.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.44\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-settings-keyfile.xml b/man/nm-settings-keyfile.xml index e7e87cf7..9dfa5fe8 100644 --- a/man/nm-settings-keyfile.xml +++ b/man/nm-settings-keyfile.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-keyfile"><refentryinfo><title>nm-settings-keyfile</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-keyfile</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.42.8</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.44.0</refmiscinfo></refmeta><refnamediv><refname>nm-settings-keyfile</refname><refpurpose>Description of <emphasis>keyfile</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on the concept of connection profiles that contain network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing diff --git a/man/nm-settings-keyfile.xsl b/man/nm-settings-keyfile.xsl index c70228bb..d63abf0f 100644 --- a/man/nm-settings-keyfile.xsl +++ b/man/nm-settings-keyfile.xsl @@ -284,7 +284,7 @@ id=4 <entry align="left"><xsl:value-of select="@variable"/></entry> <entry align="left"><xsl:value-of select="@format"/></entry> <entry align="left"> - <xsl:value-of select="@description"/> + <xsl:value-of select="description"/> <xsl:if test="string-length(@example)"> <emphasis role="bold"> diff --git a/man/nm-settings-nmcli.5 b/man/nm-settings-nmcli.5 index 8fedd64b..bbc6645f 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: Configuration -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NM\-SETTINGS\-NMCLI" "5" "" "NetworkManager 1\&.42\&.8" "Configuration" +.TH "NM\-SETTINGS\-NMCLI" "5" "" "NetworkManager 1\&.44\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -68,7 +68,7 @@ General Connection Profile Settings\&. .PP Properties: .PP -\fBauth\-retries\fR +\fBconnection\&.auth\-retries\fR .RS 4 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\&. .sp @@ -77,7 +77,7 @@ Currently, this only applies to 802\-1x authentication\&. Format: int32 .RE .PP -\fBautoconnect\fR +\fBconnection\&.autoconnect\fR .RS 4 Alias: autoconnect .sp @@ -94,28 +94,28 @@ Depending on "connection\&.multi\-connect", a profile can (auto)connect only onc Format: boolean .RE .PP -\fBautoconnect\-priority\fR +\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 .RE .PP -\fBautoconnect\-retries\fR +\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 .RE .PP -\fBautoconnect\-slaves\fR +\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) .RE .PP -\fBdns\-over\-tls\fR +\fBconnection\&.dns\-over\-tls\fR .RS 4 Whether DNSOverTls (dns\-over\-tls) is enabled for the connection\&. DNSOverTls is a technology which uses TLS to encrypt dns traffic\&. .sp @@ -126,14 +126,14 @@ This feature requires a plugin which supports DNSOverTls\&. Otherwise, the setti Format: int32 .RE .PP -\fBgateway\-ping\-timeout\fR +\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 .RE .PP -\fBid\fR +\fBconnection\&.id\fR .RS 4 Alias: con\-name .sp @@ -142,7 +142,7 @@ A human readable unique identifier for the connection, like "Work Wi\-Fi" or "T\ Format: string .RE .PP -\fBinterface\-name\fR +\fBconnection\&.interface\-name\fR .RS 4 Alias: ifname .sp @@ -155,14 +155,14 @@ For connection types where interface names cannot easily be made persistent (e\& Format: string .RE .PP -\fBlldp\fR +\fBconnection\&.lldp\fR .RS 4 Whether LLDP is enabled for the connection\&. .sp Format: int32 .RE .PP -\fBllmnr\fR +\fBconnection\&.llmnr\fR .RS 4 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\&. .sp @@ -173,7 +173,7 @@ This feature requires a plugin which supports LLMNR\&. Otherwise, the setting ha Format: int32 .RE .PP -\fBmaster\fR +\fBconnection\&.master\fR .RS 4 Alias: master .sp @@ -182,7 +182,7 @@ Interface name of the master device or UUID of the master connection\&. Format: string .RE .PP -\fBmdns\fR +\fBconnection\&.mdns\fR .RS 4 Whether mDNS is enabled for the connection\&. .sp @@ -193,7 +193,7 @@ This feature requires a plugin which supports mDNS\&. Otherwise, the setting has Format: int32 .RE .PP -\fBmetered\fR +\fBconnection\&.metered\fR .RS 4 Whether the connection is metered\&. .sp @@ -202,7 +202,7 @@ When updating this property on a currently activated connection, the change take Format: NMMetered (int32) .RE .PP -\fBmptcp\-flags\fR +\fBconnection\&.mptcp\-flags\fR .RS 4 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\&. .sp @@ -225,7 +225,7 @@ Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when M Format: uint32 .RE .PP -\fBmud\-url\fR +\fBconnection\&.mud\-url\fR .RS 4 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://"\&. .sp @@ -236,14 +236,14 @@ If the per\-profile value is unspecified (the default), a global connection defa Format: string .RE .PP -\fBmulti\-connect\fR +\fBconnection\&.multi\-connect\fR .RS 4 Specifies whether the profile can be active multiple times at a particular moment\&. The value is of type NMConnectionMultiConnect\&. .sp Format: int32 .RE .PP -\fBpermissions\fR +\fBconnection\&.permissions\fR .RS 4 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"\&. .sp @@ -252,21 +252,14 @@ At this time only the "user" [type] is allowed\&. Any other values are ignored a Format: array of string .RE .PP -\fBread\-only\fR -.RS 4 -FALSE if the connection can be modified using the provided settings service\*(Aqs D\-Bus interface with the right privileges, or TRUE if the connection is read\-only and cannot be modified\&. -.sp -Format: boolean -.RE -.PP -\fBsecondaries\fR +\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 .RE .PP -\fBslave\-type\fR +\fBconnection\&.slave\-type\fR .RS 4 Alias: slave\-type .sp @@ -275,22 +268,22 @@ Setting name of the device type of this slave\*(Aqs master connection (eg, "bond Format: string .RE .PP -\fBstable\-id\fR +\fBconnection\&.stable\-id\fR .RS 4 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\&. .sp -The stable\-id is used for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. It is also used as DHCP client identifier with ipv4\&.dhcp\-client\-id=stable and to derive the DHCP DUID with ipv6\&.dhcp\-duid=stable\-[llt,ll,uuid]\&. +The stable\-id is used for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. It is also used to derive the DHCP client identifier with ipv4\&.dhcp\-client\-id=stable, the DHCPv6 DUID with ipv6\&.dhcp\-duid=stable\-[llt,ll,uuid] and the DHCP IAID with ipv4\&.iaid=stable and ipv6\&.iaid=stable\&. .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 runtime\&. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}"\&. These effectively create unique IDs per\-connection, per\-device, per\-boot, or every time\&. Note that "${DEVICE}" corresponds to the interface name of the device and "${MAC}" is the permanent MAC address of the device\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}\-${BOOT}\-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates\&. +The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at 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\&. .sp -If the value is unset, a global connection default is consulted\&. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection\&. +If the value is unset, a global connection default is consulted\&. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile\&. .sp Format: string .RE .PP -\fBtimestamp\fR +\fBconnection\&.timestamp\fR .RS 4 The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated\&. .sp @@ -299,7 +292,7 @@ NetworkManager updates the connection timestamp periodically when the connection Format: uint64 .RE .PP -\fBtype\fR +\fBconnection\&.type\fR .RS 4 Alias: type .sp @@ -308,16 +301,16 @@ Base type of the connection\&. For hardware\-dependent connections, should conta Format: string .RE .PP -\fBuuid\fR +\fBconnection\&.uuid\fR .RS 4 -A universally unique identifier for the connection, for example generated with libuuid\&. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network\&. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re\-created when the Wi\-Fi SSID, mobile broadband network provider, or "type" property changes\&. +The 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`\&. .sp -The UUID must be in the format "2815492f\-7e56\-435e\-b2e9\-246bd7cdc664" (ie, contains only hexadecimal characters and "\-")\&. +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)\&. .RE .PP -\fBwait\-activation\-delay\fR +\fBconnection\&.wait\-activation\-delay\fR .RS 4 Time in milliseconds to wait for connection to be considered activated\&. The wait will start after the pre\-up dispatcher event\&. .sp @@ -326,7 +319,7 @@ The value 0 means no wait time\&. The default value is \-1, which currently has Format: int32 .RE .PP -\fBwait\-device\-timeout\fR +\fBconnection\&.wait\-device\-timeout\fR .RS 4 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\&. .sp @@ -335,7 +328,7 @@ The value 0 means no wait time\&. The default value is \-1, which currently has Format: int32 .RE .PP -\fBzone\fR +\fBconnection\&.zone\fR .RS 4 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\&. .sp @@ -349,7 +342,7 @@ Format: string .PP Properties: .PP -\fBparent\fR +\fB6lowpan\&.parent\fR .RS 4 Alias: dev .sp @@ -363,28 +356,28 @@ IEEE 802\&.1x Authentication Settings\&. .PP Properties: .PP -\fBaltsubject\-matches\fR +\fB802\-1x\&.altsubject\-matches\fR .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 .RE .PP -\fBanonymous\-identity\fR +\fB802\-1x\&.anonymous\-identity\fR .RS 4 Anonymous identity string for EAP authentication methods\&. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP\-TTLS\&. .sp Format: string .RE .PP -\fBauth\-timeout\fR +\fB802\-1x\&.auth\-timeout\fR .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 .RE .PP -\fBca\-cert\fR +\fB802\-1x\&.ca\-cert\fR .RS 4 Contains the CA certificate if used by the EAP method specified in the "eap" property\&. .sp @@ -395,21 +388,25 @@ Note that enabling NMSetting8021x:system\-ca\-certs will override this setting t Format: byte array .RE .PP -\fBca\-cert\-password\fR +\fB802\-1x\&.ca\-cert\-password\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBca\-cert\-password\-flags\fR +\fB802\-1x\&.ca\-cert\-password\-flags\fR .RS 4 Flags indicating how to handle the "ca\-cert\-password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBca\-path\fR +\fB802\-1x\&.ca\-path\fR .RS 4 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\&. .sp @@ -418,7 +415,7 @@ If NMSetting8021x:system\-ca\-certs is enabled and the built\-in CA path is an e Format: string .RE .PP -\fBclient\-cert\fR +\fB802\-1x\&.client\-cert\fR .RS 4 Contains the client certificate if used by the EAP method specified in the "eap" property\&. .sp @@ -427,140 +424,152 @@ Certificate data is specified using a "scheme"; two are currently supported: blo Format: byte array .RE .PP -\fBclient\-cert\-password\fR +\fB802\-1x\&.client\-cert\-password\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBclient\-cert\-password\-flags\fR +\fB802\-1x\&.client\-cert\-password\-flags\fR .RS 4 Flags indicating how to handle the "client\-cert\-password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBdomain\-match\fR +\fB802\-1x\&.domain\-match\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBdomain\-suffix\-match\fR +\fB802\-1x\&.domain\-suffix\-match\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBeap\fR +\fB802\-1x\&.eap\fR .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 .RE .PP -\fBidentity\fR +\fB802\-1x\&.identity\fR .RS 4 Identity string for EAP authentication methods\&. Often the user\*(Aqs user or login name\&. .sp Format: string .RE .PP -\fBoptional\fR +\fB802\-1x\&.optional\fR .RS 4 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 .RE .PP -\fBpac\-file\fR +\fB802\-1x\&.pac\-file\fR .RS 4 UTF\-8 encoded file path containing PAC for EAP\-FAST\&. .sp Format: string .RE .PP -\fBpassword\fR +\fB802\-1x\&.password\fR .RS 4 UTF\-8 encoded password used for EAP authentication methods\&. If both the "password" property and the "password\-raw" property are specified, "password" is preferred\&. .sp Format: string .RE .PP -\fBpassword\-flags\fR +\fB802\-1x\&.password\-flags\fR .RS 4 Flags indicating how to handle the "password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBpassword\-raw\fR +\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 .RE .PP -\fBpassword\-raw\-flags\fR +\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\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBphase1\-auth\-flags\fR +\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 .RE .PP -\fBphase1\-fast\-provisioning\fR +\fB802\-1x\&.phase1\-fast\-provisioning\fR .RS 4 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 .RE .PP -\fBphase1\-peaplabel\fR +\fB802\-1x\&.phase1\-peaplabel\fR .RS 4 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 .RE .PP -\fBphase1\-peapver\fR +\fB802\-1x\&.phase1\-peapver\fR .RS 4 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 .RE .PP -\fBphase2\-altsubject\-matches\fR +\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 .RE .PP -\fBphase2\-auth\fR +\fB802\-1x\&.phase2\-auth\fR .RS 4 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 .RE .PP -\fBphase2\-autheap\fR +\fB802\-1x\&.phase2\-autheap\fR .RS 4 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 .RE .PP -\fBphase2\-ca\-cert\fR +\fB802\-1x\&.phase2\-ca\-cert\fR .RS 4 Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2\-auth" or "phase2\-autheap" properties\&. .sp @@ -571,21 +580,25 @@ Note that enabling NMSetting8021x:system\-ca\-certs will override this setting t Format: byte array .RE .PP -\fBphase2\-ca\-cert\-password\fR +\fB802\-1x\&.phase2\-ca\-cert\-password\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBphase2\-ca\-cert\-password\-flags\fR +\fB802\-1x\&.phase2\-ca\-cert\-password\-flags\fR .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\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBphase2\-ca\-path\fR +\fB802\-1x\&.phase2\-ca\-path\fR .RS 4 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\&. .sp @@ -594,7 +607,7 @@ If NMSetting8021x:system\-ca\-certs is enabled and the built\-in CA path is an e Format: string .RE .PP -\fBphase2\-client\-cert\fR +\fB802\-1x\&.phase2\-client\-cert\fR .RS 4 Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2\-auth" or "phase2\-autheap" properties\&. .sp @@ -603,35 +616,39 @@ Certificate data is specified using a "scheme"; two are currently supported: blo Format: byte array .RE .PP -\fBphase2\-client\-cert\-password\fR +\fB802\-1x\&.phase2\-client\-cert\-password\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBphase2\-client\-cert\-password\-flags\fR +\fB802\-1x\&.phase2\-client\-cert\-password\-flags\fR .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\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBphase2\-domain\-match\fR +\fB802\-1x\&.phase2\-domain\-match\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBphase2\-domain\-suffix\-match\fR +\fB802\-1x\&.phase2\-domain\-suffix\-match\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBphase2\-private\-key\fR +\fB802\-1x\&.phase2\-private\-key\fR .RS 4 Contains the "phase 2" inner private key when the "phase2\-auth" or "phase2\-autheap" property is set to "tls"\&. .sp @@ -640,21 +657,25 @@ Key data is specified using a "scheme"; two are currently supported: blob and pa Format: byte array .RE .PP -\fBphase2\-private\-key\-password\fR +\fB802\-1x\&.phase2\-private\-key\-password\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBphase2\-private\-key\-password\-flags\fR +\fB802\-1x\&.phase2\-private\-key\-password\-flags\fR .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\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBphase2\-subject\-match\fR +\fB802\-1x\&.phase2\-subject\-match\fR .RS 4 Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and should not be used\&. .sp @@ -663,21 +684,25 @@ This property is deprecated since version 1\&.2\&. Use "phase2\-domain\-suffix\- Format: string .RE .PP -\fBpin\fR +\fB802\-1x\&.pin\fR .RS 4 PIN used for EAP authentication methods\&. .sp Format: string .RE .PP -\fBpin\-flags\fR +\fB802\-1x\&.pin\-flags\fR .RS 4 Flags indicating how to handle the "pin" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBprivate\-key\fR +\fB802\-1x\&.private\-key\fR .RS 4 Contains the private key when the "eap" property is set to "tls"\&. .sp @@ -688,21 +713,25 @@ WARNING: "private\-key" is not a "secret" property, and thus unencrypted private Format: byte array .RE .PP -\fBprivate\-key\-password\fR +\fB802\-1x\&.private\-key\-password\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBprivate\-key\-password\-flags\fR +\fB802\-1x\&.private\-key\-password\-flags\fR .RS 4 Flags indicating how to handle the "private\-key\-password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBsubject\-match\fR +\fB802\-1x\&.subject\-match\fR .RS 4 Substring to be matched against the subject of the certificate presented by the authentication server\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and should not be used\&. .sp @@ -711,7 +740,7 @@ This property is deprecated since version 1\&.2\&. Use "phase2\-domain\-suffix\- Format: string .RE .PP -\fBsystem\-ca\-certs\fR +\fB802\-1x\&.system\-ca\-certs\fR .RS 4 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 @@ -723,7 +752,7 @@ ADSL Settings\&. .PP Properties: .PP -\fBencapsulation\fR +\fBadsl\&.encapsulation\fR .RS 4 Alias: encapsulation .sp @@ -732,7 +761,7 @@ Encapsulation of ADSL connection\&. Can be "vcmux" or "llc"\&. Format: string .RE .PP -\fBpassword\fR +\fBadsl\&.password\fR .RS 4 Alias: password .sp @@ -741,14 +770,18 @@ Password used to authenticate with the ADSL service\&. Format: string .RE .PP -\fBpassword\-flags\fR +\fBadsl\&.password\-flags\fR .RS 4 Flags indicating how to handle the "password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBprotocol\fR +\fBadsl\&.protocol\fR .RS 4 Alias: protocol .sp @@ -757,7 +790,7 @@ ADSL connection protocol\&. Can be "pppoa", "pppoe" or "ipoatm"\&. Format: string .RE .PP -\fBusername\fR +\fBadsl\&.username\fR .RS 4 Alias: username .sp @@ -766,14 +799,14 @@ Username used to authenticate with the ADSL service\&. Format: string .RE .PP -\fBvci\fR +\fBadsl\&.vci\fR .RS 4 VCI of ADSL connection .sp Format: uint32 .RE .PP -\fBvpi\fR +\fBadsl\&.vpi\fR .RS 4 VPI of ADSL connection .sp @@ -785,7 +818,7 @@ Bluetooth Settings\&. .PP Properties: .PP -\fBbdaddr\fR +\fBbluetooth\&.bdaddr\fR .RS 4 Alias: addr .sp @@ -794,7 +827,7 @@ The Bluetooth address of the device\&. Format: byte array .RE .PP -\fBtype\fR +\fBbluetooth\&.type\fR .RS 4 Alias: bt\-type .sp @@ -808,7 +841,7 @@ Bonding Settings\&. .PP Properties: .PP -\fBoptions\fR +\fBbond\&.options\fR .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 @@ -820,7 +853,7 @@ Bridging Settings\&. .PP Properties: .PP -\fBageing\-time\fR +\fBbridge\&.ageing\-time\fR .RS 4 Alias: ageing\-time .sp @@ -829,7 +862,7 @@ The Ethernet MAC address aging time, in seconds\&. Format: uint32 .RE .PP -\fBforward\-delay\fR +\fBbridge\&.forward\-delay\fR .RS 4 Alias: forward\-delay .sp @@ -838,7 +871,7 @@ The Spanning Tree Protocol (STP) forwarding delay, in seconds\&. Format: uint32 .RE .PP -\fBgroup\-address\fR +\fBbridge\&.group\-address\fR .RS 4 If specified, The MAC address of the multicast group this bridge uses for STP\&. .sp @@ -847,7 +880,7 @@ The address must be a link\-local address in standard Ethernet MAC address forma Format: byte array .RE .PP -\fBgroup\-forward\-mask\fR +\fBbridge\&.group\-forward\-mask\fR .RS 4 Alias: group\-forward\-mask .sp @@ -856,7 +889,7 @@ A mask of group addresses to forward\&. Usually, group addresses in the range fr Format: uint32 .RE .PP -\fBhello\-time\fR +\fBbridge\&.hello\-time\fR .RS 4 Alias: hello\-time .sp @@ -865,7 +898,7 @@ The Spanning Tree Protocol (STP) hello time, in seconds\&. Format: uint32 .RE .PP -\fBmac\-address\fR +\fBbridge\&.mac\-address\fR .RS 4 Alias: mac .sp @@ -878,7 +911,7 @@ This property is deprecated since version 1\&.12\&. Use the "cloned\-mac\-addres Format: byte array .RE .PP -\fBmax\-age\fR +\fBbridge\&.max\-age\fR .RS 4 Alias: max\-age .sp @@ -887,70 +920,70 @@ The Spanning Tree Protocol (STP) maximum message age, in seconds\&. Format: uint32 .RE .PP -\fBmulticast\-hash\-max\fR +\fBbridge\&.multicast\-hash\-max\fR .RS 4 Set maximum size of multicast hash table (value must be a power of 2)\&. .sp Format: uint32 .RE .PP -\fBmulticast\-last\-member\-count\fR +\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 .RE .PP -\fBmulticast\-last\-member\-interval\fR +\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 .RE .PP -\fBmulticast\-membership\-interval\fR +\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 .RE .PP -\fBmulticast\-querier\fR +\fBbridge\&.multicast\-querier\fR .RS 4 Enable or disable sending of multicast queries by the bridge\&. If not specified the option is disabled\&. .sp Format: boolean .RE .PP -\fBmulticast\-querier\-interval\fR +\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 .RE .PP -\fBmulticast\-query\-interval\fR +\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 .RE .PP -\fBmulticast\-query\-response\-interval\fR +\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 .RE .PP -\fBmulticast\-query\-use\-ifaddr\fR +\fBbridge\&.multicast\-query\-use\-ifaddr\fR .RS 4 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 .RE .PP -\fBmulticast\-router\fR +\fBbridge\&.multicast\-router\fR .RS 4 Sets bridge\*(Aqs multicast router\&. Multicast\-snooping must be enabled for this option to work\&. .sp @@ -959,7 +992,7 @@ Supported values are: \*(Aqauto\*(Aq, \*(Aqdisabled\*(Aq, \*(Aqenabled\*(Aq to w Format: string .RE .PP -\fBmulticast\-snooping\fR +\fBbridge\&.multicast\-snooping\fR .RS 4 Alias: multicast\-snooping .sp @@ -968,21 +1001,21 @@ Controls whether IGMP snooping is enabled for this bridge\&. Note that if snoopi Format: boolean .RE .PP -\fBmulticast\-startup\-query\-count\fR +\fBbridge\&.multicast\-startup\-query\-count\fR .RS 4 Set the number of IGMP queries to send during startup phase\&. .sp Format: uint32 .RE .PP -\fBmulticast\-startup\-query\-interval\fR +\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 .RE .PP -\fBpriority\fR +\fBbridge\&.priority\fR .RS 4 Alias: priority .sp @@ -991,7 +1024,7 @@ Sets the Spanning Tree Protocol (STP) priority for this bridge\&. Lower values a Format: uint32 .RE .PP -\fBstp\fR +\fBbridge\&.stp\fR .RS 4 Alias: stp .sp @@ -1000,21 +1033,21 @@ Controls whether Spanning Tree Protocol (STP) is enabled for this bridge\&. Format: boolean .RE .PP -\fBvlan\-default\-pvid\fR +\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 .RE .PP -\fBvlan\-filtering\fR +\fBbridge\&.vlan\-filtering\fR .RS 4 Control whether VLAN filtering is enabled on the bridge\&. .sp Format: boolean .RE .PP -\fBvlan\-protocol\fR +\fBbridge\&.vlan\-protocol\fR .RS 4 If specified, the protocol used for VLAN filtering\&. .sp @@ -1023,14 +1056,14 @@ Supported values are: \*(Aq802\&.1Q\*(Aq, \*(Aq802\&.1ad\*(Aq\&. If not specifie Format: string .RE .PP -\fBvlan\-stats\-enabled\fR +\fBbridge\&.vlan\-stats\-enabled\fR .RS 4 Controls whether per\-VLAN stats accounting is enabled\&. .sp Format: boolean .RE .PP -\fBvlans\fR +\fBbridge\&.vlans\fR .RS 4 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\&. .sp @@ -1048,7 +1081,7 @@ Bridge Port Settings\&. .PP Properties: .PP -\fBhairpin\-mode\fR +\fBbridge\-port\&.hairpin\-mode\fR .RS 4 Alias: hairpin .sp @@ -1057,7 +1090,7 @@ Enables or disables "hairpin mode" for the port, which allows frames to be sent Format: boolean .RE .PP -\fBpath\-cost\fR +\fBbridge\-port\&.path\-cost\fR .RS 4 Alias: path\-cost .sp @@ -1066,7 +1099,7 @@ The Spanning Tree Protocol (STP) port cost for destinations via this port\&. Format: uint32 .RE .PP -\fBpriority\fR +\fBbridge\-port\&.priority\fR .RS 4 Alias: priority .sp @@ -1075,7 +1108,7 @@ The Spanning Tree Protocol (STP) priority of this bridge port\&. Format: uint32 .RE .PP -\fBvlans\fR +\fBbridge\-port\&.vlans\fR .RS 4 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\&. .sp @@ -1093,21 +1126,21 @@ CDMA\-based Mobile Broadband Settings\&. .PP Properties: .PP -\fBmtu\fR +\fBcdma\&.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 .RE .PP -\fBnumber\fR +\fBcdma\&.number\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBpassword\fR +\fBcdma\&.password\fR .RS 4 Alias: password .sp @@ -1116,14 +1149,18 @@ The password used to authenticate with the network, if required\&. Many provider Format: string .RE .PP -\fBpassword\-flags\fR +\fBcdma\&.password\-flags\fR .RS 4 Flags indicating how to handle the "password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBusername\fR +\fBcdma\&.username\fR .RS 4 Alias: user .sp @@ -1137,14 +1174,14 @@ Data Center Bridging Settings\&. .PP Properties: .PP -\fBapp\-fcoe\-flags\fR +\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)\&. .sp Format: NMSettingDcbFlags (uint32) .RE .PP -\fBapp\-fcoe\-mode\fR +\fBdcb\&.app\-fcoe\-mode\fR .RS 4 The FCoE controller mode; either "fabric" or "vn2vn"\&. .sp @@ -1153,91 +1190,91 @@ Since 1\&.34, NULL is the default and means "fabric"\&. Before 1\&.34, NULL was Format: string .RE .PP -\fBapp\-fcoe\-priority\fR +\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\&. .sp Format: int32 .RE .PP -\fBapp\-fip\-flags\fR +\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)\&. .sp Format: NMSettingDcbFlags (uint32) .RE .PP -\fBapp\-fip\-priority\fR +\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\&. .sp Format: int32 .RE .PP -\fBapp\-iscsi\-flags\fR +\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)\&. .sp Format: NMSettingDcbFlags (uint32) .RE .PP -\fBapp\-iscsi\-priority\fR +\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\&. .sp Format: int32 .RE .PP -\fBpriority\-bandwidth\fR +\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 .RE .PP -\fBpriority\-flow\-control\fR +\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 .RE .PP -\fBpriority\-flow\-control\-flags\fR +\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)\&. .sp Format: NMSettingDcbFlags (uint32) .RE .PP -\fBpriority\-group\-bandwidth\fR +\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 .RE .PP -\fBpriority\-group\-flags\fR +\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)\&. .sp Format: NMSettingDcbFlags (uint32) .RE .PP -\fBpriority\-group\-id\fR +\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 .RE .PP -\fBpriority\-strict\-bandwidth\fR +\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 .RE .PP -\fBpriority\-traffic\-class\fR +\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 @@ -1249,351 +1286,351 @@ Ethtool Ethernet Settings\&. .PP Properties: .PP -\fBcoalesce\-adaptive\-rx\fR +\fBethtool\&.coalesce\-adaptive\-rx\fR .RS 4 .RE .PP -\fBcoalesce\-adaptive\-tx\fR +\fBethtool\&.coalesce\-adaptive\-tx\fR .RS 4 .RE .PP -\fBcoalesce\-pkt\-rate\-high\fR +\fBethtool\&.coalesce\-pkt\-rate\-high\fR .RS 4 .RE .PP -\fBcoalesce\-pkt\-rate\-low\fR +\fBethtool\&.coalesce\-pkt\-rate\-low\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-frames\fR +\fBethtool\&.coalesce\-rx\-frames\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-frames\-high\fR +\fBethtool\&.coalesce\-rx\-frames\-high\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-frames\-irq\fR +\fBethtool\&.coalesce\-rx\-frames\-irq\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-frames\-low\fR +\fBethtool\&.coalesce\-rx\-frames\-low\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-usecs\fR +\fBethtool\&.coalesce\-rx\-usecs\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-usecs\-high\fR +\fBethtool\&.coalesce\-rx\-usecs\-high\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-usecs\-irq\fR +\fBethtool\&.coalesce\-rx\-usecs\-irq\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-usecs\-low\fR +\fBethtool\&.coalesce\-rx\-usecs\-low\fR .RS 4 .RE .PP -\fBcoalesce\-sample\-interval\fR +\fBethtool\&.coalesce\-sample\-interval\fR .RS 4 .RE .PP -\fBcoalesce\-stats\-block\-usecs\fR +\fBethtool\&.coalesce\-stats\-block\-usecs\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-frames\fR +\fBethtool\&.coalesce\-tx\-frames\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-frames\-high\fR +\fBethtool\&.coalesce\-tx\-frames\-high\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-frames\-irq\fR +\fBethtool\&.coalesce\-tx\-frames\-irq\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-frames\-low\fR +\fBethtool\&.coalesce\-tx\-frames\-low\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-usecs\fR +\fBethtool\&.coalesce\-tx\-usecs\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-usecs\-high\fR +\fBethtool\&.coalesce\-tx\-usecs\-high\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-usecs\-irq\fR +\fBethtool\&.coalesce\-tx\-usecs\-irq\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-usecs\-low\fR +\fBethtool\&.coalesce\-tx\-usecs\-low\fR .RS 4 .RE .PP -\fBfeature\-esp\-hw\-offload\fR +\fBethtool\&.feature\-esp\-hw\-offload\fR .RS 4 .RE .PP -\fBfeature\-esp\-tx\-csum\-hw\-offload\fR +\fBethtool\&.feature\-esp\-tx\-csum\-hw\-offload\fR .RS 4 .RE .PP -\fBfeature\-fcoe\-mtu\fR +\fBethtool\&.feature\-fcoe\-mtu\fR .RS 4 .RE .PP -\fBfeature\-gro\fR +\fBethtool\&.feature\-gro\fR .RS 4 .RE .PP -\fBfeature\-gso\fR +\fBethtool\&.feature\-gso\fR .RS 4 .RE .PP -\fBfeature\-highdma\fR +\fBethtool\&.feature\-highdma\fR .RS 4 .RE .PP -\fBfeature\-hw\-tc\-offload\fR +\fBethtool\&.feature\-hw\-tc\-offload\fR .RS 4 .RE .PP -\fBfeature\-l2\-fwd\-offload\fR +\fBethtool\&.feature\-l2\-fwd\-offload\fR .RS 4 .RE .PP -\fBfeature\-loopback\fR +\fBethtool\&.feature\-loopback\fR .RS 4 .RE .PP -\fBfeature\-lro\fR +\fBethtool\&.feature\-lro\fR .RS 4 .RE .PP -\fBfeature\-macsec\-hw\-offload\fR +\fBethtool\&.feature\-macsec\-hw\-offload\fR .RS 4 .RE .PP -\fBfeature\-ntuple\fR +\fBethtool\&.feature\-ntuple\fR .RS 4 .RE .PP -\fBfeature\-rx\fR +\fBethtool\&.feature\-rx\fR .RS 4 .RE .PP -\fBfeature\-rx\-all\fR +\fBethtool\&.feature\-rx\-all\fR .RS 4 .RE .PP -\fBfeature\-rx\-fcs\fR +\fBethtool\&.feature\-rx\-fcs\fR .RS 4 .RE .PP -\fBfeature\-rx\-gro\-hw\fR +\fBethtool\&.feature\-rx\-gro\-hw\fR .RS 4 .RE .PP -\fBfeature\-rx\-gro\-list\fR +\fBethtool\&.feature\-rx\-gro\-list\fR .RS 4 .RE .PP -\fBfeature\-rx\-udp\-gro\-forwarding\fR +\fBethtool\&.feature\-rx\-udp\-gro\-forwarding\fR .RS 4 .RE .PP -\fBfeature\-rx\-udp_tunnel\-port\-offload\fR +\fBethtool\&.feature\-rx\-udp_tunnel\-port\-offload\fR .RS 4 .RE .PP -\fBfeature\-rx\-vlan\-filter\fR +\fBethtool\&.feature\-rx\-vlan\-filter\fR .RS 4 .RE .PP -\fBfeature\-rx\-vlan\-stag\-filter\fR +\fBethtool\&.feature\-rx\-vlan\-stag\-filter\fR .RS 4 .RE .PP -\fBfeature\-rx\-vlan\-stag\-hw\-parse\fR +\fBethtool\&.feature\-rx\-vlan\-stag\-hw\-parse\fR .RS 4 .RE .PP -\fBfeature\-rxhash\fR +\fBethtool\&.feature\-rxhash\fR .RS 4 .RE .PP -\fBfeature\-rxvlan\fR +\fBethtool\&.feature\-rxvlan\fR .RS 4 .RE .PP -\fBfeature\-sg\fR +\fBethtool\&.feature\-sg\fR .RS 4 .RE .PP -\fBfeature\-tls\-hw\-record\fR +\fBethtool\&.feature\-tls\-hw\-record\fR .RS 4 .RE .PP -\fBfeature\-tls\-hw\-rx\-offload\fR +\fBethtool\&.feature\-tls\-hw\-rx\-offload\fR .RS 4 .RE .PP -\fBfeature\-tls\-hw\-tx\-offload\fR +\fBethtool\&.feature\-tls\-hw\-tx\-offload\fR .RS 4 .RE .PP -\fBfeature\-tso\fR +\fBethtool\&.feature\-tso\fR .RS 4 .RE .PP -\fBfeature\-tx\fR +\fBethtool\&.feature\-tx\fR .RS 4 .RE .PP -\fBfeature\-tx\-checksum\-fcoe\-crc\fR +\fBethtool\&.feature\-tx\-checksum\-fcoe\-crc\fR .RS 4 .RE .PP -\fBfeature\-tx\-checksum\-ip\-generic\fR +\fBethtool\&.feature\-tx\-checksum\-ip\-generic\fR .RS 4 .RE .PP -\fBfeature\-tx\-checksum\-ipv4\fR +\fBethtool\&.feature\-tx\-checksum\-ipv4\fR .RS 4 .RE .PP -\fBfeature\-tx\-checksum\-ipv6\fR +\fBethtool\&.feature\-tx\-checksum\-ipv6\fR .RS 4 .RE .PP -\fBfeature\-tx\-checksum\-sctp\fR +\fBethtool\&.feature\-tx\-checksum\-sctp\fR .RS 4 .RE .PP -\fBfeature\-tx\-esp\-segmentation\fR +\fBethtool\&.feature\-tx\-esp\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-fcoe\-segmentation\fR +\fBethtool\&.feature\-tx\-fcoe\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-gre\-csum\-segmentation\fR +\fBethtool\&.feature\-tx\-gre\-csum\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-gre\-segmentation\fR +\fBethtool\&.feature\-tx\-gre\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-gso\-list\fR +\fBethtool\&.feature\-tx\-gso\-list\fR .RS 4 .RE .PP -\fBfeature\-tx\-gso\-partial\fR +\fBethtool\&.feature\-tx\-gso\-partial\fR .RS 4 .RE .PP -\fBfeature\-tx\-gso\-robust\fR +\fBethtool\&.feature\-tx\-gso\-robust\fR .RS 4 .RE .PP -\fBfeature\-tx\-ipxip4\-segmentation\fR +\fBethtool\&.feature\-tx\-ipxip4\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-ipxip6\-segmentation\fR +\fBethtool\&.feature\-tx\-ipxip6\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-nocache\-copy\fR +\fBethtool\&.feature\-tx\-nocache\-copy\fR .RS 4 .RE .PP -\fBfeature\-tx\-scatter\-gather\fR +\fBethtool\&.feature\-tx\-scatter\-gather\fR .RS 4 .RE .PP -\fBfeature\-tx\-scatter\-gather\-fraglist\fR +\fBethtool\&.feature\-tx\-scatter\-gather\-fraglist\fR .RS 4 .RE .PP -\fBfeature\-tx\-sctp\-segmentation\fR +\fBethtool\&.feature\-tx\-sctp\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-tcp\-ecn\-segmentation\fR +\fBethtool\&.feature\-tx\-tcp\-ecn\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-tcp\-mangleid\-segmentation\fR +\fBethtool\&.feature\-tx\-tcp\-mangleid\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-tcp\-segmentation\fR +\fBethtool\&.feature\-tx\-tcp\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-tcp6\-segmentation\fR +\fBethtool\&.feature\-tx\-tcp6\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-tunnel\-remcsum\-segmentation\fR +\fBethtool\&.feature\-tx\-tunnel\-remcsum\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-udp\-segmentation\fR +\fBethtool\&.feature\-tx\-udp\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-udp_tnl\-csum\-segmentation\fR +\fBethtool\&.feature\-tx\-udp_tnl\-csum\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-udp_tnl\-segmentation\fR +\fBethtool\&.feature\-tx\-udp_tnl\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-vlan\-stag\-hw\-insert\fR +\fBethtool\&.feature\-tx\-vlan\-stag\-hw\-insert\fR .RS 4 .RE .PP -\fBfeature\-txvlan\fR +\fBethtool\&.feature\-txvlan\fR .RS 4 .RE .PP -\fBpause\-autoneg\fR +\fBethtool\&.pause\-autoneg\fR .RS 4 .RE .PP -\fBpause\-rx\fR +\fBethtool\&.pause\-rx\fR .RS 4 .RE .PP -\fBpause\-tx\fR +\fBethtool\&.pause\-tx\fR .RS 4 .RE .PP -\fBring\-rx\fR +\fBethtool\&.ring\-rx\fR .RS 4 .RE .PP -\fBring\-rx\-jumbo\fR +\fBethtool\&.ring\-rx\-jumbo\fR .RS 4 .RE .PP -\fBring\-rx\-mini\fR +\fBethtool\&.ring\-rx\-mini\fR .RS 4 .RE .PP -\fBring\-tx\fR +\fBethtool\&.ring\-tx\fR .RS 4 .RE .SS "gsm setting" @@ -1602,7 +1639,7 @@ GSM\-based Mobile Broadband Settings\&. .PP Properties: .PP -\fBapn\fR +\fBgsm\&.apn\fR .RS 4 Alias: apn .sp @@ -1611,42 +1648,56 @@ The GPRS Access Point Name specifying the APN used when establishing a data sess Format: string .RE .PP -\fBauto\-config\fR +\fBgsm\&.auto\-config\fR .RS 4 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 .RE .PP -\fBdevice\-id\fR +\fBgsm\&.device\-id\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBhome\-only\fR +\fBgsm\&.home\-only\fR .RS 4 When TRUE, only connections to the home network will be allowed\&. Connections to roaming networks will not be made\&. .sp Format: boolean .RE .PP -\fBmtu\fR +\fBgsm\&.initial\-eps\-bearer\-apn\fR +.RS 4 +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\&. +.sp +Format: string +.RE +.PP +\fBgsm\&.initial\-eps\-bearer\-configure\fR +.RS 4 +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 +.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 .RE .PP -\fBnetwork\-id\fR +\fBgsm\&.network\-id\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBnumber\fR +\fBgsm\&.number\fR .RS 4 Legacy setting that used to help establishing PPP data sessions for GSM\-based modems\&. .sp @@ -1655,7 +1706,7 @@ This property is deprecated since version 1\&.16\&. User\-provided values for th Format: string .RE .PP -\fBpassword\fR +\fBgsm\&.password\fR .RS 4 Alias: password .sp @@ -1664,42 +1715,50 @@ The password used to authenticate with the network, if required\&. Many provider Format: string .RE .PP -\fBpassword\-flags\fR +\fBgsm\&.password\-flags\fR .RS 4 Flags indicating how to handle the "password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBpin\fR +\fBgsm\&.pin\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBpin\-flags\fR +\fBgsm\&.pin\-flags\fR .RS 4 Flags indicating how to handle the "pin" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBsim\-id\fR +\fBgsm\&.sim\-id\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBsim\-operator\-id\fR +\fBgsm\&.sim\-operator\-id\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBusername\fR +\fBgsm\&.username\fR .RS 4 Alias: user .sp @@ -1713,7 +1772,7 @@ Infiniband Settings\&. .PP Properties: .PP -\fBmac\-address\fR +\fBinfiniband\&.mac\-address\fR .RS 4 Alias: mac .sp @@ -1722,7 +1781,7 @@ If specified, this connection will only apply to the IPoIB device whose permanen Format: byte array .RE .PP -\fBmtu\fR +\fBinfiniband\&.mtu\fR .RS 4 Alias: mtu .sp @@ -1731,7 +1790,7 @@ If non\-zero, only transmit packets of the specified size or smaller, breaking l Format: uint32 .RE .PP -\fBp\-key\fR +\fBinfiniband\&.p\-key\fR .RS 4 Alias: p\-key .sp @@ -1744,7 +1803,7 @@ Note that kernel will internally always set the full membership bit, although th Format: int32 .RE .PP -\fBparent\fR +\fBinfiniband\&.parent\fR .RS 4 Alias: parent .sp @@ -1753,7 +1812,7 @@ The interface name of the parent device of this device\&. Normally NULL, but if Format: string .RE .PP -\fBtransport\-mode\fR +\fBinfiniband\&.transport\-mode\fR .RS 4 Alias: transport\-mode .sp @@ -1767,16 +1826,16 @@ IPv4 Settings\&. .PP Properties: .PP -\fBaddresses\fR +\fBipv4\&.addresses\fR .RS 4 Alias: ip4 .sp -Array of IP addresses\&. +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 .RE .PP -\fBauto\-route\-ext\-gw\fR +\fBipv4\&.auto\-route\-ext\-gw\fR .RS 4 VPN connections will default to add the route automatically unless this setting is set to FALSE\&. .sp @@ -1785,7 +1844,7 @@ For other connection types, adding such an automatic route is currently not supp Format: NMTernary (int32) .RE .PP -\fBdad\-timeout\fR +\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\&. .sp @@ -1794,7 +1853,7 @@ The property is currently implemented only for IPv4\&. Format: int32 .RE .PP -\fBdhcp\-client\-id\fR +\fBipv4\&.dhcp\-client\-id\fR .RS 4 A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options\&. When the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary client ID, in which case the first byte is assumed to be the \*(Aqtype\*(Aq field as per RFC 2132 section 9\&.14 and the remaining bytes may be an hardware address (e\&.g\&. \*(Aq01:xx:xx:xx:xx:xx:xx\*(Aq where 1 is the Ethernet ARP type and the rest is a MAC address)\&. If the property is not a hex string it is considered as a non\-hardware\-address client ID and the \*(Aqtype\*(Aq field is set to 0\&. .sp @@ -1811,21 +1870,21 @@ If unset, a globally configured default is used\&. If still unset, the default d Format: string .RE .PP -\fBdhcp\-fqdn\fR +\fBipv4\&.dhcp\-fqdn\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBdhcp\-hostname\fR +\fBipv4\&.dhcp\-hostname\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBdhcp\-hostname\-flags\fR +\fBipv4\&.dhcp\-hostname\-flags\fR .RS 4 Flags for the DHCP hostname and FQDN\&. .sp @@ -1836,9 +1895,9 @@ When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), Format: uint32 .RE .PP -\fBdhcp\-iaid\fR +\fBipv4\&.dhcp\-iaid\fR .RS 4 -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. +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"\&. .sp For DHCPv4, the IAID is only used with "ipv4\&.dhcp\-client\-id" values "duid" and "ipv6\-duid" to generate the client\-id\&. .sp @@ -1849,7 +1908,7 @@ The actually used DHCPv6 IAID for a currently activated interface is exposed in Format: string .RE .PP -\fBdhcp\-reject\-servers\fR +\fBipv4\&.dhcp\-reject\-servers\fR .RS 4 Array of servers from which DHCP offers must be rejected\&. This property is useful to avoid getting a lease from misconfigured or rogue servers\&. .sp @@ -1860,14 +1919,14 @@ This property is currently not implemented for DHCPv6\&. Format: array of string .RE .PP -\fBdhcp\-send\-hostname\fR +\fBipv4\&.dhcp\-send\-hostname\fR .RS 4 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 .RE .PP -\fBdhcp\-timeout\fR +\fBipv4\&.dhcp\-timeout\fR .RS 4 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)\&. .sp @@ -1876,14 +1935,14 @@ Set to 2147483647 (MAXINT32) for infinity\&. Format: int32 .RE .PP -\fBdhcp\-vendor\-class\-identifier\fR +\fBipv4\&.dhcp\-vendor\-class\-identifier\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBdns\fR +\fBipv4\&.dns\fR .RS 4 Array of IP addresses of DNS servers\&. .sp @@ -1892,22 +1951,24 @@ For DoT (DNS over TLS), the SNI server name can be specified by appending "#exam Format: array of uint32 .RE .PP -\fBdns\-options\fR +\fBipv4\&.dns\-options\fR .RS 4 -Array of DNS options as described in man 5 resolv\&.conf\&. +DNS options for /etc/resolv\&.conf as described in resolv\&.conf(5) manual\&. .sp -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", "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\&. .sp -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"\&. +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\&. .sp 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\&. .sp When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added\&. .sp -Format: array of string +The valid "ipv4\&.dns\-options" and "ipv6\&.dns\-options" get merged together\&. +.sp +Format: a comma separated list of DNS options .RE .PP -\fBdns\-priority\fR +\fBipv4\&.dns\-priority\fR .RS 4 DNS servers priority\&. .sp @@ -1928,7 +1989,7 @@ When using a DNS resolver that supports Conditional Forwarding or Split DNS (wit Format: int32 .RE .PP -\fBdns\-search\fR +\fBipv4\&.dns\-search\fR .RS 4 List of DNS search domains\&. Domains starting with a tilde (\*(Aq~\*(Aq) are considered \*(Aqrouting\*(Aq domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names\&. .sp @@ -1939,7 +2000,7 @@ When set on a profile that also enabled DHCP, the DNS search list received autom Format: array of string .RE .PP -\fBgateway\fR +\fBipv4\&.gateway\fR .RS 4 Alias: gw4 .sp @@ -1952,21 +2013,21 @@ Note that the gateway usually conflicts with routing that NetworkManager configu Format: string .RE .PP -\fBignore\-auto\-dns\fR +\fBipv4\&.ignore\-auto\-dns\fR .RS 4 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 .RE .PP -\fBignore\-auto\-routes\fR +\fBipv4\&.ignore\-auto\-routes\fR .RS 4 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 .RE .PP -\fBlink\-local\fR +\fBipv4\&.link\-local\fR .RS 4 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\&. .sp @@ -1975,43 +2036,95 @@ When set to "auto", the value is dependent on "ipv4\&.method"\&. When set to "de Format: int32 .RE .PP -\fBmay\-fail\fR +\fBipv4\&.may\-fail\fR .RS 4 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 .RE .PP -\fBmethod\fR +\fBipv4\&.method\fR .RS 4 -IP configuration method\&. +Sets the IPv4 connection method\&. You can set one of the following values: .sp -NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link\-local"\&. See the subclass\-specific documentation for other values\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"auto" +\- Enables automatic IPv4 address assignment from DHCP, PPP, or similar services\&. +.RE .sp -In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration\&. The "ignore\-auto\-routes" and "ignore\-auto\-dns" properties modify this behavior\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"manual" +\- Enables the configuration of static IPv4 addresses on the interface\&. Note that you must set at least one IP address and subnet mask in the "ipv4\&.addresses" property\&. +.RE .sp -For methods that imply no upstream network, such as "shared" or "link\-local", these properties must be empty\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"disabled" +\- Disables the IPv4 protocol in this connection profile\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"shared" +\- Provides network access to other computers\&. If you do not specify an IP address and subnet mask in "ipv4\&.addresses", NetworkManager assigns 10\&.42\&.x\&.1/24 to the interface\&. Additionally, NetworkManager starts a DHCP server and DNS forwarder\&. Hosts that connect to this interface will then receive an IP address from the configured range, and NetworkManager configures NAT to map client addresses to the one of the current default network connection\&. +.RE .sp -For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10\&.42\&.x\&.0/24 is chosen\&. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"link\-local" +\- Enables link\-local addresses according to RFC 3927\&. NetworkManager assigns a random link\-local address from the 169\&.254\&.0\&.0/16 subnet to the interface\&. +.RE .sp Format: string .RE .PP -\fBnever\-default\fR +\fBipv4\&.never\-default\fR .RS 4 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 .RE .PP -\fBreplace\-local\-rule\fR +\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) .RE .PP -\fBrequired\-timeout\fR +\fBipv4\&.required\-timeout\fR .RS 4 The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds\&. .sp @@ -2024,14 +2137,14 @@ A zero value means that no required timeout is present, \-1 means the default va Format: int32 .RE .PP -\fBroute\-metric\fR +\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 .RE .PP -\fBroute\-table\fR +\fBipv4\&.route\-table\fR .RS 4 Enable policy routing (source routing) and set the routing table used when adding routes\&. .sp @@ -2044,7 +2157,7 @@ Policy routing disabled means that NetworkManager will add all routes to the mai Format: uint32 .RE .PP -\fBroutes\fR +\fBipv4\&.routes\fR .RS 4 A list of IPv4 destination addresses, prefix length, optional IPv4 next hop addresses, optional route metric, optional attribute\&. The valid syntax is: "ip[/prefix] [next\-hop] [metric] [attribute=val]\&.\&.\&.[,ip[/prefix]\&.\&.\&.]"\&. For example "192\&.0\&.2\&.0/24 10\&.1\&.1\&.1 77, 198\&.51\&.100\&.0/24"\&. .sp @@ -2316,7 +2429,7 @@ For details see also `man ip\-route`\&. Format: a comma separated list of routes .RE .PP -\fBrouting\-rules\fR +\fBipv4\&.routing\-rules\fR .RS 4 A comma separated list of routing rules for policy routing\&. The format is based on \fBip rule add\fR @@ -2333,33 +2446,35 @@ IPv6 Settings\&. .PP Properties: .PP -\fBaddr\-gen\-mode\fR +\fBipv6\&.addr\-gen\-mode\fR .RS 4 -Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration\&. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1)\&. NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3)\&. +Configure method for creating the IPv6 interface identifer of addresses with RFC4862 IPv6 Stateless Address Autoconfiguration and Link Local addresses\&. .sp -If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address\&. This makes the host part of the address to stay constant, making it possible to track host\*(Aqs presence when it changes networks\&. The address changes when the interface hardware is replaced\&. +The permitted values are: "eui64" (0), "stable\-privacy" (1), "default" (3) or "default\-or\-eui64" (2)\&. .sp -The value of stable\-privacy enables use of cryptographically secure hash of a secret host\-specific key along with the connection\*(Aqs stable\-id and the network address as specified by RFC7217\&. This makes it impossible to use the address track host\*(Aqs presence, and makes the address stable when the network interface hardware is replaced\&. +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\*(Aqs 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\&. .sp -The special values "default" and "default\-or\-eui64" will fallback to the global connection default in as documented in NetworkManager\&.conf(5) manual\&. If the global default is not specified, the fallback value is "stable\-privacy" or "eui64", respectively\&. +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\*(Aqs "connection\&.stable\-id" property and the address prefix\&. This improves privacy by making it harder to use the address to track the host\*(Aqs presence and the address is stable when the network interface hardware is replaced\&. .sp -For libnm, the property defaults to "default" since 1\&.40\&. Previously it defaulted to "stable\-privacy"\&. On D\-Bus, the absence of an addr\-gen\-mode setting equals "default"\&. For keyfile plugin, the absence of the setting on disk means "default\-or\-eui64" so that the property doesn\*(Aqt change on upgrade from older versions\&. +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\&. +.sp +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: int32 +Format: one of "eui64" (0), "stable\-privacy" (1), "default" (3) or "default\-or\-eui64" (2) .RE .PP -\fBaddresses\fR +\fBipv6\&.addresses\fR .RS 4 Alias: ip6 .sp -Array of IP addresses\&. +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 .RE .PP -\fBauto\-route\-ext\-gw\fR +\fBipv6\&.auto\-route\-ext\-gw\fR .RS 4 VPN connections will default to add the route automatically unless this setting is set to FALSE\&. .sp @@ -2368,7 +2483,7 @@ For other connection types, adding such an automatic route is currently not supp Format: NMTernary (int32) .RE .PP -\fBdhcp\-duid\fR +\fBipv6\&.dhcp\-duid\fR .RS 4 A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315)\&. The DUID is carried in the Client Identifier option\&. If the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option\&. .sp @@ -2383,14 +2498,14 @@ When the property is unset, the global value provided for "ipv6\&.dhcp\-duid" is Format: string .RE .PP -\fBdhcp\-hostname\fR +\fBipv6\&.dhcp\-hostname\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBdhcp\-hostname\-flags\fR +\fBipv6\&.dhcp\-hostname\-flags\fR .RS 4 Flags for the DHCP hostname and FQDN\&. .sp @@ -2401,9 +2516,9 @@ When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), Format: uint32 .RE .PP -\fBdhcp\-iaid\fR +\fBipv6\&.dhcp\-iaid\fR .RS 4 -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. +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"\&. .sp For DHCPv4, the IAID is only used with "ipv4\&.dhcp\-client\-id" values "duid" and "ipv6\-duid" to generate the client\-id\&. .sp @@ -2414,14 +2529,21 @@ The actually used DHCPv6 IAID for a currently activated interface is exposed in Format: string .RE .PP -\fBdhcp\-send\-hostname\fR +\fBipv6\&.dhcp\-pd\-hint\fR +.RS 4 +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")\&. +.sp +Format: string +.RE +.PP +\fBipv6\&.dhcp\-send\-hostname\fR .RS 4 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 .RE .PP -\fBdhcp\-timeout\fR +\fBipv6\&.dhcp\-timeout\fR .RS 4 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)\&. .sp @@ -2430,7 +2552,7 @@ Set to 2147483647 (MAXINT32) for infinity\&. Format: int32 .RE .PP -\fBdns\fR +\fBipv6\&.dns\fR .RS 4 Array of IP addresses of DNS servers\&. .sp @@ -2439,22 +2561,24 @@ For DoT (DNS over TLS), the SNI server name can be specified by appending "#exam Format: array of byte array .RE .PP -\fBdns\-options\fR +\fBipv6\&.dns\-options\fR .RS 4 -Array of DNS options as described in man 5 resolv\&.conf\&. +DNS options for /etc/resolv\&.conf as described in resolv\&.conf(5) manual\&. .sp -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", "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\&. .sp -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"\&. +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\&. .sp 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\&. .sp When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added\&. .sp -Format: array of string +The valid "ipv4\&.dns\-options" and "ipv6\&.dns\-options" get merged together\&. +.sp +Format: a comma separated list of DNS options .RE .PP -\fBdns\-priority\fR +\fBipv6\&.dns\-priority\fR .RS 4 DNS servers priority\&. .sp @@ -2475,7 +2599,7 @@ When using a DNS resolver that supports Conditional Forwarding or Split DNS (wit Format: int32 .RE .PP -\fBdns\-search\fR +\fBipv6\&.dns\-search\fR .RS 4 List of DNS search domains\&. Domains starting with a tilde (\*(Aq~\*(Aq) are considered \*(Aqrouting\*(Aq domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names\&. .sp @@ -2486,7 +2610,7 @@ When set on a profile that also enabled DHCP, the DNS search list received autom Format: array of string .RE .PP -\fBgateway\fR +\fBipv6\&.gateway\fR .RS 4 Alias: gw6 .sp @@ -2499,21 +2623,21 @@ Note that the gateway usually conflicts with routing that NetworkManager configu Format: string .RE .PP -\fBignore\-auto\-dns\fR +\fBipv6\&.ignore\-auto\-dns\fR .RS 4 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 .RE .PP -\fBignore\-auto\-routes\fR +\fBipv6\&.ignore\-auto\-routes\fR .RS 4 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 .RE .PP -\fBip6\-privacy\fR +\fBipv6\&.ip6\-privacy\fR .RS 4 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)\&. .sp @@ -2526,43 +2650,122 @@ Note that this setting is distinct from the Stable Privacy addresses that can be Format: NMSettingIP6ConfigPrivacy (int32) .RE .PP -\fBmay\-fail\fR +\fBipv6\&.may\-fail\fR .RS 4 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 .RE .PP -\fBmethod\fR +\fBipv6\&.method\fR .RS 4 -IP configuration method\&. +Sets the IPv6 connection method\&. You can set one of the following values: .sp -NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link\-local"\&. See the subclass\-specific documentation for other values\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"auto" +\- Enables IPv6 auto\-configuration\&. By default, NetworkManager uses Router Advertisements and, if the router announces the "managed" flag, NetworkManager requests an IPv6 address and prefix from a DHCPv6 server\&. +.RE .sp -In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration\&. The "ignore\-auto\-routes" and "ignore\-auto\-dns" properties modify this behavior\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"dhcp" +\- Requests an IPv6 address and prefix from a DHCPv6 server\&. Note that DHCPv6 does not have options to provide routes and the default gateway\&. As a consequence, by using the "dhcp" method, connections are limited to their own subnet\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"manual" +\- Enables the configuration of static IPv6 addresses on the interface\&. Note that you must set at least one IP address and prefix in the "ipv6\&.addresses" property\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"disabled" +\- Disables the IPv6 protocol in this connection profile\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"ignore" +\- Configures NetworkManager to make no changes to the IPv6 configuration on the interface\&. For example, you can then use the "accept_ra" feature of the kernel to accept Router Advertisements\&. +.RE .sp -For methods that imply no upstream network, such as "shared" or "link\-local", these properties must be empty\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"shared" +\- Provides network access to other computers\&. NetworkManager requests a prefix from an upstream DHCPv6 server, assigns an address to the interface, and announces the prefix to clients that connect to this interface\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"link\-local" +\- Assigns a random link\-local address from the fe80::/64 subnet to the interface\&. +.RE .sp -For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10\&.42\&.x\&.0/24 is chosen\&. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared\&. + +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 .RE .PP -\fBmtu\fR +\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 .RE .PP -\fBnever\-default\fR +\fBipv6\&.never\-default\fR .RS 4 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 .RE .PP -\fBra\-timeout\fR +\fBipv6\&.ra\-timeout\fR .RS 4 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\&. .sp @@ -2571,14 +2774,14 @@ Set to 2147483647 (MAXINT32) for infinity\&. Format: int32 .RE .PP -\fBreplace\-local\-rule\fR +\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) .RE .PP -\fBrequired\-timeout\fR +\fBipv6\&.required\-timeout\fR .RS 4 The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds\&. .sp @@ -2591,14 +2794,14 @@ A zero value means that no required timeout is present, \-1 means the default va Format: int32 .RE .PP -\fBroute\-metric\fR +\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 .RE .PP -\fBroute\-table\fR +\fBipv6\&.route\-table\fR .RS 4 Enable policy routing (source routing) and set the routing table used when adding routes\&. .sp @@ -2611,7 +2814,7 @@ Policy routing disabled means that NetworkManager will add all routes to the mai Format: uint32 .RE .PP -\fBroutes\fR +\fBipv6\&.routes\fR .RS 4 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]\&.\&.\&.]"\&. .sp @@ -2857,7 +3060,7 @@ For details see also `man ip\-route`\&. Format: a comma separated list of routes .RE .PP -\fBrouting\-rules\fR +\fBipv6\&.routing\-rules\fR .RS 4 A comma separated list of routing rules for policy routing\&. The format is based on \fBip rule add\fR @@ -2869,10 +3072,12 @@ priority 5 from 1:2:3::5/128 table 45 Format: a comma separated list of routing rules .RE .PP -\fBtoken\fR +\fBipv6\&.token\fR .RS 4 Configure the token for draft\-chown\-6man\-tokenised\-ipv6\-identifiers\-02 IPv6 tokenized interface identifiers\&. Useful with eui64 addr\-gen\-mode\&. .sp +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\&. +.sp Format: string .RE .SS "ip\-tunnel setting" @@ -2881,42 +3086,42 @@ IP Tunneling Settings\&. .PP Properties: .PP -\fBencapsulation\-limit\fR +\fBip\-tunnel\&.encapsulation\-limit\fR .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 NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1) to ip\-tunnel flags\&. .sp Format: uint32 .RE .PP -\fBflags\fR +\fBip\-tunnel\&.flags\fR .RS 4 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\&. .sp Format: uint32 .RE .PP -\fBflow\-label\fR +\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 .RE .PP -\fBfwmark\fR +\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 .RE .PP -\fBinput\-key\fR +\fBip\-tunnel\&.input\-key\fR .RS 4 The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE)\&. If empty, no key is used\&. .sp Format: string .RE .PP -\fBlocal\fR +\fBip\-tunnel\&.local\fR .RS 4 Alias: local .sp @@ -2925,7 +3130,7 @@ The local endpoint of the tunnel; the value can be empty, otherwise it must cont Format: string .RE .PP -\fBmode\fR +\fBip\-tunnel\&.mode\fR .RS 4 Alias: mode .sp @@ -2934,21 +3139,21 @@ The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_ Format: uint32 .RE .PP -\fBmtu\fR +\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 .RE .PP -\fBoutput\-key\fR +\fBip\-tunnel\&.output\-key\fR .RS 4 The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE)\&. If empty, no key is used\&. .sp Format: string .RE .PP -\fBparent\fR +\fBip\-tunnel\&.parent\fR .RS 4 Alias: dev .sp @@ -2957,14 +3162,14 @@ If given, specifies the parent interface name or parent connection UUID the new Format: string .RE .PP -\fBpath\-mtu\-discovery\fR +\fBip\-tunnel\&.path\-mtu\-discovery\fR .RS 4 Whether to enable Path MTU Discovery on this tunnel\&. .sp Format: boolean .RE .PP -\fBremote\fR +\fBip\-tunnel\&.remote\fR .RS 4 Alias: remote .sp @@ -2973,14 +3178,14 @@ The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 addres Format: string .RE .PP -\fBtos\fR +\fBip\-tunnel\&.tos\fR .RS 4 The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets\&. .sp Format: uint32 .RE .PP -\fBttl\fR +\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 @@ -2992,7 +3197,7 @@ MACSec Settings\&. .PP Properties: .PP -\fBencrypt\fR +\fBmacsec\&.encrypt\fR .RS 4 Alias: encrypt .sp @@ -3001,7 +3206,7 @@ Whether the transmitted traffic must be encrypted\&. Format: boolean .RE .PP -\fBmka\-cak\fR +\fBmacsec\&.mka\-cak\fR .RS 4 Alias: cak .sp @@ -3010,14 +3215,18 @@ The pre\-shared CAK (Connectivity Association Key) for MACsec Key Agreement\&. M Format: string .RE .PP -\fBmka\-cak\-flags\fR +\fBmacsec\&.mka\-cak\-flags\fR .RS 4 Flags indicating how to handle the "mka\-cak" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBmka\-ckn\fR +\fBmacsec\&.mka\-ckn\fR .RS 4 Alias: ckn .sp @@ -3026,7 +3235,7 @@ The pre\-shared CKN (Connectivity\-association Key Name) for MACsec Key Agreemen Format: string .RE .PP -\fBmode\fR +\fBmacsec\&.mode\fR .RS 4 Alias: mode .sp @@ -3035,7 +3244,7 @@ Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreeme Format: int32 .RE .PP -\fBparent\fR +\fBmacsec\&.parent\fR .RS 4 Alias: dev .sp @@ -3044,7 +3253,7 @@ If given, specifies the parent interface name or parent connection UUID from whi Format: string .RE .PP -\fBport\fR +\fBmacsec\&.port\fR .RS 4 Alias: port .sp @@ -3053,14 +3262,14 @@ The port component of the SCI (Secure Channel Identifier), between 1 and 65534\& Format: int32 .RE .PP -\fBsend\-sci\fR +\fBmacsec\&.send\-sci\fR .RS 4 Specifies whether the SCI (Secure Channel Identifier) is included in every packet\&. .sp Format: boolean .RE .PP -\fBvalidation\fR +\fBmacsec\&.validation\fR .RS 4 Specifies the validation mode for incoming frames\&. .sp @@ -3072,7 +3281,7 @@ MAC VLAN Settings\&. .PP Properties: .PP -\fBmode\fR +\fBmacvlan\&.mode\fR .RS 4 Alias: mode .sp @@ -3081,7 +3290,7 @@ The macvlan mode, which specifies the communication mechanism between multiple m Format: uint32 .RE .PP -\fBparent\fR +\fBmacvlan\&.parent\fR .RS 4 Alias: dev .sp @@ -3090,14 +3299,14 @@ If given, specifies the parent interface name or parent connection UUID from whi Format: string .RE .PP -\fBpromiscuous\fR +\fBmacvlan\&.promiscuous\fR .RS 4 Whether the interface should be put in promiscuous mode\&. .sp Format: boolean .RE .PP -\fBtap\fR +\fBmacvlan\&.tap\fR .RS 4 Alias: tap .sp @@ -3111,7 +3320,7 @@ Match settings\&. .PP Properties: .PP -\fBdriver\fR +\fBmatch\&.driver\fR .RS 4 A list of driver names to match\&. Each element is a shell wildcard pattern\&. .sp @@ -3120,7 +3329,7 @@ See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq Format: array of string .RE .PP -\fBinterface\-name\fR +\fBmatch\&.interface\-name\fR .RS 4 A list of interface names to match\&. Each element is a shell wildcard pattern\&. .sp @@ -3129,7 +3338,7 @@ An element can be prefixed with a pipe symbol (|) or an ampersand (&)\&. The for Format: array of string .RE .PP -\fBkernel\-command\-line\fR +\fBmatch\&.kernel\-command\-line\fR .RS 4 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\&. .sp @@ -3138,7 +3347,7 @@ See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq Format: array of string .RE .PP -\fBpath\fR +\fBmatch\&.path\fR .RS 4 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\&. .sp @@ -3160,7 +3369,7 @@ OLPC Wireless Mesh Settings\&. .PP Properties: .PP -\fBchannel\fR +\fB802\-11\-olpc\-mesh\&.channel\fR .RS 4 Alias: channel .sp @@ -3169,7 +3378,7 @@ Channel on which the mesh network to join is located\&. Format: uint32 .RE .PP -\fBdhcp\-anycast\-address\fR +\fB802\-11\-olpc\-mesh\&.dhcp\-anycast\-address\fR .RS 4 Alias: dhcp\-anycast .sp @@ -3180,7 +3389,7 @@ This is currently only implemented by dhclient DHCP plugin\&. Format: byte array .RE .PP -\fBssid\fR +\fB802\-11\-olpc\-mesh\&.ssid\fR .RS 4 Alias: ssid .sp @@ -3194,35 +3403,35 @@ OvsBridge Link Settings\&. .PP Properties: .PP -\fBdatapath\-type\fR +\fBovs\-bridge\&.datapath\-type\fR .RS 4 The data path type\&. One of "system", "netdev" or empty\&. .sp Format: string .RE .PP -\fBfail\-mode\fR +\fBovs\-bridge\&.fail\-mode\fR .RS 4 The bridge failure mode\&. One of "secure", "standalone" or empty\&. .sp Format: string .RE .PP -\fBmcast\-snooping\-enable\fR +\fBovs\-bridge\&.mcast\-snooping\-enable\fR .RS 4 Enable or disable multicast snooping\&. .sp Format: boolean .RE .PP -\fBrstp\-enable\fR +\fBovs\-bridge\&.rstp\-enable\fR .RS 4 Enable or disable RSTP\&. .sp Format: boolean .RE .PP -\fBstp\-enable\fR +\fBovs\-bridge\&.stp\-enable\fR .RS 4 Enable or disable STP\&. .sp @@ -3234,28 +3443,28 @@ OvsDpdk Link Settings\&. .PP Properties: .PP -\fBdevargs\fR +\fBovs\-dpdk\&.devargs\fR .RS 4 Open vSwitch DPDK device arguments\&. .sp Format: string .RE .PP -\fBn\-rxq\fR +\fBovs\-dpdk\&.n\-rxq\fR .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 .RE .PP -\fBn\-rxq\-desc\fR +\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 .RE .PP -\fBn\-txq\-desc\fR +\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 @@ -3267,14 +3476,14 @@ Open vSwitch Interface Settings\&. .PP Properties: .PP -\fBofport\-request\fR +\fBovs\-interface\&.ofport\-request\fR .RS 4 Open vSwitch openflow port number\&. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs\&. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network\&. OpenFlow switches connect logically to each other via their OpenFlow ports\&. .sp Format: uint32 .RE .PP -\fBtype\fR +\fBovs\-interface\&.type\fR .RS 4 The interface type\&. Either "internal", "system", "patch", "dpdk", or empty\&. .sp @@ -3286,7 +3495,7 @@ OvsPatch Link Settings\&. .PP Properties: .PP -\fBpeer\fR +\fBovs\-patch\&.peer\fR .RS 4 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\&. .sp @@ -3298,42 +3507,42 @@ OvsPort Link Settings\&. .PP Properties: .PP -\fBbond\-downdelay\fR +\fBovs\-port\&.bond\-downdelay\fR .RS 4 The time port must be inactive in order to be considered down\&. .sp Format: uint32 .RE .PP -\fBbond\-mode\fR +\fBovs\-port\&.bond\-mode\fR .RS 4 Bonding mode\&. One of "active\-backup", "balance\-slb", or "balance\-tcp"\&. .sp Format: string .RE .PP -\fBbond\-updelay\fR +\fBovs\-port\&.bond\-updelay\fR .RS 4 The time port must be active before it starts forwarding traffic\&. .sp Format: uint32 .RE .PP -\fBlacp\fR +\fBovs\-port\&.lacp\fR .RS 4 LACP mode\&. One of "active", "off", or "passive"\&. .sp Format: string .RE .PP -\fBtag\fR +\fBovs\-port\&.tag\fR .RS 4 The VLAN tag in the range 0\-4095\&. .sp Format: uint32 .RE .PP -\fBtrunks\fR +\fBovs\-port\&.trunks\fR .RS 4 A list of VLAN ranges that this port trunks\&. .sp @@ -3342,7 +3551,7 @@ The property is valid only for ports with mode "trunk", "native\-tagged", or "na Format: array of vardict .RE .PP -\fBvlan\-mode\fR +\fBovs\-port\&.vlan\-mode\fR .RS 4 The VLAN mode\&. One of "access", "native\-tagged", "native\-untagged", "trunk", "dot1q\-tunnel" or unset\&. .sp @@ -3354,126 +3563,126 @@ Point\-to\-Point Protocol Settings\&. .PP Properties: .PP -\fBbaud\fR +\fBppp\&.baud\fR .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 .RE .PP -\fBcrtscts\fR +\fBppp\&.crtscts\fR .RS 4 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 .RE .PP -\fBlcp\-echo\-failure\fR +\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 .RE .PP -\fBlcp\-echo\-interval\fR +\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 .RE .PP -\fBmppe\-stateful\fR +\fBppp\&.mppe\-stateful\fR .RS 4 If TRUE, stateful MPPE is used\&. See pppd documentation for more information on stateful MPPE\&. .sp Format: boolean .RE .PP -\fBmru\fR +\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 .RE .PP -\fBmtu\fR +\fBppp\&.mtu\fR .RS 4 If non\-zero, instruct pppd to send packets no larger than the specified size\&. .sp Format: uint32 .RE .PP -\fBno\-vj\-comp\fR +\fBppp\&.no\-vj\-comp\fR .RS 4 If TRUE, Van Jacobsen TCP header compression will not be requested\&. .sp Format: boolean .RE .PP -\fBnoauth\fR +\fBppp\&.noauth\fR .RS 4 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 .RE .PP -\fBnobsdcomp\fR +\fBppp\&.nobsdcomp\fR .RS 4 If TRUE, BSD compression will not be requested\&. .sp Format: boolean .RE .PP -\fBnodeflate\fR +\fBppp\&.nodeflate\fR .RS 4 If TRUE, "deflate" compression will not be requested\&. .sp Format: boolean .RE .PP -\fBrefuse\-chap\fR +\fBppp\&.refuse\-chap\fR .RS 4 If TRUE, the CHAP authentication method will not be used\&. .sp Format: boolean .RE .PP -\fBrefuse\-eap\fR +\fBppp\&.refuse\-eap\fR .RS 4 If TRUE, the EAP authentication method will not be used\&. .sp Format: boolean .RE .PP -\fBrefuse\-mschap\fR +\fBppp\&.refuse\-mschap\fR .RS 4 If TRUE, the MSCHAP authentication method will not be used\&. .sp Format: boolean .RE .PP -\fBrefuse\-mschapv2\fR +\fBppp\&.refuse\-mschapv2\fR .RS 4 If TRUE, the MSCHAPv2 authentication method will not be used\&. .sp Format: boolean .RE .PP -\fBrefuse\-pap\fR +\fBppp\&.refuse\-pap\fR .RS 4 If TRUE, the PAP authentication method will not be used\&. .sp Format: boolean .RE .PP -\fBrequire\-mppe\fR +\fBppp\&.require\-mppe\fR .RS 4 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 .RE .PP -\fBrequire\-mppe\-128\fR +\fBppp\&.require\-mppe\-128\fR .RS 4 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 @@ -3485,7 +3694,7 @@ PPP\-over\-Ethernet Settings\&. .PP Properties: .PP -\fBparent\fR +\fBpppoe\&.parent\fR .RS 4 Alias: parent .sp @@ -3494,7 +3703,7 @@ If given, specifies the parent interface name on which this PPPoE connection sho Format: string .RE .PP -\fBpassword\fR +\fBpppoe\&.password\fR .RS 4 Alias: password .sp @@ -3503,14 +3712,18 @@ Password used to authenticate with the PPPoE service\&. Format: string .RE .PP -\fBpassword\-flags\fR +\fBpppoe\&.password\-flags\fR .RS 4 Flags indicating how to handle the "password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBservice\fR +\fBpppoe\&.service\fR .RS 4 Alias: service .sp @@ -3519,7 +3732,7 @@ If specified, instruct PPPoE to only initiate sessions with access concentrators Format: string .RE .PP -\fBusername\fR +\fBpppoe\&.username\fR .RS 4 Alias: username .sp @@ -3533,7 +3746,7 @@ WWW Proxy Settings\&. .PP Properties: .PP -\fBbrowser\-only\fR +\fBproxy\&.browser\-only\fR .RS 4 Alias: browser\-only .sp @@ -3542,7 +3755,7 @@ Whether the proxy configuration is for browser only\&. Format: boolean .RE .PP -\fBmethod\fR +\fBproxy\&.method\fR .RS 4 Alias: method .sp @@ -3551,16 +3764,16 @@ Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0) Format: int32 .RE .PP -\fBpac\-script\fR +\fBproxy\&.pac\-script\fR .RS 4 Alias: pac\-script .sp -PAC script for the connection\&. This is an UTF\-8 encoded javascript code that defines a FindProxyForURL() function\&. +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\&. .sp Format: string .RE .PP -\fBpac\-url\fR +\fBproxy\&.pac\-url\fR .RS 4 Alias: pac\-url .sp @@ -3574,35 +3787,35 @@ Serial Link Settings\&. .PP Properties: .PP -\fBbaud\fR +\fBserial\&.baud\fR .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 .RE .PP -\fBbits\fR +\fBserial\&.bits\fR .RS 4 Byte\-width of the serial communication\&. The 8 in "8n1" for example\&. .sp Format: uint32 .RE .PP -\fBparity\fR +\fBserial\&.parity\fR .RS 4 Parity setting of the serial port\&. .sp Format: NMSettingSerialParity (byte) .RE .PP -\fBsend\-delay\fR +\fBserial\&.send\-delay\fR .RS 4 Time to delay between each byte sent to the modem, in microseconds\&. .sp Format: uint64 .RE .PP -\fBstopbits\fR +\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 @@ -3614,7 +3827,7 @@ SR\-IOV settings\&. .PP Properties: .PP -\fBautoprobe\-drivers\fR +\fBsriov\&.autoprobe\-drivers\fR .RS 4 Whether to autoprobe virtual functions by a compatible driver\&. .sp @@ -3627,7 +3840,7 @@ When set to NM_TERNARY_DEFAULT (\-1), the global default is used; in case the gl Format: NMTernary (int32) .RE .PP -\fBtotal\-vfs\fR +\fBsriov\&.total\-vfs\fR .RS 4 The total number of virtual functions to create\&. .sp @@ -3636,7 +3849,7 @@ Note that when the sriov setting is present NetworkManager enforces the number o Format: uint32 .RE .PP -\fBvfs\fR +\fBsriov\&.vfs\fR .RS 4 Array of virtual function descriptors\&. .sp @@ -3666,7 +3879,7 @@ Linux Traffic Control Settings\&. .PP Properties: .PP -\fBqdiscs\fR +\fBtc\&.qdiscs\fR .RS 4 Array of TC queueing disciplines\&. qdisc is a basic block in the Linux traffic control subsystem .sp @@ -3795,7 +4008,7 @@ specifies the maximum amount of time a packet can sit in the TBF\&. The latency Format: GPtrArray(NMTCQdisc) .RE .PP -\fBtfilters\fR +\fBtc\&.tfilters\fR .RS 4 Array of TC traffic filters\&. Traffic control can manage the packet content during classification by using filters\&. .sp @@ -3858,7 +4071,7 @@ Teaming Settings\&. .PP Properties: .PP -\fBconfig\fR +\fBteam\&.config\fR .RS 4 Alias: config .sp @@ -3867,105 +4080,105 @@ The JSON configuration for the team network interface\&. The property should con Format: string .RE .PP -\fBlink\-watchers\fR +\fBteam\&.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 .RE .PP -\fBmcast\-rejoin\-count\fR +\fBteam\&.mcast\-rejoin\-count\fR .RS 4 Corresponds to the teamd mcast_rejoin\&.count\&. .sp Format: int32 .RE .PP -\fBmcast\-rejoin\-interval\fR +\fBteam\&.mcast\-rejoin\-interval\fR .RS 4 Corresponds to the teamd mcast_rejoin\&.interval\&. .sp Format: int32 .RE .PP -\fBnotify\-peers\-count\fR +\fBteam\&.notify\-peers\-count\fR .RS 4 Corresponds to the teamd notify_peers\&.count\&. .sp Format: int32 .RE .PP -\fBnotify\-peers\-interval\fR +\fBteam\&.notify\-peers\-interval\fR .RS 4 Corresponds to the teamd notify_peers\&.interval\&. .sp Format: int32 .RE .PP -\fBrunner\fR +\fBteam\&.runner\fR .RS 4 Corresponds to the teamd runner\&.name\&. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random"\&. .sp Format: string .RE .PP -\fBrunner\-active\fR +\fBteam\&.runner\-active\fR .RS 4 Corresponds to the teamd runner\&.active\&. .sp Format: boolean .RE .PP -\fBrunner\-agg\-select\-policy\fR +\fBteam\&.runner\-agg\-select\-policy\fR .RS 4 Corresponds to the teamd runner\&.agg_select_policy\&. .sp Format: string .RE .PP -\fBrunner\-fast\-rate\fR +\fBteam\&.runner\-fast\-rate\fR .RS 4 Corresponds to the teamd runner\&.fast_rate\&. .sp Format: boolean .RE .PP -\fBrunner\-hwaddr\-policy\fR +\fBteam\&.runner\-hwaddr\-policy\fR .RS 4 Corresponds to the teamd runner\&.hwaddr_policy\&. .sp Format: string .RE .PP -\fBrunner\-min\-ports\fR +\fBteam\&.runner\-min\-ports\fR .RS 4 Corresponds to the teamd runner\&.min_ports\&. .sp Format: int32 .RE .PP -\fBrunner\-sys\-prio\fR +\fBteam\&.runner\-sys\-prio\fR .RS 4 Corresponds to the teamd runner\&.sys_prio\&. .sp Format: int32 .RE .PP -\fBrunner\-tx\-balancer\fR +\fBteam\&.runner\-tx\-balancer\fR .RS 4 Corresponds to the teamd runner\&.tx_balancer\&.name\&. .sp Format: string .RE .PP -\fBrunner\-tx\-balancer\-interval\fR +\fBteam\&.runner\-tx\-balancer\-interval\fR .RS 4 Corresponds to the teamd runner\&.tx_balancer\&.interval\&. .sp Format: int32 .RE .PP -\fBrunner\-tx\-hash\fR +\fBteam\&.runner\-tx\-hash\fR .RS 4 Corresponds to the teamd runner\&.tx_hash\&. .sp @@ -3977,7 +4190,7 @@ Team Port Settings\&. .PP Properties: .PP -\fBconfig\fR +\fBteam\-port\&.config\fR .RS 4 Alias: config .sp @@ -3986,42 +4199,42 @@ The JSON configuration for the team port\&. The property should contain raw JSON Format: string .RE .PP -\fBlacp\-key\fR +\fBteam\-port\&.lacp\-key\fR .RS 4 Corresponds to the teamd ports\&.PORTIFNAME\&.lacp_key\&. .sp Format: int32 .RE .PP -\fBlacp\-prio\fR +\fBteam\-port\&.lacp\-prio\fR .RS 4 Corresponds to the teamd ports\&.PORTIFNAME\&.lacp_prio\&. .sp Format: int32 .RE .PP -\fBlink\-watchers\fR +\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 .RE .PP -\fBprio\fR +\fBteam\-port\&.prio\fR .RS 4 Corresponds to the teamd ports\&.PORTIFNAME\&.prio\&. .sp Format: int32 .RE .PP -\fBqueue\-id\fR +\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 .RE .PP -\fBsticky\fR +\fBteam\-port\&.sticky\fR .RS 4 Corresponds to the teamd ports\&.PORTIFNAME\&.sticky\&. .sp @@ -4033,7 +4246,7 @@ Tunnel Settings\&. .PP Properties: .PP -\fBgroup\fR +\fBtun\&.group\fR .RS 4 Alias: group .sp @@ -4042,7 +4255,7 @@ The group ID which will own the device\&. If set to NULL everyone will be able t Format: string .RE .PP -\fBmode\fR +\fBtun\&.mode\fR .RS 4 Alias: mode .sp @@ -4051,7 +4264,7 @@ The operating mode of the virtual device\&. Allowed values are NM_SETTING_TUN_MO Format: uint32 .RE .PP -\fBmulti\-queue\fR +\fBtun\&.multi\-queue\fR .RS 4 Alias: multi\-queue .sp @@ -4060,7 +4273,7 @@ If the property is set to TRUE, the interface will support multiple file descrip Format: boolean .RE .PP -\fBowner\fR +\fBtun\&.owner\fR .RS 4 Alias: owner .sp @@ -4069,7 +4282,7 @@ The user ID which will own the device\&. If set to NULL everyone will be able to Format: string .RE .PP -\fBpi\fR +\fBtun\&.pi\fR .RS 4 Alias: pi .sp @@ -4078,7 +4291,7 @@ If TRUE the interface will prepend a 4 byte header describing the physical inter Format: boolean .RE .PP -\fBvnet\-hdr\fR +\fBtun\&.vnet\-hdr\fR .RS 4 Alias: vnet\-hdr .sp @@ -4092,7 +4305,7 @@ VLAN Settings\&. .PP Properties: .PP -\fBegress\-priority\-map\fR +\fBvlan\&.egress\-priority\-map\fR .RS 4 Alias: egress .sp @@ -4101,7 +4314,7 @@ For outgoing packets, a list of mappings from Linux SKB priorities to 802\&.1p p Format: array of string .RE .PP -\fBflags\fR +\fBvlan\&.flags\fR .RS 4 Alias: flags .sp @@ -4112,7 +4325,7 @@ The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used Format: NMVlanFlags (uint32) .RE .PP -\fBid\fR +\fBvlan\&.id\fR .RS 4 Alias: id .sp @@ -4121,7 +4334,7 @@ The VLAN identifier that the interface created by this connection should be assi Format: uint32 .RE .PP -\fBingress\-priority\-map\fR +\fBvlan\&.ingress\-priority\-map\fR .RS 4 Alias: ingress .sp @@ -4130,7 +4343,7 @@ For incoming packets, a list of mappings from 802\&.1p priorities to Linux SKB p Format: array of string .RE .PP -\fBparent\fR +\fBvlan\&.parent\fR .RS 4 Alias: dev .sp @@ -4139,7 +4352,7 @@ If given, specifies the parent interface name or parent connection UUID from whi Format: string .RE .PP -\fBprotocol\fR +\fBvlan\&.protocol\fR .RS 4 Specifies the VLAN protocol to use for encapsulation\&. .sp @@ -4153,28 +4366,28 @@ VPN Settings\&. .PP Properties: .PP -\fBdata\fR +\fBvpn\&.data\fR .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 .RE .PP -\fBpersistent\fR +\fBvpn\&.persistent\fR .RS 4 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 .RE .PP -\fBsecrets\fR +\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 .RE .PP -\fBservice\-type\fR +\fBvpn\&.service\-type\fR .RS 4 Alias: vpn\-type .sp @@ -4183,14 +4396,14 @@ D\-Bus service name of the VPN plugin that this setting uses to connect to its n Format: string .RE .PP -\fBtimeout\fR +\fBvpn\&.timeout\fR .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 .RE .PP -\fBuser\-name\fR +\fBvpn\&.user\-name\fR .RS 4 Alias: user .sp @@ -4204,7 +4417,7 @@ VRF settings\&. .PP Properties: .PP -\fBtable\fR +\fBvrf\&.table\fR .RS 4 Alias: table .sp @@ -4218,14 +4431,14 @@ VXLAN Settings\&. .PP Properties: .PP -\fBageing\fR +\fBvxlan\&.ageing\fR .RS 4 Specifies the lifetime in seconds of FDB entries learnt by the kernel\&. .sp Format: uint32 .RE .PP -\fBdestination\-port\fR +\fBvxlan\&.destination\-port\fR .RS 4 Alias: destination\-port .sp @@ -4234,7 +4447,7 @@ Specifies the UDP destination port to communicate to the remote VXLAN tunnel end Format: uint32 .RE .PP -\fBid\fR +\fBvxlan\&.id\fR .RS 4 Alias: id .sp @@ -4243,35 +4456,35 @@ Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use\&. Format: uint32 .RE .PP -\fBl2\-miss\fR +\fBvxlan\&.l2\-miss\fR .RS 4 Specifies whether netlink LL ADDR miss notifications are generated\&. .sp Format: boolean .RE .PP -\fBl3\-miss\fR +\fBvxlan\&.l3\-miss\fR .RS 4 Specifies whether netlink IP ADDR miss notifications are generated\&. .sp Format: boolean .RE .PP -\fBlearning\fR +\fBvxlan\&.learning\fR .RS 4 Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database\&. .sp Format: boolean .RE .PP -\fBlimit\fR +\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 .RE .PP -\fBlocal\fR +\fBvxlan\&.local\fR .RS 4 Alias: local .sp @@ -4280,7 +4493,7 @@ If given, specifies the source IP address to use in outgoing packets\&. Format: string .RE .PP -\fBparent\fR +\fBvxlan\&.parent\fR .RS 4 Alias: dev .sp @@ -4289,14 +4502,14 @@ If given, specifies the parent interface name or parent connection UUID\&. Format: string .RE .PP -\fBproxy\fR +\fBvxlan\&.proxy\fR .RS 4 Specifies whether ARP proxy is turned on\&. .sp Format: boolean .RE .PP -\fBremote\fR +\fBvxlan\&.remote\fR .RS 4 Alias: remote .sp @@ -4305,14 +4518,14 @@ Specifies the unicast destination IP address to use in outgoing packets when the Format: string .RE .PP -\fBrsc\fR +\fBvxlan\&.rsc\fR .RS 4 Specifies whether route short circuit is turned on\&. .sp Format: boolean .RE .PP -\fBsource\-port\-max\fR +\fBvxlan\&.source\-port\-max\fR .RS 4 Alias: source\-port\-max .sp @@ -4321,7 +4534,7 @@ Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel Format: uint32 .RE .PP -\fBsource\-port\-min\fR +\fBvxlan\&.source\-port\-min\fR .RS 4 Alias: source\-port\-min .sp @@ -4330,14 +4543,14 @@ Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel Format: uint32 .RE .PP -\fBtos\fR +\fBvxlan\&.tos\fR .RS 4 Specifies the TOS value to use in outgoing packets\&. .sp Format: uint32 .RE .PP -\fBttl\fR +\fBvxlan\&.ttl\fR .RS 4 Specifies the time\-to\-live value to use in outgoing packets\&. .sp @@ -4349,7 +4562,7 @@ Wi\-Fi P2P Settings\&. .PP Properties: .PP -\fBpeer\fR +\fBwifi\-p2p\&.peer\fR .RS 4 Alias: peer .sp @@ -4358,7 +4571,7 @@ The P2P device that should be connected to\&. Currently, this is the only way to Format: string .RE .PP -\fBwfd\-ies\fR +\fBwifi\-p2p\&.wfd\-ies\fR .RS 4 The Wi\-Fi Display (WFD) Information Elements (IEs) to set\&. .sp @@ -4367,7 +4580,7 @@ Wi\-Fi Display requires a protocol specific information element to be set in cer Format: byte array .RE .PP -\fBwps\-method\fR +\fBwifi\-p2p\&.wps\-method\fR .RS 4 Flags indicating which mode of WPS is to be used\&. .sp @@ -4381,7 +4594,7 @@ WiMax Settings\&. .PP Properties: .PP -\fBmac\-address\fR +\fBwimax\&.mac\-address\fR .RS 4 Alias: mac .sp @@ -4392,7 +4605,7 @@ This property is deprecated since version 1\&.2\&. WiMAX is no longer supported\ Format: byte array .RE .PP -\fBnetwork\-name\fR +\fBwimax\&.network\-name\fR .RS 4 Alias: nsp .sp @@ -4410,21 +4623,21 @@ Wired Ethernet Settings\&. .PP Properties: .PP -\fBaccept\-all\-mac\-addresses\fR +\fB802\-3\-ethernet\&.accept\-all\-mac\-addresses\fR .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) .RE .PP -\fBauto\-negotiate\fR +\fB802\-3\-ethernet\&.auto\-negotiate\fR .RS 4 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 .RE .PP -\fBcloned\-mac\-address\fR +\fB802\-3\-ethernet\&.cloned\-mac\-address\fR .RS 4 Alias: cloned\-mac .sp @@ -4439,14 +4652,14 @@ On D\-Bus, this field is expressed as "assigned\-mac\-address" or the deprecated Format: byte array .RE .PP -\fBduplex\fR +\fB802\-3\-ethernet\&.duplex\fR .RS 4 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 .RE .PP -\fBgenerate\-mac\-address\-mask\fR +\fB802\-3\-ethernet\&.generate\-mac\-address\-mask\fR .RS 4 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\&. .sp @@ -4461,7 +4674,7 @@ If the value contains more than one additional MAC addresses, one of them is cho Format: string .RE .PP -\fBmac\-address\fR +\fB802\-3\-ethernet\&.mac\-address\fR .RS 4 Alias: mac .sp @@ -4470,14 +4683,14 @@ If specified, this connection will only apply to the Ethernet device whose perma Format: byte array .RE .PP -\fBmac\-address\-blacklist\fR +\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 .RE .PP -\fBmtu\fR +\fB802\-3\-ethernet\&.mtu\fR .RS 4 Alias: mtu .sp @@ -4486,21 +4699,21 @@ If non\-zero, only transmit packets of the specified size or smaller, breaking l Format: uint32 .RE .PP -\fBport\fR +\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 .RE .PP -\fBs390\-nettype\fR +\fB802\-3\-ethernet\&.s390\-nettype\fR .RS 4 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 .RE .PP -\fBs390\-options\fR +\fB802\-3\-ethernet\&.s390\-options\fR .RS 4 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])\&. .sp @@ -4509,28 +4722,28 @@ Currently, NetworkManager itself does nothing with this information\&. However, Format: dict of string to string .RE .PP -\fBs390\-subchannels\fR +\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 .RE .PP -\fBspeed\fR +\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 .RE .PP -\fBwake\-on\-lan\fR +\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)\&. .sp Format: uint32 .RE .PP -\fBwake\-on\-lan\-password\fR +\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 @@ -4542,7 +4755,7 @@ WireGuard Settings\&. .PP Properties: .PP -\fBfwmark\fR +\fBwireguard\&.fwmark\fR .RS 4 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\&. .sp @@ -4551,7 +4764,7 @@ Note that "ip4\-auto\-default\-route" or "ip6\-auto\-default\-route" enabled, im Format: uint32 .RE .PP -\fBip4\-auto\-default\-route\fR +\fBwireguard\&.ip4\-auto\-default\-route\fR .RS 4 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"\&. .sp @@ -4562,21 +4775,21 @@ Leaving this at the default will enable this option automatically if ipv4\&.neve Format: NMTernary (int32) .RE .PP -\fBip6\-auto\-default\-route\fR +\fBwireguard\&.ip6\-auto\-default\-route\fR .RS 4 Like ip4\-auto\-default\-route, but for the IPv6 default route\&. .sp Format: NMTernary (int32) .RE .PP -\fBlisten\-port\fR +\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 .RE .PP -\fBmtu\fR +\fBwireguard\&.mtu\fR .RS 4 If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments\&. .sp @@ -4585,7 +4798,7 @@ If zero a default MTU is used\&. Note that contrary to wg\-quick\*(Aqs MTU setti Format: uint32 .RE .PP -\fBpeer\-routes\fR +\fBwireguard\&.peer\-routes\fR .RS 4 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\&. .sp @@ -4594,17 +4807,21 @@ Note that if the peer\*(Aqs AllowedIPs is "0\&.0\&.0\&.0/0" or "::/0" and the pr Format: boolean .RE .PP -\fBprivate\-key\fR +\fBwireguard\&.private\-key\fR .RS 4 The 256 bit private\-key in base64 encoding\&. .sp Format: string .RE .PP -\fBprivate\-key\-flags\fR +\fBwireguard\&.private\-key\-flags\fR .RS 4 Flags indicating how to handle the "private\-key" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .SS "802\-11\-wireless setting" @@ -4615,7 +4832,7 @@ Wi\-Fi Settings\&. .PP Properties: .PP -\fBap\-isolation\fR +\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\&. .sp @@ -4628,14 +4845,14 @@ When set to NM_TERNARY_DEFAULT (\-1), the global default is used; in case the gl Format: NMTernary (int32) .RE .PP -\fBband\fR +\fB802\-11\-wireless\&.band\fR .RS 4 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 .RE .PP -\fBbssid\fR +\fB802\-11\-wireless\&.bssid\fR .RS 4 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\&. .sp @@ -4644,14 +4861,14 @@ Locking a client profile to a certain BSSID will prevent roaming and also disabl Format: byte array .RE .PP -\fBchannel\fR +\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 .RE .PP -\fBcloned\-mac\-address\fR +\fB802\-11\-wireless\&.cloned\-mac\-address\fR .RS 4 Alias: cloned\-mac .sp @@ -4666,7 +4883,7 @@ On D\-Bus, this field is expressed as "assigned\-mac\-address" or the deprecated Format: byte array .RE .PP -\fBgenerate\-mac\-address\-mask\fR +\fB802\-11\-wireless\&.generate\-mac\-address\-mask\fR .RS 4 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\&. .sp @@ -4681,7 +4898,7 @@ If the value contains more than one additional MAC addresses, one of them is cho Format: string .RE .PP -\fBhidden\fR +\fB802\-11\-wireless\&.hidden\fR .RS 4 If TRUE, indicates that the network is a non\-broadcasting network that hides its SSID\&. This works both in infrastructure and AP mode\&. .sp @@ -4694,7 +4911,7 @@ Note that marking the network as hidden may be a privacy issue for you (in infra Format: boolean .RE .PP -\fBmac\-address\fR +\fB802\-11\-wireless\&.mac\-address\fR .RS 4 Alias: mac .sp @@ -4703,14 +4920,14 @@ If specified, this connection will only apply to the Wi\-Fi device whose permane Format: byte array .RE .PP -\fBmac\-address\-blacklist\fR +\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 .RE .PP -\fBmac\-address\-randomization\fR +\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)\&. .sp @@ -4719,7 +4936,7 @@ This property is deprecated since version 1\&.4\&. Use the "cloned\-mac\-address Format: uint32 .RE .PP -\fBmode\fR +\fB802\-11\-wireless\&.mode\fR .RS 4 Alias: mode .sp @@ -4728,7 +4945,7 @@ Wi\-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap"\&. If blan Format: string .RE .PP -\fBmtu\fR +\fB802\-11\-wireless\&.mtu\fR .RS 4 Alias: mtu .sp @@ -4737,28 +4954,23 @@ If non\-zero, only transmit packets of the specified size or smaller, breaking l Format: uint32 .RE .PP -\fBpowersave\fR +\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\&. .sp Format: uint32 .RE .PP -\fBrate\fR -.RS 4 -If non\-zero, directs the device to only use the specified bitrate for communication with the access point\&. Units are in Kb/s, ie 5500 = 5\&.5 Mbit/s\&. This property is highly driver dependent and not all devices support setting a static bitrate\&. -.sp -Format: uint32 -.RE -.PP -\fBseen\-bssids\fR +\fB802\-11\-wireless\&.seen\-bssids\fR .RS 4 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\&. .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 .RE .PP -\fBssid\fR +\fB802\-11\-wireless\&.ssid\fR .RS 4 Alias: ssid .sp @@ -4767,14 +4979,7 @@ SSID of the Wi\-Fi network\&. Must be specified\&. Format: byte array .RE .PP -\fBtx\-power\fR -.RS 4 -If non\-zero, directs the device to use the specified transmit power\&. Units are dBm\&. This property is highly driver dependent and not all devices support setting a static transmit power\&. -.sp -Format: uint32 -.RE -.PP -\fBwake\-on\-wlan\fR +\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)\&. .sp @@ -4788,28 +4993,28 @@ Wi\-Fi Security Settings\&. .PP Properties: .PP -\fBauth\-alg\fR +\fB802\-11\-wireless\-security\&.auth\-alg\fR .RS 4 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 .RE .PP -\fBfils\fR +\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\&. .sp Format: int32 .RE .PP -\fBgroup\fR +\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 .RE .PP -\fBkey\-mgmt\fR +\fB802\-11\-wireless\-security\&.key\-mgmt\fR .RS 4 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)\&. .sp @@ -4818,112 +5023,124 @@ This property must be set for any Wi\-Fi connection that uses security\&. Format: string .RE .PP -\fBleap\-password\fR +\fB802\-11\-wireless\-security\&.leap\-password\fR .RS 4 The login password for legacy LEAP connections (ie, key\-mgmt = "ieee8021x" and auth\-alg = "leap")\&. .sp Format: string .RE .PP -\fBleap\-password\-flags\fR +\fB802\-11\-wireless\-security\&.leap\-password\-flags\fR .RS 4 Flags indicating how to handle the "leap\-password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBleap\-username\fR +\fB802\-11\-wireless\-security\&.leap\-username\fR .RS 4 The login username for legacy LEAP connections (ie, key\-mgmt = "ieee8021x" and auth\-alg = "leap")\&. .sp Format: string .RE .PP -\fBpairwise\fR +\fB802\-11\-wireless\-security\&.pairwise\fR .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 .RE .PP -\fBpmf\fR +\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\&. .sp Format: int32 .RE .PP -\fBproto\fR +\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 .RE .PP -\fBpsk\fR +\fB802\-11\-wireless\-security\&.psk\fR .RS 4 Pre\-Shared\-Key for WPA networks\&. For WPA\-PSK, it\*(Aqs 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\&. .sp Format: string .RE .PP -\fBpsk\-flags\fR +\fB802\-11\-wireless\-security\&.psk\-flags\fR .RS 4 Flags indicating how to handle the "psk" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBwep\-key\-flags\fR +\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\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBwep\-key\-type\fR +\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\&. .sp Format: NMWepKeyType (uint32) .RE .PP -\fBwep\-key0\fR +\fB802\-11\-wireless\-security\&.wep\-key0\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBwep\-key1\fR +\fB802\-11\-wireless\-security\&.wep\-key1\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBwep\-key2\fR +\fB802\-11\-wireless\-security\&.wep\-key2\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBwep\-key3\fR +\fB802\-11\-wireless\-security\&.wep\-key3\fR .RS 4 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\&. .sp Format: string .RE .PP -\fBwep\-tx\-keyidx\fR +\fB802\-11\-wireless\-security\&.wep\-tx\-keyidx\fR .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 .RE .PP -\fBwps\-method\fR +\fB802\-11\-wireless\-security\&.wps\-method\fR .RS 4 Flags indicating which mode of WPS is to be used if any\&. .sp @@ -4939,7 +5156,7 @@ IEEE 802\&.15\&.4 (WPAN) MAC Settings\&. .PP Properties: .PP -\fBchannel\fR +\fBwpan\&.channel\fR .RS 4 Alias: channel .sp @@ -4948,7 +5165,7 @@ IEEE 802\&.15\&.4 channel\&. A positive integer or \-1, meaning "do not set, use Format: int32 .RE .PP -\fBmac\-address\fR +\fBwpan\&.mac\-address\fR .RS 4 Alias: mac .sp @@ -4957,7 +5174,7 @@ If specified, this connection will only apply to the IEEE 802\&.15\&.4 (WPAN) MA Format: string .RE .PP -\fBpage\fR +\fBwpan\&.page\fR .RS 4 Alias: page .sp @@ -4966,7 +5183,7 @@ IEEE 802\&.15\&.4 channel page\&. A positive integer or \-1, meaning "do not set Format: int32 .RE .PP -\fBpan\-id\fR +\fBwpan\&.pan\-id\fR .RS 4 Alias: pan\-id .sp @@ -4975,7 +5192,7 @@ IEEE 802\&.15\&.4 Personal Area Network (PAN) identifier\&. Format: uint32 .RE .PP -\fBshort\-address\fR +\fBwpan\&.short\-address\fR .RS 4 Alias: short\-addr .sp @@ -4989,7 +5206,7 @@ Bond Port Settings\&. .PP Properties: .PP -\fBprio\fR +\fBbond\-port\&.prio\fR .RS 4 Alias: prio .sp @@ -4998,7 +5215,7 @@ The port priority for bond active port re\-selection during failover\&. A higher Format: int32 .RE .PP -\fBqueue\-id\fR +\fBbond\-port\&.queue\-id\fR .RS 4 Alias: queue\-id .sp @@ -5012,7 +5229,7 @@ Hostname settings\&. .PP Properties: .PP -\fBfrom\-dhcp\fR +\fBhostname\&.from\-dhcp\fR .RS 4 Whether the system hostname can be determined from DHCP on this connection\&. .sp @@ -5021,7 +5238,7 @@ When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is use Format: NMTernary (int32) .RE .PP -\fBfrom\-dns\-lookup\fR +\fBhostname\&.from\-dns\-lookup\fR .RS 4 Whether the system hostname can be determined from reverse DNS lookup of addresses on this device\&. .sp @@ -5030,7 +5247,7 @@ When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is use Format: NMTernary (int32) .RE .PP -\fBonly\-from\-default\fR +\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)\&. .sp @@ -5041,7 +5258,7 @@ When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is use Format: NMTernary (int32) .RE .PP -\fBpriority\fR +\fBhostname\&.priority\fR .RS 4 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\&. .sp @@ -5051,13 +5268,46 @@ Negative values have the special effect of excluding other connections with a gr .sp Format: int32 .RE +.SS "link setting" +.PP +Link settings\&. +.PP +Properties: +.PP +\fBlink\&.gro\-max\-size\fR +.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 +.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 +.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 +.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 +.RE .SS "loopback setting" .PP Loopback Link Settings\&. .PP Properties: .PP -\fBmtu\fR +\fBloopback\&.mtu\fR .RS 4 Alias: mtu .sp @@ -5071,7 +5321,7 @@ Veth Settings\&. .PP Properties: .PP -\fBpeer\fR +\fBveth\&.peer\fR .RS 4 Alias: peer .sp diff --git a/man/nm-settings-nmcli.xml b/man/nm-settings-nmcli.xml index c65baaa2..5adcea39 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.42.8</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.44.0</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 @@ -33,261 +33,308 @@ property. </para><refsect2><title>connection setting</title><para>General Connection Profile Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.connection.auth-retries">auth-retries</option></term><listitem><para>The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection.</para><para>Currently, this only applies to 802-1x authentication.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect">autoconnect</option></term><listitem><para> + <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> Alias: autoconnect</para><para>Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection.</para><para>Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile.</para><para>Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.</para><para>If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined.</para><para>Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-priority">autoconnect-priority</option></term><listitem><para>The autoconnect priority in range -999 to 999. If the connection is set to autoconnect, connections with higher priority will be preferred. The higher number means higher priority. Defaults to 0. Note that this property only matters if there are more than one candidate profile to select for autoconnect. In case of equal priority, the profile used most recently is chosen.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-retries">autoconnect-retries</option></term><listitem><para>The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-slaves">autoconnect-slaves</option></term><listitem><para>Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0.</para><para> - Format: NMSettingConnectionAutoconnectSlaves (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.dns-over-tls">dns-over-tls</option></term><listitem><para>Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic.</para><para>The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting.</para><para>This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.gateway-ping-timeout">gateway-ping-timeout</option></term><listitem><para>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.id">id</option></term><listitem><para> + 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> Alias: con-name</para><para>A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.interface-name">interface-name</option></term><listitem><para> + 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">lldp</option></term><listitem><para>Whether LLDP is enabled for the connection.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.llmnr">llmnr</option></term><listitem><para>Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link.</para><para>The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes").</para><para>This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.master">master</option></term><listitem><para> + 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: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.mdns">mdns</option></term><listitem><para>Whether mDNS is enabled for the connection.</para><para>The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no").</para><para>This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.metered">metered</option></term><listitem><para>Whether the connection is metered.</para><para>When updating this property on a currently activated connection, the change takes effect immediately.</para><para> - Format: NMMetered (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.mptcp-flags">mptcp-flags</option></term><listitem><para>Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints.</para><para>If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.</para><para>The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags.</para><para>Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless.</para><para>Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that.</para><para>When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.</para><para>If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl.</para><para>NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.</para><para>Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.mud-url">mud-url</option></term><listitem><para>If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://".</para><para>The special value "none" is allowed to indicate that no MUD URL is used.</para><para>If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.multi-connect">multi-connect</option></term><listitem><para>Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.permissions">permissions</option></term><listitem><para>An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah".</para><para>At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.read-only">read-only</option></term><listitem><para>FALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.secondaries">secondaries</option></term><listitem><para>List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.slave-type">slave-type</option></term><listitem><para> + 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: 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">stable-id</option></term><listitem><para>This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context.</para><para>The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used as DHCP client identifier with ipv4.dhcp-client-id=stable and to derive the DHCP DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid].</para><para>Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity.</para><para>The '$' character is treated special to perform dynamic substitutions at runtime. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. Note that "${DEVICE}" corresponds to the interface name of the device and "${MAC}" is the permanent MAC address of the device. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates.</para><para>If the value is unset, a global connection default is consulted. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.timestamp">timestamp</option></term><listitem><para>The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated.</para><para>NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.type">type</option></term><listitem><para> + 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: 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> Alias: type</para><para>Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.uuid">uuid</option></term><listitem><para>A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes.</para><para>The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").</para><para> - Format: a valid RFC4122 universally unique identifier (UUID).</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.wait-activation-delay">wait-activation-delay</option></term><listitem><para>Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event.</para><para>The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.wait-device-timeout">wait-device-timeout</option></term><listitem><para>Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed.</para><para>The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.zone">zone</option></term><listitem><para>The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.</para><para>When updating this property on a currently activated connection, the change takes effect immediately.</para><para> + Format: string</para></listitem></varlistentry><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></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>6lowpan setting</title><para>6LoWPAN Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.6lowpan.parent">parent</option></term><listitem><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.6lowpan.parent">6lowpan.parent</option></term><listitem><para> Alias: dev</para><para>If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.</para><para> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-1x setting</title><para>IEEE 802.1x Authentication Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.altsubject-matches">altsubject-matches</option></term><listitem><para>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.anonymous-identity">anonymous-identity</option></term><listitem><para>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.auth-timeout">auth-timeout</option></term><listitem><para>A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-cert">ca-cert</option></term><listitem><para>Contains the CA certificate if used by the EAP method specified in the "eap" property.</para><para>Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</para><para>Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-cert-password">ca-cert-password</option></term><listitem><para>The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-cert-password-flags">ca-cert-password-flags</option></term><listitem><para>Flags indicating how to handle the "ca-cert-password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.ca-path">ca-path</option></term><listitem><para>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property.</para><para>If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.client-cert">client-cert</option></term><listitem><para>Contains the client certificate if used by the EAP method specified in the "eap" property.</para><para>Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.client-cert-password">client-cert-password</option></term><listitem><para>The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.client-cert-password-flags">client-cert-password-flags</option></term><listitem><para>Flags indicating how to handle the "client-cert-password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.domain-match">domain-match</option></term><listitem><para>Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.domain-suffix-match">domain-suffix-match</option></term><listitem><para>Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.eap">eap</option></term><listitem><para>The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.identity">identity</option></term><listitem><para>Identity string for EAP authentication methods. Often the user's user or login name.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.optional">optional</option></term><listitem><para>Whether the 802.1X authentication is optional. If TRUE, the activation will continue even after a timeout or an authentication failure. Setting the property to TRUE is currently allowed only for Ethernet connections. If set to FALSE, the activation can continue only after a successful authentication.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.pac-file">pac-file</option></term><listitem><para>UTF-8 encoded file path containing PAC for EAP-FAST.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password">password</option></term><listitem><para>UTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password-flags">password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password-raw">password-raw</option></term><listitem><para>Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.password-raw-flags">password-raw-flags</option></term><listitem><para>Flags indicating how to handle the "password-raw" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-auth-flags">phase1-auth-flags</option></term><listitem><para>Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. TLS time checks can be also disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x and tls_disable_time_checks settings. See the wpa_supplicant documentation for more details.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-fast-provisioning">phase1-fast-provisioning</option></term><listitem><para>Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-peaplabel">phase1-peaplabel</option></term><listitem><para>Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase1-peapver">phase1-peapver</option></term><listitem><para>Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-altsubject-matches">phase2-altsubject-matches</option></term><listitem><para>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-auth">phase2-auth</option></term><listitem><para>Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. For TTLS this property selects one of the supported non-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2-autheap" selects an EAP inner method. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. Both "phase2-auth" and "phase2-autheap" cannot be specified.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-autheap">phase2-autheap</option></term><listitem><para>Specifies the allowed "phase 2" inner EAP-based authentication method when TTLS is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-cert">phase2-ca-cert</option></term><listitem><para>Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</para><para>Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</para><para>Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-cert-password">phase2-ca-cert-password</option></term><listitem><para>The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-cert-password-flags">phase2-ca-cert-password-flags</option></term><listitem><para>Flags indicating how to handle the "phase2-ca-cert-password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-ca-path">phase2-ca-path</option></term><listitem><para>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property.</para><para>If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-client-cert">phase2-client-cert</option></term><listitem><para>Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</para><para>Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-client-cert-password">phase2-client-cert-password</option></term><listitem><para>The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-client-cert-password-flags">phase2-client-cert-password-flags</option></term><listitem><para>Flags indicating how to handle the "phase2-client-cert-password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-domain-match">phase2-domain-match</option></term><listitem><para>Constraint for server domain name. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison. Multiple valid FQDNs can be passed as a ";" delimited list.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-domain-suffix-match">phase2-domain-suffix-match</option></term><listitem><para>Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. Since version 1.24, multiple valid FQDNs can be passed as a ";" delimited list.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-private-key">phase2-private-key</option></term><listitem><para>Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls".</para><para>Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-private-key-password">phase2-private-key-password</option></term><listitem><para>The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-private-key-password-flags">phase2-private-key-password-flags</option></term><listitem><para>Flags indicating how to handle the "phase2-private-key-password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.phase2-subject-match">phase2-subject-match</option></term><listitem><para>Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.</para><para> + <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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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: 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> This property is deprecated since version 1.2. Use "phase2-domain-suffix-match" instead.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.pin">pin</option></term><listitem><para>PIN used for EAP authentication methods.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.pin-flags">pin-flags</option></term><listitem><para>Flags indicating how to handle the "pin" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.private-key">private-key</option></term><listitem><para>Contains the private key when the "eap" property is set to "tls".</para><para>Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</para><para>WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.private-key-password">private-key-password</option></term><listitem><para>The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.private-key-password-flags">private-key-password-flags</option></term><listitem><para>Flags indicating how to handle the "private-key-password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.subject-match">subject-match</option></term><listitem><para>Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and should not be used.</para><para> + 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: 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> This property is deprecated since version 1.2. Use "phase2-domain-suffix-match" instead.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-1x.system-ca-certs">system-ca-certs</option></term><listitem><para>When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).</para><para> + Format: 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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.adsl.encapsulation">encapsulation</option></term><listitem><para> + <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">password</option></term><listitem><para> + Format: string</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">password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.protocol">protocol</option></term><listitem><para> + 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> Alias: protocol</para><para>ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.username">username</option></term><listitem><para> + Format: string</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">vci</option></term><listitem><para>VCI of ADSL connection</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.adsl.vpi">vpi</option></term><listitem><para>VPI of ADSL connection</para><para> + Format: 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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bluetooth.bdaddr">bdaddr</option></term><listitem><para> + <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">type</option></term><listitem><para> + Format: byte array</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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bond.options">options</option></term><listitem><para>Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</para><para> + <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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bridge.ageing-time">ageing-time</option></term><listitem><para> + <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">forward-delay</option></term><listitem><para> + Format: uint32</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">group-address</option></term><listitem><para>If specified, The MAC address of the multicast group this bridge uses for STP.</para><para>The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.group-forward-mask">group-forward-mask</option></term><listitem><para> + 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> Alias: group-forward-mask</para><para>A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.hello-time">hello-time</option></term><listitem><para> + Format: uint32</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">mac-address</option></term><listitem><para> + Format: uint32</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">max-age</option></term><listitem><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> Alias: max-age</para><para>The Spanning Tree Protocol (STP) maximum message age, in seconds.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-hash-max">multicast-hash-max</option></term><listitem><para>Set maximum size of multicast hash table (value must be a power of 2).</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-last-member-count">multicast-last-member-count</option></term><listitem><para>Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-last-member-interval">multicast-last-member-interval</option></term><listitem><para>Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-membership-interval">multicast-membership-interval</option></term><listitem><para>Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-querier">multicast-querier</option></term><listitem><para>Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-querier-interval">multicast-querier-interval</option></term><listitem><para>If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-interval">multicast-query-interval</option></term><listitem><para>Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-response-interval">multicast-query-response-interval</option></term><listitem><para>Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-query-use-ifaddr">multicast-query-use-ifaddr</option></term><listitem><para>If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-router">multicast-router</option></term><listitem><para>Sets bridge's multicast router. Multicast-snooping must be enabled for this option to work.</para><para>Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-snooping">multicast-snooping</option></term><listitem><para> + 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> Alias: multicast-snooping</para><para>Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-startup-query-count">multicast-startup-query-count</option></term><listitem><para>Set the number of IGMP queries to send during startup phase.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.multicast-startup-query-interval">multicast-startup-query-interval</option></term><listitem><para>Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.priority">priority</option></term><listitem><para> + 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> Alias: priority</para><para>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.stp">stp</option></term><listitem><para> + Format: uint32</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">vlan-default-pvid</option></term><listitem><para>The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-filtering">vlan-filtering</option></term><listitem><para>Control whether VLAN filtering is enabled on the bridge.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-protocol">vlan-protocol</option></term><listitem><para>If specified, the protocol used for VLAN filtering.</para><para>Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlan-stats-enabled">vlan-stats-enabled</option></term><listitem><para>Controls whether per-VLAN stats accounting is enabled.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge.vlans">vlans</option></term><listitem><para>Array of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property.</para><para>In nmcli the VLAN list can be specified with the following syntax:</para><para>$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</para><para>where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</para><para> + Format: 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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bridge-port.hairpin-mode">hairpin-mode</option></term><listitem><para> + <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">path-cost</option></term><listitem><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> Alias: path-cost</para><para>The Spanning Tree Protocol (STP) port cost for destinations via this port.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.bridge-port.priority">priority</option></term><listitem><para> + Format: uint32</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">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: 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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.cdma.mtu">mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.number">number</option></term><listitem><para>The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.password">password</option></term><listitem><para> + <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: 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">password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.cdma.username">username</option></term><listitem><para> + 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> Alias: user</para><para>The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.</para><para> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>dcb setting</title><para>Data Center Bridging Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-flags">app-fcoe-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-mode">app-fcoe-mode</option></term><listitem><para>The FCoE controller mode; either "fabric" or "vn2vn".</para><para>Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fcoe-priority">app-fcoe-priority</option></term><listitem><para>The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fip-flags">app-fip-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-fip-priority">app-fip-priority</option></term><listitem><para>The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-iscsi-flags">app-iscsi-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.app-iscsi-priority">app-iscsi-priority</option></term><listitem><para>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-bandwidth">priority-bandwidth</option></term><listitem><para>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-flow-control">priority-flow-control</option></term><listitem><para>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-flow-control-flags">priority-flow-control-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-bandwidth">priority-group-bandwidth</option></term><listitem><para>An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-flags">priority-group-flags</option></term><listitem><para>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</para><para> - Format: NMSettingDcbFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-group-id">priority-group-id</option></term><listitem><para>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-strict-bandwidth">priority-strict-bandwidth</option></term><listitem><para>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.dcb.priority-traffic-class">priority-traffic-class</option></term><listitem><para>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.</para><para> + <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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-adaptive-rx">coalesce-adaptive-rx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-adaptive-tx">coalesce-adaptive-tx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-high">coalesce-pkt-rate-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-low">coalesce-pkt-rate-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames">coalesce-rx-frames</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-high">coalesce-rx-frames-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-irq">coalesce-rx-frames-irq</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-low">coalesce-rx-frames-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs">coalesce-rx-usecs</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-high">coalesce-rx-usecs-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-irq">coalesce-rx-usecs-irq</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-low">coalesce-rx-usecs-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-sample-interval">coalesce-sample-interval</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-stats-block-usecs">coalesce-stats-block-usecs</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames">coalesce-tx-frames</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-high">coalesce-tx-frames-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-irq">coalesce-tx-frames-irq</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-low">coalesce-tx-frames-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs">coalesce-tx-usecs</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-high">coalesce-tx-usecs-high</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-irq">coalesce-tx-usecs-irq</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-low">coalesce-tx-usecs-low</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-esp-hw-offload">feature-esp-hw-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-esp-tx-csum-hw-offload">feature-esp-tx-csum-hw-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-fcoe-mtu">feature-fcoe-mtu</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-gro">feature-gro</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-gso">feature-gso</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-highdma">feature-highdma</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-hw-tc-offload">feature-hw-tc-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-l2-fwd-offload">feature-l2-fwd-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-loopback">feature-loopback</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-lro">feature-lro</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-macsec-hw-offload">feature-macsec-hw-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-ntuple">feature-ntuple</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx">feature-rx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-all">feature-rx-all</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-fcs">feature-rx-fcs</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-gro-hw">feature-rx-gro-hw</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-gro-list">feature-rx-gro-list</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-udp-gro-forwarding">feature-rx-udp-gro-forwarding</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-udp_tunnel-port-offload">feature-rx-udp_tunnel-port-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-filter">feature-rx-vlan-filter</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-filter">feature-rx-vlan-stag-filter</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-hw-parse">feature-rx-vlan-stag-hw-parse</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rxhash">feature-rxhash</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-rxvlan">feature-rxvlan</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-sg">feature-sg</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-record">feature-tls-hw-record</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-rx-offload">feature-tls-hw-rx-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tls-hw-tx-offload">feature-tls-hw-tx-offload</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tso">feature-tso</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx">feature-tx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-fcoe-crc">feature-tx-checksum-fcoe-crc</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ip-generic">feature-tx-checksum-ip-generic</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv4">feature-tx-checksum-ipv4</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv6">feature-tx-checksum-ipv6</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-checksum-sctp">feature-tx-checksum-sctp</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-esp-segmentation">feature-tx-esp-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-fcoe-segmentation">feature-tx-fcoe-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gre-csum-segmentation">feature-tx-gre-csum-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gre-segmentation">feature-tx-gre-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-list">feature-tx-gso-list</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-partial">feature-tx-gso-partial</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-gso-robust">feature-tx-gso-robust</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-ipxip4-segmentation">feature-tx-ipxip4-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-ipxip6-segmentation">feature-tx-ipxip6-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-nocache-copy">feature-tx-nocache-copy</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather">feature-tx-scatter-gather</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather-fraglist">feature-tx-scatter-gather-fraglist</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-sctp-segmentation">feature-tx-sctp-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-ecn-segmentation">feature-tx-tcp-ecn-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-mangleid-segmentation">feature-tx-tcp-mangleid-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp-segmentation">feature-tx-tcp-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tcp6-segmentation">feature-tx-tcp6-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-tunnel-remcsum-segmentation">feature-tx-tunnel-remcsum-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp-segmentation">feature-tx-udp-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-csum-segmentation">feature-tx-udp_tnl-csum-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-segmentation">feature-tx-udp_tnl-segmentation</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-tx-vlan-stag-hw-insert">feature-tx-vlan-stag-hw-insert</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.feature-txvlan">feature-txvlan</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-autoneg">pause-autoneg</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-rx">pause-rx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.pause-tx">pause-tx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx">ring-rx</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx-jumbo">ring-rx-jumbo</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-rx-mini">ring-rx-mini</option></term><listitem><para/></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-tx">ring-tx</option></term><listitem><para/></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>gsm setting</title><para>GSM-based Mobile Broadband Settings.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.coalesce-adaptive-rx">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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.gsm.apn">apn</option></term><listitem><para> + <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> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.auto-config">auto-config</option></term><listitem><para>When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.device-id">device-id</option></term><listitem><para>The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.home-only">home-only</option></term><listitem><para>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.mtu">mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.network-id">network-id</option></term><listitem><para>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.number">number</option></term><listitem><para>Legacy setting that used to help establishing PPP data sessions for GSM-based modems.</para><para> + 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: 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: 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: 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">password</option></term><listitem><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">password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.pin">pin</option></term><listitem><para>If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.pin-flags">pin-flags</option></term><listitem><para>Flags indicating how to handle the "pin" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.sim-id">sim-id</option></term><listitem><para>The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.sim-operator-id">sim-operator-id</option></term><listitem><para>A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioned by the given operator.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.gsm.username">username</option></term><listitem><para> + 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: 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: 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> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>infiniband setting</title><para>Infiniband Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.infiniband.mac-address">mac-address</option></term><listitem><para> + <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">mtu</option></term><listitem><para> + Format: byte array</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">p-key</option></term><listitem><para> + Format: uint32</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">parent</option></term><listitem><para> + Format: int32</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">transport-mode</option></term><listitem><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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.addresses">addresses</option></term><listitem><para> - Alias: ip4</para><para>Array of IP addresses.</para><para> - Format: a comma separated list of addresses</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.auto-route-ext-gw">auto-route-ext-gw</option></term><listitem><para>VPN connections will default to add the route automatically unless this setting is set to FALSE.</para><para>For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dad-timeout">dad-timeout</option></term><listitem><para>Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or zero). A value greater than zero is a timeout in milliseconds.</para><para>The property is currently implemented only for IPv4.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-client-id">dhcp-client-id</option></term><listitem><para>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0.</para><para>The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links.</para><para>The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset.</para><para>The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id.</para><para>The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key.</para><para>If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-fqdn">dhcp-fqdn</option></term><listitem><para>If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-hostname">dhcp-hostname</option></term><listitem><para>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-hostname-flags">dhcp-hostname-flags</option></term><listitem><para>Flags for the DHCP hostname and FQDN.</para><para>Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.</para><para>When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-iaid">dhcp-iaid</option></term><listitem><para>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname".</para><para>For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.</para><para>For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address.</para><para>The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-reject-servers">dhcp-reject-servers</option></term><listitem><para>Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers.</para><para>For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24").</para><para>This property is currently not implemented for DHCPv6.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-send-hostname">dhcp-send-hostname</option></term><listitem><para>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-timeout">dhcp-timeout</option></term><listitem><para>A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds).</para><para>Set to 2147483647 (MAXINT32) for infinity.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-vendor-class-identifier">dhcp-vendor-class-identifier</option></term><listitem><para>The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns">dns</option></term><listitem><para>Array of IP addresses of DNS servers.</para><para>For DoT (DNS over TLS), the SNI server name can be specified by appending "#example.com" to the IP address of the DNS server. This currently only has effect when using systemd-resolved.</para><para> - Format: array of uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-options">dns-options</option></term><listitem><para>Array of DNS options as described in man 5 resolv.conf.</para><para>NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.</para><para>The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc".</para><para>The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.</para><para>When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-priority">dns-priority</option></term><listitem><para>DNS servers priority.</para><para>The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</para><para>Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.</para><para>Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections.</para><para>Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile.</para><para>When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices.</para><para>When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</para><para>When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dns-search">dns-search</option></term><listitem><para>List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.</para><para>When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</para><para>When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.gateway">gateway</option></term><listitem><para> + <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: 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-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: 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> Alias: gw4</para><para>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</para><para>Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</para><para>Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.ignore-auto-dns">ignore-auto-dns</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.ignore-auto-routes">ignore-auto-routes</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.link-local">link-local</option></term><listitem><para>Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server.</para><para>When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.may-fail">may-fail</option></term><listitem><para>If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.method">method</option></term><listitem><para>IP configuration method.</para><para>NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.</para><para>In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.</para><para>For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.</para><para>For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.never-default">never-default</option></term><listitem><para>If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.replace-local-rule">replace-local-rule</option></term><listitem><para>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.required-timeout">required-timeout</option></term><listitem><para>The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</para><para>This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.</para><para>Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</para><para>A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.route-metric">route-metric</option></term><listitem><para>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</para><para> - Format: int64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.route-table">route-table</option></term><listitem><para>Enable policy routing (source routing) and set the routing table used when adding routes.</para><para>This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para>If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para>Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.routes">routes</option></term><listitem><para> + 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> + Sets the IPv4 connection method. You can set one of the following values: +</para><para> + <itemizedlist> + <listitem> + <para><literal>"auto"</literal> - Enables automatic IPv4 address assignment from DHCP, PPP, or similar services.</para> + </listitem> + <listitem> + <para><literal>"manual"</literal> - Enables the configuration of static IPv4 addresses on the interface. Note that you must set at least one IP address and subnet mask in the "ipv4.addresses" property.</para> + </listitem> + <listitem> + <para><literal>"disabled"</literal> - Disables the IPv4 protocol in this connection profile.</para> + </listitem> + <listitem> + <para><literal>"shared"</literal> - Provides network access to other computers. If you do not specify an IP address and subnet mask in "ipv4.addresses", NetworkManager assigns 10.42.x.1/24 to the interface. Additionally, NetworkManager starts a DHCP server and DNS forwarder. Hosts that connect to this interface will then receive an IP address from the configured range, and NetworkManager configures NAT to map client addresses to the one of the current default network connection.</para> + </listitem> + <listitem> + <para><literal>"link-local"</literal> - Enables link-local addresses according to RFC 3927. NetworkManager assigns a random link-local address from the 169.254.0.0/16 subnet to the interface.</para> + </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> 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]...]". @@ -377,7 +424,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">routing-rules</option></term><listitem><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> 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 @@ -387,35 +434,65 @@ 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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.addr-gen-mode">addr-gen-mode</option></term><listitem><para>Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3).</para><para>If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced.</para><para>The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced.</para><para>The special values "default" and "default-or-eui64" will fallback to the global connection default in as documented in NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively.</para><para>For libnm, the property defaults to "default" since 1.40. Previously it defaulted to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions.</para><para>Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.addresses">addresses</option></term><listitem><para> - Alias: ip6</para><para>Array of IP addresses.</para><para> - Format: a comma separated list of addresses</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.auto-route-ext-gw">auto-route-ext-gw</option></term><listitem><para>VPN connections will default to add the route automatically unless this setting is set to FALSE.</para><para>For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-duid">dhcp-duid</option></term><listitem><para>A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option.</para><para>The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id.</para><para>The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk.</para><para>The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt").</para><para>When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-hostname">dhcp-hostname</option></term><listitem><para>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-hostname-flags">dhcp-hostname-flags</option></term><listitem><para>Flags for the DHCP hostname and FQDN.</para><para>Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.</para><para>When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-iaid">dhcp-iaid</option></term><listitem><para>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The string can be a 32-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers). Alternatively it can be set to the special values "mac", "perm-mac", "ifname" or "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname".</para><para>For DHCPv4, the IAID is only used with "ipv4.dhcp-client-id" values "duid" and "ipv6-duid" to generate the client-id.</para><para>For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address.</para><para>The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-send-hostname">dhcp-send-hostname</option></term><listitem><para>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dhcp-timeout">dhcp-timeout</option></term><listitem><para>A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds).</para><para>Set to 2147483647 (MAXINT32) for infinity.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns">dns</option></term><listitem><para>Array of IP addresses of DNS servers.</para><para>For DoT (DNS over TLS), the SNI server name can be specified by appending "#example.com" to the IP address of the DNS server. This currently only has effect when using systemd-resolved.</para><para> - Format: array of byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-options">dns-options</option></term><listitem><para>Array of DNS options as described in man 5 resolv.conf.</para><para>NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.</para><para>The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc".</para><para>The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.</para><para>When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-priority">dns-priority</option></term><listitem><para>DNS servers priority.</para><para>The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).</para><para>Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.</para><para>Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections.</para><para>Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile.</para><para>When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices.</para><para>When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</para><para>When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.dns-search">dns-search</option></term><listitem><para>List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.</para><para>When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</para><para>When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.gateway">gateway</option></term><listitem><para> + <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> + 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: 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-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> Alias: gw6</para><para>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</para><para>Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</para><para>Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ignore-auto-dns">ignore-auto-dns</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ignore-auto-routes">ignore-auto-routes</option></term><listitem><para>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ip6-privacy">ip6-privacy</option></term><listitem><para>Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).</para><para>Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy".</para><para>If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr".</para><para>Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.</para><para> - Format: NMSettingIP6ConfigPrivacy (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.may-fail">may-fail</option></term><listitem><para>If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.method">method</option></term><listitem><para>IP configuration method.</para><para>NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values.</para><para>In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior.</para><para>For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.</para><para>For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.mtu">mtu</option></term><listitem><para>Maximum transmission unit size, in bytes. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link-layer MTU. If greater than the link-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.never-default">never-default</option></term><listitem><para>If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.ra-timeout">ra-timeout</option></term><listitem><para>A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device.</para><para>Set to 2147483647 (MAXINT32) for infinity.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.replace-local-rule">replace-local-rule</option></term><listitem><para>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.required-timeout">required-timeout</option></term><listitem><para>The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.</para><para>This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.</para><para>Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</para><para>A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.route-metric">route-metric</option></term><listitem><para>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</para><para> - Format: int64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.route-table">route-table</option></term><listitem><para>Enable policy routing (source routing) and set the routing table used when adding routes.</para><para>This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.</para><para>If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</para><para>Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.routes">routes</option></term><listitem><para> + 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> + Sets the IPv6 connection method. You can set one of the following values: +</para><para> + <itemizedlist> + <listitem> + <para><literal>"auto"</literal> - Enables IPv6 auto-configuration. By default, NetworkManager uses Router Advertisements and, if the router announces the "managed" flag, NetworkManager requests an IPv6 address and prefix from a DHCPv6 server.</para> + </listitem> + <listitem> + <para><literal>"dhcp"</literal> - Requests an IPv6 address and prefix from a DHCPv6 server. Note that DHCPv6 does not have options to provide routes and the default gateway. As a consequence, by using the "dhcp" method, connections are limited to their own subnet.</para> + </listitem> + <listitem> + <para><literal>"manual"</literal> - Enables the configuration of static IPv6 addresses on the interface. Note that you must set at least one IP address and prefix in the "ipv6.addresses" property.</para> + </listitem> + <listitem> + <para><literal>"disabled"</literal> - Disables the IPv6 protocol in this connection profile.</para> + </listitem> + <listitem> + <para><literal>"ignore"</literal> - Configures NetworkManager to make no changes to the IPv6 configuration on the interface. For example, you can then use the "accept_ra" feature of the kernel to accept Router Advertisements.</para> + </listitem> + <listitem> + <para><literal>"shared"</literal> - Provides network access to other computers. NetworkManager requests a prefix from an upstream DHCPv6 server, assigns an address to the interface, and announces the prefix to clients that connect to this interface.</para> + </listitem> + <listitem> + <para><literal>"link-local"</literal> - Assigns a random link-local address from the fe80::/64 subnet to the interface.</para> + </listitem> + </itemizedlist> + <para> + 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> 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]...]". @@ -486,7 +563,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">routing-rules</option></term><listitem><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> 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 @@ -494,153 +571,157 @@ fixed priority. </para><para> Example: <literal>priority 5 from 1:2:3::5/128 table 45</literal> </para><para> - Format: a comma separated list of routing rules</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv6.token">token</option></term><listitem><para>Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</para><para> + Format: 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: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ip-tunnel setting</title><para>IP Tunneling Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.encapsulation-limit">encapsulation-limit</option></term><listitem><para>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1) to ip-tunnel flags.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.flags">flags</option></term><listitem><para>Tunnel flags. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.flow-label">flow-label</option></term><listitem><para>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.fwmark">fwmark</option></term><listitem><para>The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.input-key">input-key</option></term><listitem><para>The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.local">local</option></term><listitem><para> + <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 NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1) 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: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for IPv6 tunnels.</para><para> + Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.flow-label">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: 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">mode</option></term><listitem><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, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.mtu">mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.output-key">output-key</option></term><listitem><para>The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.parent">parent</option></term><listitem><para> + 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: 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">path-mtu-discovery</option></term><listitem><para>Whether to enable Path MTU Discovery on this tunnel.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.remote">remote</option></term><listitem><para> + 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> Alias: remote</para><para>The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.tos">tos</option></term><listitem><para>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ip-tunnel.ttl">ttl</option></term><listitem><para>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</para><para> + Format: 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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.macsec.encrypt">encrypt</option></term><listitem><para> + <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">mka-cak</option></term><listitem><para> + Format: boolean</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">mka-cak-flags</option></term><listitem><para>Flags indicating how to handle the "mka-cak" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.mka-ckn">mka-ckn</option></term><listitem><para> + 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> Alias: ckn</para><para>The pre-shared CKN (Connectivity-association Key Name) for MACsec Key Agreement. Must be a string of hexadecimal characters with a even length between 2 and 64.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.mode">mode</option></term><listitem><para> + 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">parent</option></term><listitem><para> + Format: int32</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">port</option></term><listitem><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">send-sci</option></term><listitem><para>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.validation">validation</option></term><listitem><para>Specifies the validation mode for incoming frames.</para><para> + Format: int32</para></listitem></varlistentry><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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.macvlan.mode">mode</option></term><listitem><para> + <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">parent</option></term><listitem><para> + Format: uint32</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">promiscuous</option></term><listitem><para>Whether the interface should be put in promiscuous mode.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macvlan.tap">tap</option></term><listitem><para> + 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> Alias: tap</para><para>Whether the interface should be a MACVTAP.</para><para> Format: boolean</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>match setting</title><para>Match settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.match.driver">driver</option></term><listitem><para>A list of driver names to match. Each element is a shell wildcard pattern.</para><para>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.interface-name">interface-name</option></term><listitem><para>A list of interface names to match. Each element is a shell wildcard pattern.</para><para>An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.kernel-command-line">kernel-command-line</option></term><listitem><para>A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported.</para><para>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.match.path">path</option></term><listitem><para>A list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier.</para><para>For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0".</para><para>The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev").</para><para>Each element of the list is a shell wildcard pattern.</para><para>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.match.driver">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> Alias: olpc-mesh</para><para>OLPC Wireless Mesh Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-11-olpc-mesh.channel">channel</option></term><listitem><para> + <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">dhcp-anycast-address</option></term><listitem><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> Alias: dhcp-anycast</para><para>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.</para><para>This is currently only implemented by dhclient DHCP plugin.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-olpc-mesh.ssid">ssid</option></term><listitem><para> + 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> Alias: ssid</para><para>SSID of the mesh network to join.</para><para> Format: byte array</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>ovs-bridge setting</title><para>OvsBridge Link Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.datapath-type">datapath-type</option></term><listitem><para>The data path type. One of "system", "netdev" or empty.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.fail-mode">fail-mode</option></term><listitem><para>The bridge failure mode. One of "secure", "standalone" or empty.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.mcast-snooping-enable">mcast-snooping-enable</option></term><listitem><para>Enable or disable multicast snooping.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.rstp-enable">rstp-enable</option></term><listitem><para>Enable or disable RSTP.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-bridge.stp-enable">stp-enable</option></term><listitem><para>Enable or disable STP.</para><para> + <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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.devargs">devargs</option></term><listitem><para>Open vSwitch DPDK device arguments.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.n-rxq">n-rxq</option></term><listitem><para>Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.n-rxq-desc">n-rxq-desc</option></term><listitem><para>The rx queue size (number of rx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-dpdk.n-txq-desc">n-txq-desc</option></term><listitem><para>The tx queue size (number of tx descriptors) for DPDK ports. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors.</para><para> + <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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-interface.ofport-request">ofport-request</option></term><listitem><para>Open vSwitch openflow port number. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network. OpenFlow switches connect logically to each other via their OpenFlow ports.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-interface.type">type</option></term><listitem><para>The interface type. Either "internal", "system", "patch", "dpdk", or empty.</para><para> + <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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ovs-patch.peer">peer</option></term><listitem><para>Specifies the name of the interface for the other side of the patch. The patch on the other side must also set this interface as peer.</para><para> + <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">bond-downdelay</option></term><listitem><para>The time port must be inactive in order to be considered down.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.bond-mode">bond-mode</option></term><listitem><para>Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.bond-updelay">bond-updelay</option></term><listitem><para>The time port must be active before it starts forwarding traffic.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.lacp">lacp</option></term><listitem><para>LACP mode. One of "active", "off", or "passive".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.tag">tag</option></term><listitem><para>The VLAN tag in the range 0-4095.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.trunks">trunks</option></term><listitem><para>A list of VLAN ranges that this port trunks.</para><para>The property is valid only for ports with mode "trunk", "native-tagged", or "native-untagged port". If it is empty, the port trunks all VLANs.</para><para> - Format: array of vardict</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ovs-port.vlan-mode">vlan-mode</option></term><listitem><para>The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.</para><para> + <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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.ppp.baud">baud</option></term><listitem><para>If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.crtscts">crtscts</option></term><listitem><para>If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.lcp-echo-failure">lcp-echo-failure</option></term><listitem><para>If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.lcp-echo-interval">lcp-echo-interval</option></term><listitem><para>If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mppe-stateful">mppe-stateful</option></term><listitem><para>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mru">mru</option></term><listitem><para>If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.mtu">mtu</option></term><listitem><para>If non-zero, instruct pppd to send packets no larger than the specified size.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.no-vj-comp">no-vj-comp</option></term><listitem><para>If TRUE, Van Jacobsen TCP header compression will not be requested.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.noauth">noauth</option></term><listitem><para>If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.nobsdcomp">nobsdcomp</option></term><listitem><para>If TRUE, BSD compression will not be requested.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.nodeflate">nodeflate</option></term><listitem><para>If TRUE, "deflate" compression will not be requested.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-chap">refuse-chap</option></term><listitem><para>If TRUE, the CHAP authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-eap">refuse-eap</option></term><listitem><para>If TRUE, the EAP authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-mschap">refuse-mschap</option></term><listitem><para>If TRUE, the MSCHAP authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-mschapv2">refuse-mschapv2</option></term><listitem><para>If TRUE, the MSCHAPv2 authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.refuse-pap">refuse-pap</option></term><listitem><para>If TRUE, the PAP authentication method will not be used.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.require-mppe">require-mppe</option></term><listitem><para>If TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ppp.require-mppe-128">require-mppe-128</option></term><listitem><para>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</para><para> + <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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.parent">parent</option></term><listitem><para> + <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">password</option></term><listitem><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">password-flags</option></term><listitem><para>Flags indicating how to handle the "password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.service">service</option></term><listitem><para> + 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> Alias: service</para><para>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.pppoe.username">username</option></term><listitem><para> + 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> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>proxy setting</title><para>WWW Proxy Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.proxy.browser-only">browser-only</option></term><listitem><para> + <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">method</option></term><listitem><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">pac-script</option></term><listitem><para> - Alias: pac-script</para><para>PAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.proxy.pac-url">pac-url</option></term><listitem><para> + Format: int32</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">baud</option></term><listitem><para>Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.bits">bits</option></term><listitem><para>Byte-width of the serial communication. The 8 in "8n1" for example.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.parity">parity</option></term><listitem><para>Parity setting of the serial port.</para><para> - Format: NMSettingSerialParity (byte)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.send-delay">send-delay</option></term><listitem><para>Time to delay between each byte sent to the modem, in microseconds.</para><para> - Format: uint64</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.serial.stopbits">stopbits</option></term><listitem><para>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</para><para> + <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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.sriov.autoprobe-drivers">autoprobe-drivers</option></term><listitem><para>Whether to autoprobe virtual functions by a compatible driver.</para><para>If set to NM_TERNARY_TRUE (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF.</para><para>If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them.</para><para>When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_TRUE (1).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.total-vfs">total-vfs</option></term><listitem><para>The total number of virtual functions to create.</para><para>Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.vfs">vfs</option></term><listitem><para>Array of virtual function descriptors.</para><para>Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF.</para><para>When represented as string a VF is in the form:</para><para>"INDEX [ATTR=VALUE[ ATTR=VALUE]...]".</para><para>for example:</para><para>"2 mac=00:11:22:33:44:55 spoof-check=true".</para><para>Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans.</para><para>The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form</para><para>"ID[.PRIORITY[.PROTO]]".</para><para>PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.</para><para> + <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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.tc.qdiscs">qdiscs</option></term><listitem><para> + <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 Linux traffic control subsystem </para><para> @@ -902,7 +983,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">tfilters</option></term><listitem><para> + Format: GPtrArray(NMTCQdisc)</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> @@ -995,228 +1076,240 @@ Linux traffic control subsystem </variablelist><para> Format: GPtrArray(NMTCTfilter)</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>team setting</title><para>Teaming Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.team.config">config</option></term><listitem><para> + <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">link-watchers</option></term><listitem><para>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</para><para> - Format: array of vardict</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.mcast-rejoin-count">mcast-rejoin-count</option></term><listitem><para>Corresponds to the teamd mcast_rejoin.count.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.mcast-rejoin-interval">mcast-rejoin-interval</option></term><listitem><para>Corresponds to the teamd mcast_rejoin.interval.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.notify-peers-count">notify-peers-count</option></term><listitem><para>Corresponds to the teamd notify_peers.count.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.notify-peers-interval">notify-peers-interval</option></term><listitem><para>Corresponds to the teamd notify_peers.interval.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner">runner</option></term><listitem><para>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-active">runner-active</option></term><listitem><para>Corresponds to the teamd runner.active.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-agg-select-policy">runner-agg-select-policy</option></term><listitem><para>Corresponds to the teamd runner.agg_select_policy.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-fast-rate">runner-fast-rate</option></term><listitem><para>Corresponds to the teamd runner.fast_rate.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-hwaddr-policy">runner-hwaddr-policy</option></term><listitem><para>Corresponds to the teamd runner.hwaddr_policy.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-min-ports">runner-min-ports</option></term><listitem><para>Corresponds to the teamd runner.min_ports.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-sys-prio">runner-sys-prio</option></term><listitem><para>Corresponds to the teamd runner.sys_prio.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-balancer">runner-tx-balancer</option></term><listitem><para>Corresponds to the teamd runner.tx_balancer.name.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-balancer-interval">runner-tx-balancer-interval</option></term><listitem><para>Corresponds to the teamd runner.tx_balancer.interval.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team.runner-tx-hash">runner-tx-hash</option></term><listitem><para>Corresponds to the teamd runner.tx_hash.</para><para> + Format: 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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.team-port.config">config</option></term><listitem><para> + <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">lacp-key</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.lacp_key.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.lacp-prio">lacp-prio</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.link-watchers">link-watchers</option></term><listitem><para>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</para><para> - Format: array of vardict</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.prio">prio</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.prio.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.queue-id">queue-id</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.team-port.sticky">sticky</option></term><listitem><para>Corresponds to the teamd ports.PORTIFNAME.sticky.</para><para> + Format: 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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.tun.group">group</option></term><listitem><para> + <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">mode</option></term><listitem><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">multi-queue</option></term><listitem><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: multi-queue</para><para>If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.tun.owner">owner</option></term><listitem><para> + Format: boolean</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">pi</option></term><listitem><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">vnet-hdr</option></term><listitem><para> + Format: boolean</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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.vlan.egress-priority-map">egress-priority-map</option></term><listitem><para> + <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">flags</option></term><listitem><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">id</option></term><listitem><para> + Format: NMVlanFlags (uint32)</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">ingress-priority-map</option></term><listitem><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> Alias: ingress</para><para>For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vlan.parent">parent</option></term><listitem><para> + Format: array of string</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">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><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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.vpn.data">data</option></term><listitem><para>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</para><para> - Format: dict of string to string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.persistent">persistent</option></term><listitem><para>If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.secrets">secrets</option></term><listitem><para>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</para><para> - Format: dict of string to string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.service-type">service-type</option></term><listitem><para> + <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> Alias: vpn-type</para><para>D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.timeout">timeout</option></term><listitem><para>Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vpn.user-name">user-name</option></term><listitem><para> + 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> Alias: user</para><para>If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.</para><para> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>vrf setting</title><para>VRF settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.vrf.table">table</option></term><listitem><para> + <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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.ageing">ageing</option></term><listitem><para>Specifies the lifetime in seconds of FDB entries learnt by the kernel.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.destination-port">destination-port</option></term><listitem><para> + <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> Alias: destination-port</para><para>Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.id">id</option></term><listitem><para> + Format: uint32</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">l2-miss</option></term><listitem><para>Specifies whether netlink LL ADDR miss notifications are generated.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.l3-miss">l3-miss</option></term><listitem><para>Specifies whether netlink IP ADDR miss notifications are generated.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.learning">learning</option></term><listitem><para>Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.limit">limit</option></term><listitem><para>Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.local">local</option></term><listitem><para> + 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> Alias: local</para><para>If given, specifies the source IP address to use in outgoing packets.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.parent">parent</option></term><listitem><para> + 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">proxy</option></term><listitem><para>Specifies whether ARP proxy is turned on.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.remote">remote</option></term><listitem><para> + 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> Alias: remote</para><para>Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.rsc">rsc</option></term><listitem><para>Specifies whether route short circuit is turned on.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.source-port-max">source-port-max</option></term><listitem><para> + 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> Alias: source-port-max</para><para>Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.source-port-min">source-port-min</option></term><listitem><para> + 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> Alias: source-port-min</para><para>Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.tos">tos</option></term><listitem><para>Specifies the TOS value to use in outgoing packets.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.vxlan.ttl">ttl</option></term><listitem><para>Specifies the time-to-live value to use in outgoing packets.</para><para> + Format: uint32</para></listitem></varlistentry><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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.wifi-p2p.peer">peer</option></term><listitem><para> + <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">wfd-ies</option></term><listitem><para>The Wi-Fi Display (WFD) Information Elements (IEs) to set.</para><para>Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wifi-p2p.wps-method">wps-method</option></term><listitem><para>Flags indicating which mode of WPS is to be used.</para><para>There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.</para><para> + Format: 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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.wimax.mac-address">mac-address</option></term><listitem><para> + <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">network-name</option></term><listitem><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> Alias: nsp</para><para>Network Service Provider (NSP) name of the WiMAX network this connection should use.</para><para> This property is deprecated since version 1.2. WiMAX is no longer supported.</para><para> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>802-3-ethernet setting</title><para> Alias: ethernet</para><para>Wired Ethernet Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.accept-all-mac-addresses">accept-all-mac-addresses</option></term><listitem><para>When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.auto-negotiate">auto-negotiate</option></term><listitem><para>When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.cloned-mac-address">cloned-mac-address</option></term><listitem><para> + <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> Alias: cloned-mac</para><para>If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.</para><para>Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address if the device has one (otherwise this is treated as "preserve"). "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.</para><para>If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).</para><para>On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.duplex">duplex</option></term><listitem><para>When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.generate-mac-address-mask">generate-mac-address-mask</option></term><listitem><para>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.</para><para>If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.</para><para>If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.</para><para>If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.</para><para>If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.mac-address">mac-address</option></term><listitem><para> + 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: 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">mac-address-blacklist</option></term><listitem><para>If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.mtu">mtu</option></term><listitem><para> + 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> Alias: mtu</para><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.port">port</option></term><listitem><para>Specific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-nettype">s390-nettype</option></term><listitem><para>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-options">s390-options</option></term><listitem><para>Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</para><para>Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.</para><para> - Format: dict of string to string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.s390-subchannels">s390-subchannels</option></term><listitem><para>Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.speed">speed</option></term><listitem><para>When a value greater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan">wake-on-lan</option></term><listitem><para>The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan-password">wake-on-lan-password</option></term><listitem><para>If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.</para><para> + Format: 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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.fwmark">fwmark</option></term><listitem><para>The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets.</para><para>Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.ip4-auto-default-route">ip4-auto-default-route</option></term><listitem><para>Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing".</para><para>Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route.</para><para>Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.ip6-auto-default-route">ip6-auto-default-route</option></term><listitem><para>Like ip4-auto-default-route, but for the IPv6 default route.</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.listen-port">listen-port</option></term><listitem><para>The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.mtu">mtu</option></term><listitem><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</para><para>If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.peer-routes">peer-routes</option></term><listitem><para>Whether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively.</para><para>Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.private-key">private-key</option></term><listitem><para>The 256 bit private-key in base64 encoding.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.private-key-flags">private-key-flags</option></term><listitem><para>Flags indicating how to handle the "private-key" property.</para><para> + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.wireguard.fwmark">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: 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> Alias: wifi</para><para>Wi-Fi Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.ap-isolation">ap-isolation</option></term><listitem><para>Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from NM_TERNARY_DEFAULT (-1) only when the interface is configured in AP mode.</para><para>If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.</para><para>If set to NM_TERNARY_FALSE (0), devices can talk to each other.</para><para>When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_FALSE (0).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.band">band</option></term><listitem><para>802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.bssid">bssid</option></term><listitem><para>If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.</para><para>Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.channel">channel</option></term><listitem><para>Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.cloned-mac-address">cloned-mac-address</option></term><listitem><para> + <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">generate-mac-address-mask</option></term><listitem><para>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.</para><para>If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.</para><para>If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.</para><para>If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.</para><para>If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.hidden">hidden</option></term><listitem><para>If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.</para><para>In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.</para><para>In AP mode, the created network does not broadcast its SSID.</para><para>Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</para><para> - Format: boolean</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mac-address">mac-address</option></term><listitem><para> + 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> + 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> Alias: mac</para><para>If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mac-address-blacklist">mac-address-blacklist</option></term><listitem><para>A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mac-address-randomization">mac-address-randomization</option></term><listitem><para>One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address).</para><para> + 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> This property is deprecated since version 1.4. Use the "cloned-mac-address" property instead.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mode">mode</option></term><listitem><para> + 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> Alias: mode</para><para>Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.mtu">mtu</option></term><listitem><para> + 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> Alias: mtu</para><para>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.powersave">powersave</option></term><listitem><para>One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.rate">rate</option></term><listitem><para>If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.seen-bssids">seen-bssids</option></term><listitem><para>A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.ssid">ssid</option></term><listitem><para> + 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> Alias: ssid</para><para>SSID of the Wi-Fi network. Must be specified.</para><para> - Format: byte array</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.tx-power">tx-power</option></term><listitem><para>If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless.wake-on-wlan">wake-on-wlan</option></term><listitem><para>The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</para><para> + Format: 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> Alias: wifi-sec</para><para>Wi-Fi Security Settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.auth-alg">auth-alg</option></term><listitem><para>When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.fils">fils</option></term><listitem><para>Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.group">group</option></term><listitem><para>A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.key-mgmt">key-mgmt</option></term><listitem><para>Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only).</para><para>This property must be set for any Wi-Fi connection that uses security.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.leap-password">leap-password</option></term><listitem><para>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.leap-password-flags">leap-password-flags</option></term><listitem><para>Flags indicating how to handle the "leap-password" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.leap-username">leap-username</option></term><listitem><para>The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.pairwise">pairwise</option></term><listitem><para>A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp".</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.pmf">pmf</option></term><listitem><para>Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled.</para><para> - Format: int32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.proto">proto</option></term><listitem><para>List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.</para><para> - Format: array of string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.psk">psk</option></term><listitem><para>Pre-Shared-Key for WPA networks. For WPA-PSK, it's either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character. The WPA3-Personal networks use a passphrase of any length for SAE authentication.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.psk-flags">psk-flags</option></term><listitem><para>Flags indicating how to handle the "psk" property.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key-flags">wep-key-flags</option></term><listitem><para>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</para><para> - Format: NMSettingSecretFlags (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key-type">wep-key-type</option></term><listitem><para>Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.</para><para> - Format: NMWepKeyType (uint32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key0">wep-key0</option></term><listitem><para>Index 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key1">wep-key1</option></term><listitem><para>Index 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key2">wep-key2</option></term><listitem><para>Index 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-key3">wep-key3</option></term><listitem><para>Index 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted.</para><para> - Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wep-tx-keyidx">wep-tx-keyidx</option></term><listitem><para>When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.</para><para> - Format: uint32</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.802-11-wireless-security.wps-method">wps-method</option></term><listitem><para>Flags indicating which mode of WPS is to be used if any.</para><para>There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities.</para><para>WPS can be disabled by setting this property to a value of 1.</para><para> + <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></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: 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: 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: 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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.wpan.channel">channel</option></term><listitem><para> + <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">mac-address</option></term><listitem><para> + Format: int32</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">page</option></term><listitem><para> + Format: string</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">pan-id</option></term><listitem><para> + Format: int32</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">short-address</option></term><listitem><para> + Format: uint32</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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.bond-port.prio">prio</option></term><listitem><para> + <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">queue-id</option></term><listitem><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> Alias: queue-id</para><para>The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.</para><para> Format: uint32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>hostname setting</title><para>Hostname settings.</para><para> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.hostname.from-dhcp">from-dhcp</option></term><listitem><para>Whether the system hostname can be determined from DHCP on this connection.</para><para>When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.from-dns-lookup">from-dns-lookup</option></term><listitem><para>Whether the system hostname can be determined from reverse DNS lookup of addresses on this device.</para><para>When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.only-from-default">only-from-default</option></term><listitem><para>If set to NM_TERNARY_TRUE (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6).</para><para>If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route.</para><para>When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0).</para><para> - Format: NMTernary (int32)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.hostname.priority">priority</option></term><listitem><para>The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority.</para><para>If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100.</para><para>Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.</para><para> - Format: int32</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>loopback setting</title><para>Loopback Link Settings.</para><para> + <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> + 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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.loopback.mtu">mtu</option></term><listitem><para> + <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> Properties: - <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.veth.peer">peer</option></term><listitem><para> + <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> Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2 id="secrets-flags"><title>Secret flag types:</title><para> Each password or secret property in a setting has an associated <emphasis>flags</emphasis> property diff --git a/man/nm-settings-nmcli.xsl b/man/nm-settings-nmcli.xsl index d7b770d6..5817e8e2 100644 --- a/man/nm-settings-nmcli.xsl +++ b/man/nm-settings-nmcli.xsl @@ -140,8 +140,8 @@ <varlistentry> <term> <option> - <xsl:attribute name="id">nm-settings-nmcli.property.<xsl:value-of select="../@name"/>.<xsl:value-of select="@name"/></xsl:attribute> - <xsl:value-of select="@name"/> + <xsl:attribute name="id">nm-settings-nmcli.property.<xsl:value-of select="$setting_name"/>.<xsl:value-of select="@name"/></xsl:attribute> + <xsl:value-of select="$setting_name"/>.<xsl:value-of select="@name"/> </option> </term> <listitem> @@ -154,15 +154,17 @@ <xsl:when test="description-docbook"> <xsl:copy-of select="./description-docbook/*/."/> </xsl:when> - <xsl:otherwise> + <xsl:when test="description"> <para> - <xsl:value-of select="@description"/> - <xsl:if test="@type = 'NMSettingSecretFlags (uint32)'"> - See <xref linkend="secrets-flags"/> for flag values. - </xsl:if> + <xsl:value-of select="description"/> </para> - </xsl:otherwise> + </xsl:when> </xsl:choose> + <xsl:if test="@type = 'NMSettingSecretFlags (uint32)'"> + <para> + See <xref linkend="secrets-flags"/> for flag values. + </para> + </xsl:if> <xsl:if test="deprecated"> <para> This property is deprecated since version <xsl:value-of select="deprecated/@since"/>. diff --git a/man/nmcli-examples.7 b/man/nmcli-examples.7 index 2234b39d..db2315a2 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: Examples -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.42\&.8" "Examples" +.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.44\&.0" "Examples" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nmcli.1 b/man/nmcli.1 index 295ca339..639c972e 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NMCLI" "1" "" "NetworkManager 1\&.42\&.8" "General Commands Manual" +.TH "NMCLI" "1" "" "NetworkManager 1\&.44\&.0" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nmtui.1 b/man/nmtui.1 index d1ca506a..89141829 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: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NMTUI" "1" "" "NetworkManager 1\&.42\&.8" "General Commands Manual" +.TH "NMTUI" "1" "" "NetworkManager 1\&.44\&.0" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- |