diff options
Diffstat (limited to 'docs/api/html/nm-settings-nmcli.html')
| -rw-r--r-- | docs/api/html/nm-settings-nmcli.html | 2009 |
1 files changed, 1579 insertions, 430 deletions
diff --git a/docs/api/html/nm-settings-nmcli.html b/docs/api/html/nm-settings-nmcli.html index 40cf154e..4c1c8914 100644 --- a/docs/api/html/nm-settings-nmcli.html +++ b/docs/api/html/nm-settings-nmcli.html @@ -84,7 +84,9 @@ <p>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.</p> <p>Currently, this only applies to 802-1x authentication.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -1 - 2147483647</p> </td> </tr> <tr> @@ -99,6 +101,8 @@ <p>Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -106,7 +110,9 @@ <td> <p>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.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -999 - 999</p> </td> </tr> <tr> @@ -114,7 +120,11 @@ <td> <p>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.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -1 - 2147483647</p> +<p> + Special values: default (-1), forever (0)</p> </td> </tr> <tr> @@ -122,7 +132,19 @@ <td> <p>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.</p> <p> - Format: NMSettingConnectionAutoconnectSlaves (int32)</p> + Format: choice (NMSettingConnectionAutoconnectSlaves)</p> +<p> + Valid values: default (-1), no (0), yes (1)</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.controller"></a>connection.controller</code></span></p></td> +<td> +<p> + Alias: controller</p> +<p>Interface name of the controller device or UUID of the controller connection.</p> +<p> + Format: string</p> </td> </tr> <tr> @@ -132,7 +154,9 @@ <p>The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don't ever use DNSOverTls. If unspecified "default" depends on the plugin used. Systemd-resolved uses global setting.</p> <p>This feature requires a plugin which supports DNSOverTls. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</p> <p> - Format: int32</p> + Format: choice (NMSettingConnectionDnsOverTls)</p> +<p> + Valid values: default (-1), no (0), opportunistic (1), yes (2)</p> </td> </tr> <tr> @@ -140,7 +164,9 @@ <td> <p>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 600</p> </td> </tr> <tr> @@ -170,7 +196,9 @@ <td> <p>Whether LLDP is enabled for the connection.</p> <p> - Format: int32</p> + Format: choice (NMSettingConnectionLldp)</p> +<p> + Valid values: default (-1), disable (0), enable-rx/enable (1)</p> </td> </tr> <tr> @@ -180,7 +208,9 @@ <p>The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable LLMNR for the interface, "resolve" (1) do not register hostname but allow resolving of LLMNR host names If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "yes").</p> <p>This feature requires a plugin which supports LLMNR. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</p> <p> - Format: int32</p> + Format: choice (NMSettingConnectionLlmnr)</p> +<p> + Valid values: default (-1), no (0), resolve (1), yes (2)</p> </td> </tr> <tr> @@ -189,6 +219,7 @@ <p> Alias: master</p> <p>Interface name of the master device or UUID of the master connection.</p> +<p>Deprecated 1.46. Use "controller" instead, this is just an alias.</p> <p> Format: string</p> </td> @@ -200,7 +231,9 @@ <p>The permitted values are: "yes" (2) register hostname and resolving for the connection, "no" (0) disable mDNS for the interface, "resolve" (1) do not register hostname but allow resolving of mDNS host names and "default" (-1) to allow lookup of a global default in NetworkManager.conf. If unspecified, "default" ultimately depends on the DNS plugin (which for systemd-resolved currently means "no").</p> <p>This feature requires a plugin which supports mDNS. Otherwise, the setting has no effect. One such plugin is dns-systemd-resolved.</p> <p> - Format: int32</p> + Format: choice (NMSettingConnectionMdns)</p> +<p> + Valid values: default (-1), no (0), resolve (1), yes (2)</p> </td> </tr> <tr> @@ -209,7 +242,9 @@ <p>Whether the connection is metered.</p> <p>When updating this property on a currently activated connection, the change takes effect immediately.</p> <p> - Format: NMMetered (int32)</p> + Format: ternary</p> +<p> + Valid values: true/yes/on, false/no/off, default/unknown</p> </td> </tr> <tr> @@ -225,7 +260,9 @@ <p>NetworkManager does not change the MPTCP limits nor enable MPTCP via "/proc/sys/net/mptcp/enabled". That is a host configuration which the admin can change via sysctl and ip-mptcp.</p> <p>Strict reverse path filtering (rp_filter) breaks many MPTCP use cases, so when MPTCP handling for IPv4 addresses on the interface is enabled, NetworkManager would loosen the strict reverse path filtering (1) to the loose setting (2).</p> <p> - Format: uint32</p> + Format: flags (NMMptcpFlags)</p> +<p> + Valid values: none/default (0x0), disabled (0x1), enabled (0x2), also-without-sysctl (0x4), also-without-default-route (0x8), signal (0x10), subflow (0x20), backup (0x40), fullmesh (0x80)</p> </td> </tr> <tr> @@ -243,7 +280,9 @@ <td> <p>Specifies whether the profile can be active multiple times at a particular moment. The value is of type NMConnectionMultiConnect.</p> <p> - Format: int32</p> + Format: choice (NMConnectionMultiConnect)</p> +<p> + Valid values: default (0), single (1), manual-multiple (2), multiple (3)</p> </td> </tr> <tr> @@ -252,7 +291,19 @@ <p>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".</p> <p>At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</p> <p> - Format: array of string</p> + Format: list of strings</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.connection.port-type"></a>connection.port-type</code></span></p></td> +<td> +<p> + Alias: port-type</p> +<p>Setting name of the device type of this port's controller connection (eg, "bond"), or NULL if this connection is not a port.</p> +<p> + Format: string</p> +<p> + Valid values: bond, bridge, ovs-bridge, ovs-port, team, vrf</p> </td> </tr> <tr> @@ -260,7 +311,7 @@ <td> <p>List of connection UUIDs that should be activated when the base connection itself is activated. Currently, only VPN connections are supported.</p> <p> - Format: array of string</p> + Format: list of strings</p> </td> </tr> <tr> @@ -269,8 +320,11 @@ <p> Alias: slave-type</p> <p>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</p> +<p>Deprecated 1.46. Use "port-type" instead, this is just an alias.</p> <p> Format: string</p> +<p> + Valid values: bond, bridge, ovs-bridge, ovs-port, team, vrf</p> </td> </tr> <tr> @@ -279,7 +333,7 @@ <p>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.</p> <p>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.</p> <p>Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The per-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key. See NetworkManager(8) manual about the secret-key and the host identity.</p> -<p>The '$' character is treated special to perform dynamic substitutions at activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. The "${CONNECTION}" uses the profile's connection.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates.</p> +<p>The '$' character is treated special to perform dynamic substitutions at activation time. Currently, supported are "${CONNECTION}", "${DEVICE}", "${MAC}", "${NETWORK_SSID}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-SSID, per-boot, or every time. The "${CONNECTION}" uses the profile's connection.uuid, the "${DEVICE}" uses the interface name of the device and "${MAC}" the permanent MAC address of the device. "${NETWORK_SSID}" uses the SSID for Wi-Fi networks and falls back to "${CONNECTION}" on other networks. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}-${BOOT}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates.</p> <p>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.</p> <p> Format: string</p> @@ -291,7 +345,7 @@ <p>The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated.</p> <p>NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).</p> <p> - Format: uint64</p> + Format: read only</p> </td> </tr> <tr> @@ -302,6 +356,8 @@ <p>Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).</p> <p> Format: string</p> +<p> + Valid values: 6lowpan, 802-11-olpc-mesh, 802-11-wireless, 802-3-ethernet, adsl, bluetooth, bond, bridge, cdma, dummy, generic, gsm, hsr, infiniband, ip-tunnel, loopback, macsec, macvlan, ovs-bridge, ovs-dpdk, ovs-interface, ovs-patch, ovs-port, pppoe, team, tun, veth, vlan, vpn, vrf, vxlan, wifi-p2p, wimax, wireguard, wpan</p> </td> </tr> <tr> @@ -310,7 +366,7 @@ <p>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`.</p> <p>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.</p> <p> - Format: a valid RFC4122 universally unique identifier (UUID).</p> + Format: string</p> </td> </tr> <tr> @@ -319,7 +375,9 @@ <p>Time in milliseconds to wait for connection to be considered activated. The wait will start after the pre-up dispatcher event.</p> <p>The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -1 - 2147483647</p> </td> </tr> <tr> @@ -328,7 +386,9 @@ <p>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.</p> <p>The value 0 means no wait time. The default value is -1, which currently has the same meaning as no wait time.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -1 - 2147483647</p> </td> </tr> <tr> @@ -385,7 +445,7 @@ <td> <p>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</p> <p> - Format: array of string</p> + Format: list of strings</p> </td> </tr> <tr> @@ -401,7 +461,9 @@ <td> <p>A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: 0 - 2147483647</p> </td> </tr> <tr> @@ -411,7 +473,7 @@ <p>Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</p> <p>Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</p> <p> - Format: byte array</p> + Format: filesystem path</p> </td> </tr> <tr> @@ -427,10 +489,9 @@ <td> <p>Flags indicating how to handle the "ca-cert-password" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -448,7 +509,7 @@ <p>Contains the client certificate if used by the EAP method specified in the "eap" property.</p> <p>Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.</p> <p> - Format: byte array</p> + Format: filesystem path</p> </td> </tr> <tr> @@ -464,10 +525,9 @@ <td> <p>Flags indicating how to handle the "client-cert-password" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -491,7 +551,9 @@ <td> <p>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.</p> <p> - Format: array of string</p> + Format: list of strings</p> +<p> + Valid values: leap, md5, tls, peap, ttls, sim, fast, pwd</p> </td> </tr> <tr> @@ -508,6 +570,8 @@ <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -531,10 +595,9 @@ <td> <p>Flags indicating how to handle the "password" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -542,7 +605,7 @@ <td> <p>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.</p> <p> - Format: byte array</p> + Format: bytes</p> </td> </tr> <tr> @@ -550,10 +613,9 @@ <td> <p>Flags indicating how to handle the "password-raw" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -561,7 +623,9 @@ <td> <p>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.</p> <p> - Format: uint32</p> + Format: flags (NMSetting8021xAuthFlags)</p> +<p> + Valid values: none (0x0), tls-1-0-disable (0x1), tls-1-1-disable (0x2), tls-1-2-disable (0x4), tls-disable-time-checks (0x8), tls-1-3-disable (0x10), tls-1-0-enable (0x20), tls-1-1-enable (0x40), tls-1-2-enable (0x80), tls-1-3-enable (0x100), all (0x1ff)</p> </td> </tr> <tr> @@ -570,6 +634,8 @@ <p>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.</p> <p> Format: string</p> +<p> + Valid values: 0, 1, 2, 3</p> </td> </tr> <tr> @@ -578,6 +644,8 @@ <p>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.</p> <p> Format: string</p> +<p> + Valid values: 0, 1</p> </td> </tr> <tr> @@ -586,6 +654,8 @@ <p>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.</p> <p> Format: string</p> +<p> + Valid values: 0, 1</p> </td> </tr> <tr> @@ -593,7 +663,7 @@ <td> <p>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</p> <p> - Format: array of string</p> + Format: list of strings</p> </td> </tr> <tr> @@ -602,6 +672,8 @@ <p>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.</p> <p> Format: string</p> +<p> + Valid values: pap, chap, mschap, mschapv2, gtc, otp, md5, tls</p> </td> </tr> <tr> @@ -610,6 +682,8 @@ <p>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.</p> <p> Format: string</p> +<p> + Valid values: md5, mschapv2, otp, gtc, tls</p> </td> </tr> <tr> @@ -619,7 +693,7 @@ <p>Certificate data is specified using a "scheme"; three are currently supported: blob, path and pkcs#11 URL. When using the blob scheme this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</p> <p>Note that enabling NMSetting8021x:system-ca-certs will override this setting to use the built-in path, if the built-in path is not a directory.</p> <p> - Format: byte array</p> + Format: filesystem path</p> </td> </tr> <tr> @@ -635,10 +709,9 @@ <td> <p>Flags indicating how to handle the "phase2-ca-cert-password" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -647,7 +720,7 @@ <p>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.</p> <p>If NMSetting8021x:system-ca-certs is enabled and the built-in CA path is an existing directory, then this setting is ignored.</p> <p> - Format: string</p> + Format: filesystem path</p> </td> </tr> <tr> @@ -656,7 +729,7 @@ <p>Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties.</p> <p>Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</p> <p> - Format: byte array</p> + Format: filesystem path</p> </td> </tr> <tr> @@ -672,10 +745,9 @@ <td> <p>Flags indicating how to handle the "phase2-client-cert-password" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -700,7 +772,7 @@ <p>Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls".</p> <p>Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</p> <p> - Format: byte array</p> + Format: filesystem path</p> </td> </tr> <tr> @@ -716,10 +788,9 @@ <td> <p>Flags indicating how to handle the "phase2-private-key-password" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -746,10 +817,9 @@ <td> <p>Flags indicating how to handle the "pin" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -759,7 +829,7 @@ <p>Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</p> <p>WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.</p> <p> - Format: byte array</p> + Format: filesystem path</p> </td> </tr> <tr> @@ -775,10 +845,9 @@ <td> <p>Flags indicating how to handle the "private-key-password" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -798,6 +867,8 @@ <p>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).</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> </tbody> @@ -824,6 +895,8 @@ <p>Encapsulation of ADSL connection. Can be "vcmux" or "llc".</p> <p> Format: string</p> +<p> + Valid values: vcmux, llc</p> </td> </tr> <tr> @@ -841,10 +914,9 @@ <td> <p>Flags indicating how to handle the "password" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -855,6 +927,8 @@ <p>ADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm".</p> <p> Format: string</p> +<p> + Valid values: pppoa, pppoe, ipoatm</p> </td> </tr> <tr> @@ -872,7 +946,9 @@ <td> <p>VCI of ADSL connection</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 65536</p> </td> </tr> <tr> @@ -880,7 +956,9 @@ <td> <p>VPI of ADSL connection</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 65536</p> </td> </tr> </tbody> @@ -906,7 +984,7 @@ Alias: addr</p> <p>The Bluetooth address of the device.</p> <p> - Format: byte array</p> + Format: MAC address</p> </td> </tr> <tr> @@ -917,6 +995,8 @@ <p>Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.</p> <p> Format: string</p> +<p> + Valid values: dun, panu, nap</p> </td> </tr> </tbody> @@ -939,7 +1019,7 @@ <td> <p>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]).</p> <p> - Format: dict of string to string</p> + Format: list of key/value options</p> </td> </tr></tbody> </table></div> @@ -964,7 +1044,9 @@ Alias: ageing-time</p> <p>The Ethernet MAC address aging time, in seconds.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 1000000</p> </td> </tr> <tr> @@ -974,7 +1056,9 @@ Alias: forward-delay</p> <p>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 30</p> </td> </tr> <tr> @@ -983,7 +1067,7 @@ <p>If specified, The MAC address of the multicast group this bridge uses for STP.</p> <p>The address must be a link-local address in standard Ethernet MAC address format, ie an address of the form 01:80:C2:00:00:0X, with X in [0, 4..F]. If not specified the default value is 01:80:C2:00:00:00.</p> <p> - Format: byte array</p> + Format: MAC address</p> </td> </tr> <tr> @@ -993,7 +1077,9 @@ Alias: group-forward-mask</p> <p>A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 65535</p> </td> </tr> <tr> @@ -1003,7 +1089,9 @@ Alias: hello-time</p> <p>The Spanning Tree Protocol (STP) hello time, in seconds.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 10</p> </td> </tr> <tr> @@ -1017,7 +1105,7 @@ This property is deprecated since version 1.12. Use the "cloned-mac-address" property instead.</p> <p> - Format: byte array</p> + Format: MAC address</p> </td> </tr> <tr> @@ -1027,7 +1115,9 @@ Alias: max-age</p> <p>The Spanning Tree Protocol (STP) maximum message age, in seconds.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 40</p> </td> </tr> <tr> @@ -1035,7 +1125,9 @@ <td> <p>Set maximum size of multicast hash table (value must be a power of 2).</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 1 - 4294967295</p> </td> </tr> <tr> @@ -1043,7 +1135,9 @@ <td> <p>Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -1051,7 +1145,9 @@ <td> <p>Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received.</p> <p> - Format: uint64</p> + Format: integer</p> +<p> + Valid values: 0 - 18446744073709551615</p> </td> </tr> <tr> @@ -1059,7 +1155,9 @@ <td> <p>Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received.</p> <p> - Format: uint64</p> + Format: integer</p> +<p> + Valid values: 0 - 18446744073709551615</p> </td> </tr> <tr> @@ -1068,6 +1166,8 @@ <p>Enable or disable sending of multicast queries by the bridge. If not specified the option is disabled.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -1075,7 +1175,9 @@ <td> <p>If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries.</p> <p> - Format: uint64</p> + Format: integer</p> +<p> + Valid values: 0 - 18446744073709551615</p> </td> </tr> <tr> @@ -1083,7 +1185,9 @@ <td> <p>Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase.</p> <p> - Format: uint64</p> + Format: integer</p> +<p> + Valid values: 0 - 18446744073709551615</p> </td> </tr> <tr> @@ -1091,7 +1195,9 @@ <td> <p>Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge.</p> <p> - Format: uint64</p> + Format: integer</p> +<p> + Valid values: 0 - 18446744073709551615</p> </td> </tr> <tr> @@ -1100,6 +1206,8 @@ <p>If enabled the bridge's own IP address is used as the source address for IGMP queries otherwise the default of 0.0.0.0 is used.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -1109,6 +1217,8 @@ <p>Supported values are: 'auto', 'disabled', 'enabled' to which kernel assigns the numbers 1, 0, and 2, respectively. If not specified the default value is 'auto' (1).</p> <p> Format: string</p> +<p> + Valid values: auto, disabled, enabled</p> </td> </tr> <tr> @@ -1119,6 +1229,8 @@ <p>Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -1126,7 +1238,9 @@ <td> <p>Set the number of IGMP queries to send during startup phase.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -1134,7 +1248,9 @@ <td> <p>Sets the time (in deciseconds) between queries sent out at startup to determine membership information.</p> <p> - Format: uint64</p> + Format: integer</p> +<p> + Valid values: 0 - 18446744073709551615</p> </td> </tr> <tr> @@ -1144,7 +1260,9 @@ Alias: priority</p> <p>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 65535</p> </td> </tr> <tr> @@ -1155,6 +1273,8 @@ <p>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -1162,7 +1282,9 @@ <td> <p>The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4094</p> </td> </tr> <tr> @@ -1171,6 +1293,8 @@ <p>Control whether VLAN filtering is enabled on the bridge.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -1180,6 +1304,8 @@ <p>Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</p> <p> Format: string</p> +<p> + Valid values: 802.1Q, 802.1ad</p> </td> </tr> <tr> @@ -1188,6 +1314,8 @@ <p>Controls whether per-VLAN stats accounting is enabled.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -1198,7 +1326,7 @@ <p>$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</p> <p>where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</p> <p> - Format: array of vardict</p> + Format: list of bridge.vlans objects</p> </td> </tr> </tbody> @@ -1225,6 +1353,8 @@ <p>Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -1234,7 +1364,9 @@ Alias: path-cost</p> <p>The Spanning Tree Protocol (STP) port cost for destinations via this port.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 65535</p> </td> </tr> <tr> @@ -1244,7 +1376,9 @@ Alias: priority</p> <p>The Spanning Tree Protocol (STP) priority of this bridge port.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 63</p> </td> </tr> <tr> @@ -1255,7 +1389,7 @@ <p>$vid [pvid] [untagged] [, $vid [pvid] [untagged]]...</p> <p>where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash.</p> <p> - Format: array of vardict</p> + Format: list of bridge-port.vlans objects</p> </td> </tr> </tbody> @@ -1279,7 +1413,9 @@ <td> <p>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Special values: auto</p> </td> </tr> <tr> @@ -1305,10 +1441,9 @@ <td> <p>Flags indicating how to handle the "password" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -1340,9 +1475,11 @@ <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-fcoe-flags"></a>dcb.app-fcoe-flags</code></span></p></td> <td> -<p>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).</p> +<p>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).</p> +<p> + Format: flags (NMSettingDcbFlags)</p> <p> - Format: NMSettingDcbFlags (uint32)</p> + Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)</p> </td> </tr> <tr> @@ -1352,46 +1489,64 @@ <p>Since 1.34, NULL is the default and means "fabric". Before 1.34, NULL was rejected as invalid and the default was "fabric".</p> <p> Format: string</p> +<p> + Valid values: fabric, vn2vn</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-fcoe-priority"></a>dcb.app-fcoe-priority</code></span></p></td> <td> -<p>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.</p> +<p>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 "enable" (0x1) flag.</p> +<p> + Format: integer</p> +<p> + Valid values: -1 - 7</p> <p> - Format: int32</p> + Special values: unset (-1)</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-fip-flags"></a>dcb.app-fip-flags</code></span></p></td> <td> -<p>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).</p> +<p>Specifies the NMSettingDcbFlags for the DCB FIP application. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).</p> <p> - Format: NMSettingDcbFlags (uint32)</p> + Format: flags (NMSettingDcbFlags)</p> +<p> + Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-fip-priority"></a>dcb.app-fip-priority</code></span></p></td> <td> -<p>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.</p> +<p>The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the "enable" (0x1) flag.</p> +<p> + Format: integer</p> +<p> + Valid values: -1 - 7</p> <p> - Format: int32</p> + Special values: unset (-1)</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-iscsi-flags"></a>dcb.app-iscsi-flags</code></span></p></td> <td> -<p>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).</p> +<p>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).</p> <p> - Format: NMSettingDcbFlags (uint32)</p> + Format: flags (NMSettingDcbFlags)</p> +<p> + Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.app-iscsi-priority"></a>dcb.app-iscsi-priority</code></span></p></td> <td> -<p>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.</p> +<p>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the "enable" (0x1) flag.</p> +<p> + Format: integer</p> +<p> + Valid values: -1 - 7</p> <p> - Format: int32</p> + Special values: unset (-1)</p> </td> </tr> <tr> @@ -1399,7 +1554,9 @@ <td> <p>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.</p> <p> - Format: array of uint32</p> + Format: list of integers</p> +<p> + Valid values: 0 - 100</p> </td> </tr> <tr> @@ -1407,15 +1564,19 @@ <td> <p>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.</p> <p> - Format: array of uint32</p> + Format: list of booleans</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-flow-control-flags"></a>dcb.priority-flow-control-flags</code></span></p></td> <td> -<p>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).</p> +<p>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).</p> +<p> + Format: flags (NMSettingDcbFlags)</p> <p> - Format: NMSettingDcbFlags (uint32)</p> + Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)</p> </td> </tr> <tr> @@ -1423,15 +1584,19 @@ <td> <p>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.</p> <p> - Format: array of uint32</p> + Format: list of integers</p> +<p> + Valid values: 0 - 100</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.dcb.priority-group-flags"></a>dcb.priority-group-flags</code></span></p></td> <td> -<p>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).</p> +<p>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4).</p> +<p> + Format: flags (NMSettingDcbFlags)</p> <p> - Format: NMSettingDcbFlags (uint32)</p> + Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4)</p> </td> </tr> <tr> @@ -1439,7 +1604,9 @@ <td> <p>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.</p> <p> - Format: array of uint32</p> + Format: list of integers</p> +<p> + Valid values: 0 - 7, 15</p> </td> </tr> <tr> @@ -1447,7 +1614,9 @@ <td> <p>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.</p> <p> - Format: array of uint32</p> + Format: list of booleans</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -1455,7 +1624,9 @@ <td> <p>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.</p> <p> - Format: array of uint32</p> + Format: list of integers</p> +<p> + Valid values: 0 - 7</p> </td> </tr> </tbody> @@ -1475,352 +1646,832 @@ </colgroup> <tbody> <tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.channels-combined"></a>ethtool.channels-combined</code></span></p></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.channels-other"></a>ethtool.channels-other</code></span></p></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.channels-rx"></a>ethtool.channels-rx</code></span></p></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.channels-tx"></a>ethtool.channels-tx</code></span></p></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> +</tr> +<tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-adaptive-rx"></a>ethtool.coalesce-adaptive-rx</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-adaptive-tx"></a>ethtool.coalesce-adaptive-tx</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-high"></a>ethtool.coalesce-pkt-rate-high</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-pkt-rate-low"></a>ethtool.coalesce-pkt-rate-low</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-frames"></a>ethtool.coalesce-rx-frames</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-high"></a>ethtool.coalesce-rx-frames-high</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-irq"></a>ethtool.coalesce-rx-frames-irq</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-frames-low"></a>ethtool.coalesce-rx-frames-low</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs"></a>ethtool.coalesce-rx-usecs</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-high"></a>ethtool.coalesce-rx-usecs-high</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-irq"></a>ethtool.coalesce-rx-usecs-irq</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-rx-usecs-low"></a>ethtool.coalesce-rx-usecs-low</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-sample-interval"></a>ethtool.coalesce-sample-interval</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-stats-block-usecs"></a>ethtool.coalesce-stats-block-usecs</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-frames"></a>ethtool.coalesce-tx-frames</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-high"></a>ethtool.coalesce-tx-frames-high</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-irq"></a>ethtool.coalesce-tx-frames-irq</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-frames-low"></a>ethtool.coalesce-tx-frames-low</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs"></a>ethtool.coalesce-tx-usecs</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-high"></a>ethtool.coalesce-tx-usecs-high</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-irq"></a>ethtool.coalesce-tx-usecs-irq</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.coalesce-tx-usecs-low"></a>ethtool.coalesce-tx-usecs-low</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.eee-enabled"></a>ethtool.eee-enabled</code></span></p></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-esp-hw-offload"></a>ethtool.feature-esp-hw-offload</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-esp-tx-csum-hw-offload"></a>ethtool.feature-esp-tx-csum-hw-offload</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-fcoe-mtu"></a>ethtool.feature-fcoe-mtu</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-gro"></a>ethtool.feature-gro</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-gso"></a>ethtool.feature-gso</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-highdma"></a>ethtool.feature-highdma</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-hw-tc-offload"></a>ethtool.feature-hw-tc-offload</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-l2-fwd-offload"></a>ethtool.feature-l2-fwd-offload</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-loopback"></a>ethtool.feature-loopback</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-lro"></a>ethtool.feature-lro</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-macsec-hw-offload"></a>ethtool.feature-macsec-hw-offload</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-ntuple"></a>ethtool.feature-ntuple</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx"></a>ethtool.feature-rx</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-all"></a>ethtool.feature-rx-all</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-fcs"></a>ethtool.feature-rx-fcs</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-gro-hw"></a>ethtool.feature-rx-gro-hw</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-gro-list"></a>ethtool.feature-rx-gro-list</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-udp-gro-forwarding"></a>ethtool.feature-rx-udp-gro-forwarding</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-udp_tunnel-port-offload"></a>ethtool.feature-rx-udp_tunnel-port-offload</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-vlan-filter"></a>ethtool.feature-rx-vlan-filter</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-filter"></a>ethtool.feature-rx-vlan-stag-filter</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rx-vlan-stag-hw-parse"></a>ethtool.feature-rx-vlan-stag-hw-parse</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rxhash"></a>ethtool.feature-rxhash</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-rxvlan"></a>ethtool.feature-rxvlan</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-sg"></a>ethtool.feature-sg</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tls-hw-record"></a>ethtool.feature-tls-hw-record</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tls-hw-rx-offload"></a>ethtool.feature-tls-hw-rx-offload</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tls-hw-tx-offload"></a>ethtool.feature-tls-hw-tx-offload</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tso"></a>ethtool.feature-tso</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx"></a>ethtool.feature-tx</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-fcoe-crc"></a>ethtool.feature-tx-checksum-fcoe-crc</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ip-generic"></a>ethtool.feature-tx-checksum-ip-generic</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv4"></a>ethtool.feature-tx-checksum-ipv4</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-ipv6"></a>ethtool.feature-tx-checksum-ipv6</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-checksum-sctp"></a>ethtool.feature-tx-checksum-sctp</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-esp-segmentation"></a>ethtool.feature-tx-esp-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-fcoe-segmentation"></a>ethtool.feature-tx-fcoe-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gre-csum-segmentation"></a>ethtool.feature-tx-gre-csum-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gre-segmentation"></a>ethtool.feature-tx-gre-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gso-list"></a>ethtool.feature-tx-gso-list</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gso-partial"></a>ethtool.feature-tx-gso-partial</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-gso-robust"></a>ethtool.feature-tx-gso-robust</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-ipxip4-segmentation"></a>ethtool.feature-tx-ipxip4-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-ipxip6-segmentation"></a>ethtool.feature-tx-ipxip6-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-nocache-copy"></a>ethtool.feature-tx-nocache-copy</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather"></a>ethtool.feature-tx-scatter-gather</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-scatter-gather-fraglist"></a>ethtool.feature-tx-scatter-gather-fraglist</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-sctp-segmentation"></a>ethtool.feature-tx-sctp-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tcp-ecn-segmentation"></a>ethtool.feature-tx-tcp-ecn-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tcp-mangleid-segmentation"></a>ethtool.feature-tx-tcp-mangleid-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tcp-segmentation"></a>ethtool.feature-tx-tcp-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tcp6-segmentation"></a>ethtool.feature-tx-tcp6-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-tunnel-remcsum-segmentation"></a>ethtool.feature-tx-tunnel-remcsum-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-udp-segmentation"></a>ethtool.feature-tx-udp-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-csum-segmentation"></a>ethtool.feature-tx-udp_tnl-csum-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-udp_tnl-segmentation"></a>ethtool.feature-tx-udp_tnl-segmentation</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-tx-vlan-stag-hw-insert"></a>ethtool.feature-tx-vlan-stag-hw-insert</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.feature-txvlan"></a>ethtool.feature-txvlan</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.pause-autoneg"></a>ethtool.pause-autoneg</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.pause-rx"></a>ethtool.pause-rx</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.pause-tx"></a>ethtool.pause-tx</code></span></p></td> -<td></td> +<td> +<p> + Format: ternary</p> +<p> + Valid values: on, off, ignore</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.ring-rx"></a>ethtool.ring-rx</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.ring-rx-jumbo"></a>ethtool.ring-rx-jumbo</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.ring-rx-mini"></a>ethtool.ring-rx-mini</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.ring-tx"></a>ethtool.ring-tx</code></span></p></td> -<td></td> +<td> +<p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +</td> </tr> </tbody> </table></div> @@ -1844,6 +2495,7 @@ <p> Alias: apn</p> <p>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</p> +<p>If the APN is unset (the default) then it may be detected based on "auto-config" setting. The property can be explicitly set to the empty string to prevent that and use no APN.</p> <p> Format: string</p> </td> @@ -1854,6 +2506,8 @@ <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -1870,6 +2524,8 @@ <p>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -1886,6 +2542,8 @@ <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -1893,7 +2551,9 @@ <td> <p>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Special values: auto</p> </td> </tr> <tr> @@ -1930,10 +2590,9 @@ <td> <p>Flags indicating how to handle the "password" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -1949,10 +2608,9 @@ <td> <p>Flags indicating how to handle the "pin" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -2004,7 +2662,7 @@ Alias: mac</p> <p>If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</p> <p> - Format: byte array</p> + Format: Infiniband MAC address</p> </td> </tr> <tr> @@ -2014,7 +2672,9 @@ Alias: mtu</p> <p>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Special values: auto</p> </td> </tr> <tr> @@ -2026,7 +2686,11 @@ <p>With the p-key set, the interface name is always "$parent.$p_key". Setting "connection.interface-name" to another name is not supported.</p> <p>Note that kernel will internally always set the full membership bit, although the interface name does not reflect that. Usually the user would want to configure a full membership p-key with 0x8000 flag set.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -1 - 65535</p> +<p> + Special values: default (-1)</p> </td> </tr> <tr> @@ -2047,6 +2711,8 @@ <p>The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</p> <p> Format: string</p> +<p> + Valid values: datagram, connected</p> </td> </tr> </tbody> @@ -2072,7 +2738,7 @@ Alias: ip4</p> <p>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.</p> <p> - Format: a comma separated list of addresses</p> + Format: list of ipv4.addresses objects</p> </td> </tr> <tr> @@ -2081,16 +2747,22 @@ <p>VPN connections will default to add the route automatically unless this setting is set to FALSE.</p> <p>For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</p> <p> - Format: NMTernary (int32)</p> + Format: ternary</p> +<p> + Valid values: true/yes/on, false/no/off, default/unknown</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dad-timeout"></a>ipv4.dad-timeout</code></span></p></td> <td> -<p>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.</p> -<p>The property is currently implemented only for IPv4.</p> +<p>Maximum timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. The property is currently implemented only for IPv4.</p> +<p>A zero value means that no duplicate address detection is performed, -1 means the default value (either the value configured globally in NetworkManger.conf or 200ms). A value greater than zero is a timeout in milliseconds. Note that the time intervals are subject to randomization as per RFC 5227 and so the actual duration can be between half and the full time specified in this property.</p> +<p> + Format: integer</p> +<p> + Valid values: -1 - 30000</p> <p> - Format: int32</p> + Special values: default (-1), off (0)</p> </td> </tr> <tr> @@ -2101,9 +2773,12 @@ <p>The special value "ipv6-duid" uses the DUID from "ipv6.dhcp-duid" property as an RFC4361-compliant client identifier. As IAID it uses "ipv4.dhcp-iaid" and falls back to "ipv6.dhcp-iaid" if unset.</p> <p>The special value "duid" generates a RFC4361-compliant client identifier based on "ipv4.dhcp-iaid" and uses a DUID generated by hashing /etc/machine-id.</p> <p>The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key.</p> -<p>If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.</p> +<p>The special value "none" prevents any client identifier from being sent. Note that this is normally not recommended.</p> +<p>If unset, a globally configured default from NetworkManager.conf is used. If still unset, the default depends on the DHCP plugin. The internal dhcp client will default to "mac" and the dhclient plugin will try to use one from its config file if present, or won't sent any client-id otherwise.</p> <p> Format: string</p> +<p> + Special values: mac, perm-mac, duid, ipv6-duid, stable, none</p> </td> </tr> <tr> @@ -2126,10 +2801,12 @@ <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.dhcp-hostname-flags"></a>ipv4.dhcp-hostname-flags</code></span></p></td> <td> <p>Flags for the DHCP hostname and FQDN.</p> -<p>Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.</p> -<p>When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</p> +<p>Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) and "fqdn-no-update" (0x4). When no FQDN flag is set and "fqdn-clear-flags" (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and "fqdn-clear-flags" (0x8) is not set, the standard FQDN flags are set in the request: "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) for IPv4 and "fqdn-serv-update" (0x1) for IPv6.</p> +<p>When this property is set to the default value "none" (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also "none" (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</p> +<p> + Format: flags (NMDhcpHostnameFlags)</p> <p> - Format: uint32</p> + Valid values: none (0x0), fqdn-serv-update (0x1), fqdn-encoded (0x2), fqdn-no-update (0x4), fqdn-clear-flags (0x8)</p> </td> </tr> <tr> @@ -2150,7 +2827,7 @@ <p>For DHCPv4, each element must be an IPv4 address, optionally followed by a slash and a prefix length (e.g. "192.168.122.0/24").</p> <p>This property is currently not implemented for DHCPv6.</p> <p> - Format: array of string</p> + Format: list of IPv4 addresses</p> </td> </tr> <tr> @@ -2159,6 +2836,8 @@ <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -2167,7 +2846,11 @@ <p>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).</p> <p>Set to 2147483647 (MAXINT32) for infinity.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: 0 - 2147483647</p> +<p> + Special values: default (0), infinity (2147483647)</p> </td> </tr> <tr> @@ -2184,7 +2867,7 @@ <p>Array of IP addresses of DNS servers.</p> <p>For DoT (DNS over TLS), the SNI server name can be specified by appending "#example.com" to the IP address of the DNS server. This currently only has effect when using systemd-resolved.</p> <p> - Format: array of uint32</p> + Format: list of IPv4 addresses</p> </td> </tr> <tr> @@ -2197,7 +2880,7 @@ <p>When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</p> <p>The valid "ipv4.dns-options" and "ipv6.dns-options" get merged together.</p> <p> - Format: a comma separated list of DNS options</p> + Format: list of strings</p> </td> </tr> <tr> @@ -2212,7 +2895,9 @@ <p>When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</p> <p>When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> </td> </tr> <tr> @@ -2222,7 +2907,7 @@ <p>When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</p> <p>When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</p> <p> - Format: array of string</p> + Format: list of strings</p> </td> </tr> <tr> @@ -2234,7 +2919,7 @@ <p>Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</p> <p>Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</p> <p> - Format: string</p> + Format: IPv4 address</p> </td> </tr> <tr> @@ -2243,6 +2928,8 @@ <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -2251,6 +2938,8 @@ <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -2259,7 +2948,9 @@ <p>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.</p> <p>When set to "auto", the value is dependent on "ipv4.method". When set to "default", it honors the global connection default, before falling back to "auto". Note that if "ipv4.method" is "disabled", then link local addressing is always disabled too. The default is "default".</p> <p> - Format: int32</p> + Format: choice (NMSettingIP4LinkLocal)</p> +<p> + Valid values: default (0), auto (1), disabled (2), enabled (3)</p> </td> </tr> <tr> @@ -2268,6 +2959,8 @@ <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -2289,6 +2982,8 @@ </p> <p> Format: string</p> +<p> + Valid values: auto, link-local, manual, shared, disabled</p> </td> </tr> <tr> @@ -2297,6 +2992,8 @@ <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -2304,7 +3001,9 @@ <td> <p>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</p> <p> - Format: NMTernary (int32)</p> + Format: ternary</p> +<p> + Valid values: true/yes/on, false/no/off, default/unknown</p> </td> </tr> <tr> @@ -2315,7 +3014,11 @@ <p>Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</p> <p>A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -1 - 2147483647</p> +<p> + Special values: default (-1), infinity (2147483647)</p> </td> </tr> <tr> @@ -2323,7 +3026,9 @@ <td> <p>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</p> <p> - Format: int64</p> + Format: integer</p> +<p> + Valid values: -1 - 4294967295</p> </td> </tr> <tr> @@ -2334,7 +3039,11 @@ <p>If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</p> <p>Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +<p> + Special values: unspec (0), main (254)</p> </td> </tr> <tr> @@ -2396,7 +3105,7 @@ For details see also `man ip-route`. </p> <p> - Format: a comma separated list of routes</p> + Format: list of ipv4.routes objects</p> </td> </tr> <tr> @@ -2412,7 +3121,7 @@ fixed priority. Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </p> <p> - Format: a comma separated list of routing rules</p> + Format: list of ipv4.routing-rules objects</p> </td> </tr> </tbody> @@ -2442,7 +3151,9 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>If not specified, when creating a new profile the default is "default".</p> <p>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.</p> <p> - Format: one of "eui64" (0), "stable-privacy" (1), "default" (3) or "default-or-eui64" (2)</p> + Format: choice (NMSettingIP6ConfigAddrGenMode)</p> +<p> + Valid values: eui64 (0), stable-privacy (1), default-or-eui64 (2), default (3)</p> </td> </tr> <tr> @@ -2452,7 +3163,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> Alias: ip6</p> <p>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).</p> <p> - Format: a comma separated list of addresses</p> + Format: list of ipv6.addresses objects</p> </td> </tr> <tr> @@ -2461,7 +3172,9 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>VPN connections will default to add the route automatically unless this setting is set to FALSE.</p> <p>For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect.</p> <p> - Format: NMTernary (int32)</p> + Format: ternary</p> +<p> + Valid values: true/yes/on, false/no/off, default/unknown</p> </td> </tr> <tr> @@ -2488,10 +3201,12 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv6.dhcp-hostname-flags"></a>ipv6.dhcp-hostname-flags</code></span></p></td> <td> <p>Flags for the DHCP hostname and FQDN.</p> -<p>Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6.</p> -<p>When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</p> +<p>Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) and "fqdn-no-update" (0x4). When no FQDN flag is set and "fqdn-clear-flags" (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and "fqdn-clear-flags" (0x8) is not set, the standard FQDN flags are set in the request: "fqdn-serv-update" (0x1), "fqdn-encoded" (0x2) for IPv4 and "fqdn-serv-update" (0x1) for IPv6.</p> +<p>When this property is set to the default value "none" (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also "none" (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</p> <p> - Format: uint32</p> + Format: flags (NMDhcpHostnameFlags)</p> +<p> + Valid values: none (0x0), fqdn-serv-update (0x1), fqdn-encoded (0x2), fqdn-no-update (0x4), fqdn-clear-flags (0x8)</p> </td> </tr> <tr> @@ -2519,6 +3234,8 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -2527,7 +3244,11 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>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).</p> <p>Set to 2147483647 (MAXINT32) for infinity.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: 0 - 2147483647</p> +<p> + Special values: default (0), infinity (2147483647)</p> </td> </tr> <tr> @@ -2536,7 +3257,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>Array of IP addresses of DNS servers.</p> <p>For DoT (DNS over TLS), the SNI server name can be specified by appending "#example.com" to the IP address of the DNS server. This currently only has effect when using systemd-resolved.</p> <p> - Format: array of byte array</p> + Format: list of IPv6 addresses</p> </td> </tr> <tr> @@ -2549,7 +3270,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>When using a caching DNS plugin (dnsmasq or systemd-resolved in NetworkManager.conf) then "edns0" and "trust-ad" are automatically added.</p> <p>The valid "ipv4.dns-options" and "ipv6.dns-options" get merged together.</p> <p> - Format: a comma separated list of DNS options</p> + Format: list of strings</p> </td> </tr> <tr> @@ -2564,7 +3285,9 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. Note that commonly the resolver tries name servers in /etc/resolv.conf in the order listed, proceeding with the next server in the list on failure. See for example the "rotate" option of the dns-options setting. If there are any negative DNS priorities, then only name servers from the devices with that lowest priority will be considered.</p> <p>When using a DNS resolver that supports Conditional Forwarding or Split DNS (with dns=dnsmasq or dns=systemd-resolved settings), each connection is used to query domains in its search list. The search domains determine which name servers to ask, and the DNS priority is used to prioritize name servers based on the domain. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the best priority (lowest numerical value) wins. If a sub domain is configured on another interface it will be accepted regardless the priority, unless parent domain on the other interface has a negative priority, which causes the sub domain to be shadowed. With Split DNS one can avoid undesired DNS leaks by properly configuring DNS priorities and the search domains, so that only name servers of the desired interface are configured.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> </td> </tr> <tr> @@ -2574,7 +3297,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>When using a DNS plugin that supports Conditional Forwarding or Split DNS, then the search domains specify which name servers to query. This makes the behavior different from running with plain /etc/resolv.conf. For more information see also the dns-priority setting.</p> <p>When set on a profile that also enabled DHCP, the DNS search list received automatically (option 119 for DHCPv4 and option 24 for DHCPv6) gets merged with the manual list. This can be prevented by setting "ignore-auto-dns". Note that if no DNS searches are configured, the fallback will be derived from the domain from DHCP (option 15).</p> <p> - Format: array of string</p> + Format: list of strings</p> </td> </tr> <tr> @@ -2586,7 +3309,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>Setting the gateway causes NetworkManager to configure a standard default route with the gateway as next hop. This is ignored if "never-default" is set. An alternative is to configure the default route explicitly with a manual route and /0 as prefix length.</p> <p>Note that the gateway usually conflicts with routing that NetworkManager configures for WireGuard interfaces, so usually it should not be set in that case. See "ip4-auto-default-route".</p> <p> - Format: string</p> + Format: IPv6 address</p> </td> </tr> <tr> @@ -2595,6 +3318,8 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -2603,6 +3328,8 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -2613,7 +3340,9 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr".</p> <p>Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.</p> <p> - Format: NMSettingIP6ConfigPrivacy (int32)</p> + Format: choice (NMSettingIP6ConfigPrivacy)</p> +<p> + Valid values: unknown (-1), disabled (0), prefer-public-addr (1), prefer-temp-addr (2)</p> </td> </tr> <tr> @@ -2622,6 +3351,8 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -2650,6 +3381,8 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> </p> <p> Format: string</p> +<p> + Valid values: ignore, auto, dhcp, link-local, manual, shared, disabled</p> </td> </tr> <tr> @@ -2657,7 +3390,9 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <td> <p>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.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Special values: auto</p> </td> </tr> <tr> @@ -2666,6 +3401,8 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -2674,7 +3411,11 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>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.</p> <p>Set to 2147483647 (MAXINT32) for infinity.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: 0 - 2147483647</p> +<p> + Special values: default (0), infinity (2147483647)</p> </td> </tr> <tr> @@ -2682,7 +3423,9 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <td> <p>Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE.</p> <p> - Format: NMTernary (int32)</p> + Format: ternary</p> +<p> + Valid values: true/yes/on, false/no/off, default/unknown</p> </td> </tr> <tr> @@ -2693,7 +3436,11 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>Note that if "may-fail" is FALSE for the same address family, this property has no effect as NetworkManager needs to wait for the full DHCP timeout.</p> <p>A zero value means that no required timeout is present, -1 means the default value (either configuration ipvx.required-timeout override or zero).</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -1 - 2147483647</p> +<p> + Special values: default (-1), infinity (2147483647)</p> </td> </tr> <tr> @@ -2701,7 +3448,9 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <td> <p>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</p> <p> - Format: int64</p> + Format: integer</p> +<p> + Valid values: -1 - 4294967295</p> </td> </tr> <tr> @@ -2712,7 +3461,11 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> <p>If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection.</p> <p>Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> +<p> + Special values: unspec (0), main (254)</p> </td> </tr> <tr> @@ -2756,7 +3509,7 @@ Example: <code class="literal">priority 5 from 192.167.4.0/24 table 45</code> For details see also `man ip-route`. </p> <p> - Format: a comma separated list of routes</p> + Format: list of ipv6.routes objects</p> </td> </tr> <tr> @@ -2772,7 +3525,7 @@ fixed priority. Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> </p> <p> - Format: a comma separated list of routing rules</p> + Format: list of ipv6.routing-rules objects</p> </td> </tr> <tr> @@ -2805,7 +3558,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. To disable this option, add 0x1 (ip6-ign-encap-limit) to ip-tunnel flags.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 255</p> </td> </tr> <tr> @@ -2813,7 +3568,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>Tunnel flags. Currently, the following values are supported: 0x1 (ip6-ign-encap-limit), 0x2 (ip6-use-orig-tclass), 0x4 (ip6-use-orig-flowlabel), 0x8 (ip6-mip6-dev), 0x10 (ip6-rcv-dscp-copy) and 0x20 (ip6-use-orig-fwmark). They are valid only for IPv6 tunnels.</p> <p> - Format: uint32</p> + Format: flags (NMIPTunnelFlags)</p> +<p> + Valid values: none (0x0), ip6-ign-encap-limit (0x1), ip6-use-orig-tclass (0x2), ip6-use-orig-flowlabel (0x4), ip6-mip6-dev (0x8), ip6-rcv-dscp-copy (0x10), ip6-use-orig-fwmark (0x20)</p> </td> </tr> <tr> @@ -2821,7 +3578,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 1048575</p> </td> </tr> <tr> @@ -2829,7 +3588,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>The fwmark value to assign to tunnel packets. This property can be set to a non zero value only on VTI and VTI6 tunnels.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -2857,7 +3618,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> Alias: mode</p> <p>The tunneling mode. Valid values: ipip (1), gre (2), sit (3), isatap (4), vti (5), ip6ip6 (6), ipip6 (7), ip6gre (8), vti6 (9), gretap (10) and ip6gretap (11)</p> <p> - Format: uint32</p> + Format: choice (NMIPTunnelMode)</p> +<p> + Valid values: ipip (1), gre (2), sit (3), isatap (4), vti (5), ip6ip6 (6), ipip6 (7), ip6gre (8), vti6 (9), gretap (10), ip6gretap (11)</p> </td> </tr> <tr> @@ -2865,7 +3628,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Special values: auto</p> </td> </tr> <tr> @@ -2892,6 +3657,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>Whether to enable Path MTU Discovery on this tunnel.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -2909,7 +3676,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 255</p> </td> </tr> <tr> @@ -2917,7 +3686,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 255</p> </td> </tr> </tbody> @@ -2944,6 +3715,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>Whether the transmitted traffic must be encrypted.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -2961,10 +3734,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>Flags indicating how to handle the "mka-cak" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -2984,7 +3756,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> Alias: mode</p> <p>Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</p> <p> - Format: int32</p> + Format: choice (NMSettingMacsecMode)</p> +<p> + Valid values: psk (0), eap (1)</p> </td> </tr> <tr> @@ -3004,7 +3778,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> Alias: port</p> <p>The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: 1 - 65534</p> </td> </tr> <tr> @@ -3013,6 +3789,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3020,7 +3798,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>Specifies the validation mode for incoming frames.</p> <p> - Format: int32</p> + Format: choice (NMSettingMacsecValidation)</p> +<p> + Valid values: disable (0), check (1), strict (2)</p> </td> </tr> </tbody> @@ -3046,7 +3826,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> Alias: mode</p> <p>The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</p> <p> - Format: uint32</p> + Format: choice (NMSettingMacvlanMode)</p> +<p> + Valid values: vepa (1), bridge (2), private (3), passthru (4), source (5)</p> </td> </tr> <tr> @@ -3065,6 +3847,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>Whether the interface should be put in promiscuous mode.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3075,6 +3859,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>Whether the interface should be a MACVTAP.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> </tbody> @@ -3099,7 +3885,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>A list of driver names to match. Each element is a shell wildcard pattern.</p> <p>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</p> <p> - Format: array of string</p> + Format: list of strings</p> </td> </tr> <tr> @@ -3108,7 +3894,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>A list of interface names to match. Each element is a shell wildcard pattern.</p> <p>An element can be prefixed with a pipe symbol (|) or an ampersand (&). The former means that the element is optional and the latter means that it is mandatory. If there are any optional elements, than the match evaluates to true if at least one of the optional element matches (logical OR). If there are any mandatory elements, then they all must match (logical AND). By default, an element is optional. This means that an element "foo" behaves the same as "|foo". An element can also be inverted with exclamation mark (!) between the pipe symbol (or the ampersand) and before the pattern. Note that "!foo" is a shortcut for the mandatory match "&!foo". Finally, a backslash can be used at the beginning of the element (after the optional special characters) to escape the start of the pattern. For example, "&\\!a" is an mandatory match for literally "!a".</p> <p> - Format: array of string</p> + Format: list of strings</p> </td> </tr> <tr> @@ -3117,7 +3903,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>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.</p> <p>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the match.</p> <p> - Format: array of string</p> + Format: list of strings</p> </td> </tr> <tr> @@ -3129,7 +3915,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>Each element of the list is a shell wildcard pattern.</p> <p>See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\\' are used for optional and mandatory matches and inverting the pattern.</p> <p> - Format: array of string</p> + Format: list of strings</p> </td> </tr> </tbody> @@ -3157,7 +3943,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> Alias: channel</p> <p>Channel on which the mesh network to join is located.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -3168,7 +3956,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.</p> <p>This is currently only implemented by dhclient DHCP plugin.</p> <p> - Format: byte array</p> + Format: MAC address</p> </td> </tr> <tr> @@ -3178,7 +3966,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> Alias: ssid</p> <p>SSID of the mesh network to join.</p> <p> - Format: byte array</p> + Format: string</p> </td> </tr> </tbody> @@ -3203,6 +3991,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>The data path type. One of "system", "netdev" or empty.</p> <p> Format: string</p> +<p> + Valid values: system, netdev</p> </td> </tr> <tr> @@ -3211,6 +4001,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>The bridge failure mode. One of "secure", "standalone" or empty.</p> <p> Format: string</p> +<p> + Valid values: secure, standalone</p> </td> </tr> <tr> @@ -3219,6 +4011,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>Enable or disable multicast snooping.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3227,6 +4021,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>Enable or disable RSTP.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3235,6 +4031,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>Enable or disable STP.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> </tbody> @@ -3266,7 +4064,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>Open vSwitch DPDK number of rx queues. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -3274,7 +4074,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>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.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4096</p> </td> </tr> <tr> @@ -3282,7 +4084,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>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.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4096</p> </td> </tr> </tbody> @@ -3306,7 +4110,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>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.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 65279</p> </td> </tr> <tr> @@ -3315,6 +4121,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>The interface type. Either "internal", "system", "patch", "dpdk", or empty.</p> <p> Format: string</p> +<p> + Valid values: internal, system, patch, dpdk</p> </td> </tr> </tbody> @@ -3360,7 +4168,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>The time port must be inactive in order to be considered down.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -3369,6 +4179,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>Bonding mode. One of "active-backup", "balance-slb", or "balance-tcp".</p> <p> Format: string</p> +<p> + Valid values: active-backup, balance-slb, balance-tcp</p> </td> </tr> <tr> @@ -3376,7 +4188,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>The time port must be active before it starts forwarding traffic.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -3385,6 +4199,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>LACP mode. One of "active", "off", or "passive".</p> <p> Format: string</p> +<p> + Valid values: active, off, passive</p> </td> </tr> <tr> @@ -3392,7 +4208,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>The VLAN tag in the range 0-4095.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4095</p> </td> </tr> <tr> @@ -3401,7 +4219,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>A list of VLAN ranges that this port trunks.</p> <p>The property is valid only for ports with mode "trunk", "native-tagged", or "native-untagged port". If it is empty, the port trunks all VLANs.</p> <p> - Format: array of vardict</p> + Format: list of ovs-port.trunks objects</p> </td> </tr> <tr> @@ -3410,6 +4228,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>The VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk", "dot1q-tunnel" or unset.</p> <p> Format: string</p> +<p> + Valid values: access, native-tagged, native-untagged, trunk, dot1q-tunnel</p> </td> </tr> </tbody> @@ -3433,7 +4253,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>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.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -3442,6 +4264,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3449,7 +4273,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>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.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -3457,7 +4283,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>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.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -3466,6 +4294,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3473,7 +4303,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>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.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 16384</p> </td> </tr> <tr> @@ -3481,7 +4313,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>If non-zero, instruct pppd to send packets no larger than the specified size.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Special values: auto</p> </td> </tr> <tr> @@ -3490,6 +4324,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>If TRUE, Van Jacobsen TCP header compression will not be requested.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3498,6 +4334,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3506,6 +4344,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>If TRUE, BSD compression will not be requested.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3514,6 +4354,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>If TRUE, "deflate" compression will not be requested.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3522,6 +4364,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>If TRUE, the CHAP authentication method will not be used.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3530,6 +4374,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>If TRUE, the EAP authentication method will not be used.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3538,6 +4384,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>If TRUE, the MSCHAP authentication method will not be used.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3546,6 +4394,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>If TRUE, the MSCHAPv2 authentication method will not be used.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3554,6 +4404,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>If TRUE, the PAP authentication method will not be used.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3562,6 +4414,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3570,6 +4424,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> </tbody> @@ -3613,10 +4469,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>Flags indicating how to handle the "password" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -3663,6 +4518,8 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>Whether the proxy configuration is for browser only.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -3670,9 +4527,11 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p> Alias: method</p> -<p>Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</p> +<p>Method for proxy configuration, Default is "none" (0)</p> +<p> + Format: choice (NMSettingProxyMethod)</p> <p> - Format: int32</p> + Valid values: none (0), auto (1)</p> </td> </tr> <tr> @@ -3716,7 +4575,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>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.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -3724,7 +4585,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>Byte-width of the serial communication. The 8 in "8n1" for example.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 5 - 8</p> </td> </tr> <tr> @@ -3732,7 +4595,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>Parity setting of the serial port.</p> <p> - Format: NMSettingSerialParity (byte)</p> + Format: choice (NMSettingSerialParity)</p> +<p> + Valid values: none/N/n (0), even/E/e (1), odd/O/o (2)</p> </td> </tr> <tr> @@ -3740,7 +4605,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>Time to delay between each byte sent to the modem, in microseconds.</p> <p> - Format: uint64</p> + Format: integer</p> +<p> + Valid values: 0 - 18446744073709551615</p> </td> </tr> <tr> @@ -3748,7 +4615,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td> <p>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 1 - 2</p> </td> </tr> </tbody> @@ -3771,11 +4640,13 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.sriov.autoprobe-drivers"></a>sriov.autoprobe-drivers</code></span></p></td> <td> <p>Whether to autoprobe virtual functions by a compatible driver.</p> -<p>If set to NM_TERNARY_TRUE (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF.</p> -<p>If set to NM_TERNARY_FALSE (0), VFs will not be claimed and no network interfaces will be created for them.</p> -<p>When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_TRUE (1).</p> +<p>If set to "true" (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF.</p> +<p>If set to "false" (0), VFs will not be claimed and no network interfaces will be created for them.</p> +<p>When set to "default" (-1), the global default is used; in case the global default is unspecified it is assumed to be "true" (1).</p> +<p> + Format: ternary</p> <p> - Format: NMTernary (int32)</p> + Valid values: true/yes/on, false/no/off, default/unknown</p> </td> </tr> <tr> @@ -3784,7 +4655,9 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>The total number of virtual functions to create.</p> <p>Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -3801,7 +4674,7 @@ Example: <code class="literal">priority 5 from 1:2:3::5/128 table 45</code> <p>"ID[.PRIORITY[.PROTO]]".</p> <p>PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.</p> <p> - Format: array of vardict</p> + Format: list of sriov.vfs objects</p> </td> </tr> </tbody> @@ -4076,7 +4949,7 @@ Linux traffic control subsystem </tbody> </table></div> <p> - Format: GPtrArray(NMTCQdisc)</p> + Format: list of tc.qdiscs objects</p> </td> </tr> <tr> @@ -4178,7 +5051,7 @@ Linux traffic control subsystem </tr></tbody> </table></div> <p> - Format: GPtrArray(NMTCTfilter)</p> + Format: list of tc.tfilters objects</p> </td> </tr> </tbody> @@ -4212,7 +5085,7 @@ Linux traffic control subsystem <td> <p>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</p> <p> - Format: array of vardict</p> + Format: list of team.link-watchers objects</p> </td> </tr> <tr> @@ -4220,7 +5093,11 @@ Linux traffic control subsystem <td> <p>Corresponds to the teamd mcast_rejoin.count.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> +<p> + Special values: unset (-1), disabled (0)</p> </td> </tr> <tr> @@ -4228,7 +5105,11 @@ Linux traffic control subsystem <td> <p>Corresponds to the teamd mcast_rejoin.interval.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> +<p> + Special values: unset (-1), default (0)</p> </td> </tr> <tr> @@ -4236,7 +5117,11 @@ Linux traffic control subsystem <td> <p>Corresponds to the teamd notify_peers.count.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> +<p> + Special values: unset (-1), disabled (0)</p> </td> </tr> <tr> @@ -4244,7 +5129,11 @@ Linux traffic control subsystem <td> <p>Corresponds to the teamd notify_peers.interval.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> +<p> + Special values: unset (-1), default (0)</p> </td> </tr> <tr> @@ -4253,6 +5142,8 @@ Linux traffic control subsystem <p>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random".</p> <p> Format: string</p> +<p> + Valid values: broadcast, roundrobin, random, activebackup, loadbalance, lacp</p> </td> </tr> <tr> @@ -4261,6 +5152,8 @@ Linux traffic control subsystem <p>Corresponds to the teamd runner.active.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -4269,6 +5162,8 @@ Linux traffic control subsystem <p>Corresponds to the teamd runner.agg_select_policy.</p> <p> Format: string</p> +<p> + Valid values: lacp_prio, lacp_prio_stable, bandwidth, count, port_config</p> </td> </tr> <tr> @@ -4277,6 +5172,8 @@ Linux traffic control subsystem <p>Corresponds to the teamd runner.fast_rate.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -4285,6 +5182,8 @@ Linux traffic control subsystem <p>Corresponds to the teamd runner.hwaddr_policy.</p> <p> Format: string</p> +<p> + Valid values: same_all, by_active, only_active</p> </td> </tr> <tr> @@ -4292,7 +5191,11 @@ Linux traffic control subsystem <td> <p>Corresponds to the teamd runner.min_ports.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> +<p> + Special values: unset (-1), default (1)</p> </td> </tr> <tr> @@ -4300,7 +5203,11 @@ Linux traffic control subsystem <td> <p>Corresponds to the teamd runner.sys_prio.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> +<p> + Special values: unset (-1), default (65535)</p> </td> </tr> <tr> @@ -4309,6 +5216,8 @@ Linux traffic control subsystem <p>Corresponds to the teamd runner.tx_balancer.name.</p> <p> Format: string</p> +<p> + Valid values: basic</p> </td> </tr> <tr> @@ -4316,7 +5225,11 @@ Linux traffic control subsystem <td> <p>Corresponds to the teamd runner.tx_balancer.interval.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> +<p> + Special values: unset (-1), default (50)</p> </td> </tr> <tr> @@ -4324,7 +5237,9 @@ Linux traffic control subsystem <td> <p>Corresponds to the teamd runner.tx_hash.</p> <p> - Format: array of string</p> + Format: list of strings</p> +<p> + Valid values: eth, vlan, ipv4, ipv6, ip, l3, tcp, udp, sctp, l4</p> </td> </tr> </tbody> @@ -4358,7 +5273,11 @@ Linux traffic control subsystem <td> <p>Corresponds to the teamd ports.PORTIFNAME.lacp_key.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> +<p> + Special values: unset (-1), default (0)</p> </td> </tr> <tr> @@ -4366,7 +5285,11 @@ Linux traffic control subsystem <td> <p>Corresponds to the teamd ports.PORTIFNAME.lacp_prio.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> +<p> + Special values: unset (-1), default (255)</p> </td> </tr> <tr> @@ -4374,7 +5297,7 @@ Linux traffic control subsystem <td> <p>Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher. Available link watchers are 'ethtool', 'nsna_ping' and 'arp_ping' and it is specified in the dictionary with the key 'name'. Available keys are: ethtool: 'delay-up', 'delay-down', 'init-wait'; nsna_ping: 'init-wait', 'interval', 'missed-max', 'target-host'; arp_ping: all the ones in nsna_ping and 'source-host', 'validate-active', 'validate-inactive', 'send-always'. See teamd.conf man for more details.</p> <p> - Format: array of vardict</p> + Format: list of team-port.link-watchers objects</p> </td> </tr> <tr> @@ -4382,7 +5305,11 @@ Linux traffic control subsystem <td> <p>Corresponds to the teamd ports.PORTIFNAME.prio.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> +<p> + Special values: unset (0), default (0)</p> </td> </tr> <tr> @@ -4390,7 +5317,11 @@ Linux traffic control subsystem <td> <p>Corresponds to the teamd ports.PORTIFNAME.queue_id. When set to -1 means the parameter is skipped from the json config.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> +<p> + Special values: unset (-1), default (0)</p> </td> </tr> <tr> @@ -4399,6 +5330,8 @@ Linux traffic control subsystem <p>Corresponds to the teamd ports.PORTIFNAME.sticky.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> </tbody> @@ -4432,9 +5365,11 @@ Linux traffic control subsystem <td> <p> Alias: mode</p> -<p>The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.</p> +<p>The operating mode of the virtual device. Allowed values are "tun" (1) to create a layer 3 device and "tap" (2) to create an Ethernet-like layer 2 one.</p> +<p> + Format: choice (NMSettingTunMode)</p> <p> - Format: uint32</p> + Valid values: tun (1), tap (2)</p> </td> </tr> <tr> @@ -4445,6 +5380,8 @@ Linux traffic control subsystem <p>If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -4465,6 +5402,8 @@ Linux traffic control subsystem <p>If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -4475,6 +5414,8 @@ Linux traffic control subsystem <p>If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> </tbody> @@ -4500,7 +5441,7 @@ Linux traffic control subsystem Alias: egress</p> <p>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</p> <p> - Format: array of string</p> + Format: list of vlan.egress-priority-map objects</p> </td> </tr> <tr> @@ -4508,10 +5449,12 @@ Linux traffic control subsystem <td> <p> Alias: flags</p> -<p>One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol).</p> +<p>One or more flags which control the behavior and features of the VLAN interface. Flags include "reorder-headers" (0x1) (reordering of output packet headers), "gvrp" (0x2) (use of the GVRP protocol), and "loose-binding" (0x4) (loose binding of the interface to its master device's operating state). "mvrp" (0x8) (use of the MVRP protocol).</p> <p>The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.</p> <p> - Format: NMVlanFlags (uint32)</p> + Format: flags (NMVlanFlags)</p> +<p> + Valid values: reorder-headers (0x1), gvrp (0x2), loose-binding (0x4), mvrp (0x8)</p> </td> </tr> <tr> @@ -4521,7 +5464,9 @@ Linux traffic control subsystem Alias: id</p> <p>The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4095</p> </td> </tr> <tr> @@ -4531,7 +5476,7 @@ Linux traffic control subsystem Alias: ingress</p> <p>For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</p> <p> - Format: array of string</p> + Format: list of vlan.ingress-priority-map objects</p> </td> </tr> <tr> @@ -4551,6 +5496,8 @@ Linux traffic control subsystem <p>Supported values are: '802.1Q', '802.1ad'. If not specified the default value is '802.1Q'.</p> <p> Format: string</p> +<p> + Valid values: 802.1Q, 802.1ad</p> </td> </tr> </tbody> @@ -4574,7 +5521,7 @@ Linux traffic control subsystem <td> <p>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</p> <p> - Format: dict of string to string</p> + Format: list of key/value options</p> </td> </tr> <tr> @@ -4583,6 +5530,8 @@ Linux traffic control subsystem <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -4590,7 +5539,7 @@ Linux traffic control subsystem <td> <p>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</p> <p> - Format: dict of string to string</p> + Format: list of key/value options</p> </td> </tr> <tr> @@ -4608,7 +5557,9 @@ Linux traffic control subsystem <td> <p>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.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -4643,7 +5594,9 @@ Linux traffic control subsystem Alias: table</p> <p>The routing table for this VRF.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr></tbody> </table></div> @@ -4666,7 +5619,9 @@ Linux traffic control subsystem <td> <p>Specifies the lifetime in seconds of FDB entries learnt by the kernel.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -4676,7 +5631,9 @@ Linux traffic control subsystem Alias: destination-port</p> <p>Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 65535</p> </td> </tr> <tr> @@ -4686,7 +5643,9 @@ Linux traffic control subsystem Alias: id</p> <p>Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 16777215</p> </td> </tr> <tr> @@ -4695,6 +5654,8 @@ Linux traffic control subsystem <p>Specifies whether netlink LL ADDR miss notifications are generated.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -4703,6 +5664,8 @@ Linux traffic control subsystem <p>Specifies whether netlink IP ADDR miss notifications are generated.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -4711,6 +5674,8 @@ Linux traffic control subsystem <p>Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -4718,7 +5683,9 @@ Linux traffic control subsystem <td> <p>Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -4747,6 +5714,8 @@ Linux traffic control subsystem <p>Specifies whether ARP proxy is turned on.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -4765,6 +5734,8 @@ Linux traffic control subsystem <p>Specifies whether route short circuit is turned on.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -4774,7 +5745,9 @@ Linux traffic control subsystem Alias: source-port-max</p> <p>Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 65535</p> </td> </tr> <tr> @@ -4784,7 +5757,9 @@ Linux traffic control subsystem Alias: source-port-min</p> <p>Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 65535</p> </td> </tr> <tr> @@ -4792,7 +5767,9 @@ Linux traffic control subsystem <td> <p>Specifies the TOS value to use in outgoing packets.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 255</p> </td> </tr> <tr> @@ -4800,7 +5777,9 @@ Linux traffic control subsystem <td> <p>Specifies the time-to-live value to use in outgoing packets.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 255</p> </td> </tr> </tbody> @@ -4826,7 +5805,7 @@ Linux traffic control subsystem Alias: peer</p> <p>The P2P device that should be connected to. Currently, this is the only way to create or join a group.</p> <p> - Format: string</p> + Format: MAC address</p> </td> </tr> <tr> @@ -4835,7 +5814,7 @@ Linux traffic control subsystem <p>The Wi-Fi Display (WFD) Information Elements (IEs) to set.</p> <p>Wi-Fi Display requires a protocol specific information element to be set in certain Wi-Fi frames. These can be specified here for the purpose of establishing a connection. This setting is only useful when implementing a Wi-Fi Display client.</p> <p> - Format: byte array</p> + Format: bytes</p> </td> </tr> <tr> @@ -4844,7 +5823,9 @@ Linux traffic control subsystem <p>Flags indicating which mode of WPS is to be used.</p> <p>There's little point in changing the default setting as NetworkManager will automatically determine the best method to use.</p> <p> - Format: uint32</p> + Format: flags (NMSettingWirelessSecurityWpsMethod)</p> +<p> + Valid values: default (0x0), disabled (0x1), auto (0x2), pbc (0x4), pin (0x8)</p> </td> </tr> </tbody> @@ -4873,7 +5854,7 @@ Linux traffic control subsystem This property is deprecated since version 1.2. WiMAX is no longer supported.</p> <p> - Format: byte array</p> + Format: string</p> </td> </tr> <tr> @@ -4886,7 +5867,7 @@ Linux traffic control subsystem This property is deprecated since version 1.2. WiMAX is no longer supported.</p> <p> - Format: string</p> + Format: MAC address</p> </td> </tr> </tbody> @@ -4912,7 +5893,9 @@ Linux traffic control subsystem <td> <p>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.</p> <p> - Format: NMTernary (int32)</p> + Format: ternary</p> +<p> + Valid values: true/yes/on, false/no/off, default/unknown</p> </td> </tr> <tr> @@ -4921,6 +5904,8 @@ Linux traffic control subsystem <p>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.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -4933,7 +5918,9 @@ Linux traffic control subsystem <p>If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).</p> <p>On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</p> <p> - Format: byte array</p> + Format: MAC address</p> +<p> + Special values: preserve, permanent, random, stable</p> </td> </tr> <tr> @@ -4942,6 +5929,8 @@ Linux traffic control subsystem <p>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.</p> <p> Format: string</p> +<p> + Valid values: half, full</p> </td> </tr> <tr> @@ -4963,7 +5952,7 @@ Linux traffic control subsystem Alias: mac</p> <p>If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</p> <p> - Format: byte array</p> + Format: MAC address</p> </td> </tr> <tr> @@ -4971,7 +5960,7 @@ Linux traffic control subsystem <td> <p>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).</p> <p> - Format: array of string</p> + Format: list of MAC addresses</p> </td> </tr> <tr> @@ -4981,7 +5970,9 @@ Linux traffic control subsystem Alias: mtu</p> <p>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Special values: auto</p> </td> </tr> <tr> @@ -4989,7 +5980,7 @@ Linux traffic control subsystem <td> <p>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.</p> <p> - Format: string</p> + Format: read only</p> </td> </tr> <tr> @@ -4998,6 +5989,8 @@ Linux traffic control subsystem <p>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</p> <p> Format: string</p> +<p> + Valid values: qeth, lcs, ctc</p> </td> </tr> <tr> @@ -5006,7 +5999,7 @@ Linux traffic control subsystem <p>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]).</p> <p>Currently, NetworkManager itself does nothing with this information. However, s390utils ships a udev rule which parses this information and applies it to the interface.</p> <p> - Format: dict of string to string</p> + Format: list of key/value options</p> </td> </tr> <tr> @@ -5014,7 +6007,7 @@ Linux traffic control subsystem <td> <p>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.</p> <p> - Format: array of string</p> + Format: list of 802-3-ethernet.s390-subchannels objects</p> </td> </tr> <tr> @@ -5022,15 +6015,19 @@ Linux traffic control subsystem <td> <p>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.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.wake-on-lan"></a>802-3-ethernet.wake-on-lan</code></span></p></td> <td> -<p>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).</p> +<p>The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of "phy" (0x2), "unicast" (0x4), "multicast" (0x8), "broadcast" (0x10), "arp" (0x20), "magic" (0x40) or the special values "default" (0x1) (to use global settings) and "ignore" (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</p> <p> - Format: uint32</p> + Format: flags (NMSettingWiredWakeOnLan)</p> +<p> + Valid values: phy (0x2), unicast (0x4), multicast (0x8), broadcast (0x10), arp (0x20), magic (0x40), default (0x1), ignore (0x8000)</p> </td> </tr> <tr> @@ -5038,7 +6035,7 @@ Linux traffic control subsystem <td> <p>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.</p> <p> - Format: string</p> + Format: MAC address</p> </td> </tr> </tbody> @@ -5063,7 +6060,9 @@ Linux traffic control subsystem <p>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.</p> <p>Note that "ip4-auto-default-route" or "ip6-auto-default-route" enabled, implies to automatically choose a fwmark.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -5073,7 +6072,9 @@ Linux traffic control subsystem <p>Note that for this automatism to work, you usually don't want to set ipv4.gateway, because that will result in a conflicting default route.</p> <p>Leaving this at the default will enable this option automatically if ipv4.never-default is not set and there are any peers that use a default-route as allowed-ips. Since this automatism only makes sense if you also have a peer with an /0 allowed-ips, it is usually not necessary to enable this explicitly. However, you can disable it if you want to configure your own routing and rules.</p> <p> - Format: NMTernary (int32)</p> + Format: ternary</p> +<p> + Valid values: true/yes/on, false/no/off, default/unknown</p> </td> </tr> <tr> @@ -5081,7 +6082,9 @@ Linux traffic control subsystem <td> <p>Like ip4-auto-default-route, but for the IPv6 default route.</p> <p> - Format: NMTernary (int32)</p> + Format: ternary</p> +<p> + Valid values: true/yes/on, false/no/off, default/unknown</p> </td> </tr> <tr> @@ -5089,7 +6092,9 @@ Linux traffic control subsystem <td> <p>The listen-port. If listen-port is not specified, the port will be chosen randomly when the interface comes up.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 65535</p> </td> </tr> <tr> @@ -5098,7 +6103,9 @@ Linux traffic control subsystem <p>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.</p> <p>If zero a default MTU is used. Note that contrary to wg-quick's MTU setting, this does not take into account the current routes at the time of activation.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Special values: auto</p> </td> </tr> <tr> @@ -5108,6 +6115,8 @@ Linux traffic control subsystem <p>Note that if the peer's AllowedIPs is "0.0.0.0/0" or "::/0" and the profile's ipv4.never-default or ipv6.never-default setting is enabled, the peer route for this peer won't be added automatically.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -5123,10 +6132,9 @@ Linux traffic control subsystem <td> <p>Flags indicating how to handle the "private-key" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> </tbody> @@ -5150,12 +6158,14 @@ Linux traffic control subsystem <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.ap-isolation"></a>802-11-wireless.ap-isolation</code></span></p></td> <td> -<p>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.</p> -<p>If set to NM_TERNARY_TRUE (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.</p> -<p>If set to NM_TERNARY_FALSE (0), devices can talk to each other.</p> -<p>When set to NM_TERNARY_DEFAULT (-1), the global default is used; in case the global default is unspecified it is assumed to be NM_TERNARY_FALSE (0).</p> +<p>Configures AP isolation, which prevents communication between wireless devices connected to this AP. This property can be set to a value different from "default" (-1) only when the interface is configured in AP mode.</p> +<p>If set to "true" (1), devices are not able to communicate with each other. This increases security because it protects devices against attacks from other clients in the network. At the same time, it prevents devices to access resources on the same wireless networks as file shares, printers, etc.</p> +<p>If set to "false" (0), devices can talk to each other.</p> +<p>When set to "default" (-1), the global default is used; in case the global default is unspecified it is assumed to be "false" (0).</p> <p> - Format: NMTernary (int32)</p> + Format: ternary</p> +<p> + Valid values: true/yes/on, false/no/off, default/unknown</p> </td> </tr> <tr> @@ -5164,6 +6174,8 @@ Linux traffic control subsystem <p>802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</p> <p> Format: string</p> +<p> + Valid values: a, bg</p> </td> </tr> <tr> @@ -5172,7 +6184,7 @@ Linux traffic control subsystem <p>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.</p> <p>Locking a client profile to a certain BSSID will prevent roaming and also disable background scanning. That can be useful, if there is only one access point for the SSID.</p> <p> - Format: byte array</p> + Format: MAC address</p> </td> </tr> <tr> @@ -5180,7 +6192,9 @@ Linux traffic control subsystem <td> <p>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.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 4294967295</p> </td> </tr> <tr> @@ -5189,11 +6203,13 @@ Linux traffic control subsystem <p> Alias: cloned-mac</p> <p>If specified, request that the device use this MAC address instead. This is known as MAC cloning or spoofing.</p> -<p>Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random" and "stable" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key.</p> +<p>Beside explicitly specifying a MAC address, the special values "preserve", "permanent", "random", "stable" and "stable-ssid" are supported. "preserve" means not to touch the MAC address on activation. "permanent" means to use the permanent hardware address of the device. "random" creates a random MAC address on each connect. "stable" creates a hashed MAC address based on connection.stable-id and a machine dependent key. "stable-ssid" creates a hashed MAC address based on the SSID, the same as setting the stable-id to "${NETWORK_SSID}".</p> <p>If unspecified, the value can be overwritten via global defaults, see manual of NetworkManager.conf. If still unspecified, it defaults to "preserve" (older versions of NetworkManager may use a different default value).</p> <p>On D-Bus, this field is expressed as "assigned-mac-address" or the deprecated "cloned-mac-address".</p> <p> - Format: byte array</p> + Format: MAC address</p> +<p> + Special values: preserve, permanent, random, stable, stable-ssid</p> </td> </tr> <tr> @@ -5217,6 +6233,8 @@ Linux traffic control subsystem <p>Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</p> <p> Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> <tr> @@ -5226,7 +6244,7 @@ Linux traffic control subsystem Alias: mac</p> <p>If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</p> <p> - Format: byte array</p> + Format: MAC address</p> </td> </tr> <tr> @@ -5234,18 +6252,20 @@ Linux traffic control subsystem <td> <p>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").</p> <p> - Format: array of string</p> + Format: list of MAC addresses</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.mac-address-randomization"></a>802-11-wireless.mac-address-randomization</code></span></p></td> <td> -<p>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).</p> +<p>One of "default" (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), "never" (1) (never randomize the MAC address), or "always" (2) (always randomize the MAC address).</p> <p> This property is deprecated since version 1.4. Use the "cloned-mac-address" property instead.</p> <p> - Format: uint32</p> + Format: choice (NMSettingMacRandomization)</p> +<p> + Valid values: default (0), never (1), always (2)</p> </td> </tr> <tr> @@ -5256,6 +6276,8 @@ Linux traffic control subsystem <p>Wi-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap". If blank, infrastructure is assumed.</p> <p> Format: string</p> +<p> + Valid values: infrastructure, adhoc, ap, mesh</p> </td> </tr> <tr> @@ -5265,15 +6287,19 @@ Linux traffic control subsystem Alias: mtu</p> <p>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Special values: auto</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.powersave"></a>802-11-wireless.powersave</code></span></p></td> <td> -<p>One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</p> +<p>One of "disable" (2) (disable Wi-Fi power saving), "enable" (3) (enable Wi-Fi power saving), "ignore" (1) (don't touch currently configure setting) or "default" (0) (use the globally configured value). All other values are reserved.</p> +<p> + Format: choice (NMSettingWirelessPowersave)</p> <p> - Format: uint32</p> + Valid values: default (0), ignore (1), disable (2), enable (3)</p> </td> </tr> <tr> @@ -5282,7 +6308,7 @@ Linux traffic control subsystem <p>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.</p> <p>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.</p> <p> - Format: array of string</p> + Format: read only</p> </td> </tr> <tr> @@ -5292,15 +6318,17 @@ Linux traffic control subsystem Alias: ssid</p> <p>SSID of the Wi-Fi network. Must be specified.</p> <p> - Format: byte array</p> + Format: string</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless.wake-on-wlan"></a>802-11-wireless.wake-on-wlan</code></span></p></td> <td> -<p>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).</p> +<p>The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of "any" (0x2), "disconnect" (0x4), "magic" (0x8), "gtk-rekey-failure" (0x10), "eap-identity-request" (0x20), "4way-handshake" (0x40), "rfkill-release" (0x80), "tcp" (0x100) or the special values "default" (0x1) (to use global settings) and "ignore" (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</p> +<p> + Format: flags (NMSettingWirelessWakeOnWLan)</p> <p> - Format: uint32</p> + Valid values: any (0x2), disconnect (0x4), magic (0x8), gtk-rekey-failure (0x10), eap-identity-request (0x20), 4way-handshake (0x40), rfkill-release (0x80), tcp (0x100), all (0x1fe), default (0x1), ignore (0x8000)</p> </td> </tr> </tbody> @@ -5327,14 +6355,18 @@ Linux traffic control subsystem <p>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.</p> <p> Format: string</p> +<p> + Valid values: open, shared, leap</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.fils"></a>802-11-wireless-security.fils</code></span></p></td> <td> -<p>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.</p> +<p>Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of "default" (0) (use global default value), "disable" (1) (disable FILS), "optional" (2) (enable FILS if the supplicant and the access point support it) or "required" (3) (enable FILS and fail if not supported). When set to "default" (0) and no global default is set, FILS will be optionally enabled.</p> <p> - Format: int32</p> + Format: choice (NMSettingWirelessSecurityFils)</p> +<p> + Valid values: default (0), disable (1), optional (2), required (3)</p> </td> </tr> <tr> @@ -5342,7 +6374,9 @@ Linux traffic control subsystem <td> <p>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".</p> <p> - Format: array of string</p> + Format: list of strings</p> +<p> + Valid values: wep40, wep104, tkip, ccmp</p> </td> </tr> <tr> @@ -5352,6 +6386,8 @@ Linux traffic control subsystem <p>This property must be set for any Wi-Fi connection that uses security.</p> <p> Format: string</p> +<p> + Valid values: none, ieee8021x, wpa-psk, wpa-eap, wpa-eap-suite-b-192, sae, owe</p> </td> </tr> <tr> @@ -5367,10 +6403,9 @@ Linux traffic control subsystem <td> <p>Flags indicating how to handle the "leap-password" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -5386,15 +6421,19 @@ Linux traffic control subsystem <td> <p>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".</p> <p> - Format: array of string</p> + Format: list of strings</p> +<p> + Valid values: tkip, ccmp</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.pmf"></a>802-11-wireless-security.pmf</code></span></p></td> <td> -<p>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.</p> +<p>Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of "default" (0) (use global default value), "disable" (1) (disable PMF), "optional" (2) (enable PMF if the supplicant and the access point support it) or "required" (3) (enable PMF and fail if not supported). When set to "default" (0) and no global default is set, PMF will be optionally enabled.</p> +<p> + Format: choice (NMSettingWirelessSecurityPmf)</p> <p> - Format: int32</p> + Valid values: default (0), disable (1), optional (2), required (3)</p> </td> </tr> <tr> @@ -5402,7 +6441,9 @@ Linux traffic control subsystem <td> <p>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.</p> <p> - Format: array of string</p> + Format: list of strings</p> +<p> + Valid values: wpa, rsn</p> </td> </tr> <tr> @@ -5418,10 +6459,9 @@ Linux traffic control subsystem <td> <p>Flags indicating how to handle the "psk" property.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> @@ -5429,18 +6469,19 @@ Linux traffic control subsystem <td> <p>Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties.</p> <p> - See <a class="xref" href="nm-settings-dbus.html#secrets-flags" title="Secret flag types:">the section called “Secret flag types:”</a> for flag values. - </p> + Format: flags (NMSettingSecretFlags)</p> <p> - Format: NMSettingSecretFlags (uint32)</p> + Valid values: none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.wep-key-type"></a>802-11-wireless-security.wep-key-type</code></span></p></td> <td> -<p>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.</p> +<p>Controls the interpretation of WEP keys. Allowed values are "key" (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or "passphrase" (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key.</p> <p> - Format: NMWepKeyType (uint32)</p> + Format: choice (NMWepKeyType)</p> +<p> + Valid values: unknown (0), key (1), passphrase (2)</p> </td> </tr> <tr> @@ -5480,7 +6521,9 @@ Linux traffic control subsystem <td> <p>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.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 3</p> </td> </tr> <tr> @@ -5490,7 +6533,9 @@ Linux traffic control subsystem <p>There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities.</p> <p>WPS can be disabled by setting this property to a value of 1.</p> <p> - Format: uint32</p> + Format: flags (NMSettingWirelessSecurityWpsMethod)</p> +<p> + Valid values: default (0x0), disabled (0x1), auto (0x2), pbc (0x4), pin (0x8)</p> </td> </tr> </tbody> @@ -5516,7 +6561,11 @@ Linux traffic control subsystem Alias: channel</p> <p>IEEE 802.15.4 channel. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -32768 - 32767</p> +<p> + Special values: default (-1)</p> </td> </tr> <tr> @@ -5526,7 +6575,7 @@ Linux traffic control subsystem Alias: mac</p> <p>If specified, this connection will only apply to the IEEE 802.15.4 (WPAN) MAC layer device whose permanent MAC address matches.</p> <p> - Format: string</p> + Format: WPAN MAC address</p> </td> </tr> <tr> @@ -5536,7 +6585,11 @@ Linux traffic control subsystem Alias: page</p> <p>IEEE 802.15.4 channel page. A positive integer or -1, meaning "do not set, use whatever the device is already set to".</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -32768 - 32767</p> +<p> + Special values: default (-1)</p> </td> </tr> <tr> @@ -5546,7 +6599,11 @@ Linux traffic control subsystem Alias: pan-id</p> <p>IEEE 802.15.4 Personal Area Network (PAN) identifier.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 65535</p> +<p> + Special values: unset (0xffff)</p> </td> </tr> <tr> @@ -5556,7 +6613,11 @@ Linux traffic control subsystem Alias: short-addr</p> <p>Short IEEE 802.15.4 address to be used within a restricted environment.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 65535</p> +<p> + Special values: unset (0xffff)</p> </td> </tr> </tbody> @@ -5582,7 +6643,9 @@ Linux traffic control subsystem Alias: prio</p> <p>The port priority for bond active port re-selection during failover. A higher number means a higher priority in selection. The primary port has the highest priority. This option is only compatible with active-backup, balance-tlb and balance-alb modes.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> </td> </tr> <tr> @@ -5592,7 +6655,9 @@ Linux traffic control subsystem Alias: queue-id</p> <p>The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Valid values: 0 - 65535</p> </td> </tr> </tbody> @@ -5615,28 +6680,34 @@ Linux traffic control subsystem <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hostname.from-dhcp"></a>hostname.from-dhcp</code></span></p></td> <td> <p>Whether the system hostname can be determined from DHCP on this connection.</p> -<p>When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).</p> +<p>When set to "default" (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be "true" (1).</p> +<p> + Format: ternary</p> <p> - Format: NMTernary (int32)</p> + Valid values: true/yes/on, false/no/off, default/unknown</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hostname.from-dns-lookup"></a>hostname.from-dns-lookup</code></span></p></td> <td> <p>Whether the system hostname can be determined from reverse DNS lookup of addresses on this device.</p> -<p>When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_TRUE (1).</p> +<p>When set to "default" (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be "true" (1).</p> <p> - Format: NMTernary (int32)</p> + Format: ternary</p> +<p> + Valid values: true/yes/on, false/no/off, default/unknown</p> </td> </tr> <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hostname.only-from-default"></a>hostname.only-from-default</code></span></p></td> <td> -<p>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).</p> -<p>If set to NM_TERNARY_FALSE (0), the hostname can be set from this device even if it doesn't have the default route.</p> -<p>When set to NM_TERNARY_DEFAULT (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be NM_TERNARY_FALSE (0).</p> +<p>If set to "true" (1), NetworkManager attempts to get the hostname via DHCPv4/DHCPv6 or reverse DNS lookup on this device only when the device has the default route for the given address family (IPv4/IPv6).</p> +<p>If set to "false" (0), the hostname can be set from this device even if it doesn't have the default route.</p> +<p>When set to "default" (-1), the value from global configuration is used. If the property doesn't have a value in the global configuration, NetworkManager assumes the value to be "false" (0).</p> +<p> + Format: ternary</p> <p> - Format: NMTernary (int32)</p> + Valid values: true/yes/on, false/no/off, default/unknown</p> </td> </tr> <tr> @@ -5646,7 +6717,67 @@ Linux traffic control subsystem <p>If the value is zero, it can be overridden by a global value from NetworkManager configuration. If the property doesn't have a value in the global configuration, the value is assumed to be 100.</p> <p>Negative values have the special effect of excluding other connections with a greater numerical priority value; so in presence of at least one negative priority, only connections with the lowest priority value will be used to determine the hostname.</p> <p> - Format: int32</p> + Format: integer</p> +<p> + Valid values: -2147483648 - 2147483647</p> +</td> +</tr> +</tbody> +</table></div> +</div> +<hr> +<div class="refsect2"> +<a name="id-1.2.10.4.54"></a><h3>hsr setting</h3> +<p>HSR/PRP Settings.</p> +<p> + Properties: + </p> +<div class="variablelist"><table border="0" class="variablelist"> +<colgroup> +<col align="left" valign="top"> +<col> +</colgroup> +<tbody> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hsr.multicast-spec"></a>hsr.multicast-spec</code></span></p></td> +<td> +<p> + Alias: multicast-spec</p> +<p>The last byte of supervision address.</p> +<p> + Format: integer</p> +<p> + Valid values: 0 - 255</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hsr.port1"></a>hsr.port1</code></span></p></td> +<td> +<p> + Alias: port1</p> +<p>The port1 interface name of the HSR. This property is mandatory.</p> +<p> + Format: string</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hsr.port2"></a>hsr.port2</code></span></p></td> +<td> +<p> + Alias: port2</p> +<p>The port2 interface name of the HSR. This property is mandatory.</p> +<p> + Format: string</p> +</td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.hsr.prp"></a>hsr.prp</code></span></p></td> +<td> +<p>The protocol used by the interface, whether it is PRP or HSR.</p> +<p> + Format: boolean</p> +<p> + Valid values: true/yes/on, false/no/off</p> </td> </tr> </tbody> @@ -5654,7 +6785,7 @@ Linux traffic control subsystem </div> <hr> <div class="refsect2"> -<a name="id-1.2.10.4.54"></a><h3>link setting</h3> +<a name="id-1.2.10.4.55"></a><h3>link setting</h3> <p>Link settings.</p> <p> Properties: @@ -5670,7 +6801,11 @@ Linux traffic control subsystem <td> <p>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.</p> <p> - Format: int64</p> + Format: integer</p> +<p> + Valid values: -1 - 4294967295</p> +<p> + Special values: default (-1)</p> </td> </tr> <tr> @@ -5678,7 +6813,11 @@ Linux traffic control subsystem <td> <p>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.</p> <p> - Format: int64</p> + Format: integer</p> +<p> + Valid values: -1 - 4294967295</p> +<p> + Special values: default (-1)</p> </td> </tr> <tr> @@ -5686,7 +6825,11 @@ Linux traffic control subsystem <td> <p>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.</p> <p> - Format: int64</p> + Format: integer</p> +<p> + Valid values: -1 - 4294967295</p> +<p> + Special values: default (-1)</p> </td> </tr> <tr> @@ -5694,7 +6837,11 @@ Linux traffic control subsystem <td> <p>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.</p> <p> - Format: int64</p> + Format: integer</p> +<p> + Valid values: -1 - 4294967295</p> +<p> + Special values: default (-1)</p> </td> </tr> </tbody> @@ -5702,7 +6849,7 @@ Linux traffic control subsystem </div> <hr> <div class="refsect2"> -<a name="id-1.2.10.4.55"></a><h3>loopback setting</h3> +<a name="id-1.2.10.4.56"></a><h3>loopback setting</h3> <p>Loopback Link Settings.</p> <p> Properties: @@ -5719,14 +6866,16 @@ Linux traffic control subsystem Alias: mtu</p> <p>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</p> <p> - Format: uint32</p> + Format: integer</p> +<p> + Special values: auto</p> </td> </tr></tbody> </table></div> </div> <hr> <div class="refsect2"> -<a name="id-1.2.10.4.56"></a><h3>veth setting</h3> +<a name="id-1.2.10.4.57"></a><h3>veth setting</h3> <p>Veth Settings.</p> <p> Properties: |