From 34bb501be08aa2b313d88e67d6e0a7e0a3f9cfa6 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Sun, 5 May 2024 00:07:30 +0200 Subject: New upstream version 1.47.90 --- man/NetworkManager-dispatcher.8 | 4 +- man/NetworkManager-dispatcher.xml | 4 +- man/NetworkManager-wait-online.service.8 | 4 +- man/NetworkManager-wait-online.service.xml | 4 +- man/NetworkManager.8 | 6 +- man/NetworkManager.conf.5 | 44 +- man/NetworkManager.conf.xml | 48 +- man/NetworkManager.xml | 4 +- man/meson.build | 6 +- man/nm-cloud-setup.8 | 6 +- man/nm-cloud-setup.xml | 4 +- man/nm-initrd-generator.8 | 6 +- man/nm-initrd-generator.xml | 4 +- man/nm-online.1 | 6 +- man/nm-online.xml | 4 +- man/nm-openvswitch.7 | 6 +- man/nm-openvswitch.xml | 4 +- man/nm-settings-dbus.5 | 100 +- man/nm-settings-dbus.xml | 533 -------- man/nm-settings-dbus.xsl | 4 +- man/nm-settings-ifcfg-rh.5 | 38 +- man/nm-settings-ifcfg-rh.xml | 530 -------- man/nm-settings-ifcfg-rh.xsl | 4 +- man/nm-settings-keyfile.5 | 30 +- man/nm-settings-keyfile.xml | 198 --- man/nm-settings-keyfile.xsl | 4 +- man/nm-settings-nmcli.5 | 144 ++- man/nm-settings-nmcli.xml | 1830 ---------------------------- man/nm-settings-nmcli.xsl | 4 +- man/nmcli-examples.7 | 6 +- man/nmcli-examples.xml | 4 +- man/nmcli.1 | 6 +- man/nmcli.xml | 4 +- man/nmtui.1 | 6 +- man/nmtui.xml | 4 +- 35 files changed, 397 insertions(+), 3216 deletions(-) delete mode 100644 man/nm-settings-dbus.xml delete mode 100644 man/nm-settings-ifcfg-rh.xml delete mode 100644 man/nm-settings-keyfile.xml delete mode 100644 man/nm-settings-nmcli.xml (limited to 'man') diff --git a/man/NetworkManager-dispatcher.8 b/man/NetworkManager-dispatcher.8 index 4e263d62..df8d8e91 100644 --- a/man/NetworkManager-dispatcher.8 +++ b/man/NetworkManager-dispatcher.8 @@ -2,9 +2,9 @@ .\" Title: NetworkManager-dispatcher .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: Network management daemons -.\" Source: NetworkManager-dispatcher 1.46.0 +.\" Source: NetworkManager-dispatcher 1.47.90 .\" Language: English .\" .TH "NETWORKMANAGER\-DISPATCHER" "8" "" "NetworkManager\-dispatcher 1\&" "Network management daemons" diff --git a/man/NetworkManager-dispatcher.xml b/man/NetworkManager-dispatcher.xml index f85a495a..807e5c4c 100644 --- a/man/NetworkManager-dispatcher.xml +++ b/man/NetworkManager-dispatcher.xml @@ -1,7 +1,7 @@ - %entities; ]> diff --git a/man/NetworkManager-wait-online.service.8 b/man/NetworkManager-wait-online.service.8 index 17f61261..2fbaa90c 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 -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: Network management daemons -.\" Source: NetworkManager-wait-online.service 1.46.0 +.\" Source: NetworkManager-wait-online.service 1.47.90 .\" Language: English .\" .TH "NETWORKMANAGER\-WAIT\-ONLINE\&" "8" "" "NetworkManager\-wait\-online\&" "Network management daemons" diff --git a/man/NetworkManager-wait-online.service.xml b/man/NetworkManager-wait-online.service.xml index 4776002c..4a8b63bb 100644 --- a/man/NetworkManager-wait-online.service.xml +++ b/man/NetworkManager-wait-online.service.xml @@ -1,7 +1,7 @@ - %entities; ]> diff --git a/man/NetworkManager.8 b/man/NetworkManager.8 index 4233c56e..550da99a 100644 --- a/man/NetworkManager.8 +++ b/man/NetworkManager.8 @@ -2,12 +2,12 @@ .\" Title: NetworkManager .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: Network management daemons -.\" Source: NetworkManager 1.46.0 +.\" Source: NetworkManager 1.47.90 .\" Language: English .\" -.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.46\&.0" "Network management daemons" +.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.47\&.90" "Network management daemons" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5 index 1fa1b2de..19474f38 100644 --- a/man/NetworkManager.conf.5 +++ b/man/NetworkManager.conf.5 @@ -2,12 +2,12 @@ .\" Title: NetworkManager.conf .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: Configuration -.\" Source: NetworkManager 1.46.0 +.\" Source: NetworkManager 1.47.90 .\" Language: English .\" -.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.46\&.0" "Configuration" +.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.47\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -747,6 +747,8 @@ Such default values are only consulted if the corresponding per\-connection prop connection\&.mud\-url)\&. Only if the per\-profile property is set to a special value that indicates to use the default, the default value from NetworkManager\&.conf is consulted\&. It depends on the property, which is the special value that indicates fallback to the default, but it usually is something like empty, unset values or special numeric values like 0 or \-1\&. That means the effectively used value can first always be configured for each profile, and these default values only matter if the per\-profile values explicitly indicates to use the default from NetworkManager\&.conf\&. .PP +Note that while nmcli supports various aliases and convenience features for configuring properties, the settings in this section do not\&. For example, enum values usually only can be configured via their numeric magic number\&. +.PP Example: .sp .if n \{\ @@ -786,6 +788,11 @@ If left unspecified, the default value is 3 tries before failing the connection\ .RS 4 .RE .PP +\fIconnection\&.down\-on\-poweroff\fR +.RS 4 +Whether the connection will be brought down before the system is powered off\&. +.RE +.PP \fIconnection\&.mud\-url\fR .RS 4 If unspecified, MUD URL defaults to @@ -803,7 +810,10 @@ If unspecified, the ultimate default values depends on the DNS plugin\&. With sy .PP \fIconnection\&.mdns\fR .RS 4 -If unspecified, the ultimate default values depends on the DNS plugin\&. With systemd\-resolved the default currently is "no" (0) and for all other plugins also "no" (0)\&. +Currently only the systemd\-resolve DNS plugin supports this setting\&. If the setting is unspecified both in the profile and in the global default here, then the default is determined by systemd\-resolved\&. See +MulticastDNS= +in +\fBresolved.conf\fR(5)\&. .RE .PP \fIconnection\&.mptcp\-flags\fR @@ -892,6 +902,11 @@ If left unspecified, it defaults to "ifname"\&. If left unspecified, the value 3 (fqdn\-encoded,fqdn\-serv\-update) is used\&. .RE .PP +\fIipv4\&.dhcp\-send\-release\fR +.RS 4 +Whether the DHCP client will send RELEASE message when bringing the connection down\&. +.RE +.PP \fIipv4\&.dhcp\-timeout\fR .RS 4 If left unspecified, the default value for the interface type is used\&. @@ -950,6 +965,11 @@ If left unspecified, it defaults to "ifname"\&. If left unspecified, the value 1 (fqdn\-serv\-update) is used\&. .RE .PP +\fIipv6\&.dhcp\-send\-release\fR +.RS 4 +Whether the DHCP client will send RELEASE message when bringing the connection down\&. +.RE +.PP \fIipv6\&.dhcp\-timeout\fR .RS 4 If left unspecified, the default value for the interface type is used\&. @@ -964,7 +984,21 @@ If unspecified or zero, use 50 for VPN profiles and 100 for other profiles\&. .RS 4 If ipv6\&.ip6\-privacy -is unset, use the content of "/proc/sys/net/ipv6/conf/default/use_tempaddr" as last fallback\&. +is unset, fall back to the original value of "/proc/sys/net/ipv6/conf//use_tempaddr" from before NetworkManager started\&. +.RE +.PP +\fIipv6\&.temp\-valid\-lifetime\fR +.RS 4 +If +ipv6\&.temp\-valid\-lifetime +is unset, fall back to the original value of "/proc/sys/net/ipv6/conf//temp_valid_lft" from before NetworkManager started\&. +.RE +.PP +\fIipv6\&.temp\-preferred\-lifetime\fR +.RS 4 +If +ipv6\&.temp\-preferred\-lifetime +is unset, fall back to the original value of "/proc/sys/net/ipv6/conf//temp_prefered_lft" from before NetworkManager started\&. .RE .PP \fIipv6\&.required\-timeout\fR diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml index 69cfdb07..fc184ff7 100644 --- a/man/NetworkManager.conf.xml +++ b/man/NetworkManager.conf.xml @@ -1,7 +1,7 @@ - %entities; ]> @@ -823,6 +823,11 @@ domains=ALL and these default values only matter if the per-profile values explicitly indicates to use the default from NetworkManager.conf. + + Note that while nmcli supports various aliases and convenience features for configuring + properties, the settings in this section do not. For example, enum values usually only + can be configured via their numeric magic number. + Example: @@ -855,6 +860,10 @@ ipv6.ip6-privacy=0 connection.autoconnect-slaves + + connection.down-on-poweroff + Whether the connection will be brought down before the system is powered off. + connection.mud-url If unspecified, MUD URL defaults to "none". @@ -868,7 +877,13 @@ ipv6.ip6-privacy=0 connection.mdns - If unspecified, the ultimate default values depends on the DNS plugin. With systemd-resolved the default currently is "no" (0) and for all other plugins also "no" (0). + + Currently only the systemd-resolve DNS plugin supports this setting. + If the setting is unspecified both in the profile and in the global + default here, then the default is determined by systemd-resolved. + See MulticastDNS= in + resolved.conf5. + connection.mptcp-flags @@ -935,6 +950,10 @@ ipv6.ip6-privacy=0 ipv4.dhcp-hostname-flags If left unspecified, the value 3 (fqdn-encoded,fqdn-serv-update) is used. + + ipv4.dhcp-send-release + Whether the DHCP client will send RELEASE message when bringing the connection down. + ipv4.dhcp-timeout If left unspecified, the default value for @@ -988,6 +1007,10 @@ ipv6.ip6-privacy=0 ipv6.dhcp-hostname-flags If left unspecified, the value 1 (fqdn-serv-update) is used. + + ipv6.dhcp-send-release + Whether the DHCP client will send RELEASE message when bringing the connection down. + ipv6.dhcp-timeout If left unspecified, the default value for @@ -1000,8 +1023,23 @@ ipv6.ip6-privacy=0 ipv6.ip6-privacy - If ipv6.ip6-privacy is unset, use the content of - "/proc/sys/net/ipv6/conf/default/use_tempaddr" as last fallback. + If ipv6.ip6-privacy is unset, fall back to the original + value of "/proc/sys/net/ipv6/conf/<iface>/use_tempaddr" from before NetworkManager + started. + + + + ipv6.temp-valid-lifetime + If ipv6.temp-valid-lifetime is unset, fall back to the + original value of "/proc/sys/net/ipv6/conf/<iface>/temp_valid_lft" from before + NetworkManager started. + + + + ipv6.temp-preferred-lifetime + If ipv6.temp-preferred-lifetime is unset, fall back to + the original value of "/proc/sys/net/ipv6/conf/<iface>/temp_prefered_lft" from + before NetworkManager started. diff --git a/man/NetworkManager.xml b/man/NetworkManager.xml index ff1635cd..c2392ad3 100644 --- a/man/NetworkManager.xml +++ b/man/NetworkManager.xml @@ -1,7 +1,7 @@ - %entities; ]> diff --git a/man/meson.build b/man/meson.build index f0113cd5..56f52bb4 100644 --- a/man/meson.build +++ b/man/meson.build @@ -62,7 +62,7 @@ foreach man: mans endforeach if enable_introspection - merge_cmd = join_paths(meson.source_root(), 'tools', 'generate-docs-nm-settings-docs-merge.py') + merge_cmd = files(source_root / 'tools' / 'generate-docs-nm-settings-docs-merge.py') name = 'dbus' nm_settings_docs_xml_dbus = custom_target( @@ -70,7 +70,7 @@ if enable_introspection input: [merge_cmd, nm_property_infos_xml[name], nm_settings_docs_xml_gir[name]], output: 'nm-settings-docs-' + name + '.xml', command: [ - python.path(), + python_path, merge_cmd, '@OUTPUT@', nm_property_infos_xml[name], @@ -84,7 +84,7 @@ if enable_introspection input: [merge_cmd, nm_property_infos_xml[name], gen_metadata_nm_settings_nmcli_xml, nm_settings_docs_xml_gir[name]], output: 'nm-settings-docs-' + name + '.xml', command: [ - python.path(), + python_path, merge_cmd, '@OUTPUT@', '--only-properties-from', diff --git a/man/nm-cloud-setup.8 b/man/nm-cloud-setup.8 index 43a72c57..e1664f52 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 -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: Automatic Network Configuration in Cloud with NetworkManager -.\" Source: NetworkManager 1.46.0 +.\" Source: NetworkManager 1.47.90 .\" Language: English .\" -.TH "NM\-CLOUD\-SETUP" "8" "" "NetworkManager 1\&.46\&.0" "Automatic Network Configuratio" +.TH "NM\-CLOUD\-SETUP" "8" "" "NetworkManager 1\&.47\&.90" "Automatic Network Configuratio" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-cloud-setup.xml b/man/nm-cloud-setup.xml index d0e14b4f..7f9a7dbc 100644 --- a/man/nm-cloud-setup.xml +++ b/man/nm-cloud-setup.xml @@ -1,7 +1,7 @@ - %entities; ]> diff --git a/man/nm-initrd-generator.8 b/man/nm-initrd-generator.8 index b3b6ca3f..225254e9 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 -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: System Administration -.\" Source: NetworkManager 1.46.0 +.\" Source: NetworkManager 1.47.90 .\" Language: English .\" -.TH "NM\-INITRD\-GENERATOR" "8" "" "NetworkManager 1\&.46\&.0" "System Administration" +.TH "NM\-INITRD\-GENERATOR" "8" "" "NetworkManager 1\&.47\&.90" "System Administration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-initrd-generator.xml b/man/nm-initrd-generator.xml index 27219fda..51015ea8 100644 --- a/man/nm-initrd-generator.xml +++ b/man/nm-initrd-generator.xml @@ -1,7 +1,7 @@ - %entities; ]> diff --git a/man/nm-online.1 b/man/nm-online.1 index cd739472..23a99281 100644 --- a/man/nm-online.1 +++ b/man/nm-online.1 @@ -2,12 +2,12 @@ .\" Title: nm-online .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.46.0 +.\" Source: NetworkManager 1.47.90 .\" Language: English .\" -.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.46\&.0" "General Commands Manual" +.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.47\&.90" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-online.xml b/man/nm-online.xml index e9deb83e..2ed8f3b9 100644 --- a/man/nm-online.xml +++ b/man/nm-online.xml @@ -1,7 +1,7 @@ - %entities; ]> diff --git a/man/nm-openvswitch.7 b/man/nm-openvswitch.7 index 35f5589b..fd31bdac 100644 --- a/man/nm-openvswitch.7 +++ b/man/nm-openvswitch.7 @@ -2,12 +2,12 @@ .\" Title: nm-openvswitch .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: Open vSwitch support overview -.\" Source: NetworkManager 1.46.0 +.\" Source: NetworkManager 1.47.90 .\" Language: English .\" -.TH "NM\-OPENVSWITCH" "7" "" "NetworkManager 1\&.46\&.0" "Open vSwitch support overview" +.TH "NM\-OPENVSWITCH" "7" "" "NetworkManager 1\&.47\&.90" "Open vSwitch support overview" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-openvswitch.xml b/man/nm-openvswitch.xml index f0c2ca94..67b5ea7c 100644 --- a/man/nm-openvswitch.xml +++ b/man/nm-openvswitch.xml @@ -1,7 +1,7 @@ - %entities; ]> diff --git a/man/nm-settings-dbus.5 b/man/nm-settings-dbus.5 index f586b00d..ca60be43 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 -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: Configuration -.\" Source: NetworkManager 1.46.0 +.\" Source: NetworkManager 1.47.90 .\" Language: English .\" -.TH "NM\-SETTINGS\-DBUS" "5" "" "NetworkManager 1\&.46\&.0" "Configuration" +.TH "NM\-SETTINGS\-DBUS" "5" "" "NetworkManager 1\&.47\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -104,6 +104,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{ auth\-retries @@ -168,6 +169,8 @@ T}:T{ \ \& T}:T{ Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection\&. This only has a real effect for master connections\&. The properties "autoconnect", "autoconnect\-priority" and "autoconnect\-retries" are unrelated to this setting\&. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, \-1: default\&. If \-1 (default) is set, global connection\&.autoconnect\-slaves is read to determine the real value\&. If it is default as well, this fallbacks to 0\&. + +Deprecated 1\&.46\&. Use "autoconnect\-ports" instead, this is just an alias\&. T} T{ controller @@ -192,6 +195,15 @@ The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "oppor This feature requires a plugin which supports DNSOverTls\&. Otherwise, the setting has no effect\&. One such plugin is dns\-systemd\-resolved\&. T} T{ +down\-on\-poweroff +T}:T{ +int32 +T}:T{ +\-1 +T}:T{ +Whether the connection will be brought down before the system is powered off\&. The default value is \-1 (default)\&. When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as 0 (no)\&. +T} +T{ gateway\-ping\-timeout T}:T{ uint32 @@ -264,9 +276,9 @@ T}:T{ T}:T{ Whether mDNS is enabled for the connection\&. -The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (\-1) to allow lookup of a global default in NetworkManager\&.conf\&. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd\-resolved currently means "no")\&. +The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (\-1) to allow lookup of a global default in NetworkManager\&.conf\&. If unspecified, "default" ultimately depends on the DNS plugin\&. -This feature requires a plugin which supports mDNS\&. Otherwise, the setting has no effect\&. One such plugin is dns\-systemd\-resolved\&. +This feature requires a plugin which supports mDNS\&. Otherwise, the setting has no effect\&. Currently the only supported DNS plugin is systemd\-resolved\&. For systemd\-resolved, the default is configurable via MulticastDNS= setting in resolved\&.conf\&. T} T{ metered @@ -550,6 +562,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{ altsubject\-matches @@ -686,6 +699,15 @@ T}:T{ Identity string for EAP authentication methods\&. Often the user\*(Aqs user or login name\&. T} T{ +openssl\-ciphers +T}:T{ +string +T}:T{ +\ \& +T}:T{ +Define openssl_ciphers for wpa_supplicant\&. Openssl sometimes moves ciphers among SECLEVELs, thus compiled\-in default value in wpa_supplicant (as modified by some linux distributions) sometimes prevents to connect to old servers that do not support new protocols\&. +T} +T{ optional T}:T{ boolean @@ -2154,6 +2176,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{ address\-data @@ -2297,6 +2320,15 @@ T}:T{ 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\&. T} T{ +dhcp\-send\-release +T}:T{ +NMTernary (int32) +T}:T{ +\ \& +T}:T{ +Whether the DHCP client will send RELEASE message when bringing the connection down\&. The default value is \-1 (default)\&. When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as FALSE\&. +T} +T{ dhcp\-timeout T}:T{ int32 @@ -2595,6 +2627,9 @@ l l l l l l l l l l l l l l l l +l l l l +l l l l +l l l l l l l l. T{ addr\-gen\-mode @@ -2755,6 +2790,15 @@ T}:T{ 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\&. T} T{ +dhcp\-send\-release +T}:T{ +NMTernary (int32) +T}:T{ +\ \& +T}:T{ +Whether the DHCP client will send RELEASE message when bringing the connection down\&. The default value is \-1 (default)\&. When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as FALSE\&. +T} +T{ dhcp\-timeout T}:T{ int32 @@ -2878,9 +2922,7 @@ T}:T{ T}:T{ Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941\&. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI\-64\&. This enhances privacy, but could cause problems in some applications, on the other hand\&. The permitted values are: \-1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses)\&. -Having a per\-connection setting set to "\-1" (unknown) means fallback to global configuration "ipv6\&.ip6\-privacy"\&. - -If also global configuration is unspecified or set to "\-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr"\&. +If set to "\-1" (unknown) for a connection, the value is taken from the global "ipv6\&.ip6\-privacy" setting\&. If the global setting is unspecified or also set to "\-1", the value is set from the original value of "/proc/sys/net/ipv6/conf//use_tempaddr" from before NetworkManager started\&. Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr\-gen\-mode" property\*(Aqs "stable\-privacy" setting as another way of avoiding host tracking with IPv6 addresses\&. T} @@ -3016,6 +3058,28 @@ T}:T{ Array of dictionaries for routing rules\&. Each routing rule supports the following options: action (y), dport\-end (q), dport\-start (q), family (i), from (s), from\-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport\-end (q), sport\-start (q), supress\-prefixlength (i), table (u), to (s), tos (y), to\-len (y), range\-end (u), range\-start (u)\&. T} T{ +temp\-preferred\-lifetime +T}:T{ +int32 +T}:T{ +0 +T}:T{ +The preferred lifetime of autogenerated temporary addresses, in seconds\&. + +If set to "0" (unknown) for a connection, the value is taken from the global "ipv6\&.temp\-preferred\-lifetime" setting\&. If the global setting is unspecified or also set to "0", the value is set from the original value of "/proc/sys/net/ipv6/conf//temp_prefered_lft" from before NetworkManager started\&. +T} +T{ +temp\-valid\-lifetime +T}:T{ +int32 +T}:T{ +0 +T}:T{ +The valid lifetime of autogenerated temporary addresses, in seconds\&. + +If set to "0" (unknown) for a connection, the value is taken from the global "ipv6\&.temp\-valid\-lifetime" setting\&. If the global setting is unspecified or also set to "0", the value is set from the original value of "/proc/sys/net/ipv6/conf//temp_valid_lft" from before NetworkManager started\&. +T} +T{ token T}:T{ string @@ -5207,6 +5271,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{ accept\-all\-mac\-addresses @@ -5289,6 +5354,15 @@ T}:T{ 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)\&. T} T{ +mac\-address\-denylist +T}:T{ +array of string +T}:T{ +\ \& +T}:T{ +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)\&. +T} +T{ mtu T}:T{ uint32 @@ -5517,6 +5591,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{ ap\-isolation @@ -5631,6 +5706,15 @@ T}:T{ 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")\&. T} T{ +mac\-address\-denylist +T}:T{ +array of string +T}:T{ +\ \& +T}:T{ +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")\&. +T} +T{ mac\-address\-randomization T}:T{ uint32 diff --git a/man/nm-settings-dbus.xml b/man/nm-settings-dbus.xml deleted file mode 100644 index ec9bd0ec..00000000 --- a/man/nm-settings-dbus.xml +++ /dev/null @@ -1,533 +0,0 @@ - - -nm-settings-dbusNetworkManager developersnm-settings-dbus5NetworkManagerConfiguration1.46.0nm-settings-dbusDescription of settings and properties of NetworkManager connection profiles on the D-Bus APIDescription - 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 - be applied and an active network connection will be established. Users are free to create - as many connection profiles as they see fit. Thus they are flexible in having various network - configurations for different networking needs. The connection profiles are handled by - NetworkManager via settings service and are exported on D-Bus - (/org/freedesktop/NetworkManager/Settings/<num> objects). - The conceptual objects can be described as follows: - Connection (profile) - A specific, encapsulated, independent group of settings describing - all the configuration required to connect to a specific network. - It is referred to by a unique identifier called the UUID. A connection - is tied to a one specific device type, but not necessarily a specific - hardware device. It is composed of one or more Settings - objects. - Setting - A group of related key/value pairs describing a specific piece of a - Connection (profile). Settings keys and allowed values are - described in the tables below. Keys are also referred to as properties. - Developers can find the setting objects and their properties in the libnm-core - sources. Look for the *_class_init functions near the bottom - of each setting source file. - - The settings and properties shown in tables below list all available connection - configuration options. However, note that not all settings are applicable to all - connection types. NetworkManager provides a command-line tool nmcli - that allows direct configuration of the settings and properties according to a connection - profile type. nmcli connection editor has also a built-in - describe command that can display description of particular settings - and properties of this page. - connection settingGeneral Connection Profile Settings.Key NameValue TypeDefault ValueValue Descriptionauth-retriesint32-1The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection. - -Currently, this only applies to 802-1x authentication.autoconnectbooleanTRUEWhether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection. - -Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile. - -Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles. - -If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined. - -Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.autoconnect-portsint32-1Whether or not ports of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for controller connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave port connections untouched, 1: activate all the port connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-ports is read to determine the real value. If it is default as well, this fallbacks to 0.autoconnect-priorityint320The 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.autoconnect-retriesint32-1The 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.autoconnect-slavesNMSettingConnectionAutoconnectSlaves (int32)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.controllerstringInterface name of the controller device or UUID of the controller connection.dns-over-tlsint32-1Whether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic. - -The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting. - -This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.gateway-ping-timeoutuint320If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.idstringA human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".interface-namestringThe name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). - -For software devices this specifies the name of the created device. - -For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.lldpint32-1Whether LLDP is enabled for the connection.llmnrint32-1Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link. - -The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes"). - -This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.masterstringInterface name of the master device or UUID of the master connection. - -Deprecated 1.46. Use "controller" instead, this is just an alias.mdnsint32-1Whether mDNS is enabled for the connection. - -The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no"). - -This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.meteredNMMetered (int32)Whether the connection is metered. - -When updating this property on a currently activated connection, the change takes effect immediately.mptcp-flagsuint320Whether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints. - -If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered. - -The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags. - -Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless. - -Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that. - -When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags. - -If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl. - -NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp. - -Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).mud-urlstringIf configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://". - -The special value "none" is allowed to indicate that no MUD URL is used. - -If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none".multi-connectint320Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.permissionsarray of stringAn 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.port-typestringSetting name of the device type of this port's controller connection (eg, "bond"), or NULL if this connection is not a port.read-onlybooleanFALSEThis property is deprecated and has no meaning. - -This property is deprecated since version 1.44.This property is deprecated and has no meaning.secondariesarray of stringList of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.slave-typestringSetting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave. - -Deprecated 1.46. Use "port-type" instead, this is just an alias.stable-idstringThis represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context. - -The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used to derive the DHCP client identifier with ipv4.dhcp-client-id=stable, the DHCPv6 DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid] and the DHCP IAID with ipv4.iaid=stable and ipv6.iaid=stable. - -Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity. - -The '$' character is treated special to perform dynamic substitutions at activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${NETWORK_SSID}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-SSID, per-boot, or every time. The "${CONNECTION}" uses the profile's connection.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device. "${NETWORK_SSID}" uses the SSID for Wi-Fi networks and falls back to "${CONNECTION}" on other networks. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates. - -If the value is unset, a global connection default is consulted. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile.timestampuint640The 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).typestringBase 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).uuidstringA universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. - -The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").wait-activation-delayint32-1Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event. - -The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.wait-device-timeoutint32-1Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed. - -The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.zonestringThe trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. - -When updating this property on a currently activated connection, the change takes effect immediately.6lowpan setting6LoWPAN Settings.Key NameValue TypeDefault ValueValue DescriptionparentstringIf given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created.802-1x settingIEEE 802.1x Authentication Settings.Key NameValue TypeDefault ValueValue Descriptionaltsubject-matchesarray of stringList 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.anonymous-identitystringAnonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.auth-timeoutint320A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.ca-certbyte arrayContains the CA certificate if used by the EAP method specified in the "eap" property. - -Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. - -Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.ca-cert-passwordstringThe 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.ca-cert-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "ca-cert-password" property.ca-pathstringUTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property. - -If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.client-certbyte arrayContains the client certificate if used by the EAP method specified in the "eap" property. - -Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.client-cert-passwordstringThe 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.client-cert-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "client-cert-password" property.domain-matchstringConstraint 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.domain-suffix-matchstringConstraint 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.eaparray of stringThe 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.identitystringIdentity string for EAP authentication methods. Often the user's user or login name.optionalbooleanFALSEWhether 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.pac-filestringUTF-8 encoded file path containing PAC for EAP-FAST.passwordstringUTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred.password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property.password-rawbyte arrayPassword 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.password-raw-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password-raw" property.phase1-auth-flagsuint320Specifies 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.phase1-fast-provisioningstringEnables 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.phase1-peaplabelstringForces 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.phase1-peapverstringForces 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.phase2-altsubject-matchesarray of stringList 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.phase2-authstringSpecifies 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.phase2-autheapstringSpecifies 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.phase2-ca-certbyte arrayContains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. - -Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. - -Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.phase2-ca-cert-passwordstringThe 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.phase2-ca-cert-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "phase2-ca-cert-password" property.phase2-ca-pathstringUTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property. - -If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.phase2-client-certbyte arrayContains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. - -Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.phase2-client-cert-passwordstringThe 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.phase2-client-cert-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "phase2-client-cert-password" property.phase2-domain-matchstringConstraint 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.phase2-domain-suffix-matchstringConstraint 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.phase2-private-keybyte arrayContains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". - -Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.phase2-private-key-passwordstringThe 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.phase2-private-key-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "phase2-private-key-password" property.phase2-subject-matchstringSubstring 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. - -This property is deprecated since version 1.2.Use "phase2-domain-suffix-match" instead.pinstringPIN used for EAP authentication methods.pin-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "pin" property.private-keybyte arrayContains the private key when the "eap" property is set to "tls". - -Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. - -WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.private-key-passwordstringThe 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.private-key-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "private-key-password" property.subject-matchstringSubstring 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. - -This property is deprecated since version 1.2.Use "phase2-domain-suffix-match" instead.system-ca-certsbooleanFALSEWhen 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).adsl settingADSL Settings.Key NameValue TypeDefault ValueValue DescriptionencapsulationstringEncapsulation of ADSL connection. Can be "vcmux" or "llc".passwordstringPassword used to authenticate with the ADSL service.password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property.protocolstringADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".usernamestringUsername used to authenticate with the ADSL service.vciuint320VCI of ADSL connectionvpiuint320VPI of ADSL connectionbluetooth settingBluetooth Settings.Key NameValue TypeDefault ValueValue Descriptionbdaddrbyte arrayThe Bluetooth address of the device.typestringEither "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.bond settingBonding Settings.Key NameValue TypeDefault ValueValue Descriptioninterface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.optionsdict of string to string{'mode': 'balance-rr'}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]).bridge settingBridging Settings.Key NameValue TypeDefault ValueValue Descriptionageing-timeuint32300The Ethernet MAC address aging time, in seconds.forward-delayuint3215The Spanning Tree Protocol (STP) forwarding delay, in seconds.group-addressbyte arrayIf specified, The MAC address of the multicast group this bridge uses for STP. - -The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.group-forward-maskuint320A 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.hello-timeuint322The Spanning Tree Protocol (STP) hello time, in seconds.interface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name.mac-addressbyte arrayIf specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. - -If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. - -This property is deprecated since version 1.12.Use the "cloned-mac-address" property instead.max-ageuint3220The Spanning Tree Protocol (STP) maximum message age, in seconds.multicast-hash-maxuint324096Set maximum size of multicast hash table (value must be a power of 2).multicast-last-member-countuint322Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.multicast-last-member-intervaluint64100Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.multicast-membership-intervaluint6426000Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.multicast-querierbooleanFALSEEnable or disable sending of multicast queries by the bridge. If not specified the option is disabled.multicast-querier-intervaluint6425500If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.multicast-query-intervaluint6412500Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.multicast-query-response-intervaluint641000Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.multicast-query-use-ifaddrbooleanFALSEIf 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.multicast-routerstringSets bridge's multicast router. Multicast-snooping must be enabled for this option to work. - -Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).multicast-snoopingbooleanTRUEControls 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.multicast-startup-query-countuint322Set the number of IGMP queries to send during startup phase.multicast-startup-query-intervaluint643125Sets the time (in deciseconds) between queries sent out at startup to determine membership information.priorityuint3232768Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.stpbooleanTRUEControls whether Spanning Tree Protocol (STP) is enabled for this bridge.vlan-default-pviduint321The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.vlan-filteringbooleanFALSEControl whether VLAN filtering is enabled on the bridge.vlan-protocolstringIf specified, the protocol used for VLAN filtering. - -Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.vlan-stats-enabledbooleanFALSEControls whether per-VLAN stats accounting is enabled.vlansarray of vardictArray of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property. - -In nmcli the VLAN list can be specified with the following syntax: - -$vid [pvid] [untagged] [, $vid [pvid] [untagged]]... - -where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.bridge-port settingBridge Port Settings.Key NameValue TypeDefault ValueValue Descriptionhairpin-modebooleanFALSEEnables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.path-costuint32100The Spanning Tree Protocol (STP) port cost for destinations via this port.priorityuint3232The Spanning Tree Protocol (STP) priority of this bridge port.vlansarray of vardictArray of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property. - -In nmcli the VLAN list can be specified with the following syntax: - -$vid [pvid] [untagged] [, $vid [pvid] [untagged]]... - -where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.cdma settingCDMA-based Mobile Broadband Settings.Key NameValue TypeDefault ValueValue Descriptionmtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.numberstringThe 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.passwordstringThe 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.password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property.usernamestringThe 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.dcb settingData Center Bridging Settings.Key NameValue TypeDefault ValueValue Descriptionapp-fcoe-flagsNMSettingDcbFlags (uint32)Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).app-fcoe-modestringThe 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".app-fcoe-priorityint32-1The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the 0x1 (enable) flag.app-fip-flagsNMSettingDcbFlags (uint32)Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).app-fip-priorityint32-1The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the 0x1 (enable) flag.app-iscsi-flagsNMSettingDcbFlags (uint32)Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).app-iscsi-priorityint32-1The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the 0x1 (enable) flag.priority-bandwidtharray of uint32An 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.priority-flow-controlarray of uint32An 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.priority-flow-control-flagsNMSettingDcbFlags (uint32)Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).priority-group-bandwidtharray of uint32An 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.priority-group-flagsNMSettingDcbFlags (uint32)Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing).priority-group-idarray of uint32An 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.priority-strict-bandwidtharray of uint32An 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.priority-traffic-classarray of uint32An 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.dummy settingDummy Link Settings.Key NameValue TypeDefault ValueValue Descriptionethtool settingEthtool Ethernet Settings.Key NameValue TypeDefault ValueValue Descriptiongeneric settingGeneric Link Settings.Key NameValue TypeDefault ValueValue Descriptiondevice-handlerstringName of the device handler that will be invoked to add and delete the device for this connection. The name can only contain ASCII alphanumeric characters and '-', '_', '.'. It cannot start with '.'. - -See the NetworkManager-dispatcher(8) man page for more details about how to write the device handler. - -By setting this property the generic connection becomes "virtual", meaning that it can be activated without an existing device; the device will be created at the time the connection is started by invoking the device-handler.gsm settingGSM-based Mobile Broadband Settings.Key NameValue TypeDefault ValueValue DescriptionapnstringThe 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. - -If the APN is unset (the default) then it may be detected based on "auto-config" setting. The property can be explicitly set to the empty string to prevent that and use no APN.auto-configbooleanFALSEWhen 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.device-idstringThe 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.home-onlybooleanFALSEWhen TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.initial-eps-bearer-apnstringFor 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.initial-eps-bearer-configurebooleanFALSEFor 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.mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.network-idstringThe 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.numberstringLegacy 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.passwordstringThe 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.password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property.pinstringIf 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.pin-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "pin" property.sim-idstringThe 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.sim-operator-idstringA 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.usernamestringThe 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.infiniband settingInfiniband Settings.Key NameValue TypeDefault ValueValue Descriptionmac-addressbyte arrayIf 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).mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.p-keyint32-1The InfiniBand p-key to use for this device. A value of -1 means to use the default p-key (aka "the p-key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit 0x8000 is set if it is a "full membership" p-key. The values 0 and 0x8000 are not allowed. - -With the p-key set, the interface name is always "$parent.$p_key". Setting "connection.interface-name" to another name is not supported. - -Note that kernel will internally always set the full membership bit, although the interface name does not reflect that. Usually the user would want to configure a full membership p-key with 0x8000 flag set.parentstringThe 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".transport-modestringThe IP-over-InfiniBand transport mode. Either "datagram" or "connected".ipv4 settingIPv4 Settings.Key NameValue TypeDefault ValueValue Descriptionaddress-dataarray of vardictArray of IPv4 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.addressesarray of array of uint32Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. -Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet.auto-route-ext-gwNMTernary (int32)VPN connections will default to add the route automatically unless this setting is set to FALSE. - -For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.dad-timeoutint32-1Maximum timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. The property is currently implemented only for IPv4. - -A zero value means that no duplicate address detection is performed, -1 means the default value (either the value configured globally in NetworkManger.conf or 200ms). A value greater than zero is a timeout in milliseconds. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property.dhcp-client-idstringA string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. - -The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links. - -The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset. - -The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id. - -The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key. - -The special value "none" prevents any client identifier from being sent. Note that this is normally not recommended. - -If unset, a globally configured default from NetworkManager.conf is used. If still unset, the default depends on the DHCP plugin. The internal dhcp client will default to "mac" and the dhclient plugin will try to use one from its config file if present, or won't sent any client-id otherwise.dhcp-dscpstringSpecifies the value for the DSCP field (traffic class) of the IP header. When empty, the global default value is used; if no global default is specified, it is assumed to be "CS0". Allowed values are: "CS0", "CS4" and "CS6". - -The property is currently valid only for IPv4, and it is supported only by the "internal" DHCP plugin.dhcp-fqdnstringIf 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.dhcp-hostnamestringIf 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.dhcp-hostname-flagsuint320Flags for the DHCP hostname and FQDN. - -Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) and 0x4 (fqdn-no-update). When no FQDN flag is set and 0x8 (fqdn-clear-flags) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and 0x8 (fqdn-clear-flags) is not set, the standard FQDN flags are set in the request: 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) for IPv4 and 0x1 (fqdn-serv-update) for IPv6. - -When this property is set to the default value 0x0 (none), a global default is looked up in NetworkManager configuration. If that value is unset or also 0x0 (none), then the standard FQDN flags described above are sent in the DHCP requests.dhcp-iaidstringA 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.dhcp-reject-serversarray of stringArray of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. - -For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). - -This property is currently not implemented for DHCPv6.dhcp-send-hostnamebooleanTRUEIf 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.dhcp-timeoutint320A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). - -Set to 2147483647 (MAXINT32) for infinity.dhcp-vendor-class-identifierstringThe 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.dnsarray of uint32Array of IP addresses of DNS servers (as network-byte-order integers)dns-dataarray of stringsArray of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.dns-optionsarray of stringArray of DNS options to be added to resolv.conf. - -NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. - -The following options are directly added to resolv.conf: "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". See the resolv.conf(5) man page for a detailed description of these options. - -In addition, NetworkManager supports the special options "_no-add-edns0" and "_no-add-trust-ad". They are not added to resolv.conf, and can be used to prevent the automatic addition of options "edns0" and "trust-ad" when using caching DNS plugins (see below). - -The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. - -When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added, unless "_no-add-edns0" and "_no-add-trust-ad" are present.dns-priorityint320DNS servers priority. - -The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). - -Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. - -Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. - -Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. - -When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. - -When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. - -When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.dns-searcharray of stringList of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. - -When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. - -When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).gatewaystringThe gateway associated with this configuration. This is only meaningful if "addresses" is also set. - -Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. - -Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".ignore-auto-dnsbooleanFALSEWhen "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.ignore-auto-routesbooleanFALSEWhen "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.link-localint320Enable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server. - -When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".may-failbooleanTRUEIf 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.methodstringIP configuration method. - -NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. - -In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. - -For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. - -For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.never-defaultbooleanFALSEIf TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.replace-local-ruleNMTernary (int32)Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.required-timeoutint32-1The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. - -This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. - -Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. - -A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).route-dataarray of vardictArray of IPv4 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.route-metricint64-1The 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.route-tableuint320Enable policy routing (source routing) and set the routing table used when adding routes. - -This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. - -If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. - -Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.routesarray of array of uint32Deprecated 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.)routing-rulesarray of 'a{sv}'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).ipv6 settingIPv6 Settings.Key NameValue TypeDefault ValueValue Descriptionaddr-gen-modeint323Configure the method for creating the IPv6 interface identifier of addresses for RFC4862 IPv6 Stateless Address Autoconfiguration and IPv6 Link Local. - -The permitted values are: 0 (eui64), 1 (stable-privacy). 2 (default-or-eui64) or 3 (default). - -If the property is set to "eui64", the addresses will be generated using the interface token derived from the hardware address. This makes the host part of the address constant, making it possible to track the host's presence when it changes networks. The address changes when the interface hardware is replaced. If a duplicate address is detected, there is no fallback to generate another address. When configured, the "ipv6.token" is used instead of the MAC address to generate addresses for stateless autoconfiguration. - -If the property is set to "stable-privacy", the interface identifier is generated as specified by RFC7217. This works by hashing a host specific key (see NetworkManager(8) manual), the interface name, the connection's "connection.stable-id" property and the address prefix. This improves privacy by making it harder to use the address to track the host's presence as every prefix and network has a different identifier. Also, the address is stable when the network interface hardware is replaced. - -The special values "default" and "default-or-eui64" will fallback to the global connection default as documented in the NetworkManager.conf(5) manual. If the global default is not specified, the fallback value is "stable-privacy" or "eui64", respectively. - -For libnm, the property defaults to "default" since 1.40. Previously it used to default to "stable-privacy". On D-Bus, the absence of an addr-gen-mode setting equals "default". For keyfile plugin, the absence of the setting on disk means "default-or-eui64" so that the property doesn't change on upgrade from older versions. - -Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.address-dataarray of vardictArray 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.addressesarray of legacy IPv6 address struct (a(ayuay))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.auto-route-ext-gwNMTernary (int32)VPN connections will default to add the route automatically unless this setting is set to FALSE. - -For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.dad-timeoutint32-1Maximum timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. The property is currently implemented only for IPv4. - -A zero value means that no duplicate address detection is performed, -1 means the default value (either the value configured globally in NetworkManger.conf or 200ms). A value greater than zero is a timeout in milliseconds. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property.dhcp-dscpstringSpecifies the value for the DSCP field (traffic class) of the IP header. When empty, the global default value is used; if no global default is specified, it is assumed to be "CS0". Allowed values are: "CS0", "CS4" and "CS6". - -The property is currently valid only for IPv4, and it is supported only by the "internal" DHCP plugin.dhcp-duidstringA string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option. - -The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id. - -The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk. - -The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt"). - -When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.dhcp-hostnamestringIf 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.dhcp-hostname-flagsuint320Flags for the DHCP hostname and FQDN. - -Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) and 0x4 (fqdn-no-update). When no FQDN flag is set and 0x8 (fqdn-clear-flags) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and 0x8 (fqdn-clear-flags) is not set, the standard FQDN flags are set in the request: 0x1 (fqdn-serv-update), 0x2 (fqdn-encoded) for IPv4 and 0x1 (fqdn-serv-update) for IPv6. - -When this property is set to the default value 0x0 (none), a global default is looked up in NetworkManager configuration. If that value is unset or also 0x0 (none), then the standard FQDN flags described above are sent in the DHCP requests.dhcp-iaidstringA 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.dhcp-pd-hintstringA 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").dhcp-reject-serversarray of stringArray of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. - -For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24"). - -This property is currently not implemented for DHCPv6.dhcp-send-hostnamebooleanTRUEIf 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.dhcp-timeoutint320A timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds). - -Set to 2147483647 (MAXINT32) for infinity.dnsarray of byte arrayArray of IP addresses of DNS servers (in network byte order)dns-dataarray of stringsArray of DNS name servers. This replaces the deprecated "dns" property. Each name server can also contain a DoT server name.dns-optionsarray of stringArray of DNS options to be added to resolv.conf. - -NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties. - -The following options are directly added to resolv.conf: "attempts", "debug", "edns0", "inet6", "ip6-bytestring", "ip6-dotint", "ndots", "no-aaaa", "no-check-names", "no-ip6-dotint", "no-reload", "no-tld-query", "rotate", "single-request", "single-request-reopen", "timeout", "trust-ad", "use-vc". See the resolv.conf(5) man page for a detailed description of these options. - -In addition, NetworkManager supports the special options "_no-add-edns0" and "_no-add-trust-ad". They are not added to resolv.conf, and can be used to prevent the automatic addition of options "edns0" and "trust-ad" when using caching DNS plugins (see below). - -The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled. - -When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added, unless "_no-add-edns0" and "_no-add-trust-ad" are present.dns-priorityint320DNS servers priority. - -The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority). - -Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles. - -Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections. - -Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. - -When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices. - -When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered. - -When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.dns-searcharray of stringList of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. - -When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting. - -When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).gatewaystringThe gateway associated with this configuration. This is only meaningful if "addresses" is also set. - -Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length. - -Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".ignore-auto-dnsbooleanFALSEWhen "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.ignore-auto-routesbooleanFALSEWhen "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.ip6-privacyNMSettingIP6ConfigPrivacy (int32)Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). - -Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". - -If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". - -Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.may-failbooleanTRUEIf 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.methodstringIP configuration method. - -NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link-local". See the subclass-specific documentation for other values. - -In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. - -For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. - -For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared.mtuuint320Maximum 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.never-defaultbooleanFALSEIf TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager.ra-timeoutint320A timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device. - -Set to 2147483647 (MAXINT32) for infinity.replace-local-ruleNMTernary (int32)Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.required-timeoutint32-1The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds. - -This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active. - -Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout. - -A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).route-dataarray of vardictArray of IPv6 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.route-metricint64-1The 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.route-tableuint320Enable policy routing (source routing) and set the routing table used when adding routes. - -This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. - -If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. - -Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.routesarray of legacy IPv6 route struct (a(ayuayu))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.routing-rulesarray of 'a{sv}'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).tokenstringConfigure 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.ip-tunnel settingIP Tunneling Settings.Key NameValue TypeDefault ValueValue Descriptionencapsulation-limituint320How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add 0x1 (ip6-ign-encap-limit) to ip-tunnel flags.flagsuint320Tunnel flags. Currently, the following values are supported: 0x1 (ip6-ign-encap-limit), 0x2 (ip6-use-orig-tclass), 0x4 (ip6-use-orig-flowlabel), 0x8 (ip6-mip6-dev), 0x10 (ip6-rcv-dscp-copy), 0x20 (ip6-use-orig-fwmark). They are valid only for IPv6 tunnels.flow-labeluint320The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.fwmarkuint320The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.input-keystringThe key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.localstringThe local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.modeuint320The tunneling mode. Valid values: 1 (ipip), 2 (gre), 3 (sit), 4 (isatap), 5 (vti), 6 (ip6ip6), 7 (ipip6), 8 (ip6gre), 9 (vti6), 10 (gretap) and 11 (ip6gretap)mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.output-keystringThe key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.parentstringIf 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.path-mtu-discoverybooleanTRUEWhether to enable Path MTU Discovery on this tunnel.remotestringThe remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.tosuint320The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.ttluint320The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.macsec settingMACSec Settings.Key NameValue TypeDefault ValueValue DescriptionencryptbooleanTRUEWhether the transmitted traffic must be encrypted.mka-cakstringThe pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters.mka-cak-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "mka-cak" property.mka-cknstringThe 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.modeint320Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.offloadint32-1Specifies the MACsec offload mode. - -0 (off) disables MACsec offload. - -1 (phy) and 2 (mac) request offload respectively to the PHY or to the MAC; if the selected mode is not available, the connection will fail. - --1 (default) uses the global default value specified in NetworkManager configuration; if no global default is defined, the built-in default is 0 (off).parentstringIf 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.portint321The port component of the SCI (Secure Channel Identifier), between 1 and 65534.send-scibooleanTRUESpecifies whether the SCI (Secure Channel Identifier) is included in every packet.validationint322Specifies the validation mode for incoming frames.macvlan settingMAC VLAN Settings.Key NameValue TypeDefault ValueValue Descriptionmodeuint320The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.parentstringIf 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.promiscuousbooleanTRUEWhether the interface should be put in promiscuous mode.tapbooleanFALSEWhether the interface should be a MACVTAP.match settingMatch settings.Key NameValue TypeDefault ValueValue Descriptiondriverarray of stringA 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.interface-namearray of stringA list of interface names to match. Each element is a shell wildcard pattern. - -An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".kernel-command-linearray of stringA list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported. - -See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.patharray of stringA list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier. - -For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0". - -The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev"). - -Each element of the list is a shell wildcard pattern. - -See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.802-11-olpc-mesh settingOLPC Wireless Mesh Settings.Key NameValue TypeDefault ValueValue Descriptionchanneluint320Channel on which the mesh network to join is located.dhcp-anycast-addressbyte arrayAnycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. - -This is currently only implemented by dhclient DHCP plugin.ssidbyte arraySSID of the mesh network to join.ovs-bridge settingOvsBridge Link Settings.Key NameValue TypeDefault ValueValue Descriptiondatapath-typestringThe data path type. One of "system", "netdev" or empty.fail-modestringThe bridge failure mode. One of "secure", "standalone" or empty.mcast-snooping-enablebooleanFALSEEnable or disable multicast snooping.rstp-enablebooleanFALSEEnable or disable RSTP.stp-enablebooleanFALSEEnable or disable STP.ovs-dpdk settingOvsDpdk Link Settings.Key NameValue TypeDefault ValueValue DescriptiondevargsstringOpen vSwitch DPDK device arguments.n-rxquint320Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.n-rxq-descuint320The 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.n-txq-descuint320The 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.ovs-interface settingOpen vSwitch Interface Settings.Key NameValue TypeDefault ValueValue Descriptionofport-requestuint320Open 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.typestringThe interface type. Either "internal", "system", "patch", "dpdk", or empty.ovs-patch settingOvsPatch Link Settings.Key NameValue TypeDefault ValueValue DescriptionpeerstringSpecifies 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.ovs-port settingOvsPort Link Settings.Key NameValue TypeDefault ValueValue Descriptionbond-downdelayuint320The time port must be inactive in order to be considered down.bond-modestringBonding mode. One of "active-backup", "balance-slb", or "balance-tcp".bond-updelayuint320The time port must be active before it starts forwarding traffic.lacpstringLACP mode. One of "active", "off", or "passive".taguint320The VLAN tag in the range 0-4095.trunksarray of vardictA list of VLAN ranges that this port trunks. - -The property is valid only for ports with mode "trunk", "native-tagged", or "native-untagged port". If it is empty, the port trunks all VLANs.vlan-modestringThe VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.ppp settingPoint-to-Point Protocol Settings.Key NameValue TypeDefault ValueValue Descriptionbauduint320If 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.crtsctsbooleanFALSEIf 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.lcp-echo-failureuint320If 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.lcp-echo-intervaluint320If 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.mppe-statefulbooleanFALSEIf TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.mruuint320If 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.mtuuint320If non-zero, instruct pppd to send packets no larger than the specified size.no-vj-compbooleanFALSEIf TRUE, Van Jacobsen TCP header compression will not be requested.noauthbooleanTRUEIf 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.nobsdcompbooleanFALSEIf TRUE, BSD compression will not be requested.nodeflatebooleanFALSEIf TRUE, "deflate" compression will not be requested.refuse-chapbooleanFALSEIf TRUE, the CHAP authentication method will not be used.refuse-eapbooleanFALSEIf TRUE, the EAP authentication method will not be used.refuse-mschapbooleanFALSEIf TRUE, the MSCHAP authentication method will not be used.refuse-mschapv2booleanFALSEIf TRUE, the MSCHAPv2 authentication method will not be used.refuse-papbooleanFALSEIf TRUE, the PAP authentication method will not be used.require-mppebooleanFALSEIf 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.require-mppe-128booleanFALSEIf 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.pppoe settingPPP-over-Ethernet Settings.Key NameValue TypeDefault ValueValue DescriptionparentstringIf 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.passwordstringPassword used to authenticate with the PPPoE service.password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property.servicestringIf 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.usernamestringUsername used to authenticate with the PPPoE service.proxy settingWWW Proxy Settings.Key NameValue TypeDefault ValueValue Descriptionbrowser-onlybooleanFALSEWhether the proxy configuration is for browser only.methodint320Method for proxy configuration, Default is 0 (none)pac-scriptstringPAC script for the connection. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function.pac-urlstringPAC URL for obtaining PAC file.serial settingSerial Link Settings.Key NameValue TypeDefault ValueValue Descriptionbauduint3257600Speed 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.bitsuint328Byte-width of the serial communication. The 8 in "8n1" for example.paritybyteThe connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.send-delayuint640Time to delay between each byte sent to the modem, in microseconds.stopbitsuint321Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.sriov settingSR-IOV settings.Key NameValue TypeDefault ValueValue Descriptionautoprobe-driversNMTernary (int32)Whether to autoprobe virtual functions by a compatible driver. - -If set to 1 (true), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF. - -If set to 0 (false), VFs will not be claimed and no network interfaces will be created for them. - -When set to -1 (default), the global default is used; in case the global default is unspecified it is assumed to be 1 (true).eswitch-encap-modeint32-1Select the eswitch encapsulation support. - -Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF. - -If set to -1 (preserve) (default) the eswitch encap-mode won't be modified by NetworkManager.eswitch-inline-modeint32-1Select the eswitch inline-mode of the device. Some HWs need the VF driver to put part of the packet headers on the TX descriptor so the e-switch can do proper matching and steering. - -Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF. - -If set to -1 (preserve) (default) the eswitch inline-mode won't be modified by NetworkManager.eswitch-modeint32-1Select the eswitch mode of the device. Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF. - -If set to -1 (preserve) (default) the eswitch mode won't be modified by NetworkManager.total-vfsuint320The total number of virtual functions to create. - -Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.vfsarray of vardictArray of virtual function descriptors. - -Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF. - -When represented as string a VF is in the form: - -"INDEX [ATTR=VALUE[ ATTR=VALUE]...]". - -for example: - -"2 mac=00:11:22:33:44:55 spoof-check=true". - -Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans. - -The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form - -"ID[.PRIORITY[.PROTO]]". - -PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.tc settingLinux Traffic Control Settings.Key NameValue TypeDefault ValueValue Descriptionqdiscsarray of vardictArray of TC queueing disciplines. - -When the "tc" setting is present, qdiscs from this property are applied upon activation. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net.core.default_qdisc" sysctl. - -If the "tc" setting is not present, NetworkManager doesn't touch the qdiscs present on the interface.tfiltersarray of vardictArray of TC traffic filters. - -When the "tc" setting is present, filters from this property are applied upon activation. If the property is empty, NetworkManager removes all the filters. - -If the "tc" setting is not present, NetworkManager doesn't touch the filters present on the interface.team settingTeaming Settings.Key NameValue TypeDefault ValueValue DescriptionconfigstringThe 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.interface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.link-watchersarray of vardictLink 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.mcast-rejoin-countint32-1Corresponds to the teamd mcast_rejoin.count.mcast-rejoin-intervalint32-1Corresponds to the teamd mcast_rejoin.interval.notify-peers-countint32-1Corresponds to the teamd notify_peers.count.notify-peers-intervalint32-1Corresponds to the teamd notify_peers.interval.runnerstringCorresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".runner-activebooleanTRUECorresponds to the teamd runner.active.runner-agg-select-policystringCorresponds to the teamd runner.agg_select_policy.runner-fast-ratebooleanFALSECorresponds to the teamd runner.fast_rate.runner-hwaddr-policystringCorresponds to the teamd runner.hwaddr_policy.runner-min-portsint32-1Corresponds to the teamd runner.min_ports.runner-sys-prioint32-1Corresponds to the teamd runner.sys_prio.runner-tx-balancerstringCorresponds to the teamd runner.tx_balancer.name.runner-tx-balancer-intervalint32-1Corresponds to the teamd runner.tx_balancer.interval.runner-tx-hasharray of stringCorresponds to the teamd runner.tx_hash.team-port settingTeam Port Settings.Key NameValue TypeDefault ValueValue DescriptionconfigstringThe 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.lacp-keyint32-1Corresponds to the teamd ports.PORTIFNAME.lacp_key.lacp-prioint32-1Corresponds to the teamd ports.PORTIFNAME.lacp_prio.link-watchersarray of vardictLink 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.prioint320Corresponds to the teamd ports.PORTIFNAME.prio.queue-idint32-1Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.stickybooleanFALSECorresponds to the teamd ports.PORTIFNAME.sticky.tun settingTunnel Settings.Key NameValue TypeDefault ValueValue DescriptiongroupstringThe group ID which will own the device. If set to NULL everyone will be able to use the device.modeuint321The operating mode of the virtual device. Allowed values are 1 (tun) to create a layer 3 device and 2 (tap) to create an Ethernet-like layer 2 one.multi-queuebooleanFALSEIf 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.ownerstringThe user ID which will own the device. If set to NULL everyone will be able to use the device.pibooleanFALSEIf TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.vnet-hdrbooleanFALSEIf TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.user settingGeneral User Profile Settings.Key NameValue TypeDefault ValueValue Descriptiondatadict of string to string{}A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.vlan settingVLAN Settings.Key NameValue TypeDefault ValueValue Descriptionegress-priority-maparray of stringFor 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".flagsNMVlanFlags (uint32)One or more flags which control the behavior and features of the VLAN interface. Flags include 0x1 (reorder-headers) (reordering of output packet headers), 0x2 (gvrp) (use of the GVRP protocol), and 0x4 (loose-binding) (loose binding of the interface to its master device's operating state). 0x8 (mvrp) (use of the MVRP protocol). - -The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.iduint320The 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.ingress-priority-maparray of stringFor 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".interface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.parentstringIf 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.protocolstringSpecifies the VLAN protocol to use for encapsulation. - -Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.vpn settingVPN Settings.Key NameValue TypeDefault ValueValue Descriptiondatadict of string to string{}Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.persistentbooleanFALSEIf 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.secretsdict of string to string{}Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.service-typestringD-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.timeoutuint320Timeout 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.user-namestringIf 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.vrf settingVRF settings.Key NameValue TypeDefault ValueValue Descriptiontableuint320The routing table for this VRF.vxlan settingVXLAN Settings.Key NameValue TypeDefault ValueValue Descriptionageinguint32300Specifies the lifetime in seconds of FDB entries learnt by the kernel.destination-portuint328472Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.iduint320Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.l2-missbooleanFALSESpecifies whether netlink LL ADDR miss notifications are generated.l3-missbooleanFALSESpecifies whether netlink IP ADDR miss notifications are generated.learningbooleanTRUESpecifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.limituint320Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.localstringIf given, specifies the source IP address to use in outgoing packets.parentstringIf given, specifies the parent interface name or parent connection UUID.proxybooleanFALSESpecifies whether ARP proxy is turned on.remotestringSpecifies 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.rscbooleanFALSESpecifies whether route short circuit is turned on.source-port-maxuint320Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.source-port-minuint320Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.tosuint320Specifies the TOS value to use in outgoing packets.ttluint320Specifies the time-to-live value to use in outgoing packets.wifi-p2p settingWi-Fi P2P Settings.Key NameValue TypeDefault ValueValue DescriptionpeerstringThe P2P device that should be connected to. Currently, this is the only way to create or join a group.wfd-iesbyte arrayThe Wi-Fi Display (WFD) Information Elements (IEs) to set. - -Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.wps-methoduint320Flags indicating which mode of WPS is to be used. - -There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.wimax settingWiMax Settings.Key NameValue TypeDefault ValueValue Descriptionmac-addressbyte arrayIf specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). - -This property is deprecated since version 1.2.WiMAX is no longer supported.network-namestringNetwork Service Provider (NSP) name of the WiMAX network this connection should use. - -This property is deprecated since version 1.2.WiMAX is no longer supported.802-3-ethernet settingWired Ethernet Settings.Key NameValue TypeDefault ValueValue Descriptionaccept-all-mac-addressesNMTernary (int32)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.assigned-mac-addressstringThe new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".auto-negotiatebooleanFALSEWhen 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.cloned-mac-addressbyte arrayThis D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".duplexstringWhen 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.generate-mac-address-maskstringWith "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. - -If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. - -If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. - -If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. - -If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.mac-addressbyte arrayIf 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).mac-address-blacklistarray of stringIf 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).mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.portstringSpecific 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.s390-nettypestrings390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.s390-optionsdict of string to string{}Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). - -Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.s390-subchannelsarray of stringIdentifies 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.speeduint320When 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.wake-on-lanuint321The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of 0x2 (phy), 0x4 (unicast), 0x8 (multicast), 0x10 (broadcast), 0x20 (arp), 0x40 (magic) or the special values 0x1 (default) (to use global settings) and 0x8000 (ignore) (to disable management of Wake-on-LAN in NetworkManager).wake-on-lan-passwordstringIf specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.wireguard settingWireGuard Settings.Key NameValue TypeDefault ValueValue Descriptionfwmarkuint320The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets. - -Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.ip4-auto-default-routeNMTernary (int32)Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing". - -Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route. - -Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.ip6-auto-default-routeNMTernary (int32)Like ip4-auto-default-route, but for the IPv6 default route.listen-portuint320The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. - -If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.peer-routesbooleanTRUEWhether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively. - -Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.peersarray of 'a{sv}'Array of dictionaries for the WireGuard peers.private-keystringThe 256 bit private-key in base64 encoding.private-key-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "private-key" property.802-11-wireless settingWi-Fi Settings.Key NameValue TypeDefault ValueValue Descriptionap-isolationNMTernary (int32)Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from -1 (default) only when the interface is configured in AP mode. - -If set to 1 (true), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc. - -If set to 0 (false), devices can talk to each other. - -When set to -1 (default), the global default is used; in case the global default is unspecified it is assumed to be 0 (false).assigned-mac-addressstringThe new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explicit hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".bandstring802.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.bssidbyte arrayIf specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future. - -Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.channeluint320Wireless 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.cloned-mac-addressbyte arrayThis D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".generate-mac-address-maskstringWith "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. - -If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. - -If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. - -If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. - -If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.hiddenbooleanFALSEIf TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode. - -In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. - -In AP mode, the created network does not broadcast its SSID. - -Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.mac-addressbyte arrayIf 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).mac-address-blacklistarray of stringA 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").mac-address-randomizationuint320One of 0 (default) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), 1 (never) (never randomize the MAC address), or 2 (always) (always randomize the MAC address). - -This property is deprecated since version 1.4.Use the "cloned-mac-address" property instead.modestringWi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.powersaveuint320One of 2 (disable) (disable Wi-Fi power saving), 3 (enable) (enable Wi-Fi power saving), 1 (ignore) (don't touch currently configure setting) or 0 (default) (use the globally configured value). All other values are reserved.rateuint320This 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.securityThis 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.seen-bssidsarray of stringA 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.ssidbyte arraySSID of the Wi-Fi network. Must be specified.tx-poweruint320This 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.wake-on-wlanuint321The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of 0x2 (any), 0x4 (disconnect), 0x8 (magic), 0x10 (gtk-rekey-failure), 0x20 (eap-identity-request), 0x40 (4way-handshake), 0x80 (rfkill-release), 0x100 (tcp) or the special values 0x1 (default) (to use global settings) and 0x8000 (ignore) (to disable management of Wake-on-LAN in NetworkManager).802-11-wireless-security settingWi-Fi Security Settings.Key NameValue TypeDefault ValueValue Descriptionauth-algstringWhen 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.filsint320Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of 0 (default) (use global default value), 1 (disable) (disable FILS), 2 (optional) (enable FILS if the supplicant and the access point support it) or 3 (required) (enable FILS and fail if not supported). When set to 0 (default) and no global default is set, FILS will be optionally enabled.grouparray of stringA 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".key-mgmtstringKey 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.leap-passwordstringThe login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").leap-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "leap-password" property.leap-usernamestringThe login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").pairwisearray of stringA 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".pmfint320Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of 0 (default) (use global default value), 1 (disable) (disable PMF), 2 (optional) (enable PMF if the supplicant and the access point support it) or 3 (required) (enable PMF and fail if not supported). When set to 0 (default) and no global default is set, PMF will be optionally enabled.protoarray of stringList 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.pskstringPre-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.psk-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "psk" property.wep-key-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.wep-key-typeNMWepKeyType (uint32)Controls the interpretation of WEP keys. Allowed values are 1 (key), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or 2 (passphrase), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.wep-key0stringIndex 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.wep-key1stringIndex 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.wep-key2stringIndex 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.wep-key3stringIndex 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.wep-tx-keyidxuint320When 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.wps-methoduint320Flags indicating which mode of WPS is to be used if any. - -There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities. - -WPS can be disabled by setting this property to a value of 1.wpan settingIEEE 802.15.4 (WPAN) MAC Settings.Key NameValue TypeDefault ValueValue Descriptionchannelint32-1IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".mac-addressstringIf specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.pageint32-1IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".pan-iduint3265535IEEE 802.15.4 Personal Area Network (PAN) identifier.short-addressuint3265535Short IEEE 802.15.4 address to be used within a restricted environment.bond-port settingBond Port Settings.Key NameValue TypeDefault ValueValue Descriptionprioint320The 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.queue-iduint320The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.hostname settingHostname settings.Key NameValue TypeDefault ValueValue Descriptionfrom-dhcpNMTernary (int32)Whether the system hostname can be determined from DHCP on this connection. - -When set to -1 (default), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be 1 (true).from-dns-lookupNMTernary (int32)Whether the system hostname can be determined from reverse DNS lookup of addresses on this device. - -When set to -1 (default), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be 1 (true).only-from-defaultNMTernary (int32)If set to 1 (true), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6). - -If set to 0 (false), the hostname can be set from this device even if it doesn't have the default route. - -When set to -1 (default), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be 0 (false).priorityint320The relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority. - -If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100. - -Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.hsr settingHSR/PRP Settings.Key NameValue TypeDefault ValueValue Descriptionmulticast-specuint320The last byte of supervision address.port1stringThe port1 interface name of the HSR. This property is mandatory.port2stringThe port2 interface name of the HSR. This property is mandatory.prpbooleanFALSEThe protocol used by the interface, whether it is PRP or HSR.link settingLink settings.Key NameValue TypeDefault ValueValue Descriptiongro-max-sizeint64-1The 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.gso-max-segmentsint64-1The 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.gso-max-sizeint64-1The 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.tx-queue-lengthint64-1The 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.loopback settingLoopback Link Settings.Key NameValue TypeDefault ValueValue Descriptionmtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.ovs-external-ids settingOVS External IDs Settings.Key NameValue TypeDefault ValueValue Descriptiondatadict of string to string{}A dictionary of key/value pairs with external-ids for OVS.ovs-other-config settingOVS Other Config Settings.Key NameValue TypeDefault ValueValue Descriptiondatadict of string to string{}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.veth settingVeth Settings.Key NameValue TypeDefault ValueValue DescriptionpeerstringThis property specifies the peer interface name of the veth. This property is mandatory.Secret flag types: - Each password or secret property in a setting has an associated flags property - that describes how to handle that secret. The flags property is a bitfield - that contains zero or more of the following values logically OR-ed together. - 0x0 (none) - the system is responsible for providing and storing this secret. This - may be required so that secrets are already available before the user logs in. - It also commonly means that the secret will be stored in plain text on disk, accessible - to root only. For example via the keyfile settings plugin as described in the "PLUGINS" section - in NetworkManager.conf5. - 0x1 (agent-owned) - a user-session secret agent is responsible for providing and storing - this secret; when it is required, agents will be asked to provide it.0x2 (not-saved) - this secret should not be saved but should be requested from the user - each time it is required. This flag should be used for One-Time-Pad secrets, PIN codes from hardware tokens, - or if the user simply does not want to save the secret.0x4 (not-required) - in some situations it cannot be automatically determined that a secret - is required or not. This flag hints that the secret is not required and should not be requested from the user.Files/etc/NetworkManager/system-connections or distro plugin-specific locationSee Alsonm-settings-nmcli5, - nm-settings-keyfile5, - NetworkManager8, - nmcli1, - nmcli-examples7, - NetworkManager.conf5 diff --git a/man/nm-settings-dbus.xsl b/man/nm-settings-dbus.xsl index 665105ee..c4bd6d83 100644 --- a/man/nm-settings-dbus.xsl +++ b/man/nm-settings-dbus.xsl @@ -8,8 +8,8 @@ diff --git a/man/nm-settings-ifcfg-rh.5 b/man/nm-settings-ifcfg-rh.5 index 9685f866..6bfb407c 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 -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: Configuration -.\" Source: NetworkManager 1.46.0 +.\" Source: NetworkManager 1.47.90 .\" Language: English .\" -.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.46\&.0" "Configuration" +.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.47\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -377,6 +377,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{ ssid @@ -490,6 +491,15 @@ T}:T{ It denies usage of the connection for any device whose address is listed\&. T} T{ +mac\-address\-denylist +T}:T{ +HWADDR_BLACKLIST\fI(+)\fR +T}:T{ +\ \& +T}:T{ +It denies usage of the connection for any device whose address is listed\&. +T} +T{ seen\-bssids T}:T{ (none) @@ -858,6 +868,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{ eap @@ -1245,6 +1256,15 @@ T}:T{ T}:T{ whether the 802\&.1X authentication is optional T} +T{ +openssl\-ciphers +T}:T{ +IEEE_8021X_OPENSSL_CIPHERS\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Cipher string for tls setup of wpa_supplicant\&. +T} .TE .sp 1 .sp @@ -1280,6 +1300,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{ port @@ -1353,6 +1374,17 @@ T}:T{ T}:T{ It denies usage of the connection for any device whose address is listed\&.\fB +Example: \fRHWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55" +T} +T{ +mac\-address\-denylist +T}:T{ +HWADDR_BLACKLIST\fI(+)\fR +T}:T{ +\ \& +T}:T{ +It denies usage of the connection for any device whose address is listed\&.\fB + Example: \fRHWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55" T} T{ diff --git a/man/nm-settings-ifcfg-rh.xml b/man/nm-settings-ifcfg-rh.xml deleted file mode 100644 index a7f99eb8..00000000 --- a/man/nm-settings-ifcfg-rh.xml +++ /dev/null @@ -1,530 +0,0 @@ - - -nm-settings-ifcfg-rhNetworkManager developersnm-settings-ifcfg-rh5NetworkManagerConfiguration1.46.0nm-settings-ifcfg-rhDescription of ifcfg-rh settings pluginDescription - NetworkManager is based on the concept of connection profiles that contain - network configuration (see nm-settings-nmcli5 for details). The profiles can be - stored in various formats. NetworkManager uses plugins for reading and writing - the data. The plugins can be configured in NetworkManager.conf5. - - The ifcfg-rh plugin is used on the Fedora and Red Hat - Enterprise Linux distributions to read/write configuration from/to - the traditional /etc/sysconfig/network-scripts/ifcfg-* files. - Each NetworkManager connection maps to one ifcfg-* file, with - possible usage of keys-* for passwords, route-* - for static IPv4 routes and route6-* for static IPv6 routes. - The plugin currently supports reading and writing Ethernet, Wi-Fi, InfiniBand, - VLAN, Bond, Bridge, and Team connections. Unsupported connection types (such as - WWAN, PPPoE, VPN, or ADSL) are handled by keyfile plugin - (nm-settings-keyfile5). - The main reason for using ifcfg-rh plugin is the compatibility - with legacy configurations for ifup and ifdown - (initscripts). - File Format - The ifcfg-rh config format is a simple text file containing - VARIABLE="value" lines. The format is described in sysconfig.txt - of initscripts package. Note that the configuration files - may be sourced by initscripts, so they must be valid shell - scripts. That means, for instance, that # character can be used - for comments, strings with spaces must be quoted, special characters must be escaped, - etc. - - Users can create or modify the ifcfg-rh connection files - manually, even if that is not the recommended way of managing the profiles. - However, if they choose to do that, they must inform NetworkManager about - their changes (for example via nmcli con (re)load). - Some <emphasis>ifcfg-rh</emphasis> configuration examples:Simple DHCP ethernet configuration: -NAME=ethernet -UUID=1c4ddf70-01bf-46d6-b04f-47e842bd98da -TYPE=Ethernet -BOOTPROTO=dhcp -DEFROUTE=yes -PEERDNS=yes -PEERROUTES=yes -IPV4_FAILURE_FATAL=no -ONBOOT=yes - Simple ethernet configuration with static IP: -TYPE=Ethernet -BOOTPROTO=none -IPADDR=10.1.0.25 -PREFIX=24 -GATEWAY=10.1.0.1 -DEFROUTE=yes -IPV4_FAILURE_FATAL=no -IPV6INIT=yes -IPV6_AUTOCONF=yes -IPV6_DEFROUTE=yes -IPV6_PEERDNS=yes -IPV6_PEERROUTES=yes -IPV6_FAILURE_FATAL=no -NAME=ethernet-em2 -UUID=51bb3904-c0fc-4dfe-83b2-0a71e7928c13 -DEVICE=em2 -ONBOOT=yes - WPA2 Enterprise WLAN (TTLS with inner MSCHAPV2 authentication): -ESSID="CompanyWLAN" -MODE=Managed -KEY_MGMT=WPA-EAP -TYPE=Wireless -IEEE_8021X_EAP_METHODS=TTLS -IEEE_8021X_IDENTITY=joe -IEEE_8021X_PASSWORD_FLAGS=ask -IEEE_8021X_INNER_AUTH_METHODS=MSCHAPV2 -IEEE_8021X_CA_CERT=/home/joe/.cert/company.crt -BOOTPROTO=dhcp -DEFROUTE=yes -PEERDNS=yes -PEERROUTES=yes -IPV4_FAILURE_FATAL=no -IPV6INIT=no -NAME=MyCompany -UUID=f79848ff-11a6-4810-9e1a-99039dea84c4 -ONBOOT=yes - Bridge and bridge port configuration: -ifcfg-bridge: ifcfg-bridge-port: -NAME=bridge NAME=bridge007-port-eth0 -UUID=4be99ce0-c5b2-4764-8b77-ec226e440125 UUID=3ad56c4a-47e1-419b-b0d4-8ad86eb967a3 -DEVICE=bridge007 DEVICE=eth0 -STP=yes ONBOOT=yes -TYPE=Bridge TYPE=Ethernet -BRIDGING_OPTS=priority=32768 BRIDGE=bridge007 -ONBOOT=yes -BOOTPROTO=dhcp - - Bonding configuration: -ifcfg-BOND: ifcfg-BOND-slave: -NAME=BOND NAME=BOND-slave -UUID=b41888aa-924c-450c-b0f8-85a4f0a51b4a UUID=9bb048e4-286a-4cc3-b104-007dbd20decb -DEVICE=bond100 DEVICE=eth0 -BONDING_OPTS="mode=balance-rr miimon=100" ONBOOT=yes -TYPE=Bond TYPE=Ethernet -BONDING_MASTER=yes MASTER=bond100 -ONBOOT=yes SLAVE=yes -BOOTPROTO=dhcp - - Team and team port configuration: -ifcfg-my_team0: -DEVICE=team0 -TEAM_CONFIG="{ \"device\": \"team0\", \"runner\": {\"name\": \"roundrobin\"}, \"ports\": {\"eth1\": {}, \"eth2\": {}} }" -DEVICETYPE=Team -BOOTPROTO=dhcp -NAME=team0-profile -UUID=1d3460a0-7b37-457f-a300-fe8d92da4807 -ONBOOT=yes - -ifcfg-my_team0_slave1: -NAME=team0-slave1 -UUID=d5aed298-c567-4cc1-b808-6d38ecef9e64 -DEVICE=eth1 -ONBOOT=yes -TEAM_MASTER=team0 -DEVICETYPE=TeamPort - -ifcfg-my_team0_slave2: -NAME=team0-slave2 -UUID=94e75f4e-e5ad-401c-8962-31e0ae5d2215 -DEVICE=eth2 -ONBOOT=yes -TEAM_MASTER=team0 -DEVICETYPE=TeamPort - - The UUID values in the config files must be unique. You can use uuidgen - command line tool to generate such values. Alternatively, you can leave out UUID - entirely. In that case NetworkManager will generate a UUID based on the file name. - Differences against initscripts - The main differences of NetworkManager ifcfg-rh plugin and traditional - initscripts are: - NM_CONTROLLED=yes|no - NM_CONTROLLED is NetworkManager-specific variable used by NetworkManager - for determining whether the device of the ifcfg file - should be managed. NM_CONTROLLED=yes is supposed if the variable is not - present in the file. - Note that if you have more ifcfg files for a single - device, NM_CONTROLLED=no in one of the files will cause the device not - to be managed. The profile may not even be the active one. - New variables - NetworkManager has introduced some new variable, not present in initscripts, - to be able to store data for its new features. The variables are marked - as extensions in the tables below. - Semantic change of variables and differences - NetworkManager changes the semantics for a few variables and there are other behavioral differences. - PEERDNS - - initscripts interpret PEERDNS=no to mean "never touch resolv.conf". - NetworkManager interprets it to say "never add automatic (DHCP, PPP, VPN, etc.) - nameservers to resolv.conf".ONBOOT - - initscripts use ONBOOT=yes to mark the devices that are to be activated - during boot. NetworkManager extends this to also mean that this profile - can be used for auto-connecting at any time.BOOTPROTO - - NetworkManager supports traditional values none (static), - dhcp. But it also allows additional values to - enable new addressing methods. They are autoip for IPv4 - link-local addressing using Avahi daemon and shared for - connection sharing. When shared is used, NetworkManager - assigns the interface 10.42.0.1, or it uses the first static address, - if configured.HWADDR - - initscripts compare the currently set hardware address of a device, while - NetworkManager considers the permanent one.NOZEROCONF - - initscripts add an on-link route to 169.254.0.0/16 for ethernet profiles that don't - explicitly opt-out by setting NOZEROCONF variable. NetworkManager does - not do that. Instead a static, manual route with scope=253 (link) should be added to get - that behavior. - See the next section for detailed mapping of NetworkManager properties and - ifcfg-rh variables. Variable names, format and usage - differences in NetworkManager and initscripts are documented in the tables below. - Detailsifcfg-rh plugin variables marked with (+) - are NetworkManager specific extensions not understood by traditional initscripts. - 802-11-wireless settingPropertyIfcfg-rh VariableDefaultDescriptionssidESSIDSSID of Wi-Fi network. - -Example: ESSID="Quick Net"modeMODEWi-Fi network mode. - -Allowed values: Ad-Hoc, Managed (Auto) [case insensitive]bandBAND(+)BAND alone is honored, but CHANNEL overrides BAND since it implies a band. - -Example: BAND=bg - -Allowed values: a, bgchannelCHANNELChannel used for the Wi-Fi communication. Channels greater than 14 mean "a" band, otherwise the band is "bg". - -Example: CHANNEL=6bssidBSSID(+)Restricts association only to a single AP. - -Example: BSSID=00:1E:BD:64:83:21rate(none)This property is deprecated and not handled by ifcfg-rh plugin.tx-power(none)This property is deprecated and not handled by ifcfg-rh plugin.mac-addressHWADDRHardware 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.cloned-mac-addressMACADDRCloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).generate-mac-address-maskGENERATE_MAC_ADDRESS_MASK(+)the MAC address mask for generating randomized and stable cloned-mac-address.mac-address-blacklistHWADDR_BLACKLIST(+)It denies usage of the connection for any device whose address is listed.seen-bssids(none)This is not a regular property that would be configured by the user. It is not handled by ifcfg-rh plugin.mtuMTUMTU of the wireless interface.hiddenSSID_HIDDEN(+)Whether the network hides the SSID.powersavePOWERSAVE(+)Enables or disables Wi-Fi power saving. - -Example: POWERSAVE=enable - -Allowed values: default, ignore, enable, disablemac-address-randomizationMAC_ADDRESS_RANDOMIZATION(+)Enables or disables Wi-Fi MAC address randomization. - -Example: MAC_ADDRESS_RANDOMIZATION=always - -Allowed values: default, never, alwaysap-isolationAP_ISOLATION(+)missing variable means global defaultWhether AP isolation is enabled - -Allowed values: "yes", "no"
802-11-wireless-security settingPropertyIfcfg-rh VariableDefaultDescriptionkey-mgmtKEY_MGMT(+)Key management method. - -Allowed values: none, ieee8021x, owe, wpa-psk, sae, wpa-eap, wpa-eap-suite-b-192wep-tx-keyidxDEFAULTKEY1Index of active WEP key. Note that in ifcfg format the index starts counting at 1, while NetworkManager API otherwise is zero based. - -Allowed values: 1, 2, 3, 4auth-algSECURITYMODE(+)Authentication algorithm for WEP. - -Allowed values: restricted, open, leapprotoWPA_ALLOW_WPA(+), WPA_ALLOW_WPA2(+)noAllowed WPA protocols, WPA and WPA2 (RSN). - -Allowed values: yes, nopairwiseCIPHER_PAIRWISE(+)Restrict pairwise encryption algorithms, specified as a space separated list. - -Allowed values: CCMP, TKIPgroupCIPHER_GROUP(+)Restrict group/broadcast encryption algorithms, specified as a space separated list. - -Allowed values: CCMP, TKIP, WEP40, WEP104pmfPMF(+)Enables or disables PMF (802.11w) - -Example: PMF=required - -Allowed values: default, disable, optional, requiredleap-usernameIEEE_8021X_IDENTITY(+)Login name for LEAP.wep-key0KEY1, KEY_PASSPHRASE1(+)The first WEP key (used in most networks). See also DEFAULTKEY for key index.wep-key1KEY2, KEY_PASSPHRASE2(+)WEP key with index 1. See also DEFAULTKEY for key index.wep-key2KEY3, KEY_PASSPHRASE3(+)WEP key with index 2. See also DEFAULTKEY for key index.wep-key3KEY4, KEY_PASSPHRASE4(+)WEP key with index 3. See also DEFAULTKEY for key index.wep-key-flagsWEP_KEY_FLAGS(+)Password flags for KEY<i>, KEY_PASSPHRASE<i> password. (see for _FLAGS values)pskWPA_PSKPre-Shared-Key for WPA networks.psk-flagsWPA_PSK_FLAGS(+)Password flags for WPA_PSK_FLAGS. (see for _FLAGS values) - -Example: WPA_PSK_FLAGS=userleap-passwordIEEE_8021X_PASSWORD(+)Password for LEAP. It can also go to "key-" lookaside file, or it can be owned by a secret agent.leap-password-flagsIEEE_8021X_PASSWORD_FLAGS(+)Password flags for IEEE_8021X_PASSWORD_FLAGS. (see for _FLAGS values)wep-key-typeKEY<i> or KEY_PASSPHRASE<i>(+); KEY_TYPE(+)KEY is used for "key" type (10 or 26 hexadecimal characters, or 5 or 13 character string prefixed with "s:"). KEY_PASSPHRASE is used for WEP passphrases. KEY_TYPE specifies the key type and can be either 'key' or 'passphrase'. KEY_TYPE is redundant and can be omitted. - -Example: KEY1=s:ahoj, KEY1=0a1c45bc02, KEY_PASSPHRASE1=mysupersecretkeywps-methodWPS_METHODUsed to control the WPS methods to be used Valid values are "default", "auto", "disabled", "pin" and "pbc". If omitted, whatver the AP announces is used. - -Example: WPS_METHOD=disabled, WPS_METHOD="pin pbc"filsFILS(+)Enables or disables FILS (802.11ai) - -Example: FILS=required - -Allowed values: default, disable, optional, required
802-1x settingPropertyIfcfg-rh VariableDefaultDescriptioneapIEEE_8021X_EAP_METHODS(+)EAP method for 802.1X authentication. - -Example: IEEE_8021X_EAP_METHODS=PEAP - -Allowed values: "LEAP", "PWD", "TLS", "PEAP", "TTLS", "FAST"identityIEEE_8021X_IDENTITY(+)Identity for EAP authentication methods. - -Example: IEEE_8021X_IDENTITY=itsmeanonymous-identityIEEE_8021X_ANON_IDENTITY(+)Anonymous identity for EAP authentication methods.pac-fileIEEE_8021X_PAC_FILE(+)File with PAC (Protected Access Credential) for EAP-FAST. - -Example: IEEE_8021X_PAC_FILE=/home/joe/my-fast.pacca-certIEEE_8021X_CA_CERT(+)CA certificate for EAP. - -Example: IEEE_8021X_CA_CERT=/home/joe/cacert.crtca-pathIEEE_8021X_CA_PATH(+)The search path for the certificate.subject-matchIEEE_8021X_SUBJECT_MATCH(+)Substring to match subject of server certificate against. - -Example: IEEE_8021X_SUBJECT_MATCH="Red Hat"altsubject-matchesIEEE_8021X_ALTSUBJECT_MATCHES(+)List of strings to be matched against the altSubjectName. - -Example: IEEE_8021X_ALTSUBJECT_MATCHES="s1.domain.cc"domain-suffix-matchIEEE_8021X_DOMAIN_SUFFIX_MATCH(+)Suffix to match domain of server certificate against.domain-matchIEEE_8021X_DOMAIN_MATCH(+)Value to match domain of server certificate against.client-certIEEE_8021X_CLIENT_CERT(+)Client certificate for EAP. - -Example: IEEE_8021X_CLIENT_CERT=/home/joe/mycert.crtphase1-peapverIEEE_8021X_PEAP_VERSION(+)Use to force a specific PEAP version. - -Allowed values: 0, 1phase1-peaplabelIEEE_8021X_PEAP_FORCE_NEW_LABEL(+)noUse to force the new PEAP label during key derivation. - -Allowed values: yes, nophase1-fast-provisioningIEEE_8021X_FAST_PROVISIONING(+)Enable in-line provisioning of EAP-FAST credentials. - -Example: IEEE_8021X_FAST_PROVISIONING="allow-auth allow-unauth" - -Allowed values: space-separated list of these values [allow-auth, allow-unauth]phase1-auth-flagsIEEE_8021X_PHASE1_AUTH_FLAGS(+)Authentication flags for the supplicant - -Example: IEEE_8021X_PHASE1_AUTH_FLAGS="tls-1-0-disable tls-1-1-disable" - -Allowed values: space-separated list of authentication flags namesphase2-authIEEE_8021X_INNER_AUTH_METHODS(+)Inner non-EAP authentication methods for TTLS or the inner EAP authentication method for PEAP. IEEE_8021X_INNER_AUTH_METHODS can contain values both for 'phase2-auth' and 'phase2-autheap' properties. - -Example: IEEE_8021X_INNER_AUTH_METHODS=PAP - -Allowed values: "PAP", "CHAP", "MSCHAP", "MSCHAPV2", "GTC", "OTP", "MD5" and "TLS"phase2-autheapIEEE_8021X_INNER_AUTH_METHODS(+)Inner EAP-based authentication methods. Note that IEEE_8021X_INNER_AUTH_METHODS is also used for 'phase2-auth' values. - -Example: IEEE_8021X_INNER_AUTH_METHODS="MSCHAPV2 EAP-TLS" - -Allowed values: "EAP-MD5", "EAP-MSCHAPV2", "EAP-GTC", "EAP-OTP" and "EAP-TLS"phase2-ca-pathIEEE_8021X_PHASE2_CA_PATH(+)The search path for the certificate.phase2-subject-matchIEEE_8021X_PHASE2_SUBJECT_MATCH(+)Substring to match subject of server certificate against. - -Example: IEEE_8021X_PHASE2_SUBJECT_MATCH="Red Hat"phase2-altsubject-matchesIEEE_8021X_PHASE2_ALTSUBJECT_MATCHES(+)phase2-domain-suffix-matchIEEE_8021X_PHASE2_DOMAIN_SUFFIX_MATCH(+)Suffix to match domain of server certificate for phase 2 against.phase2-domain-matchIEEE_8021X_PHASE2_DOMAIN_MATCH(+)Value to match domain of server certificate for phase 2 against.phase2-client-certIEEE_8021X_INNER_CLIENT_CERT(+)Client certificate for inner EAP method. - -Example: IEEE_8021X_INNER_CLIENT_CERT=/home/joe/mycert.crtpasswordIEEE_8021X_PASSWORD(+)UTF-8 encoded password used for EAP. It can also go to "key-" lookaside file, or it can be owned by a secret agent.password-flagsIEEE_8021X_PASSWORD_FLAGS(+)Password flags for IEEE_8021X_PASSWORD password. (see for _FLAGS values)password-rawIEEE_8021X_PASSWORD_RAW(+)password used for EAP, encoded as a hexadecimal string. It can also go to "key-" lookaside file. - -Example: IEEE_8021X_PASSWORD_RAW=041c8320083aa4bfpassword-raw-flagsIEEE_8021X_PASSWORD_RAW_FLAGS(+)The secret flags for password-raw.private-keyIEEE_8021X_PRIVATE_KEY(+)Private key for EAP-TLS. - -Example: IEEE_8021X_PRIVATE_KEY=/home/joe/mykey.p12private-key-passwordIEEE_8021X_PRIVATE_KEY_PASSWORD(+)Password for IEEE_8021X_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.private-key-password-flagsIEEE_8021X_PRIVATE_KEY_PASSWORD_FLAGS(+)Password flags for IEEE_8021X_PRIVATE_KEY_PASSWORD password. (see for _FLAGS values)phase2-private-keyIEEE_8021X_INNER_PRIVATE_KEY(+)Private key for inner authentication method for EAP-TLS.phase2-private-key-passwordIEEE_8021X_INNER_PRIVATE_KEY_PASSWORD(+)Password for IEEE_8021X_INNER_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.phase2-private-key-password-flagsIEEE_8021X_INNER_PRIVATE_KEY_PASSWORD_FLAGS(+)Password flags for IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD password. (see for _FLAGS values)pinIEEE_8021X_PIN(+)The pin secret used for EAP authentication methods.pin-flagsIEEE_8021X_PIN_FLAGS(+)The secret flags for the pin property.system-ca-certsIEEE_8021X_SYSTEM_CA_CERTS(+)a boolean value.auth-timeoutIEEE_8021X_AUTH_TIMEOUT(+)0Timeout in seconds for the 802.1X authentication. Zero means the global default or 25.optionalIEEE_8021X_OPTIONAL(+) default=nowhether the 802.1X authentication is optional
802-3-ethernet settingPropertyIfcfg-rh VariableDefaultDescriptionport(none)The property is not saved by the plugin.speedETHTOOL_OPTSFixed speed for the ethernet link. It is added as "speed" parameter in the ETHTOOL_OPTS variable.duplexETHTOOL_OPTSFixed duplex mode for the ethernet link. It is added as "duplex" parameter in the ETHOOL_OPTS variable.auto-negotiateETHTOOL_OPTSWhether link speed and duplex autonegotiation is enabled. It is not saved only if disabled and no values are provided for the "speed" and "duplex" parameters (skips link configuration).mac-addressHWADDRHardware 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.cloned-mac-addressMACADDRCloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).generate-mac-address-maskGENERATE_MAC_ADDRESS_MASK(+)the MAC address mask for generating randomized and stable cloned-mac-address.mac-address-blacklistHWADDR_BLACKLIST(+)It denies usage of the connection for any device whose address is listed. - -Example: HWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55"mtuMTUMTU of the interface.s390-subchannelsSUBCHANNELSSubchannels for IBM S390 hosts. - -Example: SUBCHANNELS=0.0.b00a,0.0.b00b,0.0.b00cs390-nettypeNETTYPENetwork type of the S390 host. - -Example: NETTYPE=qeth - -Allowed values: "qeth", "lcs" or "ctc"s390-optionsOPTIONS and PORTNAME, CTCPROTO,S390 device options. All options go to OPTIONS, except for "portname" and "ctcprot" that have their own variables.wake-on-lanETHTOOL_OPTS, ETHTOOL_WAKE_ON_LANWake on Lan mode for ethernet. The setting "ignore" is expressed with "ETHTOOL_WAKE_ON_LAN=ignore". Otherwise, the "ETHTOOL_OPTS" variable is set with the value "wol" and several of the characters "p|u|m|b|a|g|s|f|d" as explained in the ethtool manual page.wake-on-lan-passwordETHTOOL_OPTSPassword for secure-on based Wake-on-Lan. It is added as "sopass" parameter in the ETHTOOL_OPTS variable. - -Example: ETHTOOL_OPTS="wol gs sopass 00:11:22:33:44:55"accept-all-mac-addressesACCEPT_ALL_MAC_ADDRESSESEnforce the interface to accept all the packets.
bond settingPropertyIfcfg-rh VariableDefaultDescriptionoptionsBONDING_OPTSBonding options. - -Example: BONDING_OPTS="miimon=100 mode=broadcast"
bond-port settingPropertyIfcfg-rh VariableDefaultDescriptionqueue-idBOND_PORT_QUEUE_ID(+)0Queue ID. - -Allowed values: 0 - 65535prioBOND_PORT_PRIO(+)0Port priority. - -Allowed values: -2147483648 - 2147483647
bridge settingPropertyIfcfg-rh VariableDefaultDescriptionmac-addressBRIDGE_MACADDR(+)MAC address of the bridge. Note that this requires a recent kernel support, originally introduced in 3.15 upstream kernel) BRIDGE_MACADDR for bridges is an NM extension.stpSTPnoSpan tree protocol participation.priorityBRIDGING_OPTS: priority=32768STP priority. - -Allowed values: 0 - 32768forward-delayDELAY15STP forwarding delay. - -Allowed values: 2 - 30hello-timeBRIDGING_OPTS: hello_time=2STP hello time. - -Allowed values: 1 - 10max-ageBRIDGING_OPTS: max_age=20STP maximum message age. - -Allowed values: 6 - 40ageing-timeBRIDGING_OPTS: ageing_time=300Ethernet MAC ageing time. - -Allowed values: 0 - 1000000multicast-snoopingBRIDGING_OPTS: multicast_snooping=1IGMP snooping support. - -Allowed values: 0 or 1vlan-filteringBRIDGING_OPTS: vlan_filtering=0VLAN filtering support. - -Allowed values: 0 or 1vlan-default-pvidBRIDGING_OPTS: default_pvid=1default VLAN PVID. - -Allowed values: 0 - 4094vlansBRIDGE_VLANSList of VLANs on the bridge - -Example: BRIDGE_VLANS="1 pvid untagged,20,300-400 untagged"group-addressBRIDGING_OPTS: group_address=STP group address. - -Example: BRIDGING_OPTS="group_address=01:80:C2:00:00:0A"vlan-protocolBRIDGING_OPTS: vlan_protocol=VLAN filtering protocol. - -Example: BRIDGING_OPTS="vlan_protocol=802.1Q"vlan-stats-enabledBRIDGING_OPTS: vlan_stats_enabled=0 - -Example: BRIDGING_OPTS="vlan_stats_enabled=1"multicast-routerBRIDGING_OPTS: multicast_router=auto - -Example: BRIDGING_OPTS="multicast_router=enabled" - -Allowed values: auto, enabled, disabledmulticast-query-use-ifaddrBRIDGING_OPTS: multicast_query_use_ifaddr=0 - -Example: BRIDGING_OPTS="multicast_query-use_ifaddr=1"multicast-querierBRIDGING_OPTS: multicast_querier=0 - -Example: BRIDGING_OPTS="multicast_querier=1"multicast-hash-maxBRIDGING_OPTS: multicast_hash_max=4096 - -Example: BRIDGING_OPTS="multicast_hash_max=8192"multicast-last-member-countBRIDGING_OPTS: multicast_last_member_count=2 - -Example: BRIDGING_OPTS="multicast_last_member_count=4"multicast-last-member-intervalBRIDGING_OPTS: multicast_last_member_interval=100 - -Example: BRIDGING_OPTS="multicast_last_member_interval=200"multicast-membership-intervalBRIDGING_OPTS: multicast_membership_interval=26000 - -Example: BRIDGING_OPTS="multicast_membership_interval=16000"multicast-querier-intervalBRIDGING_OPTS: multicast_querier_interval=25500 - -Example: BRIDGING_OPTS="multicast_querier_interval=20000"multicast-query-intervalBRIDGING_OPTS: multicast_query_interval=12500 - -Example: BRIDGING_OPTS="multicast_query_interval=22500"multicast-query-response-intervalBRIDGING_OPTS: multicast_query_response_interval=1000 - -Example: BRIDGING_OPTS="multicast_query_response_interval=2000"multicast-startup-query-countBRIDGING_OPTS: multicast_startup_query_count=2 - -Example: BRIDGING_OPTS="multicast_startup_query_count=4"multicast-startup-query-intervalBRIDGING_OPTS: multicast_startup_query_interval=3125 - -Example: BRIDGING_OPTS="multicast_startup_query_interval=4000"
bridge-port settingPropertyIfcfg-rh VariableDefaultDescriptionpriorityBRIDGING_OPTS: priority=32STP priority. - -Allowed values: 0 - 63path-costBRIDGING_OPTS: path_cost=100STP cost. - -Allowed values: 1 - 65535hairpin-modeBRIDGING_OPTS: hairpin_mode=yesHairpin mode of the bridge port.vlansBRIDGE_PORT_VLANSList of VLANs on the bridge port - -Example: BRIDGE_PORT_VLANS="1 pvid untagged,20,300-400 untagged"
connection settingPropertyIfcfg-rh VariableDefaultDescriptionidNAME(+)User friendly name for the connection profile.uuidUUID(+)UUID for the connection profile. When missing, NetworkManager creates the UUID itself (by hashing the filename).stable-idSTABLE_ID(+)Token to generate stable IDs.interface-nameDEVICEInterface name of the device this profile is bound to. The variable can be left out when the profile should apply for more devices. Note that DEVICE can be required for some connection types.typeTYPE (DEVICETYPE, DEVICE)Base type of the connection. DEVICETYPE is used for teaming connections. - -Example: TYPE=Ethernet; TYPE=Bond; TYPE=Bridge; DEVICETYPE=TeamPort - -Allowed values: Ethernet, Wireless, InfiniBand, Bridge, Bond, Vlan, Team, TeamPortpermissionsUSERS(+)Restrict to certain users the access to this connection, and allow the connection to be active only when at least one of the specified users is logged into an active session. - -Example: USERS="joe bob"autoconnectONBOOTyesWhether the connection should be autoconnected (not only while booting).autoconnect-priorityAUTOCONNECT_PRIORITY(+)0Connection priority for automatic activation. Connections with higher numbers are preferred when selecting profiles for automatic activation. - -Example: AUTOCONNECT_PRIORITY=20 - -Allowed values: -999 to 999autoconnect-retriesAUTOCONNECT_RETRIES(+)The number of times a connection should be autoactivated before giving up and switching to the next one. - -Example: AUTOCONNECT_RETRIES=1 - -Allowed values: -1 (use global default), 0 (forever) or a positive valuemulti-connectMULTI_CONNECT(+)whether the profile can be active on multiple devices at a given moment. The values are numbers corresponding to #NMConnectionMultiConnect enum. - -Example: MULTI_CONNECT=3zoneZONE(+)Trust level of this connection. The string is usually used for a firewall. - -Example: ZONE=WorkmasterMASTER, MASTER_UUID, TEAM_MASTER, TEAM_MASTER_UUID, BRIDGE, BRIDGE_UUIDReference to master connection. The variable used depends on the connection type and the value. In general, if the *_UUID variant is present, the variant without *_UUID is ignored. NetworkManager attempts to write both for compatibility with legacy tooling.slave-typeMASTER, MASTER_UUID, TEAM_MASTER, TEAM_MASTER_UUID, DEVICETYPE, BRIDGE, BRIDGE_UUIDSlave type doesn't map directly to a variable, but it is recognized using different variables. MASTER and MASTER_UUID for bonding, TEAM_MASTER, TEAM_MASTER_UUID and DEVICETYPE for teaming, BRIDGE and BRIDGE_UUID for bridging.autoconnect-slavesAUTOCONNECT_SLAVES(+)missing variable means global defaultWhether slaves of this connection should be auto-connected when this connection is activated.secondariesSECONDARY_UUIDS(+)UUID of VPN connections that should be activated together with this connection.gateway-ping-timeoutGATEWAY_PING_TIMEOUT(+)0If greater than zero, the IP connectivity will be checked by pinging the gateway and waiting for the specified timeout (in seconds). - -Example: GATEWAY_PING_TIMEOUT=5meteredCONNECTION_METERED(+)Whether the device is metered - -Example: CONNECTION_METERED=yes - -Allowed values: yes,no,unknownlldpLLDP(+)missing variable means global defaultwhether LLDP is enabled for the connection - -Example: LLDP=no - -Allowed values: boolean value or 'rx'auth-retriesAUTH_RETRIES(+)0Number of retries for authentication.mdnsMDNS(+)missing variable means global defaultWhether or not mDNS is enabled for the connection - -Example: MDNS=yes - -Allowed values: yes,no,resolvellmnrLLMNR(+)missing variable means global defaultWhether or not LLMNR is enabled for the connection - -Example: LLMNR=yes - -Allowed values: yes,no,resolvedns-over-tlsDNS_OVER_TLS(+)missing variable means global defaultWhether or not DNSOverTls is enabled for the connection - -Allowed values: yes,no,opportunisticmptcp-flagsMPTCP_FLAGS(+)missing variable means global defaultThe MPTCP flags that indicate whether MPTCP is enabled and which flags to use for the address endpoints. - -Example: MPTCP_FLAGS="signal,subflow"wait-device-timeoutDEVTIMEOUT(+)for initscripts compatibility, this variable must be a whole integer. If necessary, NetworkManager stores also a fractional component for the milliseconds. - -Example: DEVTIMEOUT=5 - -Allowed values: timeout in seconds.mud-urlMUD_URLMUD_URL to be sent by device (See RFC 8520). - -Example: https://yourdevice.example.com/model.json - -Allowed values: a valid URL that points to recommended policy for this devicewait-activation-delayWAIT_ACTIVATION_DELAY(+)Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event. - -Example: WAIT_ACTIVATION_DELAY=5000 - -Allowed values: delay in milliseconds.
dcb settingPropertyIfcfg-rh VariableDefaultDescriptionapp-fcoe-flagsDCB_APP_FCOE_ENABLE, DCB_APP_FCOE_ADVERTISE, DCB_APP_FCOE_WILLINGnoFCOE flags. - -Example: DCB_APP_FCOE_ENABLE=yes DCB_APP_FCOE_ADVERTISE=yesapp-fcoe-priorityDCB_APP_FCOE_PRIORITYPriority of FCoE frames. - -Allowed values: 0 - 7app-fcoe-modeDCB_APP_FCOE_MODEfabricFCoE controller mode. - -Allowed values: fabric, vn2vnapp-iscsi-flagsDCB_APP_ISCSI_ENABLE, DCB_APP_ISCSI_ADVERTISE, DCB_APP_ISCSI_WILLINGnoiSCSI flags.app-iscsi-priorityDCB_APP_ISCSI_PRIORITYPriority of iSCSI frames. - -Allowed values: 0 - 7app-fip-flagsDCB_APP_FIP_ENABLE, DCB_APP_FIP_ADVERTISE, DCB_APP_FIP_WILLINGnoFIP flags.app-fip-priorityDCB_APP_FIP_PRIORITYPriority of FIP frames. - -Allowed values: 0 - 7priority-flow-control-flagsDCB_PFC_ENABLE, DCB_PFC_ADVERTISE, DCB_PFC_WILLINGnoPriority flow control flags.priority-flow-controlDCB_PFC_UPPriority flow control values. String of 8 "0" and "1", where "0". means "do not transmit priority pause", "1" means "transmit pause". - -Example: DCB_PFC_UP=01101110priority-group-flagsDCB_PG_ENABLE, DCB_PG_ADVERTISE, DCB_PG_WILLINGnoPriority groups flags.priority-group-idDCB_PG_IDPriority groups values. String of eight priorities (0 - 7) or "f" (unrestricted). - -Example: DCB_PG_ID=1205f173priority-group-bandwidthDCB_PG_PCTPriority groups values. Eight bandwidths (in percent), separated with commas. - -Example: DCB_PG_PCT=10,5,10,15,10,10,10,30priority-bandwidthDCB_PG_UPPCTPriority values. Eight bandwidths (in percent), separated with commas. The sum of the numbers must be 100. - -Example: DCB_PG_UPPCT=7,13,10,10,15,15,10,20priority-strict-bandwidthDCB_PG_STRICTPriority values. String of eight "0" or "1", where "0" means "may not utilize all bandwidth", "1" means "may utilize all bandwidth". - -Example: DCB_PG_STRICT=01101110priority-traffic-classDCB_PG_UP2TCPriority values. String of eight traffic class values (0 - 7). - -Example: DCB_PG_UP2TC=01623701
- All DCB related configuration is a NetworkManager extension. DCB=yes must be - used explicitly to enable DCB so that the rest of the DCB_* variables can apply. - ethtool settingPropertyIfcfg-rh VariableDefaultDescription
hostname settingPropertyIfcfg-rh VariableDefaultDescriptionpriorityHOSTNAME_PRIORITY(+)missing variable means global value or 100hostname priority - -Example: HOSTNAME_PRIORITY=50from-dhcpHOSTNAME_FROM_DHCP(+)missing variable means global default or 1whether the system hostname can be determined from DHCP - -Example: HOSTNAME_FROM_DHCP=0,1from-dns-lookupHOSTNAME_FROM_DNS_LOOKUP(+)missing variable means global default or 1whether the system hostname can be determined from reverse DNS lookup - -Example: HOSTNAME_FROM_DNS_LOOKUP=0,1only-best-deviceHOSTNAME_ONLY_FROM_DEFAULT(+)missing variable means global default or 1whether the hostname can be determined only from devices with the default route - -Example: HOSTNAME_ONLY_FROM_DEFAULT=0,1
hsr settingPropertyIfcfg-rh VariableDefaultDescription
infiniband settingPropertyIfcfg-rh VariableDefaultDescriptionmac-addressHWADDRIBoIP 20-byte hardware address of the device (in traditional hex-digits-and-colons notation). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device. - -Example: HWADDR=01:02:03:04:05:06:07:08:09:0A:01:02:03:04:05:06:07:08:09:11mtuMTUMTU of the interface.transport-modeCONNECTED_MODECONNECTED_MODE=noCONNECTED_MODE=yes for "connected" mode, CONNECTED_MODE=no for "datagram" modep-keyPKEY_ID or PKEY_ID_NM(*) (requires PKEY=yes)PKEY=noInfiniBand P_Key. The value can be a hex number prefixed with "0x" or a decimal number. When PKEY_ID is specified, PHYSDEV must be specified. Note that ifcfg-rh format will always automatically set the full membership flag 0x8000 for the PKEY_ID variable. To express IDs without the full membership flag, use PKEY_ID_NM. Note that kernel internally treats the interface as having the full membership flag set, this mainly affects the interface name. For the ifcfg file to be supported by initscripts' ifup-ib, the DEVICE= must always be set. NetworkManager does not require that. - -Example: PKEY=yes PKEY_ID=2 PHYSDEV=mlx4_ib0 DEVICE=mlx4_ib0.8002parentPHYSDEV (PKEY=yes)PKEY=noInfiniBand parent device. - -Example: PHYSDEV=ib0
ipv4 settingPropertyIfcfg-rh VariableDefaultDescriptionmethodBOOTPROTOnoneMethod used for IPv4 protocol configuration. - -Allowed values: none, dhcp (bootp), static, ibft, autoip, shareddnsDNS1, DNS2, ...List of DNS servers. Even if NetworkManager supports many DNS servers, initscripts and resolver only care about the first three, usually. - -Example: DNS1=1.2.3.4 DNS2=10.0.0.254 DNS3=8.8.8.8dns-searchDOMAINList of DNS search domains.addressesIPADDR, PREFIX (NETMASK), IPADDR1, PREFIX1 (NETMASK1), ...List of static IP addresses. - -Example: IPADDR=10.5.5.23 PREFIX=24 IPADDR1=1.1.1.2 PREFIX1=16gatewayGATEWAYGateway IP address. - -Example: GATEWAY=10.5.5.1routesADDRESS1, NETMASK1, GATEWAY1, METRIC1, OPTIONS1, ...List of static routes. They are not stored in ifcfg-* file, but in route-* file instead.ignore-auto-routesPEERROUTES(+)yesPEERROUTES has the opposite meaning as 'ignore-auto-routes' property.ignore-auto-dnsPEERDNSyesPEERDNS has the opposite meaning as 'ignore-auto-dns' property.dhcp-send-hostnameDHCP_SEND_HOSTNAME(+)yesWhether DHCP_HOSTNAME should be sent to the DHCP server.dhcp-hostnameDHCP_HOSTNAMEHostname to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used.never-defaultDEFROUTE (GATEWAYDEV in /etc/sysconfig/network)yesDEFROUTE=no tells NetworkManager that this connection should not be assigned the default route. DEFROUTE has the opposite meaning as 'never-default' property.may-failIPV4_FAILURE_FATAL(+)noIPV4_FAILURE_FATAL has the opposite meaning as 'may-fail' property.route-metricIPV4_ROUTE_METRIC(+)-1IPV4_ROUTE_METRIC is the default IPv4 metric for routes on this connection. If set to -1, a default metric based on the device type is used.route-tableIPV4_ROUTE_TABLE(+)0IPV4_ROUTE_TABLE enables policy-routing and sets the default routing table.dns-optionsRES_OPTIONS(+)List of DNS options to be added to /etc/resolv.conf - -Example: RES_OPTIONS=ndots:2 timeout:3dns-priorityIPV4_DNS_PRIORITY(+)0The priority for DNS servers of this connection. Lower values have higher priority. If zero, the default value will be used (50 for VPNs, 100 for other connections). A negative value prevents DNS from other connections with greater values to be used. - -Example: IPV4_DNS_PRIORITY=20auto-route-ext-gwIPV4_AUTO_ROUTE_EXT_GW(+)yesVPN connections will default to add the route automatically unless this setting is set to FALSE. For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.replace-local-ruleIPV4_REPLACE_LOCAL_RULE(+)noConnections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.dhcp-client-idDHCP_CLIENT_ID(+)A string sent to the DHCP server to identify the local machine. A binary value can be specified using hex notation ('aa:bb:cc'). - -Example: DHCP_CLIENT_ID=ax-srv-1; DHCP_CLIENT_ID=01:44:44:44:44:44:44dad-timeoutACD_TIMEOUT(+), ARPING_WAITmissing variable means global default (config override or zero)Timeout (in milliseconds for ACD_TIMEOUT or in seconds for ARPING_WAIT) for address conflict detection before configuring IPv4 addresses. 0 turns off the ACD completely, -1 means default value. - -Example: ACD_TIMEOUT=2000 or ARPING_WAIT=2dhcp-timeoutIPV4_DHCP_TIMEOUT(+)A timeout after which the DHCP transaction fails in case of no response. - -Example: IPV4_DHCP_TIMEOUT=10dhcp-hostname-flagsDHCP_HOSTNAME_FLAGSflags for the DHCP hostname and FQDN properties - -Example: DHCP_HOSTNAME_FLAGS=5dhcp-fqdnDHCP_FQDNFQDN to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used. - -Example: DHCP_FQDN=foo.bar.comdhcp-vendor-class-identifierDHCP_VENDOR_CLASS_IDENTIFIER(+)The Vendor Class Identifier DHCP option (60). - -Example: DHCP_VENDOR_CLASS_IDENTIFIER=foolink-localIPV4_LINK_LOCAL(+)Configure link-local IP address in interaction with method - -Example: IPV4_LINK_LOCAL=auto
ipv6 settingPropertyIfcfg-rh VariableDefaultDescriptionmethodIPV6INIT, IPV6FORWARDING, IPV6_AUTOCONF, DHCPV6C, IPV6_DISABLEDIPV6INIT=yes; IPV6FORWARDING=no; IPV6_AUTOCONF=!IPV6FORWARDING, DHCPV6=noMethod used for IPv6 protocol configuration. ignore ~ IPV6INIT=no; auto ~ IPV6_AUTOCONF=yes; dhcp ~ IPV6_AUTOCONF=no and DHCPV6C=yes; disabled ~ IPV6_DISABLED=yesdnsDNS1, DNS2, ...List of DNS servers. NetworkManager uses the variables both for IPv4 and IPv6.dns-searchIPV6_DOMAIN(+)List of DNS search domains.addressesIPV6ADDR, IPV6ADDR_SECONDARIESList of static IP addresses. - -Example: IPV6ADDR=ab12:9876::1 IPV6ADDR_SECONDARIES="ab12:9876::2 ab12:9876::3"gatewayIPV6_DEFAULTGWGateway IP address. - -Example: IPV6_DEFAULTGW=abbe::1routes(none)List of static routes. They are not stored in ifcfg-* file, but in route6-* file instead in the form of command line for 'ip route add'.ignore-auto-routesIPV6_PEERROUTES(+)yesIPV6_PEERROUTES has the opposite meaning as 'ignore-auto-routes' property.ignore-auto-dnsIPV6_PEERDNS(+)yesIPV6_PEERDNS has the opposite meaning as 'ignore-auto-dns' property.dhcp-hostnameDHCPV6_HOSTNAMEHostname to send the DHCP server.dhcp-timeoutIPV6_DHCP_TIMEOUT(+)A timeout after which the DHCP transaction fails in case of no response. - -Example: IPV6_DHCP_TIMEOUT=10dhcp-hostname-flagsDHCPV6_HOSTNAME_FLAGSflags for the DHCP hostname property - -Example: DHCPV6_HOSTNAME_FLAGS=5never-defaultIPV6_DEFROUTE(+), (and IPV6_DEFAULTGW, IPV6_DEFAULTDEV in /etc/sysconfig/network)IPV6_DEFROUTE=yes (when no variable specified)IPV6_DEFROUTE=no tells NetworkManager that this connection should not be assigned the default IPv6 route. IPV6_DEFROUTE has the opposite meaning as 'never-default' property.may-failIPV6_FAILURE_FATAL(+)noIPV6_FAILURE_FATAL has the opposite meaning as 'may-fail' property.route-metricIPV6_ROUTE_METRIC(+)-1IPV6_ROUTE_METRIC is the default IPv6 metric for routes on this connection. If set to -1, a default metric based on the device type is used.route-tableIPV6_ROUTE_TABLE(+)0IPV6_ROUTE_TABLE enables policy-routing and sets the default routing table.dns-priorityIPV6_DNS_PRIORITY(+)0The priority for DNS servers of this connection. Lower values have higher priority. If zero, the default value will be used (50 for VPNs, 100 for other connections). A negative value prevents DNS from other connections with greater values to be used. - -Example: IPV6_DNS_PRIORITY=20dns-optionsIPV6_RES_OPTIONS(+)List of DNS options to be added to /etc/resolv.conf - -Example: IPV6_RES_OPTIONS=ndots:2 timeout:3auto-route-ext-gwIPV6_AUTO_ROUTE_EXT_GW(+)yesVPN connections will default to add the route automatically unless this setting is set to FALSE. For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.replace-local-ruleIPV6_REPLACE_LOCAL_RULE(+)noConnections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.ip6-privacyIPV6_PRIVACY, IPV6_PRIVACY_PREFER_PUBLIC_IP(+)noConfigure IPv6 Privacy Extensions for SLAAC (RFC4941). - -Example: IPV6_PRIVACY=rfc3041 IPV6_PRIVACY_PREFER_PUBLIC_IP=yes - -Allowed values: IPV6_PRIVACY: no, yes (rfc3041 or rfc4941); IPV6_PRIVACY_PREFER_PUBLIC_IP: yes, noaddr-gen-modeIPV6_ADDR_GEN_MODE"default-or-eui64"Configure IPv6 Stable Privacy addressing for SLAAC (RFC7217). - -Example: IPV6_ADDR_GEN_MODE=stable-privacy - -Allowed values: IPV6_ADDR_GEN_MODE: default, default-or-eui64, eui64, stable-privacytokenIPV6_TOKENThe IPv6 tokenized interface identifier token - -Example: IPV6_TOKEN=::53ra-timeoutIPV6_RA_TIMEOUT(+)A timeout for waiting Router Advertisements in seconds. - -Example: IPV6_RA_TIMEOUT=10dhcp-duidDHCPV6_DUID(+)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. - -Example: DHCPV6_DUID=LL; DHCPV6_DUID=0301deadbeef0001; DHCPV6_DUID=03:01:de:ad:be:ef:00:01dhcp-pd-hintDHCPV6_PD_HINT(+)Hint for DHCPv6 prefix delegation - -Example: DHCPV6_PD_HINT=2001:db8:1111:2220::/60 DHCPV6_PD_HINT=::/60
match settingPropertyIfcfg-rh VariableDefaultDescriptionpathMATCH_PATHspace-separated list of paths to match against the udev property ID_PATHS of devices - -Example: MATCH_PATH="pci-0000:01:00.0 pci-0000:0c:00.0"
ovs-external-ids settingPropertyIfcfg-rh VariableDefaultDescription
ovs-other-config settingPropertyIfcfg-rh VariableDefaultDescription
proxy settingPropertyIfcfg-rh VariableDefaultDescriptionmethodPROXY_METHOD(+)noneMethod for proxy configuration. For "auto", WPAD is used for proxy configuration, or set the PAC file via PAC_URL or PAC_SCRIPT. - -Allowed values: none, autobrowser-onlyBROWSER_ONLY(+)noWhether the proxy configuration is for browser only.pac-urlPAC_URL(+)URL for PAC file. - -Example: PAC_URL=http://wpad.mycompany.com/wpad.datpac-scriptPAC_SCRIPT(+)The PAC script. This is an UTF-8 encoded javascript code that defines a FindProxyForURL() function. - -Example: PAC_SCRIPT="function FindProxyForURL (url, host) { return 'PROXY proxy.example.com:8080; DIRECT'; }"
sriov settingPropertyIfcfg-rh VariableDefaultDescriptiontotal-vfsSRIOV_TOTAL_VFS(+)The total number of virtual functions to create - -Example: SRIOV_TOTAL_VFS=16vfsSRIOV_VF1(+), SRIOV_VF2(+), ...SR-IOV virtual function descriptors - -Example: SRIOV_VF10="mac=00:11:22:33:44:55", ...autoprobe-driversSRIOV_AUTOPROBE_DRIVERS(+)missing variable means global defaultWhether to autoprobe virtual functions by a compatible driver - -Example: SRIOV_AUTOPROBE_DRIVERS=0,1
tc settingPropertyIfcfg-rh VariableDefaultDescriptionqdiscsQDISC1(+), QDISC2(+), ..., TC_COMMIT(+)Queueing disciplines to set on the interface. When no QDISC1, QDISC2, ..., FILTER1, FILTER2, ... keys are present, NetworkManager doesn't touch qdiscs and filters present on the interface, unless TC_COMMIT is set to 'yes'. - -Example: QDISC1=ingress, QDISC2="root handle 1234: fq_codel"tfiltersFILTER1(+), FILTER2(+), ..., TC_COMMIT(+)Traffic filters to set on the interface. When no QDISC1, QDISC2, ..., FILTER1, FILTER2, ... keys are present, NetworkManager doesn't touch qdiscs and filters present on the interface, unless TC_COMMIT is set to 'yes'. - -Example: FILTER1="parent ffff: matchall action simple sdata Input", ...
team settingPropertyIfcfg-rh VariableDefaultDescriptionconfigTEAM_CONFIGTeam configuration in JSON. See man teamd.conf for details.
team-port settingPropertyIfcfg-rh VariableDefaultDescriptionconfigTEAM_PORT_CONFIGTeam port configuration in JSON. See man teamd.conf for details.
user settingPropertyIfcfg-rh VariableDefaultDescriptiondataNM_USER_*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. - -Example: NM_USER_FOO__BAR=something
vlan settingPropertyIfcfg-rh VariableDefaultDescriptionparentDEVICE or PHYSDEVParent interface of the VLAN.idVLAN_ID, DEVICE.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.flagsGVRP, MVRP, VLAN_FLAGSVLAN flags. - -Allowed values: "yes or "no" for GVRP and MVRP; "LOOSE_BINDING" and "NO_REORDER_HDR" for VLAN_FLAGSprotocolVLAN_PROTOCOLVLAN protocol. - -Example: VLAN_PROTOCOL="802.1ad"ingress-priority-mapVLAN_INGRESS_PRIORITY_MAPIngress priority mapping. - -Example: VLAN_INGRESS_PRIORITY_MAP=4:2,3:5egress-priority-mapVLAN_EGRESS_PRIORITY_MAPEgress priority mapping. - -Example: VLAN_EGRESS_PRIORITY_MAP=5:4,4:1,3:7interface-namePHYSDEV and VLAN_ID, or DEVICEVLAN 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. - -Example: PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12
The following settings are not supported by ifcfg-rh plugin: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, wpanSecret flags - Each secret property in a NetworkManager setting has an associated - flags property that describes how to handle that secret. - In the ifcfg-rh plugin variables for secret flags have a - _FLAGS suffix. The variables contain one or more of the - following values (space separated). Missing (or empty) *_FLAGS variable means - that the password is owned by NetworkManager. - user - a user-session secret agent is responsible for providing - and storing this secret; when it is required, agents will be asked to provide it.ask - the associated password is not saved but it will be - requested from the user each time it is required.unused - in some situations it cannot be automatically determined - that a secret is required or not. This flag hints that the secret is not required and should - not be requested from the user.Files/etc/sysconfig/network-scripts/ifcfg-*/etc/sysconfig/network-scripts/keys-*/etc/sysconfig/network-scripts/route-*/etc/sysconfig/network-scripts/route6-*/usr/share/doc/initscripts/sysconfig.txtSee Alsonm-settings-nmcli5, - nm-settings-keyfile5, - NetworkManager8, - NetworkManager.conf5, - nmcli1, - nmcli-examples7 diff --git a/man/nm-settings-ifcfg-rh.xsl b/man/nm-settings-ifcfg-rh.xsl index 7b270e9b..8ad3b108 100644 --- a/man/nm-settings-ifcfg-rh.xsl +++ b/man/nm-settings-ifcfg-rh.xsl @@ -12,8 +12,8 @@ diff --git a/man/nm-settings-keyfile.5 b/man/nm-settings-keyfile.5 index 1b2bf22f..3a8ceb94 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 -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: Configuration -.\" Source: NetworkManager 1.46.0 +.\" Source: NetworkManager 1.47.90 .\" Language: English .\" -.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.46\&.0" "Configuration" +.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.47\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -252,6 +252,7 @@ T} l l l l l l l l l l l l +l l l l l l l l. T{ ssid @@ -293,6 +294,17 @@ MAC address blacklist\&.\fB Example: \fRmac\-address\-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78 T} +T{ +mac\-address\-denylist +T}:T{ +\ \& +T}:T{ +list of MACs (separated with semicolons) +T}:T{ +MAC address denylist\&.\fB + +Example: \fRmac\-address\-denylist= 00:22:68:12:79:A6;00:22:68:12:79:78 +T} .TE .sp 1 .sp @@ -316,6 +328,7 @@ T} .T& l l l l l l l l +l l l l l l l l. T{ mac\-address @@ -346,6 +359,17 @@ MAC address blacklist\&.\fB Example: \fRmac\-address\-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78 T} +T{ +mac\-address\-denylist +T}:T{ +\ \& +T}:T{ +list of MACs (separated with semicolons) +T}:T{ +MAC address denylist\&.\fB + +Example: \fRmac\-address\-denylist= 00:22:68:12:79:A6;00:22:68:12:79:78 +T} .TE .sp 1 .sp diff --git a/man/nm-settings-keyfile.xml b/man/nm-settings-keyfile.xml deleted file mode 100644 index ac4d9375..00000000 --- a/man/nm-settings-keyfile.xml +++ /dev/null @@ -1,198 +0,0 @@ - - -nm-settings-keyfileNetworkManager developersnm-settings-keyfile5NetworkManagerConfiguration1.46.0nm-settings-keyfileDescription of keyfile settings pluginDescription - NetworkManager is based on the concept of connection profiles that contain - network configuration (see nm-settings-nmcli5 for details). The profiles can be - stored in various formats. NetworkManager uses plugins for reading and writing - the data. The plugins can be configured in NetworkManager.conf5. - - The keyfile plugin is the generic plugin that supports all - the connection types and capabilities that NetworkManager has. The files are - in a .ini-style format and located in /etc/NetworkManager/system-connections/, - /usr/lib/NetworkManager/system-connections/ and - /run/NetworkManager/system-connections/. - This plugin is always enabled and will automatically be used to store - any connections that are not supported by any other active plugin. - For security, it will ignore files that are readable or writable by any user - other than 'root' since private keys and passphrases may be stored - in plaintext inside the file. - File Format - The keyfile config format is a simple .ini-style - format. It consists of sections (groups) of key-value pairs. - More information of the generic key file format can be found at - - GLib key file format (Lines beginning with a '#' are comments, - lists are separated by character ; etc.). - - Each section corresponds to a setting name as described in the settings - specification (nm-settings-nmcli5). Each key/value pair in a - section is one of the properties from the specification. - - The majority of properties are written in the same format as the - specification into the keyfile. However, some - values are inconvenient for people to use so they are stored in the - keyfile in more readable ways. These properties - that differ from the specification are described below. - An example could be IP addresses that are not written as integer arrays, - but more reasonably as "1.2.3.4/12 1.2.3.254". - Also, some lists of complex values (addresses, routes, routing-rules), - instead of using a semicolon separated list, use one key-value pair - per list element, with the key being the singular of the property name - followed by the numeric index (i.e address1, address2, ...). - - Users can create or modify the keyfile connection files - manually, even if that is not the recommended way of managing the profiles. - However, if they choose to do that, they must inform NetworkManager about - their changes (for example via nmcli con (re)load). - Examples of <emphasis>keyfile</emphasis> configurationA sample configuration for an ethernet network: -[connection] -id=Main eth0 -uuid=27afa607-ee36-43f0-b8c3-9d245cdc4bb3 -type=802-3-ethernet -autoconnect=true - -[ipv4] -method=auto - -[802-3-ethernet] -mac-address=00:23:5a:47:1f:71 - A sample configuration for WPA-EAP (PEAP with MSCHAPv2) and always-ask secret: -[connection] -id=CompanyWIFI -uuid=cdac6154-a33b-4b15-9904-666772cfa5ee -type=wifi -autoconnect=false - -[wifi] -ssid=CorpWLAN -mode=infrastructure -security=802-11-wireless-security - -[wifi-security] -key-mgmt=wpa-eap - -[ipv4] -method=auto - -[ipv6] -method=auto - -[802-1x] -eap=peap; -identity=joe -ca-cert=/home/joe/.cert/corp.crt -phase1-peapver=1 -phase2-auth=mschapv2 -password-flags=2 - A sample configuration for openvpn: -[connection] -id=RedHat-openvpn -uuid=7f9b3356-b210-4c0e-8123-bd116c9c280f -type=vpn -timestamp=1385401165 - -[vpn] -service-type=org.freedesktop.NetworkManager.openvpn -connection-type=password -password-flags=3 -remote=ovpn.my-company.com -cipher=AES-256-CBC -reneg-seconds=0 -port=443 -username=joe -ca=/etc/openvpn/ISCA.pem -tls-remote=ovpn.my-company.com - -[ipv6] -method=auto - -[ipv4] -method=auto -ignore-auto-dns=true -never-default=true - A sample configuration for a bridge and a bridge port: -[connection] [connection] -id=MainBridge id=br-port-1 -uuid=171ae855-a0ab-42b6-bd0c-60f5812eea9d uuid=d6e8ae98-71f8-4b3d-9d2d-2e26048fe794 -interface-name=MainBridge interface-name=em1 -type=bridge type=ethernet - master=MainBridge -[bridge] slave-type=bridge -interface-name=MainBridge - A sample configuration for a VLAN: -[connection] -id=VLAN for building 4A -uuid=8ce1c9e0-ce7a-4d2c-aa28-077dda09dd7e -interface-name=VLAN-4A -type=vlan - -[vlan] -interface-name=VLAN-4A -parent=eth0 -id=4 - Detailskeyfile plugin variables for the majority of NetworkManager - properties have one-to-one mapping. It means a NetworkManager property is stored - in the keyfile as a variable of the same name and in the same format. - There are several exceptions to this rule, mainly for making keyfile syntax easier - for humans. The exceptions handled specially by keyfile - plugin are listed below. Refer to - nm-settings-nmcli5 - for all available settings and properties and their description. - Name aliases - Some of the NetworkManager setting names are somewhat hard to type or remember. Therefore - keyfile introduces aliases that can be used instead of the names. - setting name keyfile alias802-3-ethernet = ethernet802-11-wireless = wifi802-11-wireless-security = wifi-security802-11-wireless setting (section)PropertyKeyfile VariableFormatDescriptionssidstring (or decimal-byte list - obsolete)SSID of Wi-Fi network. - -Example: ssid=Quick Netmac-addressusual hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162).cloned-mac-addressusual hex-digits-and-colons notationCloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).mac-address-blacklistlist of MACs (separated with semicolons)MAC address blacklist. - -Example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78
802-3-ethernet setting (section)PropertyKeyfile VariableFormatDescriptionmac-addressusual hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162)cloned-mac-addressusual hex-digits-and-colons notationCloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).mac-address-blacklistlist of MACs (separated with semicolons)MAC address blacklist. - -Example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78
bridge setting (section)PropertyKeyfile VariableFormatDescriptionmac-addressusual hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation, or semicolon separated list of 6 decimal bytes (obsolete) - -Example: mac-address=00:22:68:12:79:A2 mac-address=0;34;104;18;121;162;
infiniband setting (section)PropertyKeyfile VariableFormatDescriptionmac-addressusual hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation, or or semicolon separated list of 20 decimal bytes (obsolete) - -Example: mac-address= 80:00:00:6d:fe:80:00:00:00:00:00:00:00:02:55:00:70:33:cf:01
ipv4 setting (section)PropertyKeyfile VariableFormatDescriptiondnslist of DNS IP addressesList of DNS servers. - -Example: dns=1.2.3.4;8.8.8.8;8.8.4.4;addressesaddress1, address2, ...address/plenList of static IP addresses. - -Example: address1=192.168.100.100/24 address2=10.1.1.5/24gatewaygatewaystringGateway IP addresses as a string. - -Example: gateway=192.168.100.1routesroute1, route2, ...route/plen[,gateway,metric]List of IP routes. - -Example: route1=8.8.8.0/24,10.1.1.1,77 route2=7.7.0.0/16routes (attributes)route1_options, route2_options, ...key=val[,key=val...]Attributes defined for the routes, if any. The supported attributes are explained in ipv4.routes entry in `man nm-settings-nmcli`. - -Example: route1_options=mtu=1000,onlink=truerouting-rulesrouting-rule1, routing-rule2, ...routing rule stringRouting rules as defined with `ip rule add`, but with mandatory fixed priority. - -Example: routing-rule1=priority 5 from 192.167.4.0/24 table 45
ipv6 setting (section)PropertyKeyfile VariableFormatDescriptiondnslist of DNS IP addressesList of DNS servers. - -Example: dns=2001:4860:4860::8888;2001:4860:4860::8844;addressesaddress1, address2, ...address/plenList of static IP addresses. - -Example: address1=abbe::cafe/96 address2=2001::1234gatewaygatewaystringGateway IP addresses as a string. - -Example: gateway=abbe::1routesroute1, route2, ...route/plen[,gateway,metric]List of IP routes. - -Example: route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403routes (attributes)route1_options, route2_options, ...key=val[,key=val...]Attributes defined for the routes, if any. The supported attributes are explained in ipv6.routes entry in `man nm-settings-nmcli`. - -Example: route1_options=mtu=1000,onlink=truerouting-rulesrouting-rule1, routing-rule2, ...routing rule stringRouting rules as defined with `ip rule add`, but with mandatory fixed priority. - -Example: routing-rule1=priority 5 from 2001:4860:4860::/64 table 45
serial setting (section)PropertyKeyfile VariableFormatDescriptionparity'e', 'o', or 'n'The connection parity; even, odd, or none. Note that older versions of NetworkManager stored this as an integer: 69 ('E') for even, 111 ('o') for odd, or 110 ('n') for none. - -Example: parity=n
vpn setting (section)PropertyKeyfile VariableFormatDescriptiondataseparate variables named after keys of the dictionaryThe keys of the data dictionary are used as variable names directly under [vpn] section. - -Example: remote=ovpn.corp.com cipher=AES-256-CBC username=joesecretsseparate variables named after keys of the dictionaryThe keys of the secrets dictionary are used as variable names directly under [vpn-secrets] section. - -Example: password=Popocatepetl
wifi-p2p setting (section)PropertyKeyfile VariableFormatDescriptionpeerusual hex-digits-and-colons notationMAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162).
wpan setting (section)PropertyKeyfile VariableFormatDescriptionmac-addressusual hex-digits-and-colons notationMAC address in hex-digits-and-colons notation (e.g. 76:d8:9b:87:66:60:84:ee).
Secret flags - Each secret property in a NetworkManager setting has an associated flags - property that describes how to handle that secret. In the keyfile plugin, - the value of -flags variable is a decimal number (0 - 7) defined as a sum - of the following values: - 0 - (NM owned) - the system is responsible for providing and storing this secret.1 - (agent-owned) - a user-session secret agent is responsible for providing - and storing this secret; when it is required, agents will be asked to provide it.2 - (not-saved) - this secret should not be saved but should be requested - from the user each time it is required.4 - (not-required) - in some situations it cannot be automatically determined - that a secret is required or not. This flag hints that the secret is not required - and should not be requested from the user.Files/etc/NetworkManager/system-connections/*See Alsonm-settings-nmcli5, - nm-settings-ifcfg-rh5, - NetworkManager8, - NetworkManager.conf5, - nmcli1, - nmcli-examples7 diff --git a/man/nm-settings-keyfile.xsl b/man/nm-settings-keyfile.xsl index 450cc6fd..d216ee15 100644 --- a/man/nm-settings-keyfile.xsl +++ b/man/nm-settings-keyfile.xsl @@ -8,8 +8,8 @@ diff --git a/man/nm-settings-nmcli.5 b/man/nm-settings-nmcli.5 index d33da534..c55daf4e 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 -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: Configuration -.\" Source: NetworkManager 1.46.0 +.\" Source: NetworkManager 1.47.90 .\" Language: English .\" -.TH "NM\-SETTINGS\-NMCLI" "5" "" "NetworkManager 1\&.46\&.0" "Configuration" +.TH "NM\-SETTINGS\-NMCLI" "5" "" "NetworkManager 1\&.47\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -131,6 +131,8 @@ Special values: default (\-1), forever (0) .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 +Deprecated 1\&.46\&. Use "autoconnect\-ports" instead, this is just an alias\&. +.sp Format: choice (NMSettingConnectionAutoconnectSlaves) .sp Valid values: default (\-1), no (0), yes (1) @@ -158,6 +160,15 @@ Format: choice (NMSettingConnectionDnsOverTls) Valid values: default (\-1), no (0), opportunistic (1), yes (2) .RE .PP +\fBconnection\&.down\-on\-poweroff\fR +.RS 4 +Whether the connection will be brought down before the system is powered off\&. The default value is "default" (\-1)\&. When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as "no" (0)\&. +.sp +Format: ternary +.sp +Valid values: true/yes/on, false/no/off, default/unknown +.RE +.PP \fBconnection\&.gateway\-ping\-timeout\fR .RS 4 If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping\&. @@ -226,9 +237,9 @@ Format: string .RS 4 Whether mDNS is enabled for the connection\&. .sp -The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (\-1) to allow lookup of a global default in NetworkManager\&.conf\&. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd\-resolved currently means "no")\&. +The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (\-1) to allow lookup of a global default in NetworkManager\&.conf\&. If unspecified, "default" ultimately depends on the DNS plugin\&. .sp -This feature requires a plugin which supports mDNS\&. Otherwise, the setting has no effect\&. One such plugin is dns\-systemd\-resolved\&. +This feature requires a plugin which supports mDNS\&. Otherwise, the setting has no effect\&. Currently the only supported DNS plugin is systemd\-resolved\&. For systemd\-resolved, the default is configurable via MulticastDNS= setting in resolved\&.conf\&. .sp Format: choice (NMSettingConnectionMdns) .sp @@ -372,7 +383,7 @@ The connection\&.uuid is the real identifier of a profile\&. It cannot change an .sp The UUID cannot be changed, except in offline mode\&. In that case, the special values "new", "generate" and "" are allowed to generate a new random UUID\&. .sp -Format: string +Format: a valid RFC4122 universally unique identifier (UUID)\&. .RE .PP \fBconnection\&.wait\-activation\-delay\fR @@ -450,11 +461,11 @@ Valid values: 0 \- 2147483647 .PP \fB802\-1x\&.ca\-cert\fR .RS 4 -Contains the CA certificate if used by the EAP method specified in the "eap" property\&. +Contains the path to the CA certificate if used by the EAP method specified in the 802\-1x\&.eap property\&. .sp -Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL\&. When using the blob scheme this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. +This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. .sp -Note that enabling NMSetting8021x:system\-ca\-certs will override this setting to use the built\-in path, if the built\-in path is not a directory\&. +Note that enabling 802\-1x\&.system\-ca\-certs will override this setting to use the built\-in path, if the built\-in path is not a directory\&. .sp Format: filesystem path .RE @@ -486,9 +497,7 @@ Format: string .PP \fB802\-1x\&.client\-cert\fR .RS 4 -Contains the client certificate if used by the EAP method specified in the "eap" property\&. -.sp -Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. +Contains the path to the client certificate if used by the EAP method specified in the 802\-1x\&.eap property\&. .sp Format: filesystem path .RE @@ -539,6 +548,13 @@ Identity string for EAP authentication methods\&. Often the user\*(Aqs user or l Format: string .RE .PP +\fB802\-1x\&.openssl\-ciphers\fR +.RS 4 +Define openssl_ciphers for wpa_supplicant\&. Openssl sometimes moves ciphers among SECLEVELs, thus compiled\-in default value in wpa_supplicant (as modified by some linux distributions) sometimes prevents to connect to old servers that do not support new protocols\&. +.sp +Format: string +.RE +.PP \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\&. @@ -650,11 +666,11 @@ Valid values: md5, mschapv2, otp, gtc, tls .PP \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\&. +Contains the path to the "phase 2" CA certificate if used by the EAP method specified in the 802\-1x\&.phase2\-auth or 802\-1x\&.phase2\-autheap properties\&. .sp -Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL\&. When using the blob scheme this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. +This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. .sp -Note that enabling NMSetting8021x:system\-ca\-certs will override this setting to use the built\-in path, if the built\-in path is not a directory\&. +Note that enabling 802\-1x\&.system\-ca\-certs will override this setting to use the built\-in path, if the built\-in path is not a directory\&. .sp Format: filesystem path .RE @@ -686,9 +702,7 @@ Format: filesystem path .PP \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 -Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. +Contains the path to the "phase 2" client certificate if used by the EAP method specified in the 802\-1x\&.phase2\-auth or 802\-1x\&.phase2\-autheap properties\&. .sp Format: filesystem path .RE @@ -725,16 +739,14 @@ Format: string .PP \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 -Key data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme and private keys, this property should be set to the key\*(Aqs encrypted PEM encoded data\&. When using private keys with the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2\-private\-key\-password" property must be set to password used to decrypt the PKCS#12 certificate and key\&. When using PKCS#12 files and the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2\-private\-key\-password" property must be set to the password used to decode the PKCS#12 private key and certificate\&. +The path to the "phase 2" inner private key when the 802\-1x\&.phase2\-auth or 802\-1x\&.phase2\-autheap property is set to "tls"\&. .sp Format: filesystem path .RE .PP \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\&. +The password used to decrypt the "phase 2" private key specified in the 802\-1x\&.phase2\-private\-key property\&. This is normally used by secret agents, not directly by users\&. .sp Format: string .RE @@ -775,18 +787,14 @@ Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0 .PP \fB802\-1x\&.private\-key\fR .RS 4 -Contains the private key when the "eap" property is set to "tls"\&. -.sp -Key data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme and private keys, this property should be set to the key\*(Aqs encrypted PEM encoded data\&. When using private keys with the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "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\&. -.sp -WARNING: "private\-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users\&. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data\&. +The path to the private key when the 802\-1\&.eap property is set to "tls"\&. .sp Format: filesystem path .RE .PP \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\&. +The password used to decrypt the private key specified in the 802\-1x\&.private\-key property\&. This is normally used by secret agents, not directly by users\&. .sp Format: string .RE @@ -2327,7 +2335,7 @@ Alias: ip4 .sp A list of IPv4 addresses and their prefix length\&. Multiple addresses can be separated by comma\&. For example "192\&.168\&.1\&.5/24, 10\&.1\&.0\&.5/24"\&. The addresses are listed in decreasing priority, meaning the first address will be the primary address\&. .sp -Format: list of ipv4\&.addresses objects +Format: a comma separated list of addresses .RE .PP \fBipv4\&.auto\-route\-ext\-gw\fR @@ -2446,6 +2454,15 @@ Format: boolean Valid values: true/yes/on, false/no/off .RE .PP +\fBipv4\&.dhcp\-send\-release\fR +.RS 4 +Whether the DHCP client will send RELEASE message when bringing the connection down\&. The default value is "default" (\-1)\&. When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as FALSE\&. +.sp +Format: ternary +.sp +Valid values: true/yes/on, false/no/off, default/unknown +.RE +.PP \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)\&. @@ -2489,7 +2506,7 @@ When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\ .sp The valid "ipv4\&.dns\-options" and "ipv6\&.dns\-options" get merged together\&. .sp -Format: list of strings +Format: a comma separated list of DNS options .RE .PP \fBipv4\&.dns\-priority\fR @@ -2976,7 +2993,7 @@ Note that in NetworkManager, currently all nexthops of a ECMP route must share t .sp For details see also `man ip\-route`\&. .sp -Format: list of ipv4\&.routes objects +Format: a comma separated list of routes .RE .PP \fBipv4\&.routing\-rules\fR @@ -2988,7 +3005,7 @@ syntax and mostly compatible\&. One difference is that routing rules in NetworkM Example: priority 5 from 192\&.167\&.4\&.0/24 table 45 .sp -Format: list of ipv4\&.routing\-rules objects +Format: a comma separated list of routing rules .RE .SS "ipv6 setting" .PP @@ -3012,7 +3029,7 @@ 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: choice (NMSettingIP6ConfigAddrGenMode) +Format: one of "eui64" (0), "stable\-privacy" (1), "default" (3) or "default\-or\-eui64" (2) .sp Valid values: eui64 (0), stable\-privacy (1), default\-or\-eui64 (2), default (3) .RE @@ -3023,7 +3040,7 @@ Alias: ip6 .sp A list of IPv6 addresses and their prefix length\&. Multiple addresses can be separated by comma\&. For example "2001:db8:85a3::8a2e:370:7334/64, 2001:db8:85a3::5/64"\&. The addresses are listed in decreasing priority, meaning the first address will be the primary address\&. This can make a difference with IPv6 source address selection (RFC 6724, section 5)\&. .sp -Format: list of ipv6\&.addresses objects +Format: a comma separated list of addresses .RE .PP \fBipv6\&.auto\-route\-ext\-gw\fR @@ -3101,6 +3118,15 @@ Format: boolean Valid values: true/yes/on, false/no/off .RE .PP +\fBipv6\&.dhcp\-send\-release\fR +.RS 4 +Whether the DHCP client will send RELEASE message when bringing the connection down\&. The default value is "default" (\-1)\&. When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as FALSE\&. +.sp +Format: ternary +.sp +Valid values: true/yes/on, false/no/off, default/unknown +.RE +.PP \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)\&. @@ -3137,7 +3163,7 @@ When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\ .sp The valid "ipv4\&.dns\-options" and "ipv6\&.dns\-options" get merged together\&. .sp -Format: list of strings +Format: a comma separated list of DNS options .RE .PP \fBipv6\&.dns\-priority\fR @@ -3209,9 +3235,7 @@ Valid values: true/yes/on, false/no/off .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 -Having a per\-connection setting set to "\-1" (unknown) means fallback to global configuration "ipv6\&.ip6\-privacy"\&. -.sp -If also global configuration is unspecified or set to "\-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr"\&. +If set to "\-1" (unknown) for a connection, the value is taken from the global "ipv6\&.ip6\-privacy" setting\&. If the global setting is unspecified or also set to "\-1", the value is set from the original value of "/proc/sys/net/ipv6/conf//use_tempaddr" from before NetworkManager started\&. .sp Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr\-gen\-mode" property\*(Aqs "stable\-privacy" setting as another way of avoiding host tracking with IPv6 addresses\&. .sp @@ -3651,7 +3675,7 @@ unicast\&. .sp For details see also `man ip\-route`\&. .sp -Format: list of ipv6\&.routes objects +Format: a comma separated list of routes .RE .PP \fBipv6\&.routing\-rules\fR @@ -3663,7 +3687,29 @@ syntax and mostly compatible\&. One difference is that routing rules in NetworkM Example: priority 5 from 1:2:3::5/128 table 45 .sp -Format: list of ipv6\&.routing\-rules objects +Format: a comma separated list of routing rules +.RE +.PP +\fBipv6\&.temp\-preferred\-lifetime\fR +.RS 4 +The preferred lifetime of autogenerated temporary addresses, in seconds\&. +.sp +If set to "0" (unknown) for a connection, the value is taken from the global "ipv6\&.temp\-preferred\-lifetime" setting\&. If the global setting is unspecified or also set to "0", the value is set from the original value of "/proc/sys/net/ipv6/conf//temp_prefered_lft" from before NetworkManager started\&. +.sp +Format: integer +.sp +Valid values: 0 \- 2147483647 +.RE +.PP +\fBipv6\&.temp\-valid\-lifetime\fR +.RS 4 +The valid lifetime of autogenerated temporary addresses, in seconds\&. +.sp +If set to "0" (unknown) for a connection, the value is taken from the global "ipv6\&.temp\-valid\-lifetime" setting\&. If the global setting is unspecified or also set to "0", the value is set from the original value of "/proc/sys/net/ipv6/conf//temp_valid_lft" from before NetworkManager started\&. +.sp +Format: integer +.sp +Valid values: 0 \- 2147483647 .RE .PP \fBipv6\&.token\fR @@ -4769,7 +4815,7 @@ Limit is the number of bytes that can be queued waiting for tokens to become ava specifies the maximum amount of time a packet can sit in the TBF\&. The latency calculation takes into account the size of the bucket, the rate and possibly the peakrate (if set)\&. The latency and limit are mutually exclusive\&. .RE .sp -Format: list of tc\&.qdiscs objects +Format: GPtrArray(NMTCQdisc) .RE .PP \fBtc\&.tfilters\fR @@ -4827,7 +4873,7 @@ Action for \*(Aqsimple\*(Aq: The actual string to print\&. .RE .sp -Format: list of tc\&.tfilters objects +Format: GPtrArray(NMTCTfilter) .RE .SS "team setting" .PP @@ -5570,6 +5616,13 @@ If specified, this connection will never apply to the Ethernet device whose perm Format: list of MAC addresses .RE .PP +\fB802\-3\-ethernet\&.mac\-address\-denylist\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: list of MAC addresses +.RE +.PP \fB802\-3\-ethernet\&.mtu\fR .RS 4 Alias: mtu @@ -5835,6 +5888,13 @@ A list of permanent MAC addresses of Wi\-Fi devices to which this connection sho Format: list of MAC addresses .RE .PP +\fB802\-11\-wireless\&.mac\-address\-denylist\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: list of MAC addresses +.RE +.PP \fB802\-11\-wireless\&.mac\-address\-randomization\fR .RS 4 One of "default" (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), "never" (1) (never randomize the MAC address), or "always" (2) (always randomize the MAC address)\&. diff --git a/man/nm-settings-nmcli.xml b/man/nm-settings-nmcli.xml deleted file mode 100644 index 89130b99..00000000 --- a/man/nm-settings-nmcli.xml +++ /dev/null @@ -1,1830 +0,0 @@ - - -nm-settings-nmcliNetworkManager developersnm-settings-nmcli5NetworkManagerConfiguration1.46.0nm-settings-nmcliDescription of settings and properties of NetworkManager connection profiles for nmcliDescription - 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 - be applied and an active network connection will be established. Users are free to create - as many connection profiles as they see fit. Thus they are flexible in having various network - configurations for different networking needs. - - NetworkManager provides an API for configuring connection profiles, for activating them - to configure the network, and inspecting the current network configuration. The command - line tool nmcli is a client application to NetworkManager that uses - this API. See nmcli1 - for details. - - With commands like nmcli connection add, nmcli connection modify - and nmcli connection show, connection profiles can be created, modified - and inspected. A profile consists of properties. On D-Bus this follows the format - as described by nm-settings-dbus5, - while this manual page describes the settings format how they are expected by nmcli. - - The settings and properties shown in tables below list all available connection - configuration options. However, note that not all settings are applicable to all - connection types. nmcli connection editor has also a built-in - describe command that can display description of particular settings - and properties of this page. - - The setting and - property can be abbreviated provided they are unique. The list below - also shows aliases that can be used unqualified instead of the full name. For example - connection.interface-name and ifname refer to the same - property. - connection settingGeneral Connection Profile Settings. - Properties: - The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection.Currently, this only applies to 802-1x authentication. - Format: integer - Valid values: -1 - 2147483647 - Alias: autoconnectWhether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection.Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile.Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined.Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times. - Format: boolean - Valid values: true/yes/on, false/no/offWhether or not ports of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for controller connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave port connections untouched, 1: activate all the port connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-ports is read to determine the real value. If it is default as well, this fallbacks to 0. - Format: choice (NMTernary) - Valid values: default (-1), false (0), true (1)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. - Format: integer - Valid values: -999 - 999The 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. - Format: integer - Valid values: -1 - 2147483647 - Special values: default (-1), forever (0)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. - Format: choice (NMSettingConnectionAutoconnectSlaves) - Valid values: default (-1), no (0), yes (1) - Alias: controllerInterface name of the controller device or UUID of the controller connection. - Format: stringWhether DNSOverTls (dns-over-tls) is enabled for the connection. DNSOverTls is a technology which uses TLS to encrypt dns traffic.The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting.This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved. - Format: choice (NMSettingConnectionDnsOverTls) - Valid values: default (-1), no (0), opportunistic (1), yes (2)If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping. - Format: integer - Valid values: 0 - 600 - Alias: con-nameA human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G". - Format: string - Alias: ifnameThe name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings).For software devices this specifies the name of the created device.For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface. - Format: stringWhether LLDP is enabled for the connection. - Format: choice (NMSettingConnectionLldp) - Valid values: default (-1), disable (0), enable-rx/enable (1)Whether Link-Local Multicast Name Resolution (LLMNR) is enabled for the connection. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link.The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes").This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved. - Format: choice (NMSettingConnectionLlmnr) - Valid values: default (-1), no (0), resolve (1), yes (2) - Alias: masterInterface name of the master device or UUID of the master connection.Deprecated 1.46. Use "controller" instead, this is just an alias. - Format: stringWhether mDNS is enabled for the connection.The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no").This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved. - Format: choice (NMSettingConnectionMdns) - Valid values: default (-1), no (0), resolve (1), yes (2)Whether the connection is metered.When updating this property on a currently activated connection, the change takes effect immediately. - Format: ternary - Valid values: true/yes/on, false/no/off, default/unknownWhether to configure MPTCP endpoints and the address flags. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints. Note that IPv4 loopback addresses (127.0.0.0/8), IPv4 link local addresses (169.254.0.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6.ip6-privacy) will be excluded from being configured as endpoints.If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered.The "enabled" (0x2) flag means that MPTCP handling is enabled. This flag can also be implied from the presence of other flags.Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on. NetworkManager does not change the sysctl and this is up to the administrator or distribution. To configure endpoints even if the sysctl is disabled, "also-without-sysctl" (0x4) flag can be used. In that case, NetworkManager doesn't look at the sysctl and configures endpoints regardless.Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0.0.0.0/0 or ::/0) in the main routing table. The flag "also-without-default-route" (0x8) can override that.When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80). See ip-mptcp(8) manual for additional information about the flags.If the flags are zero (0x0), the global connection default from NetworkManager.conf is honored. If still unspecified, the fallback is "enabled,subflow". Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl.NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2). - Format: flags (NMMptcpFlags) - Valid values: none/default (0x0), disabled (0x1), enabled (0x2), also-without-sysctl (0x4), also-without-default-route (0x8), signal (0x10), subflow (0x20), backup (0x40), fullmesh (0x80)If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer-recommended network policies for IoT devices. It is transmitted as a DHCPv4 or DHCPv6 option. The value must be a valid URL starting with "https://".The special value "none" is allowed to indicate that no MUD URL is used.If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the ultimate default is "none". - Format: stringSpecifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect. - Format: choice (NMConnectionMultiConnect) - Valid values: default (0), single (1), manual-multiple (2), multiple (3)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. - Format: list of strings - Alias: port-typeSetting name of the device type of this port's controller connection (eg, "bond"), or NULL if this connection is not a port. - Format: string - Valid values: bond, bridge, ovs-bridge, ovs-port, team, vrfList of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported. - Format: list of strings - Alias: slave-typeSetting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.Deprecated 1.46. Use "port-type" instead, this is just an alias. - Format: string - Valid values: bond, bridge, ovs-bridge, ovs-port, team, vrfThis represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context.The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. It is also used to derive the DHCP client identifier with ipv4.dhcp-client-id=stable, the DHCPv6 DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid] and the DHCP IAID with ipv4.iaid=stable and ipv6.iaid=stable.Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity.The '$' character is treated special to perform dynamic substitutions at activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${NETWORK_SSID}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-SSID, per-boot, or every time. The "${CONNECTION}" uses the profile's connection.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device. "${NETWORK_SSID}" uses the SSID for Wi-Fi networks and falls back to "${CONNECTION}" on other networks. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates.If the value is unset, a global connection default is consulted. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile. - Format: stringThe 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). - Format: read only - Alias: typeBase 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). - Format: string - Valid values: 6lowpan, 802-11-olpc-mesh, 802-11-wireless, 802-3-ethernet, adsl, bluetooth, bond, bridge, cdma, dummy, generic, gsm, hsr, infiniband, ip-tunnel, loopback, macsec, macvlan, ovs-bridge, ovs-dpdk, ovs-interface, ovs-patch, ovs-port, pppoe, team, tun, veth, vlan, vpn, vrf, vxlan, wifi-p2p, wimax, wireguard, wpanThe 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`.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. - Format: stringTime in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event.The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time. - Format: integer - Valid values: -1 - 2147483647Timeout in milliseconds to wait for device at startup. During boot, devices may take a while to be detected by the driver. This property will cause to delay NetworkManager-wait-online.service and nm-online to give the device a chance to appear. This works by waiting for the given timeout until a compatible device for the profile is available and managed.The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time. - Format: integer - Valid values: -1 - 2147483647The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.When updating this property on a currently activated connection, the change takes effect immediately. - Format: string6lowpan setting6LoWPAN Settings. - Properties: - - Alias: devIf given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created. - Format: string802-1x settingIEEE 802.1x Authentication Settings. - Properties: - 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. - Format: list of stringsAnonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS. - Format: stringA timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds. - Format: integer - Valid values: 0 - 2147483647Contains the CA certificate if used by the EAP method specified in the "eap" property.Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory. - Format: filesystem pathThe 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. - Format: stringFlags indicating how to handle the "ca-cert-password" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property.If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored. - Format: stringContains the client certificate if used by the EAP method specified in the "eap" property.Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. - Format: filesystem pathThe 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. - Format: stringFlags indicating how to handle the "client-cert-password" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)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. - Format: stringConstraint 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. - Format: stringThe 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. - Format: list of strings - Valid values: leap, md5, tls, peap, ttls, sim, fast, pwdIdentity string for EAP authentication methods. Often the user's user or login name. - Format: stringWhether 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. - Format: boolean - Valid values: true/yes/on, false/no/offUTF-8 encoded file path containing PAC for EAP-FAST. - Format: stringUTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred. - Format: stringFlags indicating how to handle the "password" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)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. - Format: bytesFlags indicating how to handle the "password-raw" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)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. - Format: flags (NMSetting8021xAuthFlags) - Valid values: none (0x0), tls-1-0-disable (0x1), tls-1-1-disable (0x2), tls-1-2-disable (0x4), tls-disable-time-checks (0x8), tls-1-3-disable (0x10), tls-1-0-enable (0x20), tls-1-1-enable (0x40), tls-1-2-enable (0x80), tls-1-3-enable (0x100), all (0x1ff)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. - Format: string - Valid values: 0, 1, 2, 3Forces 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. - Format: string - Valid values: 0, 1Forces 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. - Format: string - Valid values: 0, 1List 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. - Format: list of stringsSpecifies 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. - Format: string - Valid values: pap, chap, mschap, mschapv2, gtc, otp, md5, tlsSpecifies 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. - Format: string - Valid values: md5, mschapv2, otp, gtc, tlsContains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory. - Format: filesystem pathThe 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. - Format: stringFlags indicating how to handle the "phase2-ca-cert-password" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property.If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored. - Format: filesystem pathContains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. - Format: filesystem pathThe 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. - Format: stringFlags indicating how to handle the "phase2-client-cert-password" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)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. - Format: stringConstraint 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. - Format: stringContains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls".Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. - Format: filesystem pathThe 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. - Format: stringFlags indicating how to handle the "phase2-private-key-password" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)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. - This property is deprecated since version 1.2. - Use "phase2-domain-suffix-match" instead. - Format: stringPIN used for EAP authentication methods. - Format: stringFlags indicating how to handle the "pin" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)Contains the private key when the "eap" property is set to "tls".Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data. - Format: filesystem pathThe 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. - Format: stringFlags indicating how to handle the "private-key-password" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)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. - This property is deprecated since version 1.2. - Use "phase2-domain-suffix-match" instead. - Format: stringWhen 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). - Format: boolean - Valid values: true/yes/on, false/no/offadsl settingADSL Settings. - Properties: - - Alias: encapsulationEncapsulation of ADSL connection. Can be "vcmux" or "llc". - Format: string - Valid values: vcmux, llc - Alias: passwordPassword used to authenticate with the ADSL service. - Format: stringFlags indicating how to handle the "password" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4) - Alias: protocolADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm". - Format: string - Valid values: pppoa, pppoe, ipoatm - Alias: usernameUsername used to authenticate with the ADSL service. - Format: stringVCI of ADSL connection - Format: integer - Valid values: 0 - 65536VPI of ADSL connection - Format: integer - Valid values: 0 - 65536bluetooth settingBluetooth Settings. - Properties: - - Alias: addrThe Bluetooth address of the device. - Format: MAC address - Alias: bt-typeEither "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile. - Format: string - Valid values: dun, panu, napbond settingBonding Settings. - Properties: - 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]). - Format: list of key/value optionsbridge settingBridging Settings. - Properties: - - Alias: ageing-timeThe Ethernet MAC address aging time, in seconds. - Format: integer - Valid values: 0 - 1000000 - Alias: forward-delayThe Spanning Tree Protocol (STP) forwarding delay, in seconds. - Format: integer - Valid values: 0 - 30If specified, The MAC address of the multicast group this bridge uses for STP.The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00. - Format: MAC address - Alias: group-forward-maskA 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. - Format: integer - Valid values: 0 - 65535 - Alias: hello-timeThe Spanning Tree Protocol (STP) hello time, in seconds. - Format: integer - Valid values: 0 - 10 - Alias: macIf specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set.If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. - This property is deprecated since version 1.12. - Use the "cloned-mac-address" property instead. - Format: MAC address - Alias: max-ageThe Spanning Tree Protocol (STP) maximum message age, in seconds. - Format: integer - Valid values: 0 - 40Set maximum size of multicast hash table (value must be a power of 2). - Format: integer - Valid values: 1 - 4294967295Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received. - Format: integer - Valid values: 0 - 4294967295Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received. - Format: integer - Valid values: 0 - 18446744073709551615Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received. - Format: integer - Valid values: 0 - 18446744073709551615Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled. - Format: boolean - Valid values: true/yes/on, false/no/offIf no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries. - Format: integer - Valid values: 0 - 18446744073709551615Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase. - Format: integer - Valid values: 0 - 18446744073709551615Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge. - Format: integer - Valid values: 0 - 18446744073709551615If 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. - Format: boolean - Valid values: true/yes/on, false/no/offSets bridge's multicast router. Multicast-snooping must be enabled for this option to work.Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1). - Format: string - Valid values: auto, disabled, enabled - Alias: multicast-snoopingControls 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. - Format: boolean - Valid values: true/yes/on, false/no/offSet the number of IGMP queries to send during startup phase. - Format: integer - Valid values: 0 - 4294967295Sets the time (in deciseconds) between queries sent out at startup to determine membership information. - Format: integer - Valid values: 0 - 18446744073709551615 - Alias: prioritySets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge. - Format: integer - Valid values: 0 - 65535 - Alias: stpControls whether Spanning Tree Protocol (STP) is enabled for this bridge. - Format: boolean - Valid values: true/yes/on, false/no/offThe default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames. - Format: integer - Valid values: 0 - 4094Control whether VLAN filtering is enabled on the bridge. - Format: boolean - Valid values: true/yes/on, false/no/offIf specified, the protocol used for VLAN filtering.Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'. - Format: string - Valid values: 802.1Q, 802.1adControls whether per-VLAN stats accounting is enabled. - Format: boolean - Valid values: true/yes/on, false/no/offArray of bridge VLAN objects. In addition to the VLANs specified here, the bridge will also have the default-pvid VLAN configured by the bridge.vlan-default-pvid property.In nmcli the VLAN list can be specified with the following syntax:$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash. - Format: list of bridge.vlans objectsbridge-port settingBridge Port Settings. - Properties: - - Alias: hairpinEnables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on. - Format: boolean - Valid values: true/yes/on, false/no/off - Alias: path-costThe Spanning Tree Protocol (STP) port cost for destinations via this port. - Format: integer - Valid values: 0 - 65535 - Alias: priorityThe Spanning Tree Protocol (STP) priority of this bridge port. - Format: integer - Valid values: 0 - 63Array of bridge VLAN objects. In addition to the VLANs specified here, the port will also have the default-pvid VLAN configured on the bridge by the bridge.vlan-default-pvid property.In nmcli the VLAN list can be specified with the following syntax:$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash. - Format: list of bridge-port.vlans objectscdma settingCDMA-based Mobile Broadband Settings. - Properties: - If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames. - Format: integer - Special values: autoThe 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. - Format: string - Alias: passwordThe 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. - Format: stringFlags indicating how to handle the "password" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4) - Alias: userThe 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. - Format: stringdcb settingData Center Bridging Settings. - Properties: - Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4). - Format: flags (NMSettingDcbFlags) - Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)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". - Format: string - Valid values: fabric, vn2vnThe highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the "enable" (0x1) flag. - Format: integer - Valid values: -1 - 7 - Special values: unset (-1)Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4). - Format: flags (NMSettingDcbFlags) - Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the "enable" (0x1) flag. - Format: integer - Valid values: -1 - 7 - Special values: unset (-1)Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4). - Format: flags (NMSettingDcbFlags) - Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the "enable" (0x1) flag. - Format: integer - Valid values: -1 - 7 - Special values: unset (-1)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. - Format: list of integers - Valid values: 0 - 100An 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. - Format: list of booleans - Valid values: true/yes/on, false/no/offSpecifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4). - Format: flags (NMSettingDcbFlags) - Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)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. - Format: list of integers - Valid values: 0 - 100Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4). - Format: flags (NMSettingDcbFlags) - Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)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. - Format: list of integers - Valid values: 0 - 7, 15An 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. - Format: list of booleans - Valid values: true/yes/on, false/no/offAn 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. - Format: list of integers - Valid values: 0 - 7ethtool settingEthtool Ethernet Settings. - Properties: - - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: ternary - Valid values: on, off, ignore - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295 - Format: integer - Valid values: 0 - 4294967295generic settingGeneric Link Settings. - Properties: - Name of the device handler that will be invoked to add and delete the device for this connection. The name can only contain ASCII alphanumeric characters and '-', '_', '.'. It cannot start with '.'.See the NetworkManager-dispatcher(8) man page for more details about how to write the device handler.By setting this property the generic connection becomes "virtual", meaning that it can be activated without an existing device; the device will be created at the time the connection is started by invoking the device-handler. - Format: stringgsm settingGSM-based Mobile Broadband Settings. - Properties: - - Alias: apnThe 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.If the APN is unset (the default) then it may be detected based on "auto-config" setting. The property can be explicitly set to the empty string to prevent that and use no APN. - Format: stringWhen 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. - Format: boolean - Valid values: true/yes/on, false/no/offThe 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. - Format: stringWhen TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made. - Format: boolean - Valid values: true/yes/on, false/no/offFor 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. - Format: stringFor 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. - Format: boolean - Valid values: true/yes/on, false/no/offIf non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames. - Format: integer - Special values: autoThe 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. - Format: stringLegacy 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. - Format: string - Alias: passwordThe 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. - Format: stringFlags indicating how to handle the "password" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)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. - Format: stringFlags indicating how to handle the "pin" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)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. - Format: stringA 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. - Format: string - Alias: userThe 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. - Format: stringinfiniband settingInfiniband Settings. - Properties: - - Alias: macIf 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). - Format: Infiniband MAC address - Alias: mtuIf non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames. - Format: integer - Special values: auto - Alias: p-keyThe InfiniBand p-key to use for this device. A value of -1 means to use the default p-key (aka "the p-key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit 0x8000 is set if it is a "full membership" p-key. The values 0 and 0x8000 are not allowed.With the p-key set, the interface name is always "$parent.$p_key". Setting "connection.interface-name" to another name is not supported.Note that kernel will internally always set the full membership bit, although the interface name does not reflect that. Usually the user would want to configure a full membership p-key with 0x8000 flag set. - Format: integer - Valid values: -1 - 65535 - Special values: default (-1) - Alias: parentThe 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". - Format: string - Alias: transport-modeThe IP-over-InfiniBand transport mode. Either "datagram" or "connected". - Format: string - Valid values: datagram, connectedipv4 settingIPv4 Settings. - Properties: - - Alias: ip4A 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. - Format: list of ipv4.addresses objectsVPN connections will default to add the route automatically unless this setting is set to FALSE.For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect. - Format: ternary - Valid values: true/yes/on, false/no/off, default/unknownMaximum timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. The property is currently implemented only for IPv4.A zero value means that no duplicate address detection is performed, -1 means the default value (either the value configured globally in NetworkManger.conf or 200ms). A value greater than zero is a timeout in milliseconds. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property. - Format: integer - Valid values: -1 - 30000 - Special values: default (-1), off (0)A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0.The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links.The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset.The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id.The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key.The special value "none" prevents any client identifier from being sent. Note that this is normally not recommended.If unset, a globally configured default from NetworkManager.conf is used. If still unset, the default depends on the DHCP plugin. The internal dhcp client will default to "mac" and the dhclient plugin will try to use one from its config file if present, or won't sent any client-id otherwise. - Format: string - Special values: mac, perm-mac, duid, ipv6-duid, stable, noneSpecifies the value for the DSCP field (traffic class) of the IP header. When empty, the global default value is used; if no global default is specified, it is assumed to be "CS0". Allowed values are: "CS0", "CS4" and "CS6".The property is currently valid only for IPv4, and it is supported only by the "internal" DHCP plugin. - Format: string - Valid values: CS0, CS4, CS6If 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. - Format: stringIf 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. - Format: stringFlags for the DHCP hostname and FQDN.Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) and "fqdn-no-update" (0x4). When no FQDN flag is set and "fqdn-clear-flags" (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and "fqdn-clear-flags" (0x8) is not set, the standard FQDN flags are set in the request: "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) for IPv4 and "fqdn-serv-update" (0x1) for IPv6.When this property is set to the default value "none" (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also "none" (0x0), then the standard FQDN flags described above are sent in the DHCP requests. - Format: flags (NMDhcpHostnameFlags) - Valid values: none (0x0), fqdn-serv-update (0x1), fqdn-encoded (0x2), fqdn-no-update (0x4), fqdn-clear-flags (0x8)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. - Format: stringArray of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers.For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24").This property is currently not implemented for DHCPv6. - Format: list of IPv4 addressesIf 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. - Format: boolean - Valid values: true/yes/on, false/no/offA timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds).Set to 2147483647 (MAXINT32) for infinity. - Format: integer - Valid values: 0 - 2147483647 - Special values: default (0), infinity (2147483647)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. - Format: stringArray of IP addresses of DNS servers.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. - Format: list of IPv4 addressesDNS options for /etc/resolv.conf as described in resolv.conf(5) manual.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.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.The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.The valid "ipv4.dns-options" and "ipv6.dns-options" get merged together. - Format: list of stringsDNS servers priority.The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections.Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile.When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices.When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured. - Format: integer - Valid values: -2147483648 - 2147483647List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15). - Format: list of strings - Alias: gw4The gateway associated with this configuration. This is only meaningful if "addresses" is also set.Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route". - Format: IPv4 addressWhen "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. - Format: boolean - Valid values: true/yes/on, false/no/offWhen "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. - Format: boolean - Valid values: true/yes/on, false/no/offEnable and disable the IPv4 link-local configuration independently of the ipv4.method configuration. This allows a link-local address (169.254.x.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server.When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default". - Format: choice (NMSettingIP4LinkLocal) - Valid values: default (0), auto (1), disabled (2), enabled (3)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. - Format: boolean - Valid values: true/yes/on, false/no/off - Sets the IPv4 connection method. You can set one of the following values: - - - - "auto" - Enables automatic IPv4 address assignment from DHCP, PPP, or similar services. - - - "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. - - - "disabled" - Disables the IPv4 protocol in this connection profile. - - - "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. - - - "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. - - - - Format: string - Valid values: auto, link-local, manual, shared, disabledIf TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager. - Format: boolean - Valid values: true/yes/on, false/no/offConnections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE. - Format: ternary - Valid values: true/yes/on, false/no/off, default/unknownThe minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero). - Format: integer - Valid values: -1 - 2147483647 - Special values: default (-1), infinity (2147483647)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. - Format: integer - Valid values: -1 - 4294967295Enable policy routing (source routing) and set the routing table used when adding routes.This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager. - Format: integer - Valid values: 0 - 4294967295 - Special values: unspec (0), main (254) - 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". - - Various attributes are supported: - - - "advmss" - an unsigned 32 bit integer. - - - "cwnd" - an unsigned 32 bit integer. - - - "initcwnd" - an unsigned 32 bit integer. - - - "initrwnd" - an unsigned 32 bit integer. - - - "lock-advmss" - a boolean value. - - - "lock-cwnd" - a boolean value. - - - "lock-initcwnd" - a boolean value. - - - "lock-initrwnd" - a boolean value. - - - "lock-mtu" - a boolean value. - - - "lock-window" - a boolean value. - - - "mtu" - an unsigned 32 bit integer. - - - "onlink" - a boolean value. The onlink flag - is ignored for IPv4 routes without a gateway. That also means, - with a positive "weight" the route cannot merge with ECMP routes - which are onlink and have a gateway. - - - - "quickack" - a boolean value. - - - "rto_min" - an unsigned 32 bit integer. - The value is in milliseconds. - - - "scope" - an unsigned 8 bit integer. IPv4 only. - - - "src" - an IPv4 address. - - - "table" - an unsigned 32 bit integer. The default depends on ipv4.route-table. - - - "tos" - an unsigned 8 bit integer. IPv4 only. - - - "type" - one of unicast, local, blackhole, - unreachable, prohibit, throw. - The default is unicast. - - - "weight" - an unsigned 32 bit integer - ranging from 0 to 256. A non-zero weight indicates that the IPv4 - route is an ECMP IPv4 route. NetworkManager will automatically - merge compatible ECMP routes into multi-hop routes. Setting to - zero or omitting the attribute configures single hop routes that - won't get merged. If the route finds no merge partner, it is - configured as single hop route. Note that in - NetworkManager, currently all nexthops of a ECMP route must share - the same "onlink" flag in order to be mergable. - - - "window" - an unsigned 32 bit integer. - - - -For details see also `man ip-route`. - - Format: list of ipv4.routes objects -A comma separated list of routing rules for policy routing. The format -is based on ip rule add syntax and mostly compatible. -One difference is that routing rules in NetworkManager always need a -fixed priority. - -Example: priority 5 from 192.167.4.0/24 table 45 - - Format: list of ipv4.routing-rules objectsipv6 settingIPv6 Settings. - Properties: - Configure method for creating the IPv6 interface identifer of addresses with RFC4862 IPv6 Stateless Address Autoconfiguration and Link Local addresses.The permitted values are: "eui64" (0), "stable-privacy" (1), "default" (3) or "default-or-eui64" (2).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.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.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.If not specified, when creating a new profile the default is "default".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. - Format: choice (NMSettingIP6ConfigAddrGenMode) - Valid values: eui64 (0), stable-privacy (1), default-or-eui64 (2), default (3) - Alias: ip6A 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). - Format: list of ipv6.addresses objectsVPN connections will default to add the route automatically unless this setting is set to FALSE.For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect. - Format: ternary - Valid values: true/yes/on, false/no/off, default/unknownA string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option.The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id.The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk.The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt").When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed. - Format: stringIf 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. - Format: stringFlags for the DHCP hostname and FQDN.Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) and "fqdn-no-update" (0x4). When no FQDN flag is set and "fqdn-clear-flags" (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and "fqdn-clear-flags" (0x8) is not set, the standard FQDN flags are set in the request: "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) for IPv4 and "fqdn-serv-update" (0x1) for IPv6.When this property is set to the default value "none" (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also "none" (0x0), then the standard FQDN flags described above are sent in the DHCP requests. - Format: flags (NMDhcpHostnameFlags) - Valid values: none (0x0), fqdn-serv-update (0x1), fqdn-encoded (0x2), fqdn-no-update (0x4), fqdn-clear-flags (0x8)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. - Format: stringA 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"). - Format: stringIf 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. - Format: boolean - Valid values: true/yes/on, false/no/offA timeout for a DHCP transaction in seconds. If zero (the default), a globally configured default is used. If still unspecified, a device specific timeout is used (usually 45 seconds).Set to 2147483647 (MAXINT32) for infinity. - Format: integer - Valid values: 0 - 2147483647 - Special values: default (0), infinity (2147483647)Array of IP addresses of DNS servers.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. - Format: list of IPv6 addressesDNS options for /etc/resolv.conf as described in resolv.conf(5) manual.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.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.The "trust-ad" setting is only honored if the profile contributes name servers to resolv.conf, and if all contributing profiles have "trust-ad" enabled.When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.The valid "ipv4.dns-options" and "ipv6.dns-options" get merged together. - Format: list of stringsDNS servers priority.The relative priority for DNS servers specified by this setting. A lower numerical value is better (higher priority).Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles.Zero selects a globally configured default value. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections.Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile.When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices.When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured. - Format: integer - Valid values: -2147483648 - 2147483647List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15). - Format: list of strings - Alias: gw6The gateway associated with this configuration. This is only meaningful if "addresses" is also set.Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route". - Format: IPv6 addressWhen "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. - Format: boolean - Valid values: true/yes/on, false/no/offWhen "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. - Format: boolean - Valid values: true/yes/on, false/no/offConfigure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy".If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr".Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses. - Format: choice (NMSettingIP6ConfigPrivacy) - Valid values: unknown (-1), disabled (0), prefer-public-addr (1), prefer-temp-addr (2)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. - Format: boolean - Valid values: true/yes/on, false/no/off - Sets the IPv6 connection method. You can set one of the following values: - - - - "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. - - - "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. - - - "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. - - - "disabled" - Disables the IPv6 protocol in this connection profile. - - - "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. - - - "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. - - - "link-local" - Assigns a random link-local address from the fe80::/64 subnet to the interface. - - - - 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. - - - Format: string - Valid values: ignore, auto, dhcp, link-local, manual, shared, disabledMaximum 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. - Format: integer - Special values: autoIf TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager. - Format: boolean - Valid values: true/yes/on, false/no/offA timeout for waiting Router Advertisements in seconds. If zero (the default), a globally configured default is used. If still unspecified, the timeout depends on the sysctl settings of the device.Set to 2147483647 (MAXINT32) for infinity. - Format: integer - Valid values: 0 - 2147483647 - Special values: default (0), infinity (2147483647)Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE. - Format: ternary - Valid values: true/yes/on, false/no/off, default/unknownThe minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds.This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e.g. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active.Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero). - Format: integer - Valid values: -1 - 2147483647 - Special values: default (-1), infinity (2147483647)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. - Format: integer - Valid values: -1 - 4294967295Enable policy routing (source routing) and set the routing table used when adding routes.This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table.If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager. - Format: integer - Valid values: 0 - 4294967295 - Special values: unspec (0), main (254) - 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]...]". - - Various attributes are supported: - - - "advmss" - an unsigned 32 bit integer. - - - "cwnd" - an unsigned 32 bit integer. - - - "from" - an IPv6 address with optional prefix. IPv6 only. - - - "initcwnd" - an unsigned 32 bit integer. - - - "initrwnd" - an unsigned 32 bit integer. - - - "lock-advmss" - a boolean value. - - - "lock-cwnd" - a boolean value. - - - "lock-initcwnd" - a boolean value. - - - "lock-initrwnd" - a boolean value. - - - "lock-mtu" - a boolean value. - - - "lock-window" - a boolean value. - - - "mtu" - an unsigned 32 bit integer. - - - "onlink" - a boolean value. - - - "quickack" - a boolean value. - - - "rto_min" - an unsigned 32 bit integer. - The value is in milliseconds. - - - "src" - an IPv6 address. - - - "table" - an unsigned 32 bit integer. The default depends on ipv6.route-table. - - - "type" - one of unicast, local, blackhole, - unreachable, prohibit, throw. - The default is unicast. - - - "window" - an unsigned 32 bit integer. - - - -For details see also `man ip-route`. - - Format: list of ipv6.routes objects -A comma separated list of routing rules for policy routing. The format -is based on ip rule add syntax and mostly compatible. -One difference is that routing rules in NetworkManager always need a -fixed priority. - -Example: priority 5 from 1:2:3::5/128 table 45 - - Format: list of ipv6.routing-rules objectsConfigure 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. - Format: stringip-tunnel settingIP Tunneling Settings. - Properties: - How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add 0x1 (ip6-ign-encap-limit) to ip-tunnel flags. - Format: integer - Valid values: 0 - 255Tunnel flags. Currently, the following values are supported: 0x1 (ip6-ign-encap-limit), 0x2 (ip6-use-orig-tclass), 0x4 (ip6-use-orig-flowlabel), 0x8 (ip6-mip6-dev), 0x10 (ip6-rcv-dscp-copy) and 0x20 (ip6-use-orig-fwmark). They are valid only for IPv6 tunnels. - Format: flags (NMIPTunnelFlags) - Valid values: none (0x0), ip6-ign-encap-limit (0x1), ip6-use-orig-tclass (0x2), ip6-use-orig-flowlabel (0x4), ip6-mip6-dev (0x8), ip6-rcv-dscp-copy (0x10), ip6-use-orig-fwmark (0x20)The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels. - Format: integer - Valid values: 0 - 1048575The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels. - Format: integer - Valid values: 0 - 4294967295The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used. - Format: string - Alias: localThe local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address. - Format: string - Alias: modeThe tunneling mode. Valid values: ipip (1), gre (2), sit (3), isatap (4), vti (5), ip6ip6 (6), ipip6 (7), ip6gre (8), vti6 (9), gretap (10) and ip6gretap (11) - Format: choice (NMIPTunnelMode) - Valid values: ipip (1), gre (2), sit (3), isatap (4), vti (5), ip6ip6 (6), ipip6 (7), ip6gre (8), vti6 (9), gretap (10), ip6gretap (11)If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments. - Format: integer - Special values: autoThe key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used. - Format: string - Alias: devIf 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. - Format: stringWhether to enable Path MTU Discovery on this tunnel. - Format: boolean - Valid values: true/yes/on, false/no/off - Alias: remoteThe remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address. - Format: stringThe type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets. - Format: integer - Valid values: 0 - 255The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value. - Format: integer - Valid values: 0 - 255macsec settingMACSec Settings. - Properties: - - Alias: encryptWhether the transmitted traffic must be encrypted. - Format: boolean - Valid values: true/yes/on, false/no/off - Alias: cakThe pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement. Must be a string of 32 hexadecimal characters. - Format: stringFlags indicating how to handle the "mka-cak" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4) - Alias: cknThe 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. - Format: string - Alias: modeSpecifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained. - Format: choice (NMSettingMacsecMode) - Valid values: psk (0), eap (1)Specifies the MACsec offload mode."off" (0) disables MACsec offload."phy" (1) and "mac" (2) request offload respectively to the PHY or to the MAC; if the selected mode is not available, the connection will fail."default" (-1) uses the global default value specified in NetworkManager configuration; if no global default is defined, the built-in default is "off" (0). - Format: choice (NMSettingMacsecOffload) - Valid values: default (-1), off (0), phy (1), mac (2) - Alias: devIf 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. - Format: string - Alias: portThe port component of the SCI (Secure Channel Identifier), between 1 and 65534. - Format: integer - Valid values: 1 - 65534Specifies whether the SCI (Secure Channel Identifier) is included in every packet. - Format: boolean - Valid values: true/yes/on, false/no/offSpecifies the validation mode for incoming frames. - Format: choice (NMSettingMacsecValidation) - Valid values: disable (0), check (1), strict (2)macvlan settingMAC VLAN Settings. - Properties: - - Alias: modeThe macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device. - Format: choice (NMSettingMacvlanMode) - Valid values: vepa (1), bridge (2), private (3), passthru (4), source (5) - Alias: devIf 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. - Format: stringWhether the interface should be put in promiscuous mode. - Format: boolean - Valid values: true/yes/on, false/no/off - Alias: tapWhether the interface should be a MACVTAP. - Format: boolean - Valid values: true/yes/on, false/no/offmatch settingMatch settings. - Properties: - 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. - Format: list of stringsA list of interface names to match. Each element is a shell wildcard pattern.An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a". - Format: list of stringsA list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported.See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match. - Format: list of stringsA list of paths to match against the ID_PATH udev property of devices. ID_PATH represents the topological persistent path of a device. It typically contains a subsystem string (pci, usb, platform, etc.) and a subsystem-specific identifier.For PCI devices the path has the form "pci-$domain:$bus:$device.$function", where each variable is an hexadecimal value; for example "pci-0000:0a:00.0".The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli -f general.path device show $dev").Each element of the list is a shell wildcard pattern.See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern. - Format: list of strings802-11-olpc-mesh setting - Alias: olpc-meshOLPC Wireless Mesh Settings. - Properties: - - Alias: channelChannel on which the mesh network to join is located. - Format: integer - Valid values: 0 - 4294967295 - Alias: dhcp-anycastAnycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.This is currently only implemented by dhclient DHCP plugin. - Format: MAC address - Alias: ssidSSID of the mesh network to join. - Format: stringovs-bridge settingOvsBridge Link Settings. - Properties: - The data path type. One of "system", "netdev" or empty. - Format: string - Valid values: system, netdevThe bridge failure mode. One of "secure", "standalone" or empty. - Format: string - Valid values: secure, standaloneEnable or disable multicast snooping. - Format: boolean - Valid values: true/yes/on, false/no/offEnable or disable RSTP. - Format: boolean - Valid values: true/yes/on, false/no/offEnable or disable STP. - Format: boolean - Valid values: true/yes/on, false/no/offovs-dpdk settingOvsDpdk Link Settings. - Properties: - Open vSwitch DPDK device arguments. - Format: stringOpen vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue. - Format: integer - Valid values: 0 - 4294967295The 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. - Format: integer - Valid values: 0 - 4096The 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. - Format: integer - Valid values: 0 - 4096ovs-interface settingOpen vSwitch Interface Settings. - Properties: - 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. - Format: integer - Valid values: 0 - 65279The interface type. Either "internal", "system", "patch", "dpdk", or empty. - Format: string - Valid values: internal, system, patch, dpdkovs-patch settingOvsPatch Link Settings. - Properties: - 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. - Format: stringovs-port settingOvsPort Link Settings. - Properties: - The time port must be inactive in order to be considered down. - Format: integer - Valid values: 0 - 4294967295Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp". - Format: string - Valid values: active-backup, balance-slb, balance-tcpThe time port must be active before it starts forwarding traffic. - Format: integer - Valid values: 0 - 4294967295LACP mode. One of "active", "off", or "passive". - Format: string - Valid values: active, off, passiveThe VLAN tag in the range 0-4095. - Format: integer - Valid values: 0 - 4095A list of VLAN ranges that this port trunks.The property is valid only for ports with mode "trunk", "native-tagged", or "native-untagged port". If it is empty, the port trunks all VLANs. - Format: list of ovs-port.trunks objectsThe VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset. - Format: string - Valid values: access, native-tagged, native-untagged, trunk, dot1q-tunnelppp settingPoint-to-Point Protocol Settings. - Properties: - 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. - Format: integer - Valid values: 0 - 4294967295If 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. - Format: boolean - Valid values: true/yes/on, false/no/offIf 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. - Format: integer - Valid values: 0 - 4294967295If 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. - Format: integer - Valid values: 0 - 4294967295If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE. - Format: boolean - Valid values: true/yes/on, false/no/offIf 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. - Format: integer - Valid values: 0 - 16384If non-zero, instruct pppd to send packets no larger than the specified size. - Format: integer - Special values: autoIf TRUE, Van Jacobsen TCP header compression will not be requested. - Format: boolean - Valid values: true/yes/on, false/no/offIf 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. - Format: boolean - Valid values: true/yes/on, false/no/offIf TRUE, BSD compression will not be requested. - Format: boolean - Valid values: true/yes/on, false/no/offIf TRUE, "deflate" compression will not be requested. - Format: boolean - Valid values: true/yes/on, false/no/offIf TRUE, the CHAP authentication method will not be used. - Format: boolean - Valid values: true/yes/on, false/no/offIf TRUE, the EAP authentication method will not be used. - Format: boolean - Valid values: true/yes/on, false/no/offIf TRUE, the MSCHAP authentication method will not be used. - Format: boolean - Valid values: true/yes/on, false/no/offIf TRUE, the MSCHAPv2 authentication method will not be used. - Format: boolean - Valid values: true/yes/on, false/no/offIf TRUE, the PAP authentication method will not be used. - Format: boolean - Valid values: true/yes/on, false/no/offIf 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. - Format: boolean - Valid values: true/yes/on, false/no/offIf 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. - Format: boolean - Valid values: true/yes/on, false/no/offpppoe settingPPP-over-Ethernet Settings. - Properties: - - Alias: parentIf 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. - Format: string - Alias: passwordPassword used to authenticate with the PPPoE service. - Format: stringFlags indicating how to handle the "password" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4) - Alias: serviceIf 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. - Format: string - Alias: usernameUsername used to authenticate with the PPPoE service. - Format: stringproxy settingWWW Proxy Settings. - Properties: - - Alias: browser-onlyWhether the proxy configuration is for browser only. - Format: boolean - Valid values: true/yes/on, false/no/off - Alias: methodMethod for proxy configuration, Default is "none" (0) - Format: choice (NMSettingProxyMethod) - Valid values: none (0), auto (1) - Alias: pac-scriptThe 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. - Format: string - Alias: pac-urlPAC URL for obtaining PAC file. - Format: stringserial settingSerial Link Settings. - Properties: - 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. - Format: integer - Valid values: 0 - 4294967295Byte-width of the serial communication. The 8 in "8n1" for example. - Format: integer - Valid values: 5 - 8Parity setting of the serial port. - Format: choice (NMSettingSerialParity) - Valid values: none/N/n (0), even/E/e (1), odd/O/o (2)Time to delay between each byte sent to the modem, in microseconds. - Format: integer - Valid values: 0 - 18446744073709551615Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example. - Format: integer - Valid values: 1 - 2sriov settingSR-IOV settings. - Properties: - Whether to autoprobe virtual functions by a compatible driver.If set to "true" (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF.If set to "false" (0), VFs will not be claimed and no network interfaces will be created for them.When set to "default" (-1), the global default is used; in case the global default is unspecified it is assumed to be "true" (1). - Format: ternary - Valid values: true/yes/on, false/no/off, default/unknownSelect the eswitch encapsulation support.Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.If set to "preserve" (-1) (default) the eswitch encap-mode won't be modified by NetworkManager. - Format: choice (NMSriovEswitchEncapMode) - Valid values: preserve (-1), none (0), basic (1)Select the eswitch inline-mode of the device. Some HWs need the VF driver to put part of the packet headers on the TX descriptor so the e-switch can do proper matching and steering.Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.If set to "preserve" (-1) (default) the eswitch inline-mode won't be modified by NetworkManager. - Format: choice (NMSriovEswitchInlineMode) - Valid values: preserve (-1), none (0), link (1), network (2), transport (3)Select the eswitch mode of the device. Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.If set to "preserve" (-1) (default) the eswitch mode won't be modified by NetworkManager. - Format: choice (NMSriovEswitchMode) - Valid values: preserve (-1), legacy (0), switchdev (1)The total number of virtual functions to create.Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection. - Format: integer - Valid values: 0 - 4294967295Array of virtual function descriptors.Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF.When represented as string a VF is in the form:"INDEX [ATTR=VALUE[ ATTR=VALUE]...]".for example:"2 mac=00:11:22:33:44:55 spoof-check=true".Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans.The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form"ID[.PRIORITY[.PROTO]]".PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad. - Format: list of sriov.vfs objectstc settingLinux Traffic Control Settings. - Properties: - -Array of TC queueing disciplines. qdisc is a basic block in the -Linux traffic control subsystem - - Each qdisc can be specified by the following attributes: - - - handle HANDLE - - - specifies the qdisc handle. A qdisc, which potentially can have children, gets - assigned a major number, called a 'handle', leaving the minor number namespace - available for classes. The handle is expressed as '10:'. It is customary to - explicitly assign a handle to qdiscs expected to have children. - - - - - parent HANDLE - - - specifies the handle of the parent qdisc the current qdisc must be - attached to. - - - - - root - - - specifies that the qdisc is attached to the root of device. - - - - - KIND - - - this is the qdisc kind. NetworkManager currently supports the - following kinds: fq_codel, sfq, tbf. Each qdisc kind has a - different set of parameters, described below. There are also some - kinds like pfifo, pfifo_fast, prio supported by NetworkManager - but their parameters are not supported by NetworkManager. - - - - - Parameters for 'fq_codel': - - - limit U32 - - - the hard limit on the real queue size. When this limit is - reached, incoming packets are dropped. Default is 10240 packets. - - - - - memory_limit U32 - - - sets a limit on the total number of bytes that can be queued in - this FQ-CoDel instance. The lower of the packet limit of the - limit parameter and the memory limit will be enforced. Default is - 32 MB. - - - - - flows U32 - - - the number of flows into which the incoming packets are - classified. Due to the stochastic nature of hashing, multiple - flows may end up being hashed into the same slot. Newer flows - have priority over older ones. This parameter can be set only at - load time since memory has to be allocated for the hash table. - Default value is 1024. - - - - - target U32 - - - the acceptable minimum standing/persistent queue delay. This minimum - delay is identified by tracking the local minimum queue delay that packets - experience. The unit of measurement is microsecond(us). Default value is 5ms. - - - - - interval U32 - - - used to ensure that the measured minimum delay does not become too stale. - The minimum delay must be experienced in the last epoch of length .B - interval. It should be set on the order of the worst-case RTT - through the bottleneck to give endpoints sufficient time to - react. Default value is 100ms. - - - - - quantum U32 - - - the number of bytes used as 'deficit' in the fair queuing - algorithm. Default is set to 1514 bytes which corresponds to the - Ethernet MTU plus the hardware header length of 14 bytes. - - - - - ecn BOOL - - - can be used to mark packets instead of dropping them. ecn is turned - on by default. - - - - - ce_threshold U32 - - - sets a threshold above which all packets are marked with ECN - Congestion Experienced. This is useful for DCTCP-style congestion - control algorithms that require marking at very shallow queueing - thresholds. - - - - - Parameters for 'sfq': - - - divisor U32 - - - can be used to set a different hash table size, available - from kernel 2.6.39 onwards. The specified divisor must be - a power of two and cannot be larger than 65536. - Default value: 1024. - - - - - limit U32 - - - Upper limit of the SFQ. Can be used to reduce the default - length of 127 packets. - - - - - depth U32 - - - Limit of packets per flow. Default to - 127 and can be lowered. - - - - - perturb_period U32 - - - Interval in seconds for queue algorithm perturbation. - Defaults to 0, which means that no perturbation occurs. Do - not set too low for each perturbation may cause some - packet reordering or losses. Advised value: 60 This value - has no effect when external flow classification is used. - Its better to increase divisor value to lower risk of hash - collisions. - - - - - quantum U32 - - - Amount of bytes a flow is allowed to dequeue during a - round of the round robin process. Defaults to the MTU of - the interface which is also the advised value and the - minimum value. - - - - - flows U32 - - - Default value is 127. - - - - - Parameters for 'tbf': - - - rate U64 - - - Bandwidth or rate. These parameters accept a floating - point number, possibly followed by either a unit (both SI - and IEC units supported), or a float followed by a percent - character to specify the rate as a percentage of the - device's speed. - - - - - burst U32 - - - Also known as buffer or maxburst. Size of the bucket, in - bytes. This is the maximum amount of bytes that tokens can - be available for instantaneously. In general, larger - shaping rates require a larger buffer. For 10mbit/s on - Intel, you need at least 10kbyte buffer if you want to - reach your configured rate! - - - If your buffer is too small, packets may be dropped - because more tokens arrive per timer tick than fit in your - bucket. The minimum buffer size can be calculated by - dividing the rate by HZ. - - - Token usage calculations are performed using a table which - by default has a resolution of 8 packets. This resolution - can be changed by specifying the cell size with the burst. - For example, to specify a 6000 byte buffer with a 16 byte - cell size, set a burst of 6000/16. You will probably never - have to set this. Must be an integral power of 2. - - - - - limit U32 - - - Limit is the number of bytes that can be queued waiting - for tokens to become available. - - - - - latency U32 - - - specifies the maximum amount of time a packet can - sit in the TBF. The latency calculation takes into account - the size of the bucket, the rate and possibly the peakrate - (if set). The latency and limit are mutually exclusive. - - - - - Format: list of tc.qdiscs objects - Array of TC traffic filters. Traffic control can manage the packet content during - classification by using filters. - - Each tfilters can be specified by the following attributes: - - - handle HANDLE - - - specifies the tfilters handle. A filter is used by a classful qdisc to determine in which class - a packet will be enqueued. It is important to notice that filters reside within qdiscs. Therefore, - see qdiscs handle for detailed information. - - - - - parent HANDLE - - - specifies the handle of the parent qdisc the current qdisc must be - attached to. - - - - - root - - - specifies that the qdisc is attached to the root of device. - - - - - KIND - - - this is the tfilters kind. NetworkManager currently supports - following kinds: mirred, simple. Each filter kind has a - different set of actions, described below. There are also some - other kinds like matchall, basic, u32 supported by NetworkManager. - - - - - Actions for 'mirred': - - - egress bool - - - Define whether the packet should exit from the interface. - - - - - ingress bool - - - Define whether the packet should come into the interface. - - - - - mirror bool - - - Define whether the packet should be copied to the destination space. - - - - - redirect bool - - - Define whether the packet should be moved to the destination space. - - - - - Action for 'simple': - - - sdata char[32] - - - The actual string to print. - - - - - Format: list of tc.tfilters objectsteam settingTeaming Settings. - Properties: - - Alias: configThe 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. - Format: stringLink 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. - Format: list of team.link-watchers objectsCorresponds to the teamd mcast_rejoin.count. - Format: integer - Valid values: -2147483648 - 2147483647 - Special values: unset (-1), disabled (0)Corresponds to the teamd mcast_rejoin.interval. - Format: integer - Valid values: -2147483648 - 2147483647 - Special values: unset (-1), default (0)Corresponds to the teamd notify_peers.count. - Format: integer - Valid values: -2147483648 - 2147483647 - Special values: unset (-1), disabled (0)Corresponds to the teamd notify_peers.interval. - Format: integer - Valid values: -2147483648 - 2147483647 - Special values: unset (-1), default (0)Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random". - Format: string - Valid values: broadcast, roundrobin, random, activebackup, loadbalance, lacpCorresponds to the teamd runner.active. - Format: boolean - Valid values: true/yes/on, false/no/offCorresponds to the teamd runner.agg_select_policy. - Format: string - Valid values: lacp_prio, lacp_prio_stable, bandwidth, count, port_configCorresponds to the teamd runner.fast_rate. - Format: boolean - Valid values: true/yes/on, false/no/offCorresponds to the teamd runner.hwaddr_policy. - Format: string - Valid values: same_all, by_active, only_activeCorresponds to the teamd runner.min_ports. - Format: integer - Valid values: -2147483648 - 2147483647 - Special values: unset (-1), default (1)Corresponds to the teamd runner.sys_prio. - Format: integer - Valid values: -2147483648 - 2147483647 - Special values: unset (-1), default (65535)Corresponds to the teamd runner.tx_balancer.name. - Format: string - Valid values: basicCorresponds to the teamd runner.tx_balancer.interval. - Format: integer - Valid values: -2147483648 - 2147483647 - Special values: unset (-1), default (50)Corresponds to the teamd runner.tx_hash. - Format: list of strings - Valid values: eth, vlan, ipv4, ipv6, ip, l3, tcp, udp, sctp, l4team-port settingTeam Port Settings. - Properties: - - Alias: configThe 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. - Format: stringCorresponds to the teamd ports.PORTIFNAME.lacp_key. - Format: integer - Valid values: -2147483648 - 2147483647 - Special values: unset (-1), default (0)Corresponds to the teamd ports.PORTIFNAME.lacp_prio. - Format: integer - Valid values: -2147483648 - 2147483647 - Special values: unset (-1), default (255)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. - Format: list of team-port.link-watchers objectsCorresponds to the teamd ports.PORTIFNAME.prio. - Format: integer - Valid values: -2147483648 - 2147483647 - Special values: unset (0), default (0)Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config. - Format: integer - Valid values: -2147483648 - 2147483647 - Special values: unset (-1), default (0)Corresponds to the teamd ports.PORTIFNAME.sticky. - Format: boolean - Valid values: true/yes/on, false/no/offtun settingTunnel Settings. - Properties: - - Alias: groupThe group ID which will own the device. If set to NULL everyone will be able to use the device. - Format: string - Alias: modeThe operating mode of the virtual device. Allowed values are "tun" (1) to create a layer 3 device and "tap" (2) to create an Ethernet-like layer 2 one. - Format: choice (NMSettingTunMode) - Valid values: tun (1), tap (2) - Alias: multi-queueIf 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. - Format: boolean - Valid values: true/yes/on, false/no/off - Alias: ownerThe user ID which will own the device. If set to NULL everyone will be able to use the device. - Format: string - Alias: piIf TRUE the interface will prepend a 4 byte header describing the physical interface to the packets. - Format: boolean - Valid values: true/yes/on, false/no/off - Alias: vnet-hdrIf TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header. - Format: boolean - Valid values: true/yes/on, false/no/offvlan settingVLAN Settings. - Properties: - - Alias: egressFor 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". - Format: list of vlan.egress-priority-map objects - Alias: flagsOne or more flags which control the behavior and features of the VLAN interface. Flags include "reorder-headers" (0x1) (reordering of output packet headers), "gvrp" (0x2) (use of the GVRP protocol), and "loose-binding" (0x4) (loose binding of the interface to its master device's operating state). "mvrp" (0x8) (use of the MVRP protocol).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. - Format: flags (NMVlanFlags) - Valid values: reorder-headers (0x1), gvrp (0x2), loose-binding (0x4), mvrp (0x8) - Alias: idThe 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. - Format: integer - Valid values: 0 - 4095 - Alias: ingressFor 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". - Format: list of vlan.ingress-priority-map objects - Alias: devIf 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. - Format: stringSpecifies the VLAN protocol to use for encapsulation.Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'. - Format: string - Valid values: 802.1Q, 802.1advpn settingVPN Settings. - Properties: - Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings. - Format: list of key/value optionsIf 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. - Format: boolean - Valid values: true/yes/on, false/no/offDictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings. - Format: list of key/value options - Alias: vpn-typeD-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. - Format: stringTimeout 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. - Format: integer - Valid values: 0 - 4294967295 - Alias: userIf 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. - Format: stringvrf settingVRF settings. - Properties: - - Alias: tableThe routing table for this VRF. - Format: integer - Valid values: 0 - 4294967295vxlan settingVXLAN Settings. - Properties: - Specifies the lifetime in seconds of FDB entries learnt by the kernel. - Format: integer - Valid values: 0 - 4294967295 - Alias: destination-portSpecifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint. - Format: integer - Valid values: 0 - 65535 - Alias: idSpecifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use. - Format: integer - Valid values: 0 - 16777215Specifies whether netlink LL ADDR miss notifications are generated. - Format: boolean - Valid values: true/yes/on, false/no/offSpecifies whether netlink IP ADDR miss notifications are generated. - Format: boolean - Valid values: true/yes/on, false/no/offSpecifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database. - Format: boolean - Valid values: true/yes/on, false/no/offSpecifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries. - Format: integer - Valid values: 0 - 4294967295 - Alias: localIf given, specifies the source IP address to use in outgoing packets. - Format: string - Alias: devIf given, specifies the parent interface name or parent connection UUID. - Format: stringSpecifies whether ARP proxy is turned on. - Format: boolean - Valid values: true/yes/on, false/no/off - Alias: remoteSpecifies 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. - Format: stringSpecifies whether route short circuit is turned on. - Format: boolean - Valid values: true/yes/on, false/no/off - Alias: source-port-maxSpecifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint. - Format: integer - Valid values: 0 - 65535 - Alias: source-port-minSpecifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint. - Format: integer - Valid values: 0 - 65535Specifies the TOS value to use in outgoing packets. - Format: integer - Valid values: 0 - 255Specifies the time-to-live value to use in outgoing packets. - Format: integer - Valid values: 0 - 255wifi-p2p settingWi-Fi P2P Settings. - Properties: - - Alias: peerThe P2P device that should be connected to. Currently, this is the only way to create or join a group. - Format: MAC addressThe Wi-Fi Display (WFD) Information Elements (IEs) to set.Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client. - Format: bytesFlags indicating which mode of WPS is to be used.There's little point in changing the default setting as NetworkManager will automatically determine the best method to use. - Format: flags (NMSettingWirelessSecurityWpsMethod) - Valid values: default (0x0), disabled (0x1), auto (0x2), pbc (0x4), pin (0x8)wimax settingWiMax Settings. - Properties: - - Alias: macIf specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). - This property is deprecated since version 1.2. - WiMAX is no longer supported. - Format: string - Alias: nspNetwork Service Provider (NSP) name of the WiMAX network this connection should use. - This property is deprecated since version 1.2. - WiMAX is no longer supported. - Format: MAC address802-3-ethernet setting - Alias: ethernetWired Ethernet Settings. - Properties: - 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. - Format: ternary - Valid values: true/yes/on, false/no/off, default/unknownWhen 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. - Format: boolean - Valid values: true/yes/on, false/no/off - Alias: cloned-macIf specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address if the device has one (otherwise this is treated as "preserve"). "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address". - Format: MAC address - Special values: preserve, permanent, random, stableWhen 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. - Format: string - Valid values: half, fullWith "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered. - Format: string - Alias: macIf 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). - Format: MAC addressIf 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). - Format: list of MAC addresses - Alias: mtuIf non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames. - Format: integer - Special values: autoSpecific 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. - Format: read onlys390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems. - Format: string - Valid values: qeth, lcs, ctcDictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface. - Format: list of key/value optionsIdentifies 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. - Format: list of 802-3-ethernet.s390-subchannels objectsWhen 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. - Format: integer - Valid values: 0 - 4294967295The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of "phy" (0x2), "unicast" (0x4), "multicast" (0x8), "broadcast" (0x10), "arp" (0x20), "magic" (0x40) or the special values "default" (0x1) (to use global settings) and "ignore" (0x8000) (to disable management of Wake-on-LAN in NetworkManager). - Format: flags (NMSettingWiredWakeOnLan) - Valid values: phy (0x2), unicast (0x4), multicast (0x8), broadcast (0x10), arp (0x20), magic (0x40), default (0x1), ignore (0x8000)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. - Format: MAC addresswireguard settingWireGuard Settings. - Properties: - The use of fwmark is optional and is by default off. Setting it to 0 disables it. Otherwise, it is a 32-bit fwmark for outgoing packets.Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark. - Format: integer - Valid values: 0 - 4294967295Whether to enable special handling of the IPv4 default route. If enabled, the IPv4 default route from wireguard.peer-routes will be placed to a dedicated routing-table and two policy routing rules will be added. The fwmark number is also used as routing-table for the default-route, and if fwmark is zero, an unused fwmark/table is chosen automatically. This corresponds to what wg-quick does with Table=auto and what WireGuard calls "Improved Rule-based Routing".Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route.Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules. - Format: ternary - Valid values: true/yes/on, false/no/off, default/unknownLike ip4-auto-default-route, but for the IPv6 default route. - Format: ternary - Valid values: true/yes/on, false/no/off, default/unknownThe listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up. - Format: integer - Valid values: 0 - 65535If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation. - Format: integer - Special values: autoWhether to automatically add routes for the AllowedIPs ranges of the peers. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4.route-table and ipv6.route-table. Usually you want this automatism enabled. If FALSE, no such routes are added automatically. In this case, the user may want to configure static routes in ipv4.routes and ipv6.routes, respectively.Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically. - Format: boolean - Valid values: true/yes/on, false/no/offThe 256 bit private-key in base64 encoding. - Format: stringFlags indicating how to handle the "private-key" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)802-11-wireless setting - Alias: wifiWi-Fi Settings. - Properties: - Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from "default" (-1) only when the interface is configured in AP mode.If set to "true" (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.If set to "false" (0), devices can talk to each other.When set to "default" (-1), the global default is used; in case the global default is unspecified it is assumed to be "false" (0). - Format: ternary - Valid values: true/yes/on, false/no/off, default/unknown802.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. - Format: string - Valid values: a, bgIf specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID. - Format: MAC addressWireless 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. - Format: integer - Valid values: 0 - 4294967295 - Alias: cloned-macIf specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random", "stable" and "stable-ssid" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key. "stable-ssid" creates a hashed MAC address based on the SSID, the same as setting the stable-id to "${NETWORK_SSID}".If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address". - Format: MAC address - Special values: preserve, permanent, random, stable, stable-ssidWith "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address.If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address.If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm.If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address.If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered. - Format: stringIf TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode.In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.In AP mode, the created network does not broadcast its SSID.Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air. - Format: boolean - Valid values: true/yes/on, false/no/off - Alias: macIf 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). - Format: MAC addressA 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"). - Format: list of MAC addressesOne of "default" (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), "never" (1) (never randomize the MAC address), or "always" (2) (always randomize the MAC address). - This property is deprecated since version 1.4. - Use the "cloned-mac-address" property instead. - Format: choice (NMSettingMacRandomization) - Valid values: default (0), never (1), always (2) - Alias: modeWi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed. - Format: string - Valid values: infrastructure, adhoc, ap, mesh - Alias: mtuIf non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames. - Format: integer - Special values: autoOne of "disable" (2) (disable Wi-Fi power saving), "enable" (3) (enable Wi-Fi power saving), "ignore" (1) (don't touch currently configure setting) or "default" (0) (use the globally configured value). All other values are reserved. - Format: choice (NMSettingWirelessPowersave) - Valid values: default (0), ignore (1), disable (2), enable (3)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. - Format: read only - Alias: ssidSSID of the Wi-Fi network. Must be specified. - Format: stringThe NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of "any" (0x2), "disconnect" (0x4), "magic" (0x8), "gtk-rekey-failure" (0x10), "eap-identity-request" (0x20), "4way-handshake" (0x40), "rfkill-release" (0x80), "tcp" (0x100) or the special values "default" (0x1) (to use global settings) and "ignore" (0x8000) (to disable management of Wake-on-LAN in NetworkManager). - Format: flags (NMSettingWirelessWakeOnWLan) - Valid values: any (0x2), disconnect (0x4), magic (0x8), gtk-rekey-failure (0x10), eap-identity-request (0x20), 4way-handshake (0x40), rfkill-release (0x80), tcp (0x100), all (0x1fe), default (0x1), ignore (0x8000)802-11-wireless-security setting - Alias: wifi-secWi-Fi Security Settings. - Properties: - When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified. - Format: string - Valid values: open, shared, leapIndicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of "default" (0) (use global default value), "disable" (1) (disable FILS), "optional" (2) (enable FILS if the supplicant and the access point support it) or "required" (3) (enable FILS and fail if not supported). When set to "default" (0) and no global default is set, FILS will be optionally enabled. - Format: choice (NMSettingWirelessSecurityFils) - Valid values: default (0), disable (1), optional (2), required (3)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". - Format: list of strings - Valid values: wep40, wep104, tkip, ccmpKey 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. - Format: string - Valid values: none, ieee8021x, wpa-psk, wpa-eap, wpa-eap-suite-b-192, sae, oweThe login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap"). - Format: stringFlags indicating how to handle the "leap-password" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)The login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap"). - Format: stringA 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". - Format: list of strings - Valid values: tkip, ccmpIndicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of "default" (0) (use global default value), "disable" (1) (disable PMF), "optional" (2) (enable PMF if the supplicant and the access point support it) or "required" (3) (enable PMF and fail if not supported). When set to "default" (0) and no global default is set, PMF will be optionally enabled. - Format: choice (NMSettingWirelessSecurityPmf) - Valid values: default (0), disable (1), optional (2), required (3)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. - Format: list of strings - Valid values: wpa, rsnPre-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. - Format: stringFlags indicating how to handle the "psk" property. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties. - Format: flags (NMSettingSecretFlags) - Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)Controls the interpretation of WEP keys. Allowed values are "key" (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or "passphrase" (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key. - Format: choice (NMWepKeyType) - Valid values: unknown (0), key (1), passphrase (2)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. - Format: stringIndex 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. - Format: stringIndex 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. - Format: stringIndex 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. - Format: stringWhen 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. - Format: integer - Valid values: 0 - 3Flags indicating which mode of WPS is to be used if any.There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities.WPS can be disabled by setting this property to a value of 1. - Format: flags (NMSettingWirelessSecurityWpsMethod) - Valid values: default (0x0), disabled (0x1), auto (0x2), pbc (0x4), pin (0x8)wpan settingIEEE 802.15.4 (WPAN) MAC Settings. - Properties: - - Alias: channelIEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to". - Format: integer - Valid values: -32768 - 32767 - Special values: default (-1) - Alias: macIf specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches. - Format: WPAN MAC address - Alias: pageIEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to". - Format: integer - Valid values: -32768 - 32767 - Special values: default (-1) - Alias: pan-idIEEE 802.15.4 Personal Area Network (PAN) identifier. - Format: integer - Valid values: 0 - 65535 - Special values: unset (0xffff) - Alias: short-addrShort IEEE 802.15.4 address to be used within a restricted environment. - Format: integer - Valid values: 0 - 65535 - Special values: unset (0xffff)bond-port settingBond Port Settings. - Properties: - - Alias: prioThe 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. - Format: integer - Valid values: -2147483648 - 2147483647 - Alias: queue-idThe queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device. - Format: integer - Valid values: 0 - 65535hostname settingHostname settings. - Properties: - Whether the system hostname can be determined from DHCP on this connection.When set to "default" (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be "true" (1). - Format: ternary - Valid values: true/yes/on, false/no/off, default/unknownWhether the system hostname can be determined from reverse DNS lookup of addresses on this device.When set to "default" (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be "true" (1). - Format: ternary - Valid values: true/yes/on, false/no/off, default/unknownIf set to "true" (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6).If set to "false" (0), the hostname can be set from this device even if it doesn't have the default route.When set to "default" (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be "false" (0). - Format: ternary - Valid values: true/yes/on, false/no/off, default/unknownThe relative priority of this connection to determine the system hostname. A lower numerical value is better (higher priority). A connection with higher priority is considered before connections with lower priority.If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100.Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname. - Format: integer - Valid values: -2147483648 - 2147483647hsr settingHSR/PRP Settings. - Properties: - - Alias: multicast-specThe last byte of supervision address. - Format: integer - Valid values: 0 - 255 - Alias: port1The port1 interface name of the HSR. This property is mandatory. - Format: string - Alias: port2The port2 interface name of the HSR. This property is mandatory. - Format: stringThe protocol used by the interface, whether it is PRP or HSR. - Format: boolean - Valid values: true/yes/on, false/no/offlink settingLink settings. - Properties: - 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. - Format: integer - Valid values: -1 - 4294967295 - Special values: default (-1)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. - Format: integer - Valid values: -1 - 4294967295 - Special values: default (-1)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. - Format: integer - Valid values: -1 - 4294967295 - Special values: default (-1)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. - Format: integer - Valid values: -1 - 4294967295 - Special values: default (-1)loopback settingLoopback Link Settings. - Properties: - - Alias: mtuIf non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames. - Format: integer - Special values: autoveth settingVeth Settings. - Properties: - - Alias: peerThis property specifies the peer interface name of the veth. This property is mandatory. - Format: stringSecret flag types: - Each password or secret property in a setting has an associated flags property - that describes how to handle that secret. The flags property is a bitfield - that contains zero or more of the following values logically OR-ed together. - 0x0 (none) - the system is responsible for providing and storing this secret. This - may be required so that secrets are already available before the user logs in. - It also commonly means that the secret will be stored in plain text on disk, accessible - to root only. For example via the keyfile settings plugin as described in the "PLUGINS" section - in NetworkManager.conf5. - 0x1 (agent-owned) - a user-session secret agent is responsible for providing and storing - this secret; when it is required, agents will be asked to provide it.0x2 (not-saved) - this secret should not be saved but should be requested from the user - each time it is required. This flag should be used for One-Time-Pad secrets, PIN codes from hardware tokens, - or if the user simply does not want to save the secret.0x4 (not-required) - in some situations it cannot be automatically determined that a secret - is required or not. This flag hints that the secret is not required and should not be requested from the user.Files/etc/NetworkManager/system-connections or distro plugin-specific locationSee Alsonmcli1, - nmcli-examples7, - NetworkManager8, - nm-settings-dbus5, - nm-settings-keyfile5, - NetworkManager.conf5 diff --git a/man/nm-settings-nmcli.xsl b/man/nm-settings-nmcli.xsl index 794ee507..2f1d035c 100644 --- a/man/nm-settings-nmcli.xsl +++ b/man/nm-settings-nmcli.xsl @@ -8,8 +8,8 @@ diff --git a/man/nmcli-examples.7 b/man/nmcli-examples.7 index 68b24fa3..7e1ed352 100644 --- a/man/nmcli-examples.7 +++ b/man/nmcli-examples.7 @@ -2,12 +2,12 @@ .\" Title: nmcli-examples .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: Examples -.\" Source: NetworkManager 1.46.0 +.\" Source: NetworkManager 1.47.90 .\" Language: English .\" -.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.46\&.0" "Examples" +.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.47\&.90" "Examples" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml index 2c7e16ab..5249d6ba 100644 --- a/man/nmcli-examples.xml +++ b/man/nmcli-examples.xml @@ -1,7 +1,7 @@ - %entities; ]> diff --git a/man/nmcli.1 b/man/nmcli.1 index 5bd86fb3..13c54eef 100644 --- a/man/nmcli.1 +++ b/man/nmcli.1 @@ -2,12 +2,12 @@ .\" Title: nmcli .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.46.0 +.\" Source: NetworkManager 1.47.90 .\" Language: English .\" -.TH "NMCLI" "1" "" "NetworkManager 1\&.46\&.0" "General Commands Manual" +.TH "NMCLI" "1" "" "NetworkManager 1\&.47\&.90" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nmcli.xml b/man/nmcli.xml index 6b3054c3..62994047 100644 --- a/man/nmcli.xml +++ b/man/nmcli.xml @@ -1,7 +1,7 @@ - %entities; ]> diff --git a/man/nmtui.1 b/man/nmtui.1 index 4d58cadc..21693d91 100644 --- a/man/nmtui.1 +++ b/man/nmtui.1 @@ -2,12 +2,12 @@ .\" Title: nmtui .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 02/22/2024 +.\" Date: 05/03/2024 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.46.0 +.\" Source: NetworkManager 1.47.90 .\" Language: English .\" -.TH "NMTUI" "1" "" "NetworkManager 1\&.46\&.0" "General Commands Manual" +.TH "NMTUI" "1" "" "NetworkManager 1\&.47\&.90" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nmtui.xml b/man/nmtui.xml index f610be9d..eac94ab0 100644 --- a/man/nmtui.xml +++ b/man/nmtui.xml @@ -1,7 +1,7 @@ - %entities; ]> -- cgit 1.3.0-6-gf8a5