diff options
Diffstat (limited to 'man/nm-settings-nmcli.5')
| -rw-r--r-- | man/nm-settings-nmcli.5 | 1416 |
1 files changed, 833 insertions, 583 deletions
diff --git a/man/nm-settings-nmcli.5 b/man/nm-settings-nmcli.5 index 8fedd64b..bbc6645f 100644 --- a/man/nm-settings-nmcli.5 +++ b/man/nm-settings-nmcli.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-nmcli .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 06/28/2023 +.\" Date: 08/09/2023 .\" Manual: Configuration -.\" Source: NetworkManager 1.42.8 +.\" Source: NetworkManager 1.44.0 .\" Language: English .\" -.TH "NM\-SETTINGS\-NMCLI" "5" "" "NetworkManager 1\&.42\&.8" "Configuration" +.TH "NM\-SETTINGS\-NMCLI" "5" "" "NetworkManager 1\&.44\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -68,7 +68,7 @@ General Connection Profile Settings\&. .PP Properties: .PP -\fBauth\-retries\fR +\fBconnection\&.auth\-retries\fR .RS 4 The number of retries for the authentication\&. Zero means to try indefinitely; \-1 means to use a global default\&. If the global default is not set, the authentication retries for 3 times before failing the connection\&. .sp @@ -77,7 +77,7 @@ Currently, this only applies to 802\-1x authentication\&. Format: int32 .RE .PP -\fBautoconnect\fR +\fBconnection\&.autoconnect\fR .RS 4 Alias: autoconnect .sp @@ -94,28 +94,28 @@ Depending on "connection\&.multi\-connect", a profile can (auto)connect only onc Format: boolean .RE .PP -\fBautoconnect\-priority\fR +\fBconnection\&.autoconnect\-priority\fR .RS 4 The autoconnect priority in range \-999 to 999\&. If the connection is set to autoconnect, connections with higher priority will be preferred\&. The higher number means higher priority\&. Defaults to 0\&. Note that this property only matters if there are more than one candidate profile to select for autoconnect\&. In case of equal priority, the profile used most recently is chosen\&. .sp Format: int32 .RE .PP -\fBautoconnect\-retries\fR +\fBconnection\&.autoconnect\-retries\fR .RS 4 The number of times a connection should be tried when autoactivating before giving up\&. Zero means forever, \-1 means the global default (4 times if not overridden)\&. Setting this to 1 means to try activation only once before blocking autoconnect\&. Note that after a timeout, NetworkManager will try to autoconnect again\&. .sp Format: int32 .RE .PP -\fBautoconnect\-slaves\fR +\fBconnection\&.autoconnect\-slaves\fR .RS 4 Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection\&. This only has a real effect for master connections\&. The properties "autoconnect", "autoconnect\-priority" and "autoconnect\-retries" are unrelated to this setting\&. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, \-1: default\&. If \-1 (default) is set, global connection\&.autoconnect\-slaves is read to determine the real value\&. If it is default as well, this fallbacks to 0\&. .sp Format: NMSettingConnectionAutoconnectSlaves (int32) .RE .PP -\fBdns\-over\-tls\fR +\fBconnection\&.dns\-over\-tls\fR .RS 4 Whether DNSOverTls (dns\-over\-tls) is enabled for the connection\&. DNSOverTls is a technology which uses TLS to encrypt dns traffic\&. .sp @@ -126,14 +126,14 @@ This feature requires a plugin which supports DNSOverTls\&. Otherwise, the setti Format: int32 .RE .PP -\fBgateway\-ping\-timeout\fR +\fBconnection\&.gateway\-ping\-timeout\fR .RS 4 If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping\&. .sp Format: uint32 .RE .PP -\fBid\fR +\fBconnection\&.id\fR .RS 4 Alias: con\-name .sp @@ -142,7 +142,7 @@ A human readable unique identifier for the connection, like "Work Wi\-Fi" or "T\ Format: string .RE .PP -\fBinterface\-name\fR +\fBconnection\&.interface\-name\fR .RS 4 Alias: ifname .sp @@ -155,14 +155,14 @@ For connection types where interface names cannot easily be made persistent (e\& Format: string .RE .PP -\fBlldp\fR +\fBconnection\&.lldp\fR .RS 4 Whether LLDP is enabled for the connection\&. .sp Format: int32 .RE .PP -\fBllmnr\fR +\fBconnection\&.llmnr\fR .RS 4 Whether Link\-Local Multicast Name Resolution (LLMNR) is enabled for the connection\&. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link\&. .sp @@ -173,7 +173,7 @@ This feature requires a plugin which supports LLMNR\&. Otherwise, the setting ha Format: int32 .RE .PP -\fBmaster\fR +\fBconnection\&.master\fR .RS 4 Alias: master .sp @@ -182,7 +182,7 @@ Interface name of the master device or UUID of the master connection\&. Format: string .RE .PP -\fBmdns\fR +\fBconnection\&.mdns\fR .RS 4 Whether mDNS is enabled for the connection\&. .sp @@ -193,7 +193,7 @@ This feature requires a plugin which supports mDNS\&. Otherwise, the setting has Format: int32 .RE .PP -\fBmetered\fR +\fBconnection\&.metered\fR .RS 4 Whether the connection is metered\&. .sp @@ -202,7 +202,7 @@ When updating this property on a currently activated connection, the change take Format: NMMetered (int32) .RE .PP -\fBmptcp\-flags\fR +\fBconnection\&.mptcp\-flags\fR .RS 4 Whether to configure MPTCP endpoints and the address flags\&. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints\&. Note that IPv4 loopback addresses (127\&.0\&.0\&.0/8), IPv4 link local addresses (169\&.254\&.0\&.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6\&.ip6\-privacy) will be excluded from being configured as endpoints\&. .sp @@ -225,7 +225,7 @@ Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when M Format: uint32 .RE .PP -\fBmud\-url\fR +\fBconnection\&.mud\-url\fR .RS 4 If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer\-recommended network policies for IoT devices\&. It is transmitted as a DHCPv4 or DHCPv6 option\&. The value must be a valid URL starting with "https://"\&. .sp @@ -236,14 +236,14 @@ If the per\-profile value is unspecified (the default), a global connection defa Format: string .RE .PP -\fBmulti\-connect\fR +\fBconnection\&.multi\-connect\fR .RS 4 Specifies whether the profile can be active multiple times at a particular moment\&. The value is of type NMConnectionMultiConnect\&. .sp Format: int32 .RE .PP -\fBpermissions\fR +\fBconnection\&.permissions\fR .RS 4 An array of strings defining what access a given user has to this connection\&. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list\&. When this is not empty, the connection can be active only when one of the specified users is logged into an active session\&. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah"\&. .sp @@ -252,21 +252,14 @@ At this time only the "user" [type] is allowed\&. Any other values are ignored a Format: array of string .RE .PP -\fBread\-only\fR -.RS 4 -FALSE if the connection can be modified using the provided settings service\*(Aqs D\-Bus interface with the right privileges, or TRUE if the connection is read\-only and cannot be modified\&. -.sp -Format: boolean -.RE -.PP -\fBsecondaries\fR +\fBconnection\&.secondaries\fR .RS 4 List of connection UUIDs that should be activated when the base connection itself is activated\&. Currently, only VPN connections are supported\&. .sp Format: array of string .RE .PP -\fBslave\-type\fR +\fBconnection\&.slave\-type\fR .RS 4 Alias: slave\-type .sp @@ -275,22 +268,22 @@ Setting name of the device type of this slave\*(Aqs master connection (eg, "bond Format: string .RE .PP -\fBstable\-id\fR +\fBconnection\&.stable\-id\fR .RS 4 This represents the identity of the connection used for various purposes\&. It allows to configure multiple profiles to share the identity\&. Also, the stable\-id can contain placeholders that are substituted dynamically and deterministically depending on the context\&. .sp -The stable\-id is used for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. It is also used as DHCP client identifier with ipv4\&.dhcp\-client\-id=stable and to derive the DHCP DUID with ipv6\&.dhcp\-duid=stable\-[llt,ll,uuid]\&. +The stable\-id is used for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. It is also used to derive the DHCP client identifier with ipv4\&.dhcp\-client\-id=stable, the DHCPv6 DUID with ipv6\&.dhcp\-duid=stable\-[llt,ll,uuid] and the DHCP IAID with ipv4\&.iaid=stable and ipv6\&.iaid=stable\&. .sp Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm\&. For example, a per\-host key is commonly also included, so that different systems end up generating different IDs\&. Or with ipv6\&.addr\-gen\-mode=stable\-privacy, also the device\*(Aqs name is included, so that different interfaces yield different addresses\&. The per\-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key\&. See NetworkManager(8) manual about the secret\-key and the host identity\&. .sp -The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at runtime\&. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}"\&. These effectively create unique IDs per\-connection, per\-device, per\-boot, or every time\&. Note that "${DEVICE}" corresponds to the interface name of the device and "${MAC}" is the permanent MAC address of the device\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}\-${BOOT}\-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates\&. +The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at activation time\&. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}"\&. These effectively create unique IDs per\-connection, per\-device, per\-boot, or every time\&. The "${CONNECTION}" uses the profile\*(Aqs connection\&.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}\-${BOOT}\-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates\&. .sp -If the value is unset, a global connection default is consulted\&. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection\&. +If the value is unset, a global connection default is consulted\&. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile\&. .sp Format: string .RE .PP -\fBtimestamp\fR +\fBconnection\&.timestamp\fR .RS 4 The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated\&. .sp @@ -299,7 +292,7 @@ NetworkManager updates the connection timestamp periodically when the connection Format: uint64 .RE .PP -\fBtype\fR +\fBconnection\&.type\fR .RS 4 Alias: type .sp @@ -308,16 +301,16 @@ Base type of the connection\&. For hardware\-dependent connections, should conta Format: string .RE .PP -\fBuuid\fR +\fBconnection\&.uuid\fR .RS 4 -A universally unique identifier for the connection, for example generated with libuuid\&. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network\&. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re\-created when the Wi\-Fi SSID, mobile broadband network provider, or "type" property changes\&. +The connection\&.uuid is the real identifier of a profile\&. It cannot change and it must be unique\&. It is therefore often best to refer to a profile by UUID, for example with `nmcli connection up uuid $UUID`\&. .sp -The UUID must be in the format "2815492f\-7e56\-435e\-b2e9\-246bd7cdc664" (ie, contains only hexadecimal characters and "\-")\&. +The UUID cannot be changed, except in offline mode\&. In that case, the special values "new", "generate" and "" are allowed to generate a new random UUID\&. .sp Format: a valid RFC4122 universally unique identifier (UUID)\&. .RE .PP -\fBwait\-activation\-delay\fR +\fBconnection\&.wait\-activation\-delay\fR .RS 4 Time in milliseconds to wait for connection to be considered activated\&. The wait will start after the pre\-up dispatcher event\&. .sp @@ -326,7 +319,7 @@ The value 0 means no wait time\&. The default value is \-1, which currently has Format: int32 .RE .PP -\fBwait\-device\-timeout\fR +\fBconnection\&.wait\-device\-timeout\fR .RS 4 Timeout in milliseconds to wait for device at startup\&. During boot, devices may take a while to be detected by the driver\&. This property will cause to delay NetworkManager\-wait\-online\&.service and nm\-online to give the device a chance to appear\&. This works by waiting for the given timeout until a compatible device for the profile is available and managed\&. .sp @@ -335,7 +328,7 @@ The value 0 means no wait time\&. The default value is \-1, which currently has Format: int32 .RE .PP -\fBzone\fR +\fBconnection\&.zone\fR .RS 4 The trust level of a the connection\&. Free form case\-insensitive string (for example "Home", "Work", "Public")\&. NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall\&. .sp @@ -349,7 +342,7 @@ Format: string .PP Properties: .PP -\fBparent\fR +\fB6lowpan\&.parent\fR .RS 4 Alias: dev .sp @@ -363,28 +356,28 @@ IEEE 802\&.1x Authentication Settings\&. .PP Properties: .PP -\fBaltsubject\-matches\fR +\fB802\-1x\&.altsubject\-matches\fR .RS 4 List of strings to be matched against the altSubjectName of the certificate presented by the authentication server\&. If the list is empty, no verification of the server certificate\*(Aqs altSubjectName is performed\&. .sp Format: array of string .RE .PP -\fBanonymous\-identity\fR +\fB802\-1x\&.anonymous\-identity\fR .RS 4 Anonymous identity string for EAP authentication methods\&. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP\-TTLS\&. .sp Format: string .RE .PP -\fBauth\-timeout\fR +\fB802\-1x\&.auth\-timeout\fR .RS 4 A timeout for the authentication\&. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds\&. .sp Format: int32 .RE .PP -\fBca\-cert\fR +\fB802\-1x\&.ca\-cert\fR .RS 4 Contains the CA certificate if used by the EAP method specified in the "eap" property\&. .sp @@ -395,21 +388,25 @@ Note that enabling NMSetting8021x:system\-ca\-certs will override this setting t Format: byte array .RE .PP -\fBca\-cert\-password\fR +\fB802\-1x\&.ca\-cert\-password\fR .RS 4 The password used to access the CA certificate stored in "ca\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. .sp Format: string .RE .PP -\fBca\-cert\-password\-flags\fR +\fB802\-1x\&.ca\-cert\-password\-flags\fR .RS 4 Flags indicating how to handle the "ca\-cert\-password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBca\-path\fR +\fB802\-1x\&.ca\-path\fR .RS 4 UTF\-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca\-cert" property\&. .sp @@ -418,7 +415,7 @@ If NMSetting8021x:system\-ca\-certs is enabled and the built\-in CA path is an e Format: string .RE .PP -\fBclient\-cert\fR +\fB802\-1x\&.client\-cert\fR .RS 4 Contains the client certificate if used by the EAP method specified in the "eap" property\&. .sp @@ -427,140 +424,152 @@ Certificate data is specified using a "scheme"; two are currently supported: blo Format: byte array .RE .PP -\fBclient\-cert\-password\fR +\fB802\-1x\&.client\-cert\-password\fR .RS 4 The password used to access the client certificate stored in "client\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. .sp Format: string .RE .PP -\fBclient\-cert\-password\-flags\fR +\fB802\-1x\&.client\-cert\-password\-flags\fR .RS 4 Flags indicating how to handle the "client\-cert\-password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBdomain\-match\fR +\fB802\-1x\&.domain\-match\fR .RS 4 Constraint for server domain name\&. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server\&. If a matching dNSName is found, this constraint is met\&. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison\&. Multiple valid FQDNs can be passed as a ";" delimited list\&. .sp Format: string .RE .PP -\fBdomain\-suffix\-match\fR +\fB802\-1x\&.domain\-suffix\-match\fR .RS 4 Constraint for server domain name\&. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server\&. If a matching dNSName is found, this constraint is met\&. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison\&. Since version 1\&.24, multiple valid FQDNs can be passed as a ";" delimited list\&. .sp Format: string .RE .PP -\fBeap\fR +\fB802\-1x\&.eap\fR .RS 4 The allowed EAP method to be used when authenticating to the network with 802\&.1x\&. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast"\&. Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations\&. .sp Format: array of string .RE .PP -\fBidentity\fR +\fB802\-1x\&.identity\fR .RS 4 Identity string for EAP authentication methods\&. Often the user\*(Aqs user or login name\&. .sp Format: string .RE .PP -\fBoptional\fR +\fB802\-1x\&.optional\fR .RS 4 Whether the 802\&.1X authentication is optional\&. If TRUE, the activation will continue even after a timeout or an authentication failure\&. Setting the property to TRUE is currently allowed only for Ethernet connections\&. If set to FALSE, the activation can continue only after a successful authentication\&. .sp Format: boolean .RE .PP -\fBpac\-file\fR +\fB802\-1x\&.pac\-file\fR .RS 4 UTF\-8 encoded file path containing PAC for EAP\-FAST\&. .sp Format: string .RE .PP -\fBpassword\fR +\fB802\-1x\&.password\fR .RS 4 UTF\-8 encoded password used for EAP authentication methods\&. If both the "password" property and the "password\-raw" property are specified, "password" is preferred\&. .sp Format: string .RE .PP -\fBpassword\-flags\fR +\fB802\-1x\&.password\-flags\fR .RS 4 Flags indicating how to handle the "password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBpassword\-raw\fR +\fB802\-1x\&.password\-raw\fR .RS 4 Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF\-8 to be used\&. If both the "password" property and the "password\-raw" property are specified, "password" is preferred\&. .sp Format: byte array .RE .PP -\fBpassword\-raw\-flags\fR +\fB802\-1x\&.password\-raw\-flags\fR .RS 4 Flags indicating how to handle the "password\-raw" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBphase1\-auth\-flags\fR +\fB802\-1x\&.phase1\-auth\-flags\fR .RS 4 Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options\&. The individual TLS versions can be explicitly disabled\&. TLS time checks can be also disabled\&. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it\&. The TLS options map to tls_disable_tlsv1_x and tls_disable_time_checks settings\&. See the wpa_supplicant documentation for more details\&. .sp Format: uint32 .RE .PP -\fBphase1\-fast\-provisioning\fR +\fB802\-1x\&.phase1\-fast\-provisioning\fR .RS 4 Enables or disables in\-line provisioning of EAP\-FAST credentials when FAST is specified as the EAP method in the "eap" property\&. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning)\&. See the wpa_supplicant documentation for more details\&. .sp Format: string .RE .PP -\fBphase1\-peaplabel\fR +\fB802\-1x\&.phase1\-peaplabel\fR .RS 4 Forces use of the new PEAP label during key derivation\&. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1\&. Set to "1" to force use of the new PEAP label\&. See the wpa_supplicant documentation for more details\&. .sp Format: string .RE .PP -\fBphase1\-peapver\fR +\fB802\-1x\&.phase1\-peapver\fR .RS 4 Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property\&. When unset, the version reported by the server will be used\&. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version\&. To do so, this property may be set to "0" or "1" to force that specific PEAP version\&. .sp Format: string .RE .PP -\fBphase2\-altsubject\-matches\fR +\fB802\-1x\&.phase2\-altsubject\-matches\fR .RS 4 List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication\&. If the list is empty, no verification of the server certificate\*(Aqs altSubjectName is performed\&. .sp Format: array of string .RE .PP -\fBphase2\-auth\fR +\fB802\-1x\&.phase2\-auth\fR .RS 4 Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property\&. For TTLS this property selects one of the supported non\-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2\-autheap" selects an EAP inner method\&. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls"\&. Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details\&. Both "phase2\-auth" and "phase2\-autheap" cannot be specified\&. .sp Format: string .RE .PP -\fBphase2\-autheap\fR +\fB802\-1x\&.phase2\-autheap\fR .RS 4 Specifies the allowed "phase 2" inner EAP\-based authentication method when TTLS is specified in the "eap" property\&. Recognized EAP\-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls"\&. Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details\&. .sp Format: string .RE .PP -\fBphase2\-ca\-cert\fR +\fB802\-1x\&.phase2\-ca\-cert\fR .RS 4 Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2\-auth" or "phase2\-autheap" properties\&. .sp @@ -571,21 +580,25 @@ Note that enabling NMSetting8021x:system\-ca\-certs will override this setting t Format: byte array .RE .PP -\fBphase2\-ca\-cert\-password\fR +\fB802\-1x\&.phase2\-ca\-cert\-password\fR .RS 4 The password used to access the "phase2" CA certificate stored in "phase2\-ca\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. .sp Format: string .RE .PP -\fBphase2\-ca\-cert\-password\-flags\fR +\fB802\-1x\&.phase2\-ca\-cert\-password\-flags\fR .RS 4 Flags indicating how to handle the "phase2\-ca\-cert\-password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBphase2\-ca\-path\fR +\fB802\-1x\&.phase2\-ca\-path\fR .RS 4 UTF\-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2\-ca\-cert" property\&. .sp @@ -594,7 +607,7 @@ If NMSetting8021x:system\-ca\-certs is enabled and the built\-in CA path is an e Format: string .RE .PP -\fBphase2\-client\-cert\fR +\fB802\-1x\&.phase2\-client\-cert\fR .RS 4 Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2\-auth" or "phase2\-autheap" properties\&. .sp @@ -603,35 +616,39 @@ Certificate data is specified using a "scheme"; two are currently supported: blo Format: byte array .RE .PP -\fBphase2\-client\-cert\-password\fR +\fB802\-1x\&.phase2\-client\-cert\-password\fR .RS 4 The password used to access the "phase2" client certificate stored in "phase2\-client\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. .sp Format: string .RE .PP -\fBphase2\-client\-cert\-password\-flags\fR +\fB802\-1x\&.phase2\-client\-cert\-password\-flags\fR .RS 4 Flags indicating how to handle the "phase2\-client\-cert\-password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBphase2\-domain\-match\fR +\fB802\-1x\&.phase2\-domain\-match\fR .RS 4 Constraint for server domain name\&. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication\&. If a matching dNSName is found, this constraint is met\&. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison\&. Multiple valid FQDNs can be passed as a ";" delimited list\&. .sp Format: string .RE .PP -\fBphase2\-domain\-suffix\-match\fR +\fB802\-1x\&.phase2\-domain\-suffix\-match\fR .RS 4 Constraint for server domain name\&. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication\&. If a matching dNSName is found, this constraint is met\&. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison\&. Since version 1\&.24, multiple valid FQDNs can be passed as a ";" delimited list\&. .sp Format: string .RE .PP -\fBphase2\-private\-key\fR +\fB802\-1x\&.phase2\-private\-key\fR .RS 4 Contains the "phase 2" inner private key when the "phase2\-auth" or "phase2\-autheap" property is set to "tls"\&. .sp @@ -640,21 +657,25 @@ Key data is specified using a "scheme"; two are currently supported: blob and pa Format: byte array .RE .PP -\fBphase2\-private\-key\-password\fR +\fB802\-1x\&.phase2\-private\-key\-password\fR .RS 4 The password used to decrypt the "phase 2" private key specified in the "phase2\-private\-key" property when the private key either uses the path scheme, or is a PKCS#12 format key\&. .sp Format: string .RE .PP -\fBphase2\-private\-key\-password\-flags\fR +\fB802\-1x\&.phase2\-private\-key\-password\-flags\fR .RS 4 Flags indicating how to handle the "phase2\-private\-key\-password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBphase2\-subject\-match\fR +\fB802\-1x\&.phase2\-subject\-match\fR .RS 4 Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and should not be used\&. .sp @@ -663,21 +684,25 @@ This property is deprecated since version 1\&.2\&. Use "phase2\-domain\-suffix\- Format: string .RE .PP -\fBpin\fR +\fB802\-1x\&.pin\fR .RS 4 PIN used for EAP authentication methods\&. .sp Format: string .RE .PP -\fBpin\-flags\fR +\fB802\-1x\&.pin\-flags\fR .RS 4 Flags indicating how to handle the "pin" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBprivate\-key\fR +\fB802\-1x\&.private\-key\fR .RS 4 Contains the private key when the "eap" property is set to "tls"\&. .sp @@ -688,21 +713,25 @@ WARNING: "private\-key" is not a "secret" property, and thus unencrypted private Format: byte array .RE .PP -\fBprivate\-key\-password\fR +\fB802\-1x\&.private\-key\-password\fR .RS 4 The password used to decrypt the private key specified in the "private\-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key\&. .sp Format: string .RE .PP -\fBprivate\-key\-password\-flags\fR +\fB802\-1x\&.private\-key\-password\-flags\fR .RS 4 Flags indicating how to handle the "private\-key\-password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBsubject\-match\fR +\fB802\-1x\&.subject\-match\fR .RS 4 Substring to be matched against the subject of the certificate presented by the authentication server\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and should not be used\&. .sp @@ -711,7 +740,7 @@ This property is deprecated since version 1\&.2\&. Use "phase2\-domain\-suffix\- Format: string .RE .PP -\fBsystem\-ca\-certs\fR +\fB802\-1x\&.system\-ca\-certs\fR .RS 4 When TRUE, overrides the "ca\-path" and "phase2\-ca\-path" properties using the system CA directory specified at configure time with the \-\-system\-ca\-path switch\&. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca\-cert" and "phase2\-ca\-cert" properties\&. If the path provided with \-\-system\-ca\-path is rather a file name (bundle of trusted CA certificates), it overrides "ca\-cert" and "phase2\-ca\-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant)\&. .sp @@ -723,7 +752,7 @@ ADSL Settings\&. .PP Properties: .PP -\fBencapsulation\fR +\fBadsl\&.encapsulation\fR .RS 4 Alias: encapsulation .sp @@ -732,7 +761,7 @@ Encapsulation of ADSL connection\&. Can be "vcmux" or "llc"\&. Format: string .RE .PP -\fBpassword\fR +\fBadsl\&.password\fR .RS 4 Alias: password .sp @@ -741,14 +770,18 @@ Password used to authenticate with the ADSL service\&. Format: string .RE .PP -\fBpassword\-flags\fR +\fBadsl\&.password\-flags\fR .RS 4 Flags indicating how to handle the "password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBprotocol\fR +\fBadsl\&.protocol\fR .RS 4 Alias: protocol .sp @@ -757,7 +790,7 @@ ADSL connection protocol\&. Can be "pppoa", "pppoe" or "ipoatm"\&. Format: string .RE .PP -\fBusername\fR +\fBadsl\&.username\fR .RS 4 Alias: username .sp @@ -766,14 +799,14 @@ Username used to authenticate with the ADSL service\&. Format: string .RE .PP -\fBvci\fR +\fBadsl\&.vci\fR .RS 4 VCI of ADSL connection .sp Format: uint32 .RE .PP -\fBvpi\fR +\fBadsl\&.vpi\fR .RS 4 VPI of ADSL connection .sp @@ -785,7 +818,7 @@ Bluetooth Settings\&. .PP Properties: .PP -\fBbdaddr\fR +\fBbluetooth\&.bdaddr\fR .RS 4 Alias: addr .sp @@ -794,7 +827,7 @@ The Bluetooth address of the device\&. Format: byte array .RE .PP -\fBtype\fR +\fBbluetooth\&.type\fR .RS 4 Alias: bt\-type .sp @@ -808,7 +841,7 @@ Bonding Settings\&. .PP Properties: .PP -\fBoptions\fR +\fBbond\&.options\fR .RS 4 Dictionary of key/value pairs of bonding options\&. Both keys and values must be strings\&. Option names must contain only alphanumeric characters (ie, [a\-zA\-Z0\-9])\&. .sp @@ -820,7 +853,7 @@ Bridging Settings\&. .PP Properties: .PP -\fBageing\-time\fR +\fBbridge\&.ageing\-time\fR .RS 4 Alias: ageing\-time .sp @@ -829,7 +862,7 @@ The Ethernet MAC address aging time, in seconds\&. Format: uint32 .RE .PP -\fBforward\-delay\fR +\fBbridge\&.forward\-delay\fR .RS 4 Alias: forward\-delay .sp @@ -838,7 +871,7 @@ The Spanning Tree Protocol (STP) forwarding delay, in seconds\&. Format: uint32 .RE .PP -\fBgroup\-address\fR +\fBbridge\&.group\-address\fR .RS 4 If specified, The MAC address of the multicast group this bridge uses for STP\&. .sp @@ -847,7 +880,7 @@ The address must be a link\-local address in standard Ethernet MAC address forma Format: byte array .RE .PP -\fBgroup\-forward\-mask\fR +\fBbridge\&.group\-forward\-mask\fR .RS 4 Alias: group\-forward\-mask .sp @@ -856,7 +889,7 @@ A mask of group addresses to forward\&. Usually, group addresses in the range fr Format: uint32 .RE .PP -\fBhello\-time\fR +\fBbridge\&.hello\-time\fR .RS 4 Alias: hello\-time .sp @@ -865,7 +898,7 @@ The Spanning Tree Protocol (STP) hello time, in seconds\&. Format: uint32 .RE .PP -\fBmac\-address\fR +\fBbridge\&.mac\-address\fR .RS 4 Alias: mac .sp @@ -878,7 +911,7 @@ This property is deprecated since version 1\&.12\&. Use the "cloned\-mac\-addres Format: byte array .RE .PP -\fBmax\-age\fR +\fBbridge\&.max\-age\fR .RS 4 Alias: max\-age .sp @@ -887,70 +920,70 @@ The Spanning Tree Protocol (STP) maximum message age, in seconds\&. Format: uint32 .RE .PP -\fBmulticast\-hash\-max\fR +\fBbridge\&.multicast\-hash\-max\fR .RS 4 Set maximum size of multicast hash table (value must be a power of 2)\&. .sp Format: uint32 .RE .PP -\fBmulticast\-last\-member\-count\fR +\fBbridge\&.multicast\-last\-member\-count\fR .RS 4 Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received\&. .sp Format: uint32 .RE .PP -\fBmulticast\-last\-member\-interval\fR +\fBbridge\&.multicast\-last\-member\-interval\fR .RS 4 Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received\&. .sp Format: uint64 .RE .PP -\fBmulticast\-membership\-interval\fR +\fBbridge\&.multicast\-membership\-interval\fR .RS 4 Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received\&. .sp Format: uint64 .RE .PP -\fBmulticast\-querier\fR +\fBbridge\&.multicast\-querier\fR .RS 4 Enable or disable sending of multicast queries by the bridge\&. If not specified the option is disabled\&. .sp Format: boolean .RE .PP -\fBmulticast\-querier\-interval\fR +\fBbridge\&.multicast\-querier\-interval\fR .RS 4 If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries\&. .sp Format: uint64 .RE .PP -\fBmulticast\-query\-interval\fR +\fBbridge\&.multicast\-query\-interval\fR .RS 4 Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase\&. .sp Format: uint64 .RE .PP -\fBmulticast\-query\-response\-interval\fR +\fBbridge\&.multicast\-query\-response\-interval\fR .RS 4 Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge\&. .sp Format: uint64 .RE .PP -\fBmulticast\-query\-use\-ifaddr\fR +\fBbridge\&.multicast\-query\-use\-ifaddr\fR .RS 4 If enabled the bridge\*(Aqs own IP address is used as the source address for IGMP queries otherwise the default of 0\&.0\&.0\&.0 is used\&. .sp Format: boolean .RE .PP -\fBmulticast\-router\fR +\fBbridge\&.multicast\-router\fR .RS 4 Sets bridge\*(Aqs multicast router\&. Multicast\-snooping must be enabled for this option to work\&. .sp @@ -959,7 +992,7 @@ Supported values are: \*(Aqauto\*(Aq, \*(Aqdisabled\*(Aq, \*(Aqenabled\*(Aq to w Format: string .RE .PP -\fBmulticast\-snooping\fR +\fBbridge\&.multicast\-snooping\fR .RS 4 Alias: multicast\-snooping .sp @@ -968,21 +1001,21 @@ Controls whether IGMP snooping is enabled for this bridge\&. Note that if snoopi Format: boolean .RE .PP -\fBmulticast\-startup\-query\-count\fR +\fBbridge\&.multicast\-startup\-query\-count\fR .RS 4 Set the number of IGMP queries to send during startup phase\&. .sp Format: uint32 .RE .PP -\fBmulticast\-startup\-query\-interval\fR +\fBbridge\&.multicast\-startup\-query\-interval\fR .RS 4 Sets the time (in deciseconds) between queries sent out at startup to determine membership information\&. .sp Format: uint64 .RE .PP -\fBpriority\fR +\fBbridge\&.priority\fR .RS 4 Alias: priority .sp @@ -991,7 +1024,7 @@ Sets the Spanning Tree Protocol (STP) priority for this bridge\&. Lower values a Format: uint32 .RE .PP -\fBstp\fR +\fBbridge\&.stp\fR .RS 4 Alias: stp .sp @@ -1000,21 +1033,21 @@ Controls whether Spanning Tree Protocol (STP) is enabled for this bridge\&. Format: boolean .RE .PP -\fBvlan\-default\-pvid\fR +\fBbridge\&.vlan\-default\-pvid\fR .RS 4 The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames\&. .sp Format: uint32 .RE .PP -\fBvlan\-filtering\fR +\fBbridge\&.vlan\-filtering\fR .RS 4 Control whether VLAN filtering is enabled on the bridge\&. .sp Format: boolean .RE .PP -\fBvlan\-protocol\fR +\fBbridge\&.vlan\-protocol\fR .RS 4 If specified, the protocol used for VLAN filtering\&. .sp @@ -1023,14 +1056,14 @@ Supported values are: \*(Aq802\&.1Q\*(Aq, \*(Aq802\&.1ad\*(Aq\&. If not specifie Format: string .RE .PP -\fBvlan\-stats\-enabled\fR +\fBbridge\&.vlan\-stats\-enabled\fR .RS 4 Controls whether per\-VLAN stats accounting is enabled\&. .sp Format: boolean .RE .PP -\fBvlans\fR +\fBbridge\&.vlans\fR .RS 4 Array of bridge VLAN objects\&. In addition to the VLANs specified here, the bridge will also have the default\-pvid VLAN configured by the bridge\&.vlan\-default\-pvid property\&. .sp @@ -1048,7 +1081,7 @@ Bridge Port Settings\&. .PP Properties: .PP -\fBhairpin\-mode\fR +\fBbridge\-port\&.hairpin\-mode\fR .RS 4 Alias: hairpin .sp @@ -1057,7 +1090,7 @@ Enables or disables "hairpin mode" for the port, which allows frames to be sent Format: boolean .RE .PP -\fBpath\-cost\fR +\fBbridge\-port\&.path\-cost\fR .RS 4 Alias: path\-cost .sp @@ -1066,7 +1099,7 @@ The Spanning Tree Protocol (STP) port cost for destinations via this port\&. Format: uint32 .RE .PP -\fBpriority\fR +\fBbridge\-port\&.priority\fR .RS 4 Alias: priority .sp @@ -1075,7 +1108,7 @@ The Spanning Tree Protocol (STP) priority of this bridge port\&. Format: uint32 .RE .PP -\fBvlans\fR +\fBbridge\-port\&.vlans\fR .RS 4 Array of bridge VLAN objects\&. In addition to the VLANs specified here, the port will also have the default\-pvid VLAN configured on the bridge by the bridge\&.vlan\-default\-pvid property\&. .sp @@ -1093,21 +1126,21 @@ CDMA\-based Mobile Broadband Settings\&. .PP Properties: .PP -\fBmtu\fR +\fBcdma\&.mtu\fR .RS 4 If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. .sp Format: uint32 .RE .PP -\fBnumber\fR +\fBcdma\&.number\fR .RS 4 The number to dial to establish the connection to the CDMA\-based mobile broadband network, if any\&. If not specified, the default number (#777) is used when required\&. .sp Format: string .RE .PP -\fBpassword\fR +\fBcdma\&.password\fR .RS 4 Alias: password .sp @@ -1116,14 +1149,18 @@ The password used to authenticate with the network, if required\&. Many provider Format: string .RE .PP -\fBpassword\-flags\fR +\fBcdma\&.password\-flags\fR .RS 4 Flags indicating how to handle the "password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBusername\fR +\fBcdma\&.username\fR .RS 4 Alias: user .sp @@ -1137,14 +1174,14 @@ Data Center Bridging Settings\&. .PP Properties: .PP -\fBapp\-fcoe\-flags\fR +\fBdcb\&.app\-fcoe\-flags\fR .RS 4 Specifies the NMSettingDcbFlags for the DCB FCoE application\&. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4)\&. .sp Format: NMSettingDcbFlags (uint32) .RE .PP -\fBapp\-fcoe\-mode\fR +\fBdcb\&.app\-fcoe\-mode\fR .RS 4 The FCoE controller mode; either "fabric" or "vn2vn"\&. .sp @@ -1153,91 +1190,91 @@ Since 1\&.34, NULL is the default and means "fabric"\&. Before 1\&.34, NULL was Format: string .RE .PP -\fBapp\-fcoe\-priority\fR +\fBdcb\&.app\-fcoe\-priority\fR .RS 4 The highest User Priority (0 \- 7) which FCoE frames should use, or \-1 for default priority\&. Only used when the "app\-fcoe\-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag\&. .sp Format: int32 .RE .PP -\fBapp\-fip\-flags\fR +\fBdcb\&.app\-fip\-flags\fR .RS 4 Specifies the NMSettingDcbFlags for the DCB FIP application\&. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4)\&. .sp Format: NMSettingDcbFlags (uint32) .RE .PP -\fBapp\-fip\-priority\fR +\fBdcb\&.app\-fip\-priority\fR .RS 4 The highest User Priority (0 \- 7) which FIP frames should use, or \-1 for default priority\&. Only used when the "app\-fip\-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag\&. .sp Format: int32 .RE .PP -\fBapp\-iscsi\-flags\fR +\fBdcb\&.app\-iscsi\-flags\fR .RS 4 Specifies the NMSettingDcbFlags for the DCB iSCSI application\&. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4)\&. .sp Format: NMSettingDcbFlags (uint32) .RE .PP -\fBapp\-iscsi\-priority\fR +\fBdcb\&.app\-iscsi\-priority\fR .RS 4 The highest User Priority (0 \- 7) which iSCSI frames should use, or \-1 for default priority\&. Only used when the "app\-iscsi\-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag\&. .sp Format: int32 .RE .PP -\fBpriority\-bandwidth\fR +\fBdcb\&.priority\-bandwidth\fR .RS 4 An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the percentage of bandwidth of the priority\*(Aqs assigned group that the priority may use\&. The sum of all percentages for priorities which belong to the same group must total 100 percents\&. .sp Format: array of uint32 .RE .PP -\fBpriority\-flow\-control\fR +\fBdcb\&.priority\-flow\-control\fR .RS 4 An array of 8 boolean values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates whether or not the corresponding priority should transmit priority pause\&. .sp Format: array of uint32 .RE .PP -\fBpriority\-flow\-control\-flags\fR +\fBdcb\&.priority\-flow\-control\-flags\fR .RS 4 Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC)\&. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4)\&. .sp Format: NMSettingDcbFlags (uint32) .RE .PP -\fBpriority\-group\-bandwidth\fR +\fBdcb\&.priority\-group\-bandwidth\fR .RS 4 An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 \- 7) and the value indicates the percentage of link bandwidth allocated to that group\&. Allowed values are 0 \- 100, and the sum of all values must total 100 percents\&. .sp Format: array of uint32 .RE .PP -\fBpriority\-group\-flags\fR +\fBdcb\&.priority\-group\-flags\fR .RS 4 Specifies the NMSettingDcbFlags for DCB Priority Groups\&. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4)\&. .sp Format: NMSettingDcbFlags (uint32) .RE .PP -\fBpriority\-group\-id\fR +\fBdcb\&.priority\-group\-id\fR .RS 4 An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the Priority Group ID\&. Allowed Priority Group ID values are 0 \- 7 or 15 for the unrestricted group\&. .sp Format: array of uint32 .RE .PP -\fBpriority\-strict\-bandwidth\fR +\fBdcb\&.priority\-strict\-bandwidth\fR .RS 4 An array of 8 boolean values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group\&. .sp Format: array of uint32 .RE .PP -\fBpriority\-traffic\-class\fR +\fBdcb\&.priority\-traffic\-class\fR .RS 4 An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the traffic class (0 \- 7) to which the priority is mapped\&. .sp @@ -1249,351 +1286,351 @@ Ethtool Ethernet Settings\&. .PP Properties: .PP -\fBcoalesce\-adaptive\-rx\fR +\fBethtool\&.coalesce\-adaptive\-rx\fR .RS 4 .RE .PP -\fBcoalesce\-adaptive\-tx\fR +\fBethtool\&.coalesce\-adaptive\-tx\fR .RS 4 .RE .PP -\fBcoalesce\-pkt\-rate\-high\fR +\fBethtool\&.coalesce\-pkt\-rate\-high\fR .RS 4 .RE .PP -\fBcoalesce\-pkt\-rate\-low\fR +\fBethtool\&.coalesce\-pkt\-rate\-low\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-frames\fR +\fBethtool\&.coalesce\-rx\-frames\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-frames\-high\fR +\fBethtool\&.coalesce\-rx\-frames\-high\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-frames\-irq\fR +\fBethtool\&.coalesce\-rx\-frames\-irq\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-frames\-low\fR +\fBethtool\&.coalesce\-rx\-frames\-low\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-usecs\fR +\fBethtool\&.coalesce\-rx\-usecs\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-usecs\-high\fR +\fBethtool\&.coalesce\-rx\-usecs\-high\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-usecs\-irq\fR +\fBethtool\&.coalesce\-rx\-usecs\-irq\fR .RS 4 .RE .PP -\fBcoalesce\-rx\-usecs\-low\fR +\fBethtool\&.coalesce\-rx\-usecs\-low\fR .RS 4 .RE .PP -\fBcoalesce\-sample\-interval\fR +\fBethtool\&.coalesce\-sample\-interval\fR .RS 4 .RE .PP -\fBcoalesce\-stats\-block\-usecs\fR +\fBethtool\&.coalesce\-stats\-block\-usecs\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-frames\fR +\fBethtool\&.coalesce\-tx\-frames\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-frames\-high\fR +\fBethtool\&.coalesce\-tx\-frames\-high\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-frames\-irq\fR +\fBethtool\&.coalesce\-tx\-frames\-irq\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-frames\-low\fR +\fBethtool\&.coalesce\-tx\-frames\-low\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-usecs\fR +\fBethtool\&.coalesce\-tx\-usecs\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-usecs\-high\fR +\fBethtool\&.coalesce\-tx\-usecs\-high\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-usecs\-irq\fR +\fBethtool\&.coalesce\-tx\-usecs\-irq\fR .RS 4 .RE .PP -\fBcoalesce\-tx\-usecs\-low\fR +\fBethtool\&.coalesce\-tx\-usecs\-low\fR .RS 4 .RE .PP -\fBfeature\-esp\-hw\-offload\fR +\fBethtool\&.feature\-esp\-hw\-offload\fR .RS 4 .RE .PP -\fBfeature\-esp\-tx\-csum\-hw\-offload\fR +\fBethtool\&.feature\-esp\-tx\-csum\-hw\-offload\fR .RS 4 .RE .PP -\fBfeature\-fcoe\-mtu\fR +\fBethtool\&.feature\-fcoe\-mtu\fR .RS 4 .RE .PP -\fBfeature\-gro\fR +\fBethtool\&.feature\-gro\fR .RS 4 .RE .PP -\fBfeature\-gso\fR +\fBethtool\&.feature\-gso\fR .RS 4 .RE .PP -\fBfeature\-highdma\fR +\fBethtool\&.feature\-highdma\fR .RS 4 .RE .PP -\fBfeature\-hw\-tc\-offload\fR +\fBethtool\&.feature\-hw\-tc\-offload\fR .RS 4 .RE .PP -\fBfeature\-l2\-fwd\-offload\fR +\fBethtool\&.feature\-l2\-fwd\-offload\fR .RS 4 .RE .PP -\fBfeature\-loopback\fR +\fBethtool\&.feature\-loopback\fR .RS 4 .RE .PP -\fBfeature\-lro\fR +\fBethtool\&.feature\-lro\fR .RS 4 .RE .PP -\fBfeature\-macsec\-hw\-offload\fR +\fBethtool\&.feature\-macsec\-hw\-offload\fR .RS 4 .RE .PP -\fBfeature\-ntuple\fR +\fBethtool\&.feature\-ntuple\fR .RS 4 .RE .PP -\fBfeature\-rx\fR +\fBethtool\&.feature\-rx\fR .RS 4 .RE .PP -\fBfeature\-rx\-all\fR +\fBethtool\&.feature\-rx\-all\fR .RS 4 .RE .PP -\fBfeature\-rx\-fcs\fR +\fBethtool\&.feature\-rx\-fcs\fR .RS 4 .RE .PP -\fBfeature\-rx\-gro\-hw\fR +\fBethtool\&.feature\-rx\-gro\-hw\fR .RS 4 .RE .PP -\fBfeature\-rx\-gro\-list\fR +\fBethtool\&.feature\-rx\-gro\-list\fR .RS 4 .RE .PP -\fBfeature\-rx\-udp\-gro\-forwarding\fR +\fBethtool\&.feature\-rx\-udp\-gro\-forwarding\fR .RS 4 .RE .PP -\fBfeature\-rx\-udp_tunnel\-port\-offload\fR +\fBethtool\&.feature\-rx\-udp_tunnel\-port\-offload\fR .RS 4 .RE .PP -\fBfeature\-rx\-vlan\-filter\fR +\fBethtool\&.feature\-rx\-vlan\-filter\fR .RS 4 .RE .PP -\fBfeature\-rx\-vlan\-stag\-filter\fR +\fBethtool\&.feature\-rx\-vlan\-stag\-filter\fR .RS 4 .RE .PP -\fBfeature\-rx\-vlan\-stag\-hw\-parse\fR +\fBethtool\&.feature\-rx\-vlan\-stag\-hw\-parse\fR .RS 4 .RE .PP -\fBfeature\-rxhash\fR +\fBethtool\&.feature\-rxhash\fR .RS 4 .RE .PP -\fBfeature\-rxvlan\fR +\fBethtool\&.feature\-rxvlan\fR .RS 4 .RE .PP -\fBfeature\-sg\fR +\fBethtool\&.feature\-sg\fR .RS 4 .RE .PP -\fBfeature\-tls\-hw\-record\fR +\fBethtool\&.feature\-tls\-hw\-record\fR .RS 4 .RE .PP -\fBfeature\-tls\-hw\-rx\-offload\fR +\fBethtool\&.feature\-tls\-hw\-rx\-offload\fR .RS 4 .RE .PP -\fBfeature\-tls\-hw\-tx\-offload\fR +\fBethtool\&.feature\-tls\-hw\-tx\-offload\fR .RS 4 .RE .PP -\fBfeature\-tso\fR +\fBethtool\&.feature\-tso\fR .RS 4 .RE .PP -\fBfeature\-tx\fR +\fBethtool\&.feature\-tx\fR .RS 4 .RE .PP -\fBfeature\-tx\-checksum\-fcoe\-crc\fR +\fBethtool\&.feature\-tx\-checksum\-fcoe\-crc\fR .RS 4 .RE .PP -\fBfeature\-tx\-checksum\-ip\-generic\fR +\fBethtool\&.feature\-tx\-checksum\-ip\-generic\fR .RS 4 .RE .PP -\fBfeature\-tx\-checksum\-ipv4\fR +\fBethtool\&.feature\-tx\-checksum\-ipv4\fR .RS 4 .RE .PP -\fBfeature\-tx\-checksum\-ipv6\fR +\fBethtool\&.feature\-tx\-checksum\-ipv6\fR .RS 4 .RE .PP -\fBfeature\-tx\-checksum\-sctp\fR +\fBethtool\&.feature\-tx\-checksum\-sctp\fR .RS 4 .RE .PP -\fBfeature\-tx\-esp\-segmentation\fR +\fBethtool\&.feature\-tx\-esp\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-fcoe\-segmentation\fR +\fBethtool\&.feature\-tx\-fcoe\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-gre\-csum\-segmentation\fR +\fBethtool\&.feature\-tx\-gre\-csum\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-gre\-segmentation\fR +\fBethtool\&.feature\-tx\-gre\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-gso\-list\fR +\fBethtool\&.feature\-tx\-gso\-list\fR .RS 4 .RE .PP -\fBfeature\-tx\-gso\-partial\fR +\fBethtool\&.feature\-tx\-gso\-partial\fR .RS 4 .RE .PP -\fBfeature\-tx\-gso\-robust\fR +\fBethtool\&.feature\-tx\-gso\-robust\fR .RS 4 .RE .PP -\fBfeature\-tx\-ipxip4\-segmentation\fR +\fBethtool\&.feature\-tx\-ipxip4\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-ipxip6\-segmentation\fR +\fBethtool\&.feature\-tx\-ipxip6\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-nocache\-copy\fR +\fBethtool\&.feature\-tx\-nocache\-copy\fR .RS 4 .RE .PP -\fBfeature\-tx\-scatter\-gather\fR +\fBethtool\&.feature\-tx\-scatter\-gather\fR .RS 4 .RE .PP -\fBfeature\-tx\-scatter\-gather\-fraglist\fR +\fBethtool\&.feature\-tx\-scatter\-gather\-fraglist\fR .RS 4 .RE .PP -\fBfeature\-tx\-sctp\-segmentation\fR +\fBethtool\&.feature\-tx\-sctp\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-tcp\-ecn\-segmentation\fR +\fBethtool\&.feature\-tx\-tcp\-ecn\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-tcp\-mangleid\-segmentation\fR +\fBethtool\&.feature\-tx\-tcp\-mangleid\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-tcp\-segmentation\fR +\fBethtool\&.feature\-tx\-tcp\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-tcp6\-segmentation\fR +\fBethtool\&.feature\-tx\-tcp6\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-tunnel\-remcsum\-segmentation\fR +\fBethtool\&.feature\-tx\-tunnel\-remcsum\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-udp\-segmentation\fR +\fBethtool\&.feature\-tx\-udp\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-udp_tnl\-csum\-segmentation\fR +\fBethtool\&.feature\-tx\-udp_tnl\-csum\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-udp_tnl\-segmentation\fR +\fBethtool\&.feature\-tx\-udp_tnl\-segmentation\fR .RS 4 .RE .PP -\fBfeature\-tx\-vlan\-stag\-hw\-insert\fR +\fBethtool\&.feature\-tx\-vlan\-stag\-hw\-insert\fR .RS 4 .RE .PP -\fBfeature\-txvlan\fR +\fBethtool\&.feature\-txvlan\fR .RS 4 .RE .PP -\fBpause\-autoneg\fR +\fBethtool\&.pause\-autoneg\fR .RS 4 .RE .PP -\fBpause\-rx\fR +\fBethtool\&.pause\-rx\fR .RS 4 .RE .PP -\fBpause\-tx\fR +\fBethtool\&.pause\-tx\fR .RS 4 .RE .PP -\fBring\-rx\fR +\fBethtool\&.ring\-rx\fR .RS 4 .RE .PP -\fBring\-rx\-jumbo\fR +\fBethtool\&.ring\-rx\-jumbo\fR .RS 4 .RE .PP -\fBring\-rx\-mini\fR +\fBethtool\&.ring\-rx\-mini\fR .RS 4 .RE .PP -\fBring\-tx\fR +\fBethtool\&.ring\-tx\fR .RS 4 .RE .SS "gsm setting" @@ -1602,7 +1639,7 @@ GSM\-based Mobile Broadband Settings\&. .PP Properties: .PP -\fBapn\fR +\fBgsm\&.apn\fR .RS 4 Alias: apn .sp @@ -1611,42 +1648,56 @@ The GPRS Access Point Name specifying the APN used when establishing a data sess Format: string .RE .PP -\fBauto\-config\fR +\fBgsm\&.auto\-config\fR .RS 4 When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database\&. .sp Format: boolean .RE .PP -\fBdevice\-id\fR +\fBgsm\&.device\-id\fR .RS 4 The device unique identifier (as given by the WWAN management service) which this connection applies to\&. If given, the connection will only apply to the specified device\&. .sp Format: string .RE .PP -\fBhome\-only\fR +\fBgsm\&.home\-only\fR .RS 4 When TRUE, only connections to the home network will be allowed\&. Connections to roaming networks will not be made\&. .sp Format: boolean .RE .PP -\fBmtu\fR +\fBgsm\&.initial\-eps\-bearer\-apn\fR +.RS 4 +For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network\&. Setting this parameter implies initial\-eps\-bearer\-configure to be TRUE\&. +.sp +Format: string +.RE +.PP +\fBgsm\&.initial\-eps\-bearer\-configure\fR +.RS 4 +For LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection\&. It is inferred TRUE if initial\-eps\-bearer\-apn is set\&. +.sp +Format: boolean +.RE +.PP +\fBgsm\&.mtu\fR .RS 4 If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. .sp Format: uint32 .RE .PP -\fBnetwork\-id\fR +\fBgsm\&.network\-id\fR .RS 4 The Network ID (GSM LAI format, ie MCC\-MNC) to force specific network registration\&. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network\&. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible\&. .sp Format: string .RE .PP -\fBnumber\fR +\fBgsm\&.number\fR .RS 4 Legacy setting that used to help establishing PPP data sessions for GSM\-based modems\&. .sp @@ -1655,7 +1706,7 @@ This property is deprecated since version 1\&.16\&. User\-provided values for th Format: string .RE .PP -\fBpassword\fR +\fBgsm\&.password\fR .RS 4 Alias: password .sp @@ -1664,42 +1715,50 @@ The password used to authenticate with the network, if required\&. Many provider Format: string .RE .PP -\fBpassword\-flags\fR +\fBgsm\&.password\-flags\fR .RS 4 Flags indicating how to handle the "password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBpin\fR +\fBgsm\&.pin\fR .RS 4 If the SIM is locked with a PIN it must be unlocked before any other operations are requested\&. Specify the PIN here to allow operation of the device\&. .sp Format: string .RE .PP -\fBpin\-flags\fR +\fBgsm\&.pin\-flags\fR .RS 4 Flags indicating how to handle the "pin" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBsim\-id\fR +\fBgsm\&.sim\-id\fR .RS 4 The SIM card unique identifier (as given by the WWAN management service) which this connection applies to\&. If given, the connection will apply to any device also allowed by "device\-id" which contains a SIM card matching the given identifier\&. .sp Format: string .RE .PP -\fBsim\-operator\-id\fR +\fBgsm\&.sim\-operator\-id\fR .RS 4 A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to\&. If given, the connection will apply to any device also allowed by "device\-id" and "sim\-id" which contains a SIM card provisioned by the given operator\&. .sp Format: string .RE .PP -\fBusername\fR +\fBgsm\&.username\fR .RS 4 Alias: user .sp @@ -1713,7 +1772,7 @@ Infiniband Settings\&. .PP Properties: .PP -\fBmac\-address\fR +\fBinfiniband\&.mac\-address\fR .RS 4 Alias: mac .sp @@ -1722,7 +1781,7 @@ If specified, this connection will only apply to the IPoIB device whose permanen Format: byte array .RE .PP -\fBmtu\fR +\fBinfiniband\&.mtu\fR .RS 4 Alias: mtu .sp @@ -1731,7 +1790,7 @@ If non\-zero, only transmit packets of the specified size or smaller, breaking l Format: uint32 .RE .PP -\fBp\-key\fR +\fBinfiniband\&.p\-key\fR .RS 4 Alias: p\-key .sp @@ -1744,7 +1803,7 @@ Note that kernel will internally always set the full membership bit, although th Format: int32 .RE .PP -\fBparent\fR +\fBinfiniband\&.parent\fR .RS 4 Alias: parent .sp @@ -1753,7 +1812,7 @@ The interface name of the parent device of this device\&. Normally NULL, but if Format: string .RE .PP -\fBtransport\-mode\fR +\fBinfiniband\&.transport\-mode\fR .RS 4 Alias: transport\-mode .sp @@ -1767,16 +1826,16 @@ IPv4 Settings\&. .PP Properties: .PP -\fBaddresses\fR +\fBipv4\&.addresses\fR .RS 4 Alias: ip4 .sp -Array of IP addresses\&. +A list of IPv4 addresses and their prefix length\&. Multiple addresses can be separated by comma\&. For example "192\&.168\&.1\&.5/24, 10\&.1\&.0\&.5/24"\&. The addresses are listed in decreasing priority, meaning the first address will be the primary address\&. .sp Format: a comma separated list of addresses .RE .PP -\fBauto\-route\-ext\-gw\fR +\fBipv4\&.auto\-route\-ext\-gw\fR .RS 4 VPN connections will default to add the route automatically unless this setting is set to FALSE\&. .sp @@ -1785,7 +1844,7 @@ For other connection types, adding such an automatic route is currently not supp Format: NMTernary (int32) .RE .PP -\fBdad\-timeout\fR +\fBipv4\&.dad\-timeout\fR .RS 4 Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network\&. If an address conflict is detected, the activation will fail\&. A zero value means that no duplicate address detection is performed, \-1 means the default value (either configuration ipvx\&.dad\-timeout override or zero)\&. A value greater than zero is a timeout in milliseconds\&. .sp @@ -1794,7 +1853,7 @@ The property is currently implemented only for IPv4\&. Format: int32 .RE .PP -\fBdhcp\-client\-id\fR +\fBipv4\&.dhcp\-client\-id\fR .RS 4 A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options\&. When the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary client ID, in which case the first byte is assumed to be the \*(Aqtype\*(Aq field as per RFC 2132 section 9\&.14 and the remaining bytes may be an hardware address (e\&.g\&. \*(Aq01:xx:xx:xx:xx:xx:xx\*(Aq where 1 is the Ethernet ARP type and the rest is a MAC address)\&. If the property is not a hex string it is considered as a non\-hardware\-address client ID and the \*(Aqtype\*(Aq field is set to 0\&. .sp @@ -1811,21 +1870,21 @@ If unset, a globally configured default is used\&. If still unset, the default d Format: string .RE .PP -\fBdhcp\-fqdn\fR +\fBipv4\&.dhcp\-fqdn\fR .RS 4 If the "dhcp\-send\-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease\&. This property and "dhcp\-hostname" are mutually exclusive and cannot be set at the same time\&. .sp Format: string .RE .PP -\fBdhcp\-hostname\fR +\fBipv4\&.dhcp\-hostname\fR .RS 4 If the "dhcp\-send\-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease\&. This property and "dhcp\-fqdn" are mutually exclusive and cannot be set at the same time\&. .sp Format: string .RE .PP -\fBdhcp\-hostname\-flags\fR +\fBipv4\&.dhcp\-hostname\-flags\fR .RS 4 Flags for the DHCP hostname and FQDN\&. .sp @@ -1836,9 +1895,9 @@ When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), Format: uint32 .RE .PP -\fBdhcp\-iaid\fR +\fBipv4\&.dhcp\-iaid\fR .RS 4 -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. +A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. .sp For DHCPv4, the IAID is only used with "ipv4\&.dhcp\-client\-id" values "duid" and "ipv6\-duid" to generate the client\-id\&. .sp @@ -1849,7 +1908,7 @@ The actually used DHCPv6 IAID for a currently activated interface is exposed in Format: string .RE .PP -\fBdhcp\-reject\-servers\fR +\fBipv4\&.dhcp\-reject\-servers\fR .RS 4 Array of servers from which DHCP offers must be rejected\&. This property is useful to avoid getting a lease from misconfigured or rogue servers\&. .sp @@ -1860,14 +1919,14 @@ This property is currently not implemented for DHCPv6\&. Format: array of string .RE .PP -\fBdhcp\-send\-hostname\fR +\fBipv4\&.dhcp\-send\-hostname\fR .RS 4 If TRUE, a hostname is sent to the DHCP server when acquiring a lease\&. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer\&. If the "dhcp\-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent\&. .sp Format: boolean .RE .PP -\fBdhcp\-timeout\fR +\fBipv4\&.dhcp\-timeout\fR .RS 4 A timeout for a DHCP transaction in seconds\&. If zero (the default), a globally configured default is used\&. If still unspecified, a device specific timeout is used (usually 45 seconds)\&. .sp @@ -1876,14 +1935,14 @@ Set to 2147483647 (MAXINT32) for infinity\&. Format: int32 .RE .PP -\fBdhcp\-vendor\-class\-identifier\fR +\fBipv4\&.dhcp\-vendor\-class\-identifier\fR .RS 4 The Vendor Class Identifier DHCP option (60)\&. Special characters in the data string may be escaped using C\-style escapes, nevertheless this property cannot contain nul bytes\&. If the per\-profile value is unspecified (the default), a global connection default gets consulted\&. If still unspecified, the DHCP option is not sent to the server\&. .sp Format: string .RE .PP -\fBdns\fR +\fBipv4\&.dns\fR .RS 4 Array of IP addresses of DNS servers\&. .sp @@ -1892,22 +1951,24 @@ For DoT (DNS over TLS), the SNI server name can be specified by appending "#exam Format: array of uint32 .RE .PP -\fBdns\-options\fR +\fBipv4\&.dns\-options\fR .RS 4 -Array of DNS options as described in man 5 resolv\&.conf\&. +DNS options for /etc/resolv\&.conf as described in resolv\&.conf(5) manual\&. .sp -NULL means that the options are unset and left at the default\&. In this case NetworkManager will use default options\&. This is distinct from an empty list of properties\&. +The currently supported options are "attempts", "debug", "edns0", "ndots", "no\-aaaa", "no\-check\-names", "no\-reload", "no\-tld\-query", "rotate", "single\-request", "single\-request\-reopen", "timeout", "trust\-ad", "use\-vc"\&. See the resolv\&.conf(5) manual\&. .sp -The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6\-bytestring", "ip6\-dotint", "ndots", "no\-aaaa", "no\-check\-names", "no\-ip6\-dotint", "no\-reload", "no\-tld\-query", "rotate", "single\-request", "single\-request\-reopen", "timeout", "trust\-ad", "use\-vc"\&. +Note that there is a distinction between an unset (default) list and an empty list\&. In nmcli, to unset the list set the value to ""\&. To set an empty list, set it to " "\&. Currently, an unset list has the same meaning as an empty list\&. That might change in the future\&. .sp The "trust\-ad" setting is only honored if the profile contributes name servers to resolv\&.conf, and if all contributing profiles have "trust\-ad" enabled\&. .sp When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added\&. .sp -Format: array of string +The valid "ipv4\&.dns\-options" and "ipv6\&.dns\-options" get merged together\&. +.sp +Format: a comma separated list of DNS options .RE .PP -\fBdns\-priority\fR +\fBipv4\&.dns\-priority\fR .RS 4 DNS servers priority\&. .sp @@ -1928,7 +1989,7 @@ When using a DNS resolver that supports Conditional Forwarding or Split DNS (wit Format: int32 .RE .PP -\fBdns\-search\fR +\fBipv4\&.dns\-search\fR .RS 4 List of DNS search domains\&. Domains starting with a tilde (\*(Aq~\*(Aq) are considered \*(Aqrouting\*(Aq domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names\&. .sp @@ -1939,7 +2000,7 @@ When set on a profile that also enabled DHCP, the DNS search list received autom Format: array of string .RE .PP -\fBgateway\fR +\fBipv4\&.gateway\fR .RS 4 Alias: gw4 .sp @@ -1952,21 +2013,21 @@ Note that the gateway usually conflicts with routing that NetworkManager configu Format: string .RE .PP -\fBignore\-auto\-dns\fR +\fBipv4\&.ignore\-auto\-dns\fR .RS 4 When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns\-search" properties, if any, are used\&. .sp Format: boolean .RE .PP -\fBignore\-auto\-routes\fR +\fBipv4\&.ignore\-auto\-routes\fR .RS 4 When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used\&. .sp Format: boolean .RE .PP -\fBlink\-local\fR +\fBipv4\&.link\-local\fR .RS 4 Enable and disable the IPv4 link\-local configuration independently of the ipv4\&.method configuration\&. This allows a link\-local address (169\&.254\&.x\&.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server\&. .sp @@ -1975,43 +2036,95 @@ When set to "auto", the value is dependent on "ipv4\&.method"\&. When set to "de Format: int32 .RE .PP -\fBmay\-fail\fR +\fBipv4\&.may\-fail\fR .RS 4 If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out\&. Note that at least one IP configuration must succeed or overall network configuration will still fail\&. For example, in IPv6\-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully\&. .sp Format: boolean .RE .PP -\fBmethod\fR +\fBipv4\&.method\fR .RS 4 -IP configuration method\&. +Sets the IPv4 connection method\&. You can set one of the following values: .sp -NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link\-local"\&. See the subclass\-specific documentation for other values\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"auto" +\- Enables automatic IPv4 address assignment from DHCP, PPP, or similar services\&. +.RE .sp -In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration\&. The "ignore\-auto\-routes" and "ignore\-auto\-dns" properties modify this behavior\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"manual" +\- Enables the configuration of static IPv4 addresses on the interface\&. Note that you must set at least one IP address and subnet mask in the "ipv4\&.addresses" property\&. +.RE .sp -For methods that imply no upstream network, such as "shared" or "link\-local", these properties must be empty\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"disabled" +\- Disables the IPv4 protocol in this connection profile\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"shared" +\- Provides network access to other computers\&. If you do not specify an IP address and subnet mask in "ipv4\&.addresses", NetworkManager assigns 10\&.42\&.x\&.1/24 to the interface\&. Additionally, NetworkManager starts a DHCP server and DNS forwarder\&. Hosts that connect to this interface will then receive an IP address from the configured range, and NetworkManager configures NAT to map client addresses to the one of the current default network connection\&. +.RE .sp -For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10\&.42\&.x\&.0/24 is chosen\&. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"link\-local" +\- Enables link\-local addresses according to RFC 3927\&. NetworkManager assigns a random link\-local address from the 169\&.254\&.0\&.0/16 subnet to the interface\&. +.RE .sp Format: string .RE .PP -\fBnever\-default\fR +\fBipv4\&.never\-default\fR .RS 4 If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager\&. .sp Format: boolean .RE .PP -\fBreplace\-local\-rule\fR +\fBipv4\&.replace\-local\-rule\fR .RS 4 Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. .sp Format: NMTernary (int32) .RE .PP -\fBrequired\-timeout\fR +\fBipv4\&.required\-timeout\fR .RS 4 The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds\&. .sp @@ -2024,14 +2137,14 @@ A zero value means that no required timeout is present, \-1 means the default va Format: int32 .RE .PP -\fBroute\-metric\fR +\fBipv4\&.route\-metric\fR .RS 4 The default metric for routes that don\*(Aqt explicitly specify a metric\&. The default value \-1 means that the metric is chosen automatically based on the device type\&. The metric applies to dynamic routes, manual (static) routes that don\*(Aqt have an explicit metric setting, address prefix routes, and the default route\&. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default)\&. Hence, setting this property to zero effectively mean setting it to 1024\&. For IPv4, zero is a regular value for the metric\&. .sp Format: int64 .RE .PP -\fBroute\-table\fR +\fBipv4\&.route\-table\fR .RS 4 Enable policy routing (source routing) and set the routing table used when adding routes\&. .sp @@ -2044,7 +2157,7 @@ Policy routing disabled means that NetworkManager will add all routes to the mai Format: uint32 .RE .PP -\fBroutes\fR +\fBipv4\&.routes\fR .RS 4 A list of IPv4 destination addresses, prefix length, optional IPv4 next hop addresses, optional route metric, optional attribute\&. The valid syntax is: "ip[/prefix] [next\-hop] [metric] [attribute=val]\&.\&.\&.[,ip[/prefix]\&.\&.\&.]"\&. For example "192\&.0\&.2\&.0/24 10\&.1\&.1\&.1 77, 198\&.51\&.100\&.0/24"\&. .sp @@ -2316,7 +2429,7 @@ For details see also `man ip\-route`\&. Format: a comma separated list of routes .RE .PP -\fBrouting\-rules\fR +\fBipv4\&.routing\-rules\fR .RS 4 A comma separated list of routing rules for policy routing\&. The format is based on \fBip rule add\fR @@ -2333,33 +2446,35 @@ IPv6 Settings\&. .PP Properties: .PP -\fBaddr\-gen\-mode\fR +\fBipv6\&.addr\-gen\-mode\fR .RS 4 -Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration\&. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0), NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1)\&. NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT_OR_EUI64 (2) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_DEFAULT (3)\&. +Configure method for creating the IPv6 interface identifer of addresses with RFC4862 IPv6 Stateless Address Autoconfiguration and Link Local addresses\&. .sp -If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address\&. This makes the host part of the address to stay constant, making it possible to track host\*(Aqs presence when it changes networks\&. The address changes when the interface hardware is replaced\&. +The permitted values are: "eui64" (0), "stable\-privacy" (1), "default" (3) or "default\-or\-eui64" (2)\&. .sp -The value of stable\-privacy enables use of cryptographically secure hash of a secret host\-specific key along with the connection\*(Aqs stable\-id and the network address as specified by RFC7217\&. This makes it impossible to use the address track host\*(Aqs presence, and makes the address stable when the network interface hardware is replaced\&. +If the property is set to "eui64", the addresses will be generated using the interface token derived from hardware address\&. This makes the host part of the address to stay constant, making it possible to track the host\*(Aqs presence when it changes networks\&. The address changes when the interface hardware is replaced\&. If a duplicate address is detected, there is also no fallback to generate another address\&. When configured, the "ipv6\&.token" is used instead of the MAC address to generate addresses for stateless autoconfiguration\&. .sp -The special values "default" and "default\-or\-eui64" will fallback to the global connection default in as documented in NetworkManager\&.conf(5) manual\&. If the global default is not specified, the fallback value is "stable\-privacy" or "eui64", respectively\&. +If the property is set to "stable\-privacy", the interface identifier is generated as specified by RFC7217\&. This works by hashing a host specific key (see NetworkManager(8) manual), the interface name, the connection\*(Aqs "connection\&.stable\-id" property and the address prefix\&. This improves privacy by making it harder to use the address to track the host\*(Aqs presence and the address is stable when the network interface hardware is replaced\&. .sp -For libnm, the property defaults to "default" since 1\&.40\&. Previously it defaulted to "stable\-privacy"\&. On D\-Bus, the absence of an addr\-gen\-mode setting equals "default"\&. For keyfile plugin, the absence of the setting on disk means "default\-or\-eui64" so that the property doesn\*(Aqt change on upgrade from older versions\&. +The special values "default" and "default\-or\-eui64" will fallback to the global connection default as documented in the NetworkManager\&.conf(5) manual\&. If the global default is not specified, the fallback value is "stable\-privacy" or "eui64", respectively\&. +.sp +If not specified, when creating a new profile the default is "default"\&. .sp Note that this setting is distinct from the Privacy Extensions as configured by "ip6\-privacy" property and it does not affect the temporary addresses configured with this option\&. .sp -Format: int32 +Format: one of "eui64" (0), "stable\-privacy" (1), "default" (3) or "default\-or\-eui64" (2) .RE .PP -\fBaddresses\fR +\fBipv6\&.addresses\fR .RS 4 Alias: ip6 .sp -Array of IP addresses\&. +A list of IPv6 addresses and their prefix length\&. Multiple addresses can be separated by comma\&. For example "2001:db8:85a3::8a2e:370:7334/64, 2001:db8:85a3::5/64"\&. The addresses are listed in decreasing priority, meaning the first address will be the primary address\&. This can make a difference with IPv6 source address selection (RFC 6724, section 5)\&. .sp Format: a comma separated list of addresses .RE .PP -\fBauto\-route\-ext\-gw\fR +\fBipv6\&.auto\-route\-ext\-gw\fR .RS 4 VPN connections will default to add the route automatically unless this setting is set to FALSE\&. .sp @@ -2368,7 +2483,7 @@ For other connection types, adding such an automatic route is currently not supp Format: NMTernary (int32) .RE .PP -\fBdhcp\-duid\fR +\fBipv6\&.dhcp\-duid\fR .RS 4 A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315)\&. The DUID is carried in the Client Identifier option\&. If the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option\&. .sp @@ -2383,14 +2498,14 @@ When the property is unset, the global value provided for "ipv6\&.dhcp\-duid" is Format: string .RE .PP -\fBdhcp\-hostname\fR +\fBipv6\&.dhcp\-hostname\fR .RS 4 If the "dhcp\-send\-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease\&. This property and "dhcp\-fqdn" are mutually exclusive and cannot be set at the same time\&. .sp Format: string .RE .PP -\fBdhcp\-hostname\-flags\fR +\fBipv6\&.dhcp\-hostname\-flags\fR .RS 4 Flags for the DHCP hostname and FQDN\&. .sp @@ -2401,9 +2516,9 @@ When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), Format: uint32 .RE .PP -\fBdhcp\-iaid\fR +\fBipv6\&.dhcp\-iaid\fR .RS 4 -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. +A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. .sp For DHCPv4, the IAID is only used with "ipv4\&.dhcp\-client\-id" values "duid" and "ipv6\-duid" to generate the client\-id\&. .sp @@ -2414,14 +2529,21 @@ The actually used DHCPv6 IAID for a currently activated interface is exposed in Format: string .RE .PP -\fBdhcp\-send\-hostname\fR +\fBipv6\&.dhcp\-pd\-hint\fR +.RS 4 +A IPv6 address followed by a slash and a prefix length\&. If set, the value is sent to the DHCPv6 server as hint indicating the prefix delegation (IA_PD) we want to receive\&. To only hint a prefix length without prefix, set the address part to the zero address (for example "::/60")\&. +.sp +Format: string +.RE +.PP +\fBipv6\&.dhcp\-send\-hostname\fR .RS 4 If TRUE, a hostname is sent to the DHCP server when acquiring a lease\&. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer\&. If the "dhcp\-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent\&. .sp Format: boolean .RE .PP -\fBdhcp\-timeout\fR +\fBipv6\&.dhcp\-timeout\fR .RS 4 A timeout for a DHCP transaction in seconds\&. If zero (the default), a globally configured default is used\&. If still unspecified, a device specific timeout is used (usually 45 seconds)\&. .sp @@ -2430,7 +2552,7 @@ Set to 2147483647 (MAXINT32) for infinity\&. Format: int32 .RE .PP -\fBdns\fR +\fBipv6\&.dns\fR .RS 4 Array of IP addresses of DNS servers\&. .sp @@ -2439,22 +2561,24 @@ For DoT (DNS over TLS), the SNI server name can be specified by appending "#exam Format: array of byte array .RE .PP -\fBdns\-options\fR +\fBipv6\&.dns\-options\fR .RS 4 -Array of DNS options as described in man 5 resolv\&.conf\&. +DNS options for /etc/resolv\&.conf as described in resolv\&.conf(5) manual\&. .sp -NULL means that the options are unset and left at the default\&. In this case NetworkManager will use default options\&. This is distinct from an empty list of properties\&. +The currently supported options are "attempts", "debug", "edns0", "ndots", "no\-aaaa", "no\-check\-names", "no\-reload", "no\-tld\-query", "rotate", "single\-request", "single\-request\-reopen", "timeout", "trust\-ad", "use\-vc" and "inet6", "ip6\-bytestring", "ip6\-dotint", "no\-ip6\-dotint"\&. See the resolv\&.conf(5) manual\&. .sp -The currently supported options are "attempts", "debug", "edns0", "inet6", "ip6\-bytestring", "ip6\-dotint", "ndots", "no\-aaaa", "no\-check\-names", "no\-ip6\-dotint", "no\-reload", "no\-tld\-query", "rotate", "single\-request", "single\-request\-reopen", "timeout", "trust\-ad", "use\-vc"\&. +Note that there is a distinction between an unset (default) list and an empty list\&. In nmcli, to unset the list set the value to ""\&. To set an empty list, set it to " "\&. Currently, an unset list has the same meaning as an empty list\&. That might change in the future\&. .sp The "trust\-ad" setting is only honored if the profile contributes name servers to resolv\&.conf, and if all contributing profiles have "trust\-ad" enabled\&. .sp When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added\&. .sp -Format: array of string +The valid "ipv4\&.dns\-options" and "ipv6\&.dns\-options" get merged together\&. +.sp +Format: a comma separated list of DNS options .RE .PP -\fBdns\-priority\fR +\fBipv6\&.dns\-priority\fR .RS 4 DNS servers priority\&. .sp @@ -2475,7 +2599,7 @@ When using a DNS resolver that supports Conditional Forwarding or Split DNS (wit Format: int32 .RE .PP -\fBdns\-search\fR +\fBipv6\&.dns\-search\fR .RS 4 List of DNS search domains\&. Domains starting with a tilde (\*(Aq~\*(Aq) are considered \*(Aqrouting\*(Aq domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names\&. .sp @@ -2486,7 +2610,7 @@ When set on a profile that also enabled DHCP, the DNS search list received autom Format: array of string .RE .PP -\fBgateway\fR +\fBipv6\&.gateway\fR .RS 4 Alias: gw6 .sp @@ -2499,21 +2623,21 @@ Note that the gateway usually conflicts with routing that NetworkManager configu Format: string .RE .PP -\fBignore\-auto\-dns\fR +\fBipv6\&.ignore\-auto\-dns\fR .RS 4 When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns\-search" properties, if any, are used\&. .sp Format: boolean .RE .PP -\fBignore\-auto\-routes\fR +\fBipv6\&.ignore\-auto\-routes\fR .RS 4 When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used\&. .sp Format: boolean .RE .PP -\fBip6\-privacy\fR +\fBipv6\&.ip6\-privacy\fR .RS 4 Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941\&. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI\-64\&. This enhances privacy, but could cause problems in some applications, on the other hand\&. The permitted values are: \-1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses)\&. .sp @@ -2526,43 +2650,122 @@ Note that this setting is distinct from the Stable Privacy addresses that can be Format: NMSettingIP6ConfigPrivacy (int32) .RE .PP -\fBmay\-fail\fR +\fBipv6\&.may\-fail\fR .RS 4 If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out\&. Note that at least one IP configuration must succeed or overall network configuration will still fail\&. For example, in IPv6\-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully\&. .sp Format: boolean .RE .PP -\fBmethod\fR +\fBipv6\&.method\fR .RS 4 -IP configuration method\&. +Sets the IPv6 connection method\&. You can set one of the following values: .sp -NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link\-local"\&. See the subclass\-specific documentation for other values\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"auto" +\- Enables IPv6 auto\-configuration\&. By default, NetworkManager uses Router Advertisements and, if the router announces the "managed" flag, NetworkManager requests an IPv6 address and prefix from a DHCPv6 server\&. +.RE .sp -In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration\&. The "ignore\-auto\-routes" and "ignore\-auto\-dns" properties modify this behavior\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"dhcp" +\- Requests an IPv6 address and prefix from a DHCPv6 server\&. Note that DHCPv6 does not have options to provide routes and the default gateway\&. As a consequence, by using the "dhcp" method, connections are limited to their own subnet\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"manual" +\- Enables the configuration of static IPv6 addresses on the interface\&. Note that you must set at least one IP address and prefix in the "ipv6\&.addresses" property\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"disabled" +\- Disables the IPv6 protocol in this connection profile\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"ignore" +\- Configures NetworkManager to make no changes to the IPv6 configuration on the interface\&. For example, you can then use the "accept_ra" feature of the kernel to accept Router Advertisements\&. +.RE .sp -For methods that imply no upstream network, such as "shared" or "link\-local", these properties must be empty\&. +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"shared" +\- Provides network access to other computers\&. NetworkManager requests a prefix from an upstream DHCPv6 server, assigns an address to the interface, and announces the prefix to clients that connect to this interface\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +"link\-local" +\- Assigns a random link\-local address from the fe80::/64 subnet to the interface\&. +.RE .sp -For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10\&.42\&.x\&.0/24 is chosen\&. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared\&. + +If you set "auto", "dhcp", "manual", "ignore", or "shared", NetworkManager assigns, in addition to the global address, an IPv6 link\-local address to the interface\&. This is compliant with RFC 4291\&. .sp Format: string .RE .PP -\fBmtu\fR +\fBipv6\&.mtu\fR .RS 4 Maximum transmission unit size, in bytes\&. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link\-layer MTU\&. If greater than the link\-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect\&. .sp Format: uint32 .RE .PP -\fBnever\-default\fR +\fBipv6\&.never\-default\fR .RS 4 If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager\&. .sp Format: boolean .RE .PP -\fBra\-timeout\fR +\fBipv6\&.ra\-timeout\fR .RS 4 A timeout for waiting Router Advertisements in seconds\&. If zero (the default), a globally configured default is used\&. If still unspecified, the timeout depends on the sysctl settings of the device\&. .sp @@ -2571,14 +2774,14 @@ Set to 2147483647 (MAXINT32) for infinity\&. Format: int32 .RE .PP -\fBreplace\-local\-rule\fR +\fBipv6\&.replace\-local\-rule\fR .RS 4 Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. .sp Format: NMTernary (int32) .RE .PP -\fBrequired\-timeout\fR +\fBipv6\&.required\-timeout\fR .RS 4 The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds\&. .sp @@ -2591,14 +2794,14 @@ A zero value means that no required timeout is present, \-1 means the default va Format: int32 .RE .PP -\fBroute\-metric\fR +\fBipv6\&.route\-metric\fR .RS 4 The default metric for routes that don\*(Aqt explicitly specify a metric\&. The default value \-1 means that the metric is chosen automatically based on the device type\&. The metric applies to dynamic routes, manual (static) routes that don\*(Aqt have an explicit metric setting, address prefix routes, and the default route\&. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default)\&. Hence, setting this property to zero effectively mean setting it to 1024\&. For IPv4, zero is a regular value for the metric\&. .sp Format: int64 .RE .PP -\fBroute\-table\fR +\fBipv6\&.route\-table\fR .RS 4 Enable policy routing (source routing) and set the routing table used when adding routes\&. .sp @@ -2611,7 +2814,7 @@ Policy routing disabled means that NetworkManager will add all routes to the mai Format: uint32 .RE .PP -\fBroutes\fR +\fBipv6\&.routes\fR .RS 4 A list of IPv6 destination addresses, prefix length, optional IPv6 next hop addresses, optional route metric, optional attribute\&. The valid syntax is: "ip[/prefix] [next\-hop] [metric] [attribute=val]\&.\&.\&.[,ip[/prefix]\&.\&.\&.]"\&. .sp @@ -2857,7 +3060,7 @@ For details see also `man ip\-route`\&. Format: a comma separated list of routes .RE .PP -\fBrouting\-rules\fR +\fBipv6\&.routing\-rules\fR .RS 4 A comma separated list of routing rules for policy routing\&. The format is based on \fBip rule add\fR @@ -2869,10 +3072,12 @@ priority 5 from 1:2:3::5/128 table 45 Format: a comma separated list of routing rules .RE .PP -\fBtoken\fR +\fBipv6\&.token\fR .RS 4 Configure the token for draft\-chown\-6man\-tokenised\-ipv6\-identifiers\-02 IPv6 tokenized interface identifiers\&. Useful with eui64 addr\-gen\-mode\&. .sp +When set, the token is used as IPv6 interface identifier instead of the hardware address\&. This only applies to addresses from stateless autoconfiguration, not to IPv6 link local addresses\&. +.sp Format: string .RE .SS "ip\-tunnel setting" @@ -2881,42 +3086,42 @@ IP Tunneling Settings\&. .PP Properties: .PP -\fBencapsulation\-limit\fR +\fBip\-tunnel\&.encapsulation\-limit\fR .RS 4 How many additional levels of encapsulation are permitted to be prepended to packets\&. This property applies only to IPv6 tunnels\&. To disable this option, add NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1) to ip\-tunnel flags\&. .sp Format: uint32 .RE .PP -\fBflags\fR +\fBip\-tunnel\&.flags\fR .RS 4 Tunnel flags\&. Currently, the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20)\&. They are valid only for IPv6 tunnels\&. .sp Format: uint32 .RE .PP -\fBflow\-label\fR +\fBip\-tunnel\&.flow\-label\fR .RS 4 The flow label to assign to tunnel packets\&. This property applies only to IPv6 tunnels\&. .sp Format: uint32 .RE .PP -\fBfwmark\fR +\fBip\-tunnel\&.fwmark\fR .RS 4 The fwmark value to assign to tunnel packets\&. This property can be set to a non zero value only on VTI and VTI6 tunnels\&. .sp Format: uint32 .RE .PP -\fBinput\-key\fR +\fBip\-tunnel\&.input\-key\fR .RS 4 The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE)\&. If empty, no key is used\&. .sp Format: string .RE .PP -\fBlocal\fR +\fBip\-tunnel\&.local\fR .RS 4 Alias: local .sp @@ -2925,7 +3130,7 @@ The local endpoint of the tunnel; the value can be empty, otherwise it must cont Format: string .RE .PP -\fBmode\fR +\fBip\-tunnel\&.mode\fR .RS 4 Alias: mode .sp @@ -2934,21 +3139,21 @@ The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_ Format: uint32 .RE .PP -\fBmtu\fR +\fBip\-tunnel\&.mtu\fR .RS 4 If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments\&. .sp Format: uint32 .RE .PP -\fBoutput\-key\fR +\fBip\-tunnel\&.output\-key\fR .RS 4 The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE)\&. If empty, no key is used\&. .sp Format: string .RE .PP -\fBparent\fR +\fBip\-tunnel\&.parent\fR .RS 4 Alias: dev .sp @@ -2957,14 +3162,14 @@ If given, specifies the parent interface name or parent connection UUID the new Format: string .RE .PP -\fBpath\-mtu\-discovery\fR +\fBip\-tunnel\&.path\-mtu\-discovery\fR .RS 4 Whether to enable Path MTU Discovery on this tunnel\&. .sp Format: boolean .RE .PP -\fBremote\fR +\fBip\-tunnel\&.remote\fR .RS 4 Alias: remote .sp @@ -2973,14 +3178,14 @@ The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 addres Format: string .RE .PP -\fBtos\fR +\fBip\-tunnel\&.tos\fR .RS 4 The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets\&. .sp Format: uint32 .RE .PP -\fBttl\fR +\fBip\-tunnel\&.ttl\fR .RS 4 The TTL to assign to tunneled packets\&. 0 is a special value meaning that packets inherit the TTL value\&. .sp @@ -2992,7 +3197,7 @@ MACSec Settings\&. .PP Properties: .PP -\fBencrypt\fR +\fBmacsec\&.encrypt\fR .RS 4 Alias: encrypt .sp @@ -3001,7 +3206,7 @@ Whether the transmitted traffic must be encrypted\&. Format: boolean .RE .PP -\fBmka\-cak\fR +\fBmacsec\&.mka\-cak\fR .RS 4 Alias: cak .sp @@ -3010,14 +3215,18 @@ The pre\-shared CAK (Connectivity Association Key) for MACsec Key Agreement\&. M Format: string .RE .PP -\fBmka\-cak\-flags\fR +\fBmacsec\&.mka\-cak\-flags\fR .RS 4 Flags indicating how to handle the "mka\-cak" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBmka\-ckn\fR +\fBmacsec\&.mka\-ckn\fR .RS 4 Alias: ckn .sp @@ -3026,7 +3235,7 @@ The pre\-shared CKN (Connectivity\-association Key Name) for MACsec Key Agreemen Format: string .RE .PP -\fBmode\fR +\fBmacsec\&.mode\fR .RS 4 Alias: mode .sp @@ -3035,7 +3244,7 @@ Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreeme Format: int32 .RE .PP -\fBparent\fR +\fBmacsec\&.parent\fR .RS 4 Alias: dev .sp @@ -3044,7 +3253,7 @@ If given, specifies the parent interface name or parent connection UUID from whi Format: string .RE .PP -\fBport\fR +\fBmacsec\&.port\fR .RS 4 Alias: port .sp @@ -3053,14 +3262,14 @@ The port component of the SCI (Secure Channel Identifier), between 1 and 65534\& Format: int32 .RE .PP -\fBsend\-sci\fR +\fBmacsec\&.send\-sci\fR .RS 4 Specifies whether the SCI (Secure Channel Identifier) is included in every packet\&. .sp Format: boolean .RE .PP -\fBvalidation\fR +\fBmacsec\&.validation\fR .RS 4 Specifies the validation mode for incoming frames\&. .sp @@ -3072,7 +3281,7 @@ MAC VLAN Settings\&. .PP Properties: .PP -\fBmode\fR +\fBmacvlan\&.mode\fR .RS 4 Alias: mode .sp @@ -3081,7 +3290,7 @@ The macvlan mode, which specifies the communication mechanism between multiple m Format: uint32 .RE .PP -\fBparent\fR +\fBmacvlan\&.parent\fR .RS 4 Alias: dev .sp @@ -3090,14 +3299,14 @@ If given, specifies the parent interface name or parent connection UUID from whi Format: string .RE .PP -\fBpromiscuous\fR +\fBmacvlan\&.promiscuous\fR .RS 4 Whether the interface should be put in promiscuous mode\&. .sp Format: boolean .RE .PP -\fBtap\fR +\fBmacvlan\&.tap\fR .RS 4 Alias: tap .sp @@ -3111,7 +3320,7 @@ Match settings\&. .PP Properties: .PP -\fBdriver\fR +\fBmatch\&.driver\fR .RS 4 A list of driver names to match\&. Each element is a shell wildcard pattern\&. .sp @@ -3120,7 +3329,7 @@ See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq Format: array of string .RE .PP -\fBinterface\-name\fR +\fBmatch\&.interface\-name\fR .RS 4 A list of interface names to match\&. Each element is a shell wildcard pattern\&. .sp @@ -3129,7 +3338,7 @@ An element can be prefixed with a pipe symbol (|) or an ampersand (&)\&. The for Format: array of string .RE .PP -\fBkernel\-command\-line\fR +\fBmatch\&.kernel\-command\-line\fR .RS 4 A list of kernel command line arguments to match\&. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark)\&. The argument must either be a single word, or an assignment (i\&.e\&. two words, joined by "=")\&. In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment\&. In the latter case, the exact assignment is looked for with right and left hand side matching\&. Wildcard patterns are not supported\&. .sp @@ -3138,7 +3347,7 @@ See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq Format: array of string .RE .PP -\fBpath\fR +\fBmatch\&.path\fR .RS 4 A list of paths to match against the ID_PATH udev property of devices\&. ID_PATH represents the topological persistent path of a device\&. It typically contains a subsystem string (pci, usb, platform, etc\&.) and a subsystem\-specific identifier\&. .sp @@ -3160,7 +3369,7 @@ OLPC Wireless Mesh Settings\&. .PP Properties: .PP -\fBchannel\fR +\fB802\-11\-olpc\-mesh\&.channel\fR .RS 4 Alias: channel .sp @@ -3169,7 +3378,7 @@ Channel on which the mesh network to join is located\&. Format: uint32 .RE .PP -\fBdhcp\-anycast\-address\fR +\fB802\-11\-olpc\-mesh\&.dhcp\-anycast\-address\fR .RS 4 Alias: dhcp\-anycast .sp @@ -3180,7 +3389,7 @@ This is currently only implemented by dhclient DHCP plugin\&. Format: byte array .RE .PP -\fBssid\fR +\fB802\-11\-olpc\-mesh\&.ssid\fR .RS 4 Alias: ssid .sp @@ -3194,35 +3403,35 @@ OvsBridge Link Settings\&. .PP Properties: .PP -\fBdatapath\-type\fR +\fBovs\-bridge\&.datapath\-type\fR .RS 4 The data path type\&. One of "system", "netdev" or empty\&. .sp Format: string .RE .PP -\fBfail\-mode\fR +\fBovs\-bridge\&.fail\-mode\fR .RS 4 The bridge failure mode\&. One of "secure", "standalone" or empty\&. .sp Format: string .RE .PP -\fBmcast\-snooping\-enable\fR +\fBovs\-bridge\&.mcast\-snooping\-enable\fR .RS 4 Enable or disable multicast snooping\&. .sp Format: boolean .RE .PP -\fBrstp\-enable\fR +\fBovs\-bridge\&.rstp\-enable\fR .RS 4 Enable or disable RSTP\&. .sp Format: boolean .RE .PP -\fBstp\-enable\fR +\fBovs\-bridge\&.stp\-enable\fR .RS 4 Enable or disable STP\&. .sp @@ -3234,28 +3443,28 @@ OvsDpdk Link Settings\&. .PP Properties: .PP -\fBdevargs\fR +\fBovs\-dpdk\&.devargs\fR .RS 4 Open vSwitch DPDK device arguments\&. .sp Format: string .RE .PP -\fBn\-rxq\fR +\fBovs\-dpdk\&.n\-rxq\fR .RS 4 Open vSwitch DPDK number of rx queues\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue\&. .sp Format: uint32 .RE .PP -\fBn\-rxq\-desc\fR +\fBovs\-dpdk\&.n\-rxq\-desc\fR .RS 4 The rx queue size (number of rx descriptors) for DPDK ports\&. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors\&. .sp Format: uint32 .RE .PP -\fBn\-txq\-desc\fR +\fBovs\-dpdk\&.n\-txq\-desc\fR .RS 4 The tx queue size (number of tx descriptors) for DPDK ports\&. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors\&. .sp @@ -3267,14 +3476,14 @@ Open vSwitch Interface Settings\&. .PP Properties: .PP -\fBofport\-request\fR +\fBovs\-interface\&.ofport\-request\fR .RS 4 Open vSwitch openflow port number\&. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs\&. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network\&. OpenFlow switches connect logically to each other via their OpenFlow ports\&. .sp Format: uint32 .RE .PP -\fBtype\fR +\fBovs\-interface\&.type\fR .RS 4 The interface type\&. Either "internal", "system", "patch", "dpdk", or empty\&. .sp @@ -3286,7 +3495,7 @@ OvsPatch Link Settings\&. .PP Properties: .PP -\fBpeer\fR +\fBovs\-patch\&.peer\fR .RS 4 Specifies the name of the interface for the other side of the patch\&. The patch on the other side must also set this interface as peer\&. .sp @@ -3298,42 +3507,42 @@ OvsPort Link Settings\&. .PP Properties: .PP -\fBbond\-downdelay\fR +\fBovs\-port\&.bond\-downdelay\fR .RS 4 The time port must be inactive in order to be considered down\&. .sp Format: uint32 .RE .PP -\fBbond\-mode\fR +\fBovs\-port\&.bond\-mode\fR .RS 4 Bonding mode\&. One of "active\-backup", "balance\-slb", or "balance\-tcp"\&. .sp Format: string .RE .PP -\fBbond\-updelay\fR +\fBovs\-port\&.bond\-updelay\fR .RS 4 The time port must be active before it starts forwarding traffic\&. .sp Format: uint32 .RE .PP -\fBlacp\fR +\fBovs\-port\&.lacp\fR .RS 4 LACP mode\&. One of "active", "off", or "passive"\&. .sp Format: string .RE .PP -\fBtag\fR +\fBovs\-port\&.tag\fR .RS 4 The VLAN tag in the range 0\-4095\&. .sp Format: uint32 .RE .PP -\fBtrunks\fR +\fBovs\-port\&.trunks\fR .RS 4 A list of VLAN ranges that this port trunks\&. .sp @@ -3342,7 +3551,7 @@ The property is valid only for ports with mode "trunk", "native\-tagged", or "na Format: array of vardict .RE .PP -\fBvlan\-mode\fR +\fBovs\-port\&.vlan\-mode\fR .RS 4 The VLAN mode\&. One of "access", "native\-tagged", "native\-untagged", "trunk", "dot1q\-tunnel" or unset\&. .sp @@ -3354,126 +3563,126 @@ Point\-to\-Point Protocol Settings\&. .PP Properties: .PP -\fBbaud\fR +\fBppp\&.baud\fR .RS 4 If non\-zero, instruct pppd to set the serial port to the specified baudrate\&. This value should normally be left as 0 to automatically choose the speed\&. .sp Format: uint32 .RE .PP -\fBcrtscts\fR +\fBppp\&.crtscts\fR .RS 4 If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals\&. This value should normally be set to FALSE\&. .sp Format: boolean .RE .PP -\fBlcp\-echo\-failure\fR +\fBppp\&.lcp\-echo\-failure\fR .RS 4 If non\-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo\-requests go unanswered by the peer\&. The "lcp\-echo\-interval" property must also be set to a non\-zero value if this property is used\&. .sp Format: uint32 .RE .PP -\fBlcp\-echo\-interval\fR +\fBppp\&.lcp\-echo\-interval\fR .RS 4 If non\-zero, instruct pppd to send an LCP echo\-request frame to the peer every n seconds (where n is the specified value)\&. Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this\&. .sp Format: uint32 .RE .PP -\fBmppe\-stateful\fR +\fBppp\&.mppe\-stateful\fR .RS 4 If TRUE, stateful MPPE is used\&. See pppd documentation for more information on stateful MPPE\&. .sp Format: boolean .RE .PP -\fBmru\fR +\fBppp\&.mru\fR .RS 4 If non\-zero, instruct pppd to request that the peer send packets no larger than the specified size\&. If non\-zero, the MRU should be between 128 and 16384\&. .sp Format: uint32 .RE .PP -\fBmtu\fR +\fBppp\&.mtu\fR .RS 4 If non\-zero, instruct pppd to send packets no larger than the specified size\&. .sp Format: uint32 .RE .PP -\fBno\-vj\-comp\fR +\fBppp\&.no\-vj\-comp\fR .RS 4 If TRUE, Van Jacobsen TCP header compression will not be requested\&. .sp Format: boolean .RE .PP -\fBnoauth\fR +\fBppp\&.noauth\fR .RS 4 If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client\&. If FALSE, require authentication from the remote side\&. In almost all cases, this should be TRUE\&. .sp Format: boolean .RE .PP -\fBnobsdcomp\fR +\fBppp\&.nobsdcomp\fR .RS 4 If TRUE, BSD compression will not be requested\&. .sp Format: boolean .RE .PP -\fBnodeflate\fR +\fBppp\&.nodeflate\fR .RS 4 If TRUE, "deflate" compression will not be requested\&. .sp Format: boolean .RE .PP -\fBrefuse\-chap\fR +\fBppp\&.refuse\-chap\fR .RS 4 If TRUE, the CHAP authentication method will not be used\&. .sp Format: boolean .RE .PP -\fBrefuse\-eap\fR +\fBppp\&.refuse\-eap\fR .RS 4 If TRUE, the EAP authentication method will not be used\&. .sp Format: boolean .RE .PP -\fBrefuse\-mschap\fR +\fBppp\&.refuse\-mschap\fR .RS 4 If TRUE, the MSCHAP authentication method will not be used\&. .sp Format: boolean .RE .PP -\fBrefuse\-mschapv2\fR +\fBppp\&.refuse\-mschapv2\fR .RS 4 If TRUE, the MSCHAPv2 authentication method will not be used\&. .sp Format: boolean .RE .PP -\fBrefuse\-pap\fR +\fBppp\&.refuse\-pap\fR .RS 4 If TRUE, the PAP authentication method will not be used\&. .sp Format: boolean .RE .PP -\fBrequire\-mppe\fR +\fBppp\&.require\-mppe\fR .RS 4 If TRUE, MPPE (Microsoft Point\-to\-Point Encryption) will be required for the PPP session\&. If either 64\-bit or 128\-bit MPPE is not available the session will fail\&. Note that MPPE is not used on mobile broadband connections\&. .sp Format: boolean .RE .PP -\fBrequire\-mppe\-128\fR +\fBppp\&.require\-mppe\-128\fR .RS 4 If TRUE, 128\-bit MPPE (Microsoft Point\-to\-Point Encryption) will be required for the PPP session, and the "require\-mppe" property must also be set to TRUE\&. If 128\-bit MPPE is not available the session will fail\&. .sp @@ -3485,7 +3694,7 @@ PPP\-over\-Ethernet Settings\&. .PP Properties: .PP -\fBparent\fR +\fBpppoe\&.parent\fR .RS 4 Alias: parent .sp @@ -3494,7 +3703,7 @@ If given, specifies the parent interface name on which this PPPoE connection sho Format: string .RE .PP -\fBpassword\fR +\fBpppoe\&.password\fR .RS 4 Alias: password .sp @@ -3503,14 +3712,18 @@ Password used to authenticate with the PPPoE service\&. Format: string .RE .PP -\fBpassword\-flags\fR +\fBpppoe\&.password\-flags\fR .RS 4 Flags indicating how to handle the "password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBservice\fR +\fBpppoe\&.service\fR .RS 4 Alias: service .sp @@ -3519,7 +3732,7 @@ If specified, instruct PPPoE to only initiate sessions with access concentrators Format: string .RE .PP -\fBusername\fR +\fBpppoe\&.username\fR .RS 4 Alias: username .sp @@ -3533,7 +3746,7 @@ WWW Proxy Settings\&. .PP Properties: .PP -\fBbrowser\-only\fR +\fBproxy\&.browser\-only\fR .RS 4 Alias: browser\-only .sp @@ -3542,7 +3755,7 @@ Whether the proxy configuration is for browser only\&. Format: boolean .RE .PP -\fBmethod\fR +\fBproxy\&.method\fR .RS 4 Alias: method .sp @@ -3551,16 +3764,16 @@ Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0) Format: int32 .RE .PP -\fBpac\-script\fR +\fBproxy\&.pac\-script\fR .RS 4 Alias: pac\-script .sp -PAC script for the connection\&. This is an UTF\-8 encoded javascript code that defines a FindProxyForURL() function\&. +The PAC script\&. In the profile this must be an UTF\-8 encoded javascript code that defines a FindProxyForURL() function\&. When setting the property in nmcli, a filename is accepted too\&. In that case, nmcli will read the content of the file and set the script\&. The prefixes "file://" and "js://" are supported to explicitly differentiate between the two\&. .sp Format: string .RE .PP -\fBpac\-url\fR +\fBproxy\&.pac\-url\fR .RS 4 Alias: pac\-url .sp @@ -3574,35 +3787,35 @@ Serial Link Settings\&. .PP Properties: .PP -\fBbaud\fR +\fBserial\&.baud\fR .RS 4 Speed to use for communication over the serial port\&. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed\&. .sp Format: uint32 .RE .PP -\fBbits\fR +\fBserial\&.bits\fR .RS 4 Byte\-width of the serial communication\&. The 8 in "8n1" for example\&. .sp Format: uint32 .RE .PP -\fBparity\fR +\fBserial\&.parity\fR .RS 4 Parity setting of the serial port\&. .sp Format: NMSettingSerialParity (byte) .RE .PP -\fBsend\-delay\fR +\fBserial\&.send\-delay\fR .RS 4 Time to delay between each byte sent to the modem, in microseconds\&. .sp Format: uint64 .RE .PP -\fBstopbits\fR +\fBserial\&.stopbits\fR .RS 4 Number of stop bits for communication on the serial port\&. Either 1 or 2\&. The 1 in "8n1" for example\&. .sp @@ -3614,7 +3827,7 @@ SR\-IOV settings\&. .PP Properties: .PP -\fBautoprobe\-drivers\fR +\fBsriov\&.autoprobe\-drivers\fR .RS 4 Whether to autoprobe virtual functions by a compatible driver\&. .sp @@ -3627,7 +3840,7 @@ When set to NM_TERNARY_DEFAULT (\-1), the global default is used; in case the gl Format: NMTernary (int32) .RE .PP -\fBtotal\-vfs\fR +\fBsriov\&.total\-vfs\fR .RS 4 The total number of virtual functions to create\&. .sp @@ -3636,7 +3849,7 @@ Note that when the sriov setting is present NetworkManager enforces the number o Format: uint32 .RE .PP -\fBvfs\fR +\fBsriov\&.vfs\fR .RS 4 Array of virtual function descriptors\&. .sp @@ -3666,7 +3879,7 @@ Linux Traffic Control Settings\&. .PP Properties: .PP -\fBqdiscs\fR +\fBtc\&.qdiscs\fR .RS 4 Array of TC queueing disciplines\&. qdisc is a basic block in the Linux traffic control subsystem .sp @@ -3795,7 +4008,7 @@ specifies the maximum amount of time a packet can sit in the TBF\&. The latency Format: GPtrArray(NMTCQdisc) .RE .PP -\fBtfilters\fR +\fBtc\&.tfilters\fR .RS 4 Array of TC traffic filters\&. Traffic control can manage the packet content during classification by using filters\&. .sp @@ -3858,7 +4071,7 @@ Teaming Settings\&. .PP Properties: .PP -\fBconfig\fR +\fBteam\&.config\fR .RS 4 Alias: config .sp @@ -3867,105 +4080,105 @@ The JSON configuration for the team network interface\&. The property should con Format: string .RE .PP -\fBlink\-watchers\fR +\fBteam\&.link\-watchers\fR .RS 4 Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher\&. Available link watchers are \*(Aqethtool\*(Aq, \*(Aqnsna_ping\*(Aq and \*(Aqarp_ping\*(Aq and it is specified in the dictionary with the key \*(Aqname\*(Aq\&. Available keys are: ethtool: \*(Aqdelay\-up\*(Aq, \*(Aqdelay\-down\*(Aq, \*(Aqinit\-wait\*(Aq; nsna_ping: \*(Aqinit\-wait\*(Aq, \*(Aqinterval\*(Aq, \*(Aqmissed\-max\*(Aq, \*(Aqtarget\-host\*(Aq; arp_ping: all the ones in nsna_ping and \*(Aqsource\-host\*(Aq, \*(Aqvalidate\-active\*(Aq, \*(Aqvalidate\-inactive\*(Aq, \*(Aqsend\-always\*(Aq\&. See teamd\&.conf man for more details\&. .sp Format: array of vardict .RE .PP -\fBmcast\-rejoin\-count\fR +\fBteam\&.mcast\-rejoin\-count\fR .RS 4 Corresponds to the teamd mcast_rejoin\&.count\&. .sp Format: int32 .RE .PP -\fBmcast\-rejoin\-interval\fR +\fBteam\&.mcast\-rejoin\-interval\fR .RS 4 Corresponds to the teamd mcast_rejoin\&.interval\&. .sp Format: int32 .RE .PP -\fBnotify\-peers\-count\fR +\fBteam\&.notify\-peers\-count\fR .RS 4 Corresponds to the teamd notify_peers\&.count\&. .sp Format: int32 .RE .PP -\fBnotify\-peers\-interval\fR +\fBteam\&.notify\-peers\-interval\fR .RS 4 Corresponds to the teamd notify_peers\&.interval\&. .sp Format: int32 .RE .PP -\fBrunner\fR +\fBteam\&.runner\fR .RS 4 Corresponds to the teamd runner\&.name\&. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random"\&. .sp Format: string .RE .PP -\fBrunner\-active\fR +\fBteam\&.runner\-active\fR .RS 4 Corresponds to the teamd runner\&.active\&. .sp Format: boolean .RE .PP -\fBrunner\-agg\-select\-policy\fR +\fBteam\&.runner\-agg\-select\-policy\fR .RS 4 Corresponds to the teamd runner\&.agg_select_policy\&. .sp Format: string .RE .PP -\fBrunner\-fast\-rate\fR +\fBteam\&.runner\-fast\-rate\fR .RS 4 Corresponds to the teamd runner\&.fast_rate\&. .sp Format: boolean .RE .PP -\fBrunner\-hwaddr\-policy\fR +\fBteam\&.runner\-hwaddr\-policy\fR .RS 4 Corresponds to the teamd runner\&.hwaddr_policy\&. .sp Format: string .RE .PP -\fBrunner\-min\-ports\fR +\fBteam\&.runner\-min\-ports\fR .RS 4 Corresponds to the teamd runner\&.min_ports\&. .sp Format: int32 .RE .PP -\fBrunner\-sys\-prio\fR +\fBteam\&.runner\-sys\-prio\fR .RS 4 Corresponds to the teamd runner\&.sys_prio\&. .sp Format: int32 .RE .PP -\fBrunner\-tx\-balancer\fR +\fBteam\&.runner\-tx\-balancer\fR .RS 4 Corresponds to the teamd runner\&.tx_balancer\&.name\&. .sp Format: string .RE .PP -\fBrunner\-tx\-balancer\-interval\fR +\fBteam\&.runner\-tx\-balancer\-interval\fR .RS 4 Corresponds to the teamd runner\&.tx_balancer\&.interval\&. .sp Format: int32 .RE .PP -\fBrunner\-tx\-hash\fR +\fBteam\&.runner\-tx\-hash\fR .RS 4 Corresponds to the teamd runner\&.tx_hash\&. .sp @@ -3977,7 +4190,7 @@ Team Port Settings\&. .PP Properties: .PP -\fBconfig\fR +\fBteam\-port\&.config\fR .RS 4 Alias: config .sp @@ -3986,42 +4199,42 @@ The JSON configuration for the team port\&. The property should contain raw JSON Format: string .RE .PP -\fBlacp\-key\fR +\fBteam\-port\&.lacp\-key\fR .RS 4 Corresponds to the teamd ports\&.PORTIFNAME\&.lacp_key\&. .sp Format: int32 .RE .PP -\fBlacp\-prio\fR +\fBteam\-port\&.lacp\-prio\fR .RS 4 Corresponds to the teamd ports\&.PORTIFNAME\&.lacp_prio\&. .sp Format: int32 .RE .PP -\fBlink\-watchers\fR +\fBteam\-port\&.link\-watchers\fR .RS 4 Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher\&. Available link watchers are \*(Aqethtool\*(Aq, \*(Aqnsna_ping\*(Aq and \*(Aqarp_ping\*(Aq and it is specified in the dictionary with the key \*(Aqname\*(Aq\&. Available keys are: ethtool: \*(Aqdelay\-up\*(Aq, \*(Aqdelay\-down\*(Aq, \*(Aqinit\-wait\*(Aq; nsna_ping: \*(Aqinit\-wait\*(Aq, \*(Aqinterval\*(Aq, \*(Aqmissed\-max\*(Aq, \*(Aqtarget\-host\*(Aq; arp_ping: all the ones in nsna_ping and \*(Aqsource\-host\*(Aq, \*(Aqvalidate\-active\*(Aq, \*(Aqvalidate\-inactive\*(Aq, \*(Aqsend\-always\*(Aq\&. See teamd\&.conf man for more details\&. .sp Format: array of vardict .RE .PP -\fBprio\fR +\fBteam\-port\&.prio\fR .RS 4 Corresponds to the teamd ports\&.PORTIFNAME\&.prio\&. .sp Format: int32 .RE .PP -\fBqueue\-id\fR +\fBteam\-port\&.queue\-id\fR .RS 4 Corresponds to the teamd ports\&.PORTIFNAME\&.queue_id\&. When set to \-1 means the parameter is skipped from the json config\&. .sp Format: int32 .RE .PP -\fBsticky\fR +\fBteam\-port\&.sticky\fR .RS 4 Corresponds to the teamd ports\&.PORTIFNAME\&.sticky\&. .sp @@ -4033,7 +4246,7 @@ Tunnel Settings\&. .PP Properties: .PP -\fBgroup\fR +\fBtun\&.group\fR .RS 4 Alias: group .sp @@ -4042,7 +4255,7 @@ The group ID which will own the device\&. If set to NULL everyone will be able t Format: string .RE .PP -\fBmode\fR +\fBtun\&.mode\fR .RS 4 Alias: mode .sp @@ -4051,7 +4264,7 @@ The operating mode of the virtual device\&. Allowed values are NM_SETTING_TUN_MO Format: uint32 .RE .PP -\fBmulti\-queue\fR +\fBtun\&.multi\-queue\fR .RS 4 Alias: multi\-queue .sp @@ -4060,7 +4273,7 @@ If the property is set to TRUE, the interface will support multiple file descrip Format: boolean .RE .PP -\fBowner\fR +\fBtun\&.owner\fR .RS 4 Alias: owner .sp @@ -4069,7 +4282,7 @@ The user ID which will own the device\&. If set to NULL everyone will be able to Format: string .RE .PP -\fBpi\fR +\fBtun\&.pi\fR .RS 4 Alias: pi .sp @@ -4078,7 +4291,7 @@ If TRUE the interface will prepend a 4 byte header describing the physical inter Format: boolean .RE .PP -\fBvnet\-hdr\fR +\fBtun\&.vnet\-hdr\fR .RS 4 Alias: vnet\-hdr .sp @@ -4092,7 +4305,7 @@ VLAN Settings\&. .PP Properties: .PP -\fBegress\-priority\-map\fR +\fBvlan\&.egress\-priority\-map\fR .RS 4 Alias: egress .sp @@ -4101,7 +4314,7 @@ For outgoing packets, a list of mappings from Linux SKB priorities to 802\&.1p p Format: array of string .RE .PP -\fBflags\fR +\fBvlan\&.flags\fR .RS 4 Alias: flags .sp @@ -4112,7 +4325,7 @@ The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used Format: NMVlanFlags (uint32) .RE .PP -\fBid\fR +\fBvlan\&.id\fR .RS 4 Alias: id .sp @@ -4121,7 +4334,7 @@ The VLAN identifier that the interface created by this connection should be assi Format: uint32 .RE .PP -\fBingress\-priority\-map\fR +\fBvlan\&.ingress\-priority\-map\fR .RS 4 Alias: ingress .sp @@ -4130,7 +4343,7 @@ For incoming packets, a list of mappings from 802\&.1p priorities to Linux SKB p Format: array of string .RE .PP -\fBparent\fR +\fBvlan\&.parent\fR .RS 4 Alias: dev .sp @@ -4139,7 +4352,7 @@ If given, specifies the parent interface name or parent connection UUID from whi Format: string .RE .PP -\fBprotocol\fR +\fBvlan\&.protocol\fR .RS 4 Specifies the VLAN protocol to use for encapsulation\&. .sp @@ -4153,28 +4366,28 @@ VPN Settings\&. .PP Properties: .PP -\fBdata\fR +\fBvpn\&.data\fR .RS 4 Dictionary of key/value pairs of VPN plugin specific data\&. Both keys and values must be strings\&. .sp Format: dict of string to string .RE .PP -\fBpersistent\fR +\fBvpn\&.persistent\fR .RS 4 If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected\&. .sp Format: boolean .RE .PP -\fBsecrets\fR +\fBvpn\&.secrets\fR .RS 4 Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys\&. Both keys and values must be strings\&. .sp Format: dict of string to string .RE .PP -\fBservice\-type\fR +\fBvpn\&.service\-type\fR .RS 4 Alias: vpn\-type .sp @@ -4183,14 +4396,14 @@ D\-Bus service name of the VPN plugin that this setting uses to connect to its n Format: string .RE .PP -\fBtimeout\fR +\fBvpn\&.timeout\fR .RS 4 Timeout for the VPN service to establish the connection\&. Some services may take quite a long time to connect\&. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn\&.timeout in configuration file)\&. Values greater than zero mean timeout in seconds\&. .sp Format: uint32 .RE .PP -\fBuser\-name\fR +\fBvpn\&.user\-name\fR .RS 4 Alias: user .sp @@ -4204,7 +4417,7 @@ VRF settings\&. .PP Properties: .PP -\fBtable\fR +\fBvrf\&.table\fR .RS 4 Alias: table .sp @@ -4218,14 +4431,14 @@ VXLAN Settings\&. .PP Properties: .PP -\fBageing\fR +\fBvxlan\&.ageing\fR .RS 4 Specifies the lifetime in seconds of FDB entries learnt by the kernel\&. .sp Format: uint32 .RE .PP -\fBdestination\-port\fR +\fBvxlan\&.destination\-port\fR .RS 4 Alias: destination\-port .sp @@ -4234,7 +4447,7 @@ Specifies the UDP destination port to communicate to the remote VXLAN tunnel end Format: uint32 .RE .PP -\fBid\fR +\fBvxlan\&.id\fR .RS 4 Alias: id .sp @@ -4243,35 +4456,35 @@ Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use\&. Format: uint32 .RE .PP -\fBl2\-miss\fR +\fBvxlan\&.l2\-miss\fR .RS 4 Specifies whether netlink LL ADDR miss notifications are generated\&. .sp Format: boolean .RE .PP -\fBl3\-miss\fR +\fBvxlan\&.l3\-miss\fR .RS 4 Specifies whether netlink IP ADDR miss notifications are generated\&. .sp Format: boolean .RE .PP -\fBlearning\fR +\fBvxlan\&.learning\fR .RS 4 Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database\&. .sp Format: boolean .RE .PP -\fBlimit\fR +\fBvxlan\&.limit\fR .RS 4 Specifies the maximum number of FDB entries\&. A value of zero means that the kernel will store unlimited entries\&. .sp Format: uint32 .RE .PP -\fBlocal\fR +\fBvxlan\&.local\fR .RS 4 Alias: local .sp @@ -4280,7 +4493,7 @@ If given, specifies the source IP address to use in outgoing packets\&. Format: string .RE .PP -\fBparent\fR +\fBvxlan\&.parent\fR .RS 4 Alias: dev .sp @@ -4289,14 +4502,14 @@ If given, specifies the parent interface name or parent connection UUID\&. Format: string .RE .PP -\fBproxy\fR +\fBvxlan\&.proxy\fR .RS 4 Specifies whether ARP proxy is turned on\&. .sp Format: boolean .RE .PP -\fBremote\fR +\fBvxlan\&.remote\fR .RS 4 Alias: remote .sp @@ -4305,14 +4518,14 @@ Specifies the unicast destination IP address to use in outgoing packets when the Format: string .RE .PP -\fBrsc\fR +\fBvxlan\&.rsc\fR .RS 4 Specifies whether route short circuit is turned on\&. .sp Format: boolean .RE .PP -\fBsource\-port\-max\fR +\fBvxlan\&.source\-port\-max\fR .RS 4 Alias: source\-port\-max .sp @@ -4321,7 +4534,7 @@ Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel Format: uint32 .RE .PP -\fBsource\-port\-min\fR +\fBvxlan\&.source\-port\-min\fR .RS 4 Alias: source\-port\-min .sp @@ -4330,14 +4543,14 @@ Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel Format: uint32 .RE .PP -\fBtos\fR +\fBvxlan\&.tos\fR .RS 4 Specifies the TOS value to use in outgoing packets\&. .sp Format: uint32 .RE .PP -\fBttl\fR +\fBvxlan\&.ttl\fR .RS 4 Specifies the time\-to\-live value to use in outgoing packets\&. .sp @@ -4349,7 +4562,7 @@ Wi\-Fi P2P Settings\&. .PP Properties: .PP -\fBpeer\fR +\fBwifi\-p2p\&.peer\fR .RS 4 Alias: peer .sp @@ -4358,7 +4571,7 @@ The P2P device that should be connected to\&. Currently, this is the only way to Format: string .RE .PP -\fBwfd\-ies\fR +\fBwifi\-p2p\&.wfd\-ies\fR .RS 4 The Wi\-Fi Display (WFD) Information Elements (IEs) to set\&. .sp @@ -4367,7 +4580,7 @@ Wi\-Fi Display requires a protocol specific information element to be set in cer Format: byte array .RE .PP -\fBwps\-method\fR +\fBwifi\-p2p\&.wps\-method\fR .RS 4 Flags indicating which mode of WPS is to be used\&. .sp @@ -4381,7 +4594,7 @@ WiMax Settings\&. .PP Properties: .PP -\fBmac\-address\fR +\fBwimax\&.mac\-address\fR .RS 4 Alias: mac .sp @@ -4392,7 +4605,7 @@ This property is deprecated since version 1\&.2\&. WiMAX is no longer supported\ Format: byte array .RE .PP -\fBnetwork\-name\fR +\fBwimax\&.network\-name\fR .RS 4 Alias: nsp .sp @@ -4410,21 +4623,21 @@ Wired Ethernet Settings\&. .PP Properties: .PP -\fBaccept\-all\-mac\-addresses\fR +\fB802\-3\-ethernet\&.accept\-all\-mac\-addresses\fR .RS 4 When TRUE, setup the interface to accept packets for all MAC addresses\&. This is enabling the kernel interface flag IFF_PROMISC\&. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast\&. .sp Format: NMTernary (int32) .RE .PP -\fBauto\-negotiate\fR +\fB802\-3\-ethernet\&.auto\-negotiate\fR .RS 4 When TRUE, enforce auto\-negotiation of speed and duplex mode\&. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto\-negotiation process: this works only for BASE\-T 802\&.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory\&. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped\&. .sp Format: boolean .RE .PP -\fBcloned\-mac\-address\fR +\fB802\-3\-ethernet\&.cloned\-mac\-address\fR .RS 4 Alias: cloned\-mac .sp @@ -4439,14 +4652,14 @@ On D\-Bus, this field is expressed as "assigned\-mac\-address" or the deprecated Format: byte array .RE .PP -\fBduplex\fR +\fB802\-3\-ethernet\&.duplex\fR .RS 4 When a value is set, either "half" or "full", configures the device to use the specified duplex mode\&. If "auto\-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE\-T 802\&.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory\&. If the value is unset (the default), the link configuration will be either skipped (if "auto\-negotiate" is "no", the default) or will be auto\-negotiated (if "auto\-negotiate" is "yes") and the local device will advertise all the supported duplex modes\&. Must be set together with the "speed" property if specified\&. Before specifying a duplex mode be sure your device supports it\&. .sp Format: string .RE .PP -\fBgenerate\-mac\-address\-mask\fR +\fB802\-3\-ethernet\&.generate\-mac\-address\-mask\fR .RS 4 With "cloned\-mac\-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally\-administered, unicast MAC address is created\&. This property allows to specify that certain bits are fixed\&. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address\&. .sp @@ -4461,7 +4674,7 @@ If the value contains more than one additional MAC addresses, one of them is cho Format: string .RE .PP -\fBmac\-address\fR +\fB802\-3\-ethernet\&.mac\-address\fR .RS 4 Alias: mac .sp @@ -4470,14 +4683,14 @@ If specified, this connection will only apply to the Ethernet device whose perma Format: byte array .RE .PP -\fBmac\-address\-blacklist\fR +\fB802\-3\-ethernet\&.mac\-address\-blacklist\fR .RS 4 If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list\&. Each MAC address is in the standard hex\-digits\-and\-colons notation (00:11:22:33:44:55)\&. .sp Format: array of string .RE .PP -\fBmtu\fR +\fB802\-3\-ethernet\&.mtu\fR .RS 4 Alias: mtu .sp @@ -4486,21 +4699,21 @@ If non\-zero, only transmit packets of the specified size or smaller, breaking l Format: uint32 .RE .PP -\fBport\fR +\fB802\-3\-ethernet\&.port\fR .RS 4 Specific port type to use if the device supports multiple attachment methods\&. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface)\&. If the device supports only one port type, this setting is ignored\&. .sp Format: string .RE .PP -\fBs390\-nettype\fR +\fB802\-3\-ethernet\&.s390\-nettype\fR .RS 4 s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems\&. .sp Format: string .RE .PP -\fBs390\-options\fR +\fB802\-3\-ethernet\&.s390\-options\fR .RS 4 Dictionary of key/value pairs of s390\-specific device options\&. Both keys and values must be strings\&. Allowed keys include "portno", "layer2", "portname", "protocol", among others\&. Key names must contain only alphanumeric characters (ie, [a\-zA\-Z0\-9])\&. .sp @@ -4509,28 +4722,28 @@ Currently, NetworkManager itself does nothing with this information\&. However, Format: dict of string to string .RE .PP -\fBs390\-subchannels\fR +\fB802\-3\-ethernet\&.s390\-subchannels\fR .RS 4 Identifies specific subchannels that this network device uses for communication with z/VM or s390 host\&. Like the "mac\-address" property for non\-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels\&. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (\&.) character\&. .sp Format: array of string .RE .PP -\fBspeed\fR +\fB802\-3\-ethernet\&.speed\fR .RS 4 When a value greater than 0 is set, configures the device to use the specified speed\&. If "auto\-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE\-T 802\&.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory\&. If the value is unset (0, the default), the link configuration will be either skipped (if "auto\-negotiate" is "no", the default) or will be auto\-negotiated (if "auto\-negotiate" is "yes") and the local device will advertise all the supported speeds\&. In Mbit/s, ie 100 == 100Mbit/s\&. Must be set together with the "duplex" property when non\-zero\&. Before specifying a speed value be sure your device supports it\&. .sp Format: uint32 .RE .PP -\fBwake\-on\-lan\fR +\fB802\-3\-ethernet\&.wake\-on\-lan\fR .RS 4 The NMSettingWiredWakeOnLan options to enable\&. Not all devices support all options\&. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake\-on\-LAN in NetworkManager)\&. .sp Format: uint32 .RE .PP -\fBwake\-on\-lan\-password\fR +\fB802\-3\-ethernet\&.wake\-on\-lan\-password\fR .RS 4 If specified, the password used with magic\-packet\-based Wake\-on\-LAN, represented as an Ethernet MAC address\&. If NULL, no password will be required\&. .sp @@ -4542,7 +4755,7 @@ WireGuard Settings\&. .PP Properties: .PP -\fBfwmark\fR +\fBwireguard\&.fwmark\fR .RS 4 The use of fwmark is optional and is by default off\&. Setting it to 0 disables it\&. Otherwise, it is a 32\-bit fwmark for outgoing packets\&. .sp @@ -4551,7 +4764,7 @@ Note that "ip4\-auto\-default\-route" or "ip6\-auto\-default\-route" enabled, im Format: uint32 .RE .PP -\fBip4\-auto\-default\-route\fR +\fBwireguard\&.ip4\-auto\-default\-route\fR .RS 4 Whether to enable special handling of the IPv4 default route\&. If enabled, the IPv4 default route from wireguard\&.peer\-routes will be placed to a dedicated routing\-table and two policy routing rules will be added\&. The fwmark number is also used as routing\-table for the default\-route, and if fwmark is zero, an unused fwmark/table is chosen automatically\&. This corresponds to what wg\-quick does with Table=auto and what WireGuard calls "Improved Rule\-based Routing"\&. .sp @@ -4562,21 +4775,21 @@ Leaving this at the default will enable this option automatically if ipv4\&.neve Format: NMTernary (int32) .RE .PP -\fBip6\-auto\-default\-route\fR +\fBwireguard\&.ip6\-auto\-default\-route\fR .RS 4 Like ip4\-auto\-default\-route, but for the IPv6 default route\&. .sp Format: NMTernary (int32) .RE .PP -\fBlisten\-port\fR +\fBwireguard\&.listen\-port\fR .RS 4 The listen\-port\&. If listen\-port is not specified, the port will be chosen randomly when the interface comes up\&. .sp Format: uint32 .RE .PP -\fBmtu\fR +\fBwireguard\&.mtu\fR .RS 4 If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments\&. .sp @@ -4585,7 +4798,7 @@ If zero a default MTU is used\&. Note that contrary to wg\-quick\*(Aqs MTU setti Format: uint32 .RE .PP -\fBpeer\-routes\fR +\fBwireguard\&.peer\-routes\fR .RS 4 Whether to automatically add routes for the AllowedIPs ranges of the peers\&. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4\&.route\-table and ipv6\&.route\-table\&. Usually you want this automatism enabled\&. If FALSE, no such routes are added automatically\&. In this case, the user may want to configure static routes in ipv4\&.routes and ipv6\&.routes, respectively\&. .sp @@ -4594,17 +4807,21 @@ Note that if the peer\*(Aqs AllowedIPs is "0\&.0\&.0\&.0/0" or "::/0" and the pr Format: boolean .RE .PP -\fBprivate\-key\fR +\fBwireguard\&.private\-key\fR .RS 4 The 256 bit private\-key in base64 encoding\&. .sp Format: string .RE .PP -\fBprivate\-key\-flags\fR +\fBwireguard\&.private\-key\-flags\fR .RS 4 Flags indicating how to handle the "private\-key" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .SS "802\-11\-wireless setting" @@ -4615,7 +4832,7 @@ Wi\-Fi Settings\&. .PP Properties: .PP -\fBap\-isolation\fR +\fB802\-11\-wireless\&.ap\-isolation\fR .RS 4 Configures AP isolation, which prevents communication between wireless devices connected to this AP\&. This property can be set to a value different from NM_TERNARY_DEFAULT (\-1) only when the interface is configured in AP mode\&. .sp @@ -4628,14 +4845,14 @@ When set to NM_TERNARY_DEFAULT (\-1), the global default is used; in case the gl Format: NMTernary (int32) .RE .PP -\fBband\fR +\fB802\-11\-wireless\&.band\fR .RS 4 802\&.11 frequency band of the network\&. One of "a" for 5GHz 802\&.11a or "bg" for 2\&.4GHz 802\&.11\&. This will lock associations to the Wi\-Fi network to the specific band, i\&.e\&. if "a" is specified, the device will not associate with the same network in the 2\&.4GHz band even if the network\*(Aqs settings are compatible\&. This setting depends on specific driver capability and may not work with all drivers\&. .sp Format: string .RE .PP -\fBbssid\fR +\fB802\-11\-wireless\&.bssid\fR .RS 4 If specified, directs the device to only associate with the given access point\&. This capability is highly driver dependent and not supported by all devices\&. Note: this property does not control the BSSID used when creating an Ad\-Hoc network and is unlikely to in the future\&. .sp @@ -4644,14 +4861,14 @@ Locking a client profile to a certain BSSID will prevent roaming and also disabl Format: byte array .RE .PP -\fBchannel\fR +\fB802\-11\-wireless\&.channel\fR .RS 4 Wireless channel to use for the Wi\-Fi connection\&. The device will only join (or create for Ad\-Hoc networks) a Wi\-Fi network on the specified channel\&. Because channel numbers overlap between bands, this property also requires the "band" property to be set\&. .sp Format: uint32 .RE .PP -\fBcloned\-mac\-address\fR +\fB802\-11\-wireless\&.cloned\-mac\-address\fR .RS 4 Alias: cloned\-mac .sp @@ -4666,7 +4883,7 @@ On D\-Bus, this field is expressed as "assigned\-mac\-address" or the deprecated Format: byte array .RE .PP -\fBgenerate\-mac\-address\-mask\fR +\fB802\-11\-wireless\&.generate\-mac\-address\-mask\fR .RS 4 With "cloned\-mac\-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally\-administered, unicast MAC address is created\&. This property allows to specify that certain bits are fixed\&. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address\&. .sp @@ -4681,7 +4898,7 @@ If the value contains more than one additional MAC addresses, one of them is cho Format: string .RE .PP -\fBhidden\fR +\fB802\-11\-wireless\&.hidden\fR .RS 4 If TRUE, indicates that the network is a non\-broadcasting network that hides its SSID\&. This works both in infrastructure and AP mode\&. .sp @@ -4694,7 +4911,7 @@ Note that marking the network as hidden may be a privacy issue for you (in infra Format: boolean .RE .PP -\fBmac\-address\fR +\fB802\-11\-wireless\&.mac\-address\fR .RS 4 Alias: mac .sp @@ -4703,14 +4920,14 @@ If specified, this connection will only apply to the Wi\-Fi device whose permane Format: byte array .RE .PP -\fBmac\-address\-blacklist\fR +\fB802\-11\-wireless\&.mac\-address\-blacklist\fR .RS 4 A list of permanent MAC addresses of Wi\-Fi devices to which this connection should never apply\&. Each MAC address should be given in the standard hex\-digits\-and\-colons notation (eg "00:11:22:33:44:55")\&. .sp Format: array of string .RE .PP -\fBmac\-address\-randomization\fR +\fB802\-11\-wireless\&.mac\-address\-randomization\fR .RS 4 One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address)\&. .sp @@ -4719,7 +4936,7 @@ This property is deprecated since version 1\&.4\&. Use the "cloned\-mac\-address Format: uint32 .RE .PP -\fBmode\fR +\fB802\-11\-wireless\&.mode\fR .RS 4 Alias: mode .sp @@ -4728,7 +4945,7 @@ Wi\-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap"\&. If blan Format: string .RE .PP -\fBmtu\fR +\fB802\-11\-wireless\&.mtu\fR .RS 4 Alias: mtu .sp @@ -4737,28 +4954,23 @@ If non\-zero, only transmit packets of the specified size or smaller, breaking l Format: uint32 .RE .PP -\fBpowersave\fR +\fB802\-11\-wireless\&.powersave\fR .RS 4 One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi\-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi\-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don\*(Aqt touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value)\&. All other values are reserved\&. .sp Format: uint32 .RE .PP -\fBrate\fR -.RS 4 -If non\-zero, directs the device to only use the specified bitrate for communication with the access point\&. Units are in Kb/s, ie 5500 = 5\&.5 Mbit/s\&. This property is highly driver dependent and not all devices support setting a static bitrate\&. -.sp -Format: uint32 -.RE -.PP -\fBseen\-bssids\fR +\fB802\-11\-wireless\&.seen\-bssids\fR .RS 4 A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi\-Fi network\&. NetworkManager internally tracks previously seen BSSIDs\&. The property is only meant for reading and reflects the BSSID list of NetworkManager\&. The changes you make to this property will not be preserved\&. .sp +This is not a regular property that the user would configure\&. Instead, NetworkManager automatically sets the seen BSSIDs and tracks them internally in "/var/lib/NetworkManager/seen\-bssids" file\&. +.sp Format: array of string .RE .PP -\fBssid\fR +\fB802\-11\-wireless\&.ssid\fR .RS 4 Alias: ssid .sp @@ -4767,14 +4979,7 @@ SSID of the Wi\-Fi network\&. Must be specified\&. Format: byte array .RE .PP -\fBtx\-power\fR -.RS 4 -If non\-zero, directs the device to use the specified transmit power\&. Units are dBm\&. This property is highly driver dependent and not all devices support setting a static transmit power\&. -.sp -Format: uint32 -.RE -.PP -\fBwake\-on\-wlan\fR +\fB802\-11\-wireless\&.wake\-on\-wlan\fR .RS 4 The NMSettingWirelessWakeOnWLan options to enable\&. Not all devices support all options\&. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake\-on\-LAN in NetworkManager)\&. .sp @@ -4788,28 +4993,28 @@ Wi\-Fi Security Settings\&. .PP Properties: .PP -\fBauth\-alg\fR +\fB802\-11\-wireless\-security\&.auth\-alg\fR .RS 4 When WEP is used (ie, key\-mgmt = "none" or "ieee8021x") indicate the 802\&.11 authentication algorithm required by the AP here\&. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP\&. When using Cisco LEAP (ie, key\-mgmt = "ieee8021x" and auth\-alg = "leap") the "leap\-username" and "leap\-password" properties must be specified\&. .sp Format: string .RE .PP -\fBfils\fR +\fB802\-11\-wireless\-security\&.fils\fR .RS 4 Indicates whether Fast Initial Link Setup (802\&.11ai) must be enabled for the connection\&. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported)\&. When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled\&. .sp Format: int32 .RE .PP -\fBgroup\fR +\fB802\-11\-wireless\-security\&.group\fR .RS 4 A list of group/broadcast encryption algorithms which prevents connections to Wi\-Fi networks that do not utilize one of the algorithms in the list\&. For maximum compatibility leave this property empty\&. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp"\&. .sp Format: array of string .RE .PP -\fBkey\-mgmt\fR +\fB802\-11\-wireless\-security\&.key\-mgmt\fR .RS 4 Key management used for the connection\&. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa\-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa\-eap" (WPA2 + WPA3 enterprise) or "wpa\-eap\-suite\-b\-192" (WPA3 enterprise only)\&. .sp @@ -4818,112 +5023,124 @@ This property must be set for any Wi\-Fi connection that uses security\&. Format: string .RE .PP -\fBleap\-password\fR +\fB802\-11\-wireless\-security\&.leap\-password\fR .RS 4 The login password for legacy LEAP connections (ie, key\-mgmt = "ieee8021x" and auth\-alg = "leap")\&. .sp Format: string .RE .PP -\fBleap\-password\-flags\fR +\fB802\-11\-wireless\-security\&.leap\-password\-flags\fR .RS 4 Flags indicating how to handle the "leap\-password" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBleap\-username\fR +\fB802\-11\-wireless\-security\&.leap\-username\fR .RS 4 The login username for legacy LEAP connections (ie, key\-mgmt = "ieee8021x" and auth\-alg = "leap")\&. .sp Format: string .RE .PP -\fBpairwise\fR +\fB802\-11\-wireless\-security\&.pairwise\fR .RS 4 A list of pairwise encryption algorithms which prevents connections to Wi\-Fi networks that do not utilize one of the algorithms in the list\&. For maximum compatibility leave this property empty\&. Each list element may be one of "tkip" or "ccmp"\&. .sp Format: array of string .RE .PP -\fBpmf\fR +\fB802\-11\-wireless\-security\&.pmf\fR .RS 4 Indicates whether Protected Management Frames (802\&.11w) must be enabled for the connection\&. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported)\&. When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled\&. .sp Format: int32 .RE .PP -\fBproto\fR +\fB802\-11\-wireless\-security\&.proto\fR .RS 4 List of strings specifying the allowed WPA protocol versions to use\&. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN)\&. If not specified, both WPA and RSN connections are allowed\&. .sp Format: array of string .RE .PP -\fBpsk\fR +\fB802\-11\-wireless\-security\&.psk\fR .RS 4 Pre\-Shared\-Key for WPA networks\&. For WPA\-PSK, it\*(Aqs either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802\&.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character\&. The WPA3\-Personal networks use a passphrase of any length for SAE authentication\&. .sp Format: string .RE .PP -\fBpsk\-flags\fR +\fB802\-11\-wireless\-security\&.psk\-flags\fR .RS 4 Flags indicating how to handle the "psk" property\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBwep\-key\-flags\fR +\fB802\-11\-wireless\-security\&.wep\-key\-flags\fR .RS 4 Flags indicating how to handle the "wep\-key0", "wep\-key1", "wep\-key2", and "wep\-key3" properties\&. .sp +See +the section called \(lqSecret flag types:\(rq +for flag values\&. +.sp Format: NMSettingSecretFlags (uint32) .RE .PP -\fBwep\-key\-type\fR +\fB802\-11\-wireless\-security\&.wep\-key\-type\fR .RS 4 Controls the interpretation of WEP keys\&. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10\- or 26\-character hexadecimal string, or a 5\- or 13\-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de\-facto MD5 method to derive the actual WEP key\&. .sp Format: NMWepKeyType (uint32) .RE .PP -\fBwep\-key0\fR +\fB802\-11\-wireless\-security\&.wep\-key0\fR .RS 4 Index 0 WEP key\&. This is the WEP key used in most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. .sp Format: string .RE .PP -\fBwep\-key1\fR +\fB802\-11\-wireless\-security\&.wep\-key1\fR .RS 4 Index 1 WEP key\&. This WEP index is not used by most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. .sp Format: string .RE .PP -\fBwep\-key2\fR +\fB802\-11\-wireless\-security\&.wep\-key2\fR .RS 4 Index 2 WEP key\&. This WEP index is not used by most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. .sp Format: string .RE .PP -\fBwep\-key3\fR +\fB802\-11\-wireless\-security\&.wep\-key3\fR .RS 4 Index 3 WEP key\&. This WEP index is not used by most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. .sp Format: string .RE .PP -\fBwep\-tx\-keyidx\fR +\fB802\-11\-wireless\-security\&.wep\-tx\-keyidx\fR .RS 4 When static WEP is used (ie, key\-mgmt = "none") and a non\-default WEP key index is used by the AP, put that WEP key index here\&. Valid values are 0 (default key) through 3\&. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 \- 4\&. .sp Format: uint32 .RE .PP -\fBwps\-method\fR +\fB802\-11\-wireless\-security\&.wps\-method\fR .RS 4 Flags indicating which mode of WPS is to be used if any\&. .sp @@ -4939,7 +5156,7 @@ IEEE 802\&.15\&.4 (WPAN) MAC Settings\&. .PP Properties: .PP -\fBchannel\fR +\fBwpan\&.channel\fR .RS 4 Alias: channel .sp @@ -4948,7 +5165,7 @@ IEEE 802\&.15\&.4 channel\&. A positive integer or \-1, meaning "do not set, use Format: int32 .RE .PP -\fBmac\-address\fR +\fBwpan\&.mac\-address\fR .RS 4 Alias: mac .sp @@ -4957,7 +5174,7 @@ If specified, this connection will only apply to the IEEE 802\&.15\&.4 (WPAN) MA Format: string .RE .PP -\fBpage\fR +\fBwpan\&.page\fR .RS 4 Alias: page .sp @@ -4966,7 +5183,7 @@ IEEE 802\&.15\&.4 channel page\&. A positive integer or \-1, meaning "do not set Format: int32 .RE .PP -\fBpan\-id\fR +\fBwpan\&.pan\-id\fR .RS 4 Alias: pan\-id .sp @@ -4975,7 +5192,7 @@ IEEE 802\&.15\&.4 Personal Area Network (PAN) identifier\&. Format: uint32 .RE .PP -\fBshort\-address\fR +\fBwpan\&.short\-address\fR .RS 4 Alias: short\-addr .sp @@ -4989,7 +5206,7 @@ Bond Port Settings\&. .PP Properties: .PP -\fBprio\fR +\fBbond\-port\&.prio\fR .RS 4 Alias: prio .sp @@ -4998,7 +5215,7 @@ The port priority for bond active port re\-selection during failover\&. A higher Format: int32 .RE .PP -\fBqueue\-id\fR +\fBbond\-port\&.queue\-id\fR .RS 4 Alias: queue\-id .sp @@ -5012,7 +5229,7 @@ Hostname settings\&. .PP Properties: .PP -\fBfrom\-dhcp\fR +\fBhostname\&.from\-dhcp\fR .RS 4 Whether the system hostname can be determined from DHCP on this connection\&. .sp @@ -5021,7 +5238,7 @@ When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is use Format: NMTernary (int32) .RE .PP -\fBfrom\-dns\-lookup\fR +\fBhostname\&.from\-dns\-lookup\fR .RS 4 Whether the system hostname can be determined from reverse DNS lookup of addresses on this device\&. .sp @@ -5030,7 +5247,7 @@ When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is use Format: NMTernary (int32) .RE .PP -\fBonly\-from\-default\fR +\fBhostname\&.only\-from\-default\fR .RS 4 If set to NM_TERNARY_TRUE (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6)\&. .sp @@ -5041,7 +5258,7 @@ When set to NM_TERNARY_DEFAULT (\-1), the value from global configuration is use Format: NMTernary (int32) .RE .PP -\fBpriority\fR +\fBhostname\&.priority\fR .RS 4 The relative priority of this connection to determine the system hostname\&. A lower numerical value is better (higher priority)\&. A connection with higher priority is considered before connections with lower priority\&. .sp @@ -5051,13 +5268,46 @@ Negative values have the special effect of excluding other connections with a gr .sp Format: int32 .RE +.SS "link setting" +.PP +Link settings\&. +.PP +Properties: +.PP +\fBlink\&.gro\-max\-size\fR +.RS 4 +The maximum size of a packet built by the Generic Receive Offload stack for this device\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. +.sp +Format: int64 +.RE +.PP +\fBlink\&.gso\-max\-segments\fR +.RS 4 +The maximum segments of a Generic Segment Offload packet the device should accept\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. +.sp +Format: int64 +.RE +.PP +\fBlink\&.gso\-max\-size\fR +.RS 4 +The maximum size of a Generic Segment Offload packet the device should accept\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. +.sp +Format: int64 +.RE +.PP +\fBlink\&.tx\-queue\-length\fR +.RS 4 +The size of the transmit queue for the device, in number of packets\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. +.sp +Format: int64 +.RE .SS "loopback setting" .PP Loopback Link Settings\&. .PP Properties: .PP -\fBmtu\fR +\fBloopback\&.mtu\fR .RS 4 Alias: mtu .sp @@ -5071,7 +5321,7 @@ Veth Settings\&. .PP Properties: .PP -\fBpeer\fR +\fBveth\&.peer\fR .RS 4 Alias: peer .sp |