diff options
Diffstat (limited to 'man/nm-settings.5')
| -rw-r--r-- | man/nm-settings.5 | 66 |
1 files changed, 48 insertions, 18 deletions
diff --git a/man/nm-settings.5 b/man/nm-settings.5 index 07ccd4b3..10c88c20 100644 --- a/man/nm-settings.5 +++ b/man/nm-settings.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 03/12/2018 +.\" Date: 04/23/2018 .\" Manual: Configuration -.\" Source: NetworkManager 1.10.6 +.\" Source: NetworkManager 1.11.3 .\" Language: English .\" -.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.10\&.6" "Configuration" +.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.11\&.3" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -94,6 +94,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 @@ -111,7 +112,7 @@ boolean T}:T{ TRUE T}:T{ -Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available\&. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection\&. +Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available\&. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection\&. Note that autoconnect is not implemented for VPN profiles\&. See "secondaries" as an alternative to automatically connect VPN profiles\&. T} T{ autoconnect\-priority @@ -138,7 +139,7 @@ NMSettingConnectionAutoconnectSlaves (int32) 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 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\&. +Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection\&. This only has a real effect for master connections\&. The properties "autoconnect", "autoconnect\-priority" and "autoconnect\-retries" are unrelated to this setting\&. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, \-1: default\&. If \-1 (default) is set, global connection\&.autoconnect\-slaves is read to determine the real value\&. If it is default as well, this fallbacks to 0\&. T} T{ gateway\-ping\-timeout @@ -186,6 +187,15 @@ T}:T{ Interface name of the master device or UUID of the master connection\&. T} T{ +mdns +T}:T{ +int32 +T}:T{ +\-1 +T}:T{ +Whether mDNS is enabled for the connection\&. The permitted values are: yes: register hostname and resolving for the connection, no: disable mDNS for the interface, resolve: do not register hostname but allow resolving of mDNS host names\&. When updating this property on a currently activated connection, the change takes effect immediately\&. This feature requires a plugin which supports mDNS\&. One such plugin is dns\-systemd\-resolved\&. +T} +T{ metered T}:T{ NMMetered (int32) @@ -246,7 +256,7 @@ string T}:T{ \ \& T}:T{ -Token to generate stable IDs for the connection\&. 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\&. Note that also the interface name of the activating connection and a per\-host secret key is included into the address generation so that the same stable\-id on different hosts/devices yields different addresses\&. If the value is unset, an ID unique for the connection is used\&. Specifying a stable\-id allows multiple connections to generate the same addresses\&. Another use is to generate IDs at runtime via dynamic substitutions\&. The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at runtime\&. Currently supported are "${CONNECTION}", "${BOOT}", "${RANDOM}"\&. These effectively create unique IDs per\-connection, per\-boot, or every time\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}/${BOOT}" to create a unique id for this connection that changes with every reboot\&. Note that two connections only use the same effective id if their stable\-id is also identical before performing dynamic substitutions\&. +Token to generate stable IDs for the connection\&. The stable\-id is used for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. It is also used as DHCP client identifier with ipv4\&.dhcp\-client\-id=stable\&. Note that also the interface name of the activating connection and a per\-host secret key is included into the address generation so that the same stable\-id on different hosts/devices yields different addresses\&. If the value is unset, an ID unique for the connection is used\&. Specifying a stable\-id allows multiple connections to generate the same addresses\&. Another use is to generate IDs at runtime via dynamic substitutions\&. The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at runtime\&. Currently supported are "${CONNECTION}", "${BOOT}", "${RANDOM}"\&. These effectively create unique IDs per\-connection, per\-boot, or every time\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}/${BOOT}" to create a unique id for this connection that changes with every reboot\&. Note that two connections only use the same effective id if their stable\-id is also identical before performing dynamic substitutions\&. T} T{ timestamp @@ -1027,7 +1037,7 @@ byte array T}:T{ \ \& T}:T{ -If specified, the MAC address of bridge\&. When creating a new bridge, this MAC address will be set\&. If this field is left unspecified, the "ethernet\&.cloned\-mac\-address" is referred instead to generate the initial MAC address\&. Note that setting "ethernet\&.cloned\-mac\-address" anyway overwrites the MAC address of the bridge later while activating the bridge\&. Hence, this property is deprecated\&. +If specified, the MAC address of bridge\&. When creating a new bridge, this MAC address will be set\&. If this field is left unspecified, the "ethernet\&.cloned\-mac\-address" is referred instead to generate the initial MAC address\&. Note that setting "ethernet\&.cloned\-mac\-address" anyway overwrites the MAC address of the bridge later while activating the bridge\&. Hence, this property is deprecated\&. Deprecated: 1 T} T{ max\-age @@ -1321,7 +1331,7 @@ priority\-bandwidth T}:T{ array of uint32 T}:T{ -[0, 0, 0, 0, 0, 0, 0, 0] +[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L] T}:T{ An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the percentage of bandwidth of the priority\*(Aqs assigned group that the priority may use\&. The sum of all percentages for priorities which belong to the same group must total 100 percents\&. T} @@ -1330,7 +1340,7 @@ priority\-flow\-control T}:T{ array of uint32 T}:T{ -[0, 0, 0, 0, 0, 0, 0, 0] +[False, False, False, False, False, False, False, False] T}:T{ An array of 8 boolean values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates whether or not the corresponding priority should transmit priority pause\&. T} @@ -1348,7 +1358,7 @@ priority\-group\-bandwidth T}:T{ array of uint32 T}:T{ -[0, 0, 0, 0, 0, 0, 0, 0] +[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L] T}:T{ 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\&. T} @@ -1366,7 +1376,7 @@ priority\-group\-id T}:T{ array of uint32 T}:T{ -[0, 0, 0, 0, 0, 0, 0, 0] +[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L] T}:T{ 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\&. T} @@ -1375,7 +1385,7 @@ priority\-strict\-bandwidth T}:T{ array of uint32 T}:T{ -[0, 0, 0, 0, 0, 0, 0, 0] +[False, False, False, False, False, False, False, False] T}:T{ An array of 8 boolean values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group\&. T} @@ -1384,7 +1394,7 @@ priority\-traffic\-class T}:T{ array of uint32 T}:T{ -[0, 0, 0, 0, 0, 0, 0, 0] +[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L] T}:T{ An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the traffic class (0 \- 7) to which the priority is mapped\&. T} @@ -1746,7 +1756,7 @@ int32 T}:T{ \-1 T}:T{ -Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network\&. If an address conflict is detected, the activation will fail\&. A zero value means that no duplicate address detection is performed, \-1 means the default value (either configuration ipvx\&.dad\-timeout override or 3 seconds)\&. A value greater than zero is a timeout in milliseconds\&. +Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network\&. If an address conflict is detected, the activation will fail\&. A zero value means that no duplicate address detection is performed, \-1 means the default value (either configuration ipvx\&.dad\-timeout override or zero)\&. A value greater than zero is a timeout in milliseconds\&. The property is currently implemented only for IPv4\&. T} T{ dhcp\-client\-id @@ -1755,7 +1765,7 @@ string T}:T{ \ \& T}:T{ -A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options\&. When the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary client ID, in which case the first byte is assumed to be the \*(Aqtype\*(Aq field as per RFC 2132 section 9\&.14 and the remaining bytes may be an hardware address (e\&.g\&. \*(Aq01:xx:xx:xx:xx:xx:xx\*(Aq where 1 is the Ethernet ARP type and the rest is a MAC address)\&. If the property is not a hex string it is considered as a non\-hardware\-address client ID and the \*(Aqtype\*(Aq field is set to 0\&. +A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options\&. When the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary client ID, in which case the first byte is assumed to be the \*(Aqtype\*(Aq field as per RFC 2132 section 9\&.14 and the remaining bytes may be an hardware address (e\&.g\&. \*(Aq01:xx:xx:xx:xx:xx:xx\*(Aq where 1 is the Ethernet ARP type and the rest is a MAC address)\&. If the property is not a hex string it is considered as a non\-hardware\-address client ID and the \*(Aqtype\*(Aq field is set to 0\&. 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 type (01)\&. Currently, these options only work for ethernet type of links\&. The special value "stable" is supported to generate a type 0 client identifier based on the stable\-id (see connection\&.stable\-id)\&. If unset, a globally configured default is used\&. If still unset, the client\-id from the last lease is reused\&. T} T{ dhcp\-fqdn @@ -1827,7 +1837,7 @@ array of string T}:T{ [] T}:T{ -Array of DNS search domains\&. +Array of DNS search domains\&. Domains starting with a tilde (\*(Aq~\*(Aq) are considered \*(Aqrouting\*(Aq domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names\&. T} T{ gateway @@ -2004,7 +2014,7 @@ int32 T}:T{ \-1 T}:T{ -Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network\&. If an address conflict is detected, the activation will fail\&. A zero value means that no duplicate address detection is performed, \-1 means the default value (either configuration ipvx\&.dad\-timeout override or 3 seconds)\&. A value greater than zero is a timeout in milliseconds\&. +Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network\&. If an address conflict is detected, the activation will fail\&. A zero value means that no duplicate address detection is performed, \-1 means the default value (either configuration ipvx\&.dad\-timeout override or zero)\&. A value greater than zero is a timeout in milliseconds\&. The property is currently implemented only for IPv4\&. T} T{ dhcp\-hostname @@ -2067,7 +2077,7 @@ array of string T}:T{ [] T}:T{ -Array of DNS search domains\&. +Array of DNS search domains\&. Domains starting with a tilde (\*(Aq~\*(Aq) are considered \*(Aqrouting\*(Aq domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names\&. T} T{ gateway @@ -2216,6 +2226,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{ encapsulation\-limit @@ -2227,6 +2238,15 @@ T}:T{ How many additional levels of encapsulation are permitted to be prepended to packets\&. This property applies only to IPv6 tunnels\&. T} T{ +flags +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Tunnel flags\&. Currently the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20)\&. They are valid only for IPv6 tunnels\&. +T} +T{ flow\-label T}:T{ uint32 @@ -4537,6 +4557,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\-alg @@ -4548,6 +4569,15 @@ T}:T{ 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\&. T} T{ +fils +T}:T{ +int32 +T}:T{ +0 +T}:T{ +Indicates whether Fast Initial Link Setup (802\&.11ai) must be enabled for the connection\&. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported)\&. When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled\&. +T} +T{ group T}:T{ array of string |