diff options
Diffstat (limited to 'man/nm-settings-dbus.5')
| -rw-r--r-- | man/nm-settings-dbus.5 | 134 |
1 files changed, 117 insertions, 17 deletions
diff --git a/man/nm-settings-dbus.5 b/man/nm-settings-dbus.5 index c6038e9f..8aea6de6 100644 --- a/man/nm-settings-dbus.5 +++ b/man/nm-settings-dbus.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-dbus .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: Configuration -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NM\-SETTINGS\-DBUS" "5" "" "NetworkManager 1\&.42\&.8" "Configuration" +.TH "NM\-SETTINGS\-DBUS" "5" "" "NetworkManager 1\&.44\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -321,7 +321,9 @@ boolean T}:T{ FALSE T}:T{ -FALSE if the connection can be modified using the provided settings service\*(Aqs D\-Bus interface with the right privileges, or TRUE if the connection is read\-only and cannot be modified\&. +This property is deprecated and has no meaning\&. + +This property is deprecated since version 1\&.44\&.This property is deprecated and has no meaning\&. T} T{ secondaries @@ -350,13 +352,13 @@ T}:T{ T}:T{ This represents the identity of the connection used for various purposes\&. It allows to configure multiple profiles to share the identity\&. Also, the stable\-id can contain placeholders that are substituted dynamically and deterministically depending on the context\&. -The stable\-id is used for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. It is also used as DHCP client identifier with ipv4\&.dhcp\-client\-id=stable and to derive the DHCP DUID with ipv6\&.dhcp\-duid=stable\-[llt,ll,uuid]\&. +The stable\-id is used for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. It is also used to derive the DHCP client identifier with ipv4\&.dhcp\-client\-id=stable, the DHCPv6 DUID with ipv6\&.dhcp\-duid=stable\-[llt,ll,uuid] and the DHCP IAID with ipv4\&.iaid=stable and ipv6\&.iaid=stable\&. Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm\&. For example, a per\-host key is commonly also included, so that different systems end up generating different IDs\&. Or with ipv6\&.addr\-gen\-mode=stable\-privacy, also the device\*(Aqs name is included, so that different interfaces yield different addresses\&. The per\-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key\&. See NetworkManager(8) manual about the secret\-key and the host identity\&. -The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at runtime\&. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}"\&. These effectively create unique IDs per\-connection, per\-device, per\-boot, or every time\&. Note that "${DEVICE}" corresponds to the interface name of the device and "${MAC}" is the permanent MAC address of the device\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}\-${BOOT}\-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates\&. +The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at activation time\&. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}"\&. These effectively create unique IDs per\-connection, per\-device, per\-boot, or every time\&. The "${CONNECTION}" uses the profile\*(Aqs connection\&.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}\-${BOOT}\-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates\&. -If the value is unset, a global connection default is consulted\&. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection\&. +If the value is unset, a global connection default is consulted\&. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile\&. T} T{ timestamp @@ -1832,6 +1834,8 @@ l l l l l l l l l l l l l l l l +l l l l +l l l l l l l l. T{ apn @@ -1870,6 +1874,24 @@ T}:T{ When TRUE, only connections to the home network will be allowed\&. Connections to roaming networks will not be made\&. T} T{ +initial\-eps\-bearer\-apn +T}:T{ +string +T}:T{ +\ \& +T}:T{ +For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network\&. Setting this parameter implies initial\-eps\-bearer\-configure to be TRUE\&. +T} +T{ +initial\-eps\-bearer\-configure +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +For LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection\&. It is inferred TRUE if initial\-eps\-bearer\-apn is set\&. +T} +T{ mtu T}:T{ uint32 @@ -2181,7 +2203,7 @@ string T}:T{ \ \& T}:T{ -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. +A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. For DHCPv4, the IAID is only used with "ipv4\&.dhcp\-client\-id" values "duid" and "ipv6\-duid" to generate the client\-id\&. @@ -2506,6 +2528,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ addr\-gen\-mode @@ -2514,15 +2537,17 @@ int32 T}:T{ 3 T}:T{ -Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration\&. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1)\&. NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3)\&. +Configure the method for creating the IPv6 interface identifier of addresses for RFC4862 IPv6 Stateless Address Autoconfiguration and IPv6 Link Local\&. -If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address\&. This makes the host part of the address to stay constant, making it possible to track host\*(Aqs presence when it changes networks\&. The address changes when the interface hardware is replaced\&. +The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1)\&. NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3)\&. -The value of stable\-privacy enables use of cryptographically secure hash of a secret host\-specific key along with the connection\*(Aqs stable\-id and the network address as specified by RFC7217\&. This makes it impossible to use the address track host\*(Aqs presence, and makes the address stable when the network interface hardware is replaced\&. +If the property is set to "eui64", the addresses will be generated using the interface token derived from the hardware address\&. This makes the host part of the address constant, making it possible to track the host\*(Aqs presence when it changes networks\&. The address changes when the interface hardware is replaced\&. If a duplicate address is detected, there is no fallback to generate another address\&. When configured, the "ipv6\&.token" is used instead of the MAC address to generate addresses for stateless autoconfiguration\&. -The special values "default" and "default\-or\-eui64" will fallback to the global connection default in as documented in NetworkManager\&.conf(5) manual\&. If the global default is not specified, the fallback value is "stable\-privacy" or "eui64", respectively\&. +If the property is set to "stable\-privacy", the interface identifier is generated as specified by RFC7217\&. This works by hashing a host specific key (see NetworkManager(8) manual), the interface name, the connection\*(Aqs "connection\&.stable\-id" property and the address prefix\&. This improves privacy by making it harder to use the address to track the host\*(Aqs presence as every prefix and network has a different identifier\&. Also, the address is stable when the network interface hardware is replaced\&. -For libnm, the property defaults to "default" since 1\&.40\&. Previously it defaulted to "stable\-privacy"\&. On D\-Bus, the absence of an addr\-gen\-mode setting equals "default"\&. For keyfile plugin, the absence of the setting on disk means "default\-or\-eui64" so that the property doesn\*(Aqt change on upgrade from older versions\&. +The special values "default" and "default\-or\-eui64" will fallback to the global connection default as documented in the NetworkManager\&.conf(5) manual\&. If the global default is not specified, the fallback value is "stable\-privacy" or "eui64", respectively\&. + +For libnm, the property defaults to "default" since 1\&.40\&. Previously it used to default to "stable\-privacy"\&. On D\-Bus, the absence of an addr\-gen\-mode setting equals "default"\&. For keyfile plugin, the absence of the setting on disk means "default\-or\-eui64" so that the property doesn\*(Aqt change on upgrade from older versions\&. Note that this setting is distinct from the Privacy Extensions as configured by "ip6\-privacy" property and it does not affect the temporary addresses configured with this option\&. T} @@ -2613,7 +2638,7 @@ string T}:T{ \ \& T}:T{ -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. +A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. For DHCPv4, the IAID is only used with "ipv4\&.dhcp\-client\-id" values "duid" and "ipv6\-duid" to generate the client\-id\&. @@ -2622,6 +2647,15 @@ For DHCPv6, note that at the moment this property is only supported by the "inte The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device\&. T} T{ +dhcp\-pd\-hint +T}:T{ +string +T}:T{ +\ \& +T}:T{ +A IPv6 address followed by a slash and a prefix length\&. If set, the value is sent to the DHCPv6 server as hint indicating the prefix delegation (IA_PD) we want to receive\&. To only hint a prefix length without prefix, set the address part to the zero address (for example "::/60")\&. +T} +T{ dhcp\-reject\-servers T}:T{ array of string @@ -2910,6 +2944,8 @@ T}:T{ \ \& T}:T{ Configure the token for draft\-chown\-6man\-tokenised\-ipv6\-identifiers\-02 IPv6 tokenized interface identifiers\&. Useful with eui64 addr\-gen\-mode\&. + +When set, the token is used as IPv6 interface identifier instead of the hardware address\&. This only applies to addresses from stateless autoconfiguration, not to IPv6 link local addresses\&. T} .TE .sp 1 @@ -5504,7 +5540,9 @@ uint32 T}:T{ 0 T}:T{ -If non\-zero, directs the device to only use the specified bitrate for communication with the access point\&. Units are in Kb/s, ie 5500 = 5\&.5 Mbit/s\&. This property is highly driver dependent and not all devices support setting a static bitrate\&. +This property is not implemented and has no effect\&. + +This property is deprecated since version 1\&.44\&.This property is not implemented and has no effect\&. T} T{ security @@ -5513,7 +5551,7 @@ T}:T{ T}:T{ \ \& T}:T{ -This property is deprecated, but can be set to the value \*(Aq802\-11\-wireless\-security\*(Aq when a wireless security setting is also present in the connection dictionary, for compatibility with very old NetworkManager daemons\&. +This property is deprecated and has no effect\&. For backwards compatibility, it can be set to "802\-11\-wireless\-security" if the profile has a wireless security setting\&. T} T{ seen\-bssids @@ -5523,6 +5561,8 @@ T}:T{ \ \& T}:T{ A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi\-Fi network\&. NetworkManager internally tracks previously seen BSSIDs\&. The property is only meant for reading and reflects the BSSID list of NetworkManager\&. The changes you make to this property will not be preserved\&. + +This is not a regular property that the user would configure\&. Instead, NetworkManager automatically sets the seen BSSIDs and tracks them internally in "/var/lib/NetworkManager/seen\-bssids" file\&. T} T{ ssid @@ -5540,7 +5580,9 @@ uint32 T}:T{ 0 T}:T{ -If non\-zero, directs the device to use the specified transmit power\&. Units are dBm\&. This property is highly driver dependent and not all devices support setting a static transmit power\&. +This property is not implemented and has no effect\&. + +This property is deprecated since version 1\&.44\&.This property is not implemented and has no effect\&. T} T{ wake\-on\-wlan @@ -5953,6 +5995,64 @@ Negative values have the special effect of excluding other connections with a gr T} .TE .sp 1 +.SS "link setting" +.PP +Link settings\&. +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l +l l l l +l l l l +l l l l. +T{ +gro\-max\-size +T}:T{ +int64 +T}:T{ +\-1 +T}:T{ +The maximum size of a packet built by the Generic Receive Offload stack for this device\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. +T} +T{ +gso\-max\-segments +T}:T{ +int64 +T}:T{ +\-1 +T}:T{ +The maximum segments of a Generic Segment Offload packet the device should accept\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. +T} +T{ +gso\-max\-size +T}:T{ +int64 +T}:T{ +\-1 +T}:T{ +The maximum size of a Generic Segment Offload packet the device should accept\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. +T} +T{ +tx\-queue\-length +T}:T{ +int64 +T}:T{ +\-1 +T}:T{ +The size of the transmit queue for the device, in number of packets\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. +T} +.TE +.sp 1 .SS "loopback setting" .PP Loopback Link Settings\&. |