diff options
Diffstat (limited to 'man/nm-settings-nmcli.xml')
| -rw-r--r-- | man/nm-settings-nmcli.xml | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/man/nm-settings-nmcli.xml b/man/nm-settings-nmcli.xml index a5475e71..1a18a20c 100644 --- a/man/nm-settings-nmcli.xml +++ b/man/nm-settings-nmcli.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-nmcli"><refentryinfo><title>nm-settings-nmcli</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.45.90</refmiscinfo></refmeta><refnamediv><refname>nm-settings-nmcli</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles for nmcli</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> +<refentry id="nm-settings-nmcli"><refentryinfo><title>nm-settings-nmcli</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.45.91</refmiscinfo></refmeta><refnamediv><refname>nm-settings-nmcli</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles for nmcli</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on a concept of connection profiles, sometimes referred to as connections only. These connection profiles contain a network configuration. When NetworkManager activates a connection profile on a network device the configuration will @@ -38,7 +38,9 @@ Valid values: -1 - 2147483647</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect">connection.autoconnect</option></term><listitem><para> Alias: autoconnect</para><para>Whether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection.</para><para>Autoconnect happens when the circumstances are suitable. That means for example that the device is currently managed and not active. Autoconnect thus never replaces or competes with an already active profile.</para><para>Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.</para><para>If multiple profiles are ready to autoconnect on the same device, the one with the better "connection.autoconnect-priority" is chosen. If the priorities are equal, then the most recently connected profile is activated. If the profiles were not connected earlier or their "connection.timestamp" is identical, the choice is undefined.</para><para>Depending on "connection.multi-connect", a profile can (auto)connect only once at a time or multiple times.</para><para> Format: boolean</para><para> - Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-priority">connection.autoconnect-priority</option></term><listitem><para>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.</para><para> + Valid values: true/yes/on, false/no/off</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-ports">connection.autoconnect-ports</option></term><listitem><para>Whether or not ports of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for controller connections. The properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. The permitted values are: 0: leave port connections untouched, 1: activate all the port connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-ports is read to determine the real value. If it is default as well, this fallbacks to 0.</para><para> + Format: choice (NMTernary)</para><para> + Valid values: default (-1), false (0), true (1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-priority">connection.autoconnect-priority</option></term><listitem><para>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.</para><para> Format: integer</para><para> Valid values: -999 - 999</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.connection.autoconnect-retries">connection.autoconnect-retries</option></term><listitem><para>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.</para><para> Format: integer</para><para> @@ -557,7 +559,9 @@ Valid values: -1 - 30000</para><para> Special values: default (-1), off (0)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-client-id">ipv4.dhcp-client-id</option></term><listitem><para>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0.</para><para>The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet (01). Currently, these options only work for ethernet type of links.</para><para>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.</para><para>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.</para><para>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.</para><para>The special value "none" prevents any client identifier from being sent. Note that this is normally not recommended.</para><para>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.</para><para> Format: string</para><para> - Special values: mac, perm-mac, duid, ipv6-duid, stable, none</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-fqdn">ipv4.dhcp-fqdn</option></term><listitem><para>If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</para><para> + Special values: mac, perm-mac, duid, ipv6-duid, stable, none</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-dscp">ipv4.dhcp-dscp</option></term><listitem><para>Specifies the value for the DSCP field (traffic class) of the IP header. When empty, the global default value is used; if no global default is specified, it is assumed to be "CS0". Allowed values are: "CS0", "CS4" and "CS6".</para><para>The property is currently valid only for IPv4, and it is supported only by the "internal" DHCP plugin.</para><para> + Format: string</para><para> + Valid values: CS0, CS4, CS6</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-fqdn">ipv4.dhcp-fqdn</option></term><listitem><para>If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-hostname">ipv4.dhcp-hostname</option></term><listitem><para>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ipv4.dhcp-hostname-flags">ipv4.dhcp-hostname-flags</option></term><listitem><para>Flags for the DHCP hostname and FQDN.</para><para>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.</para><para>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.</para><para> Format: flags (NMDhcpHostnameFlags)</para><para> |