diff options
Diffstat (limited to 'src/nmcli/gen-metadata-nm-settings-nmcli.xml.in')
| -rw-r--r-- | src/nmcli/gen-metadata-nm-settings-nmcli.xml.in | 110 |
1 files changed, 103 insertions, 7 deletions
diff --git a/src/nmcli/gen-metadata-nm-settings-nmcli.xml.in b/src/nmcli/gen-metadata-nm-settings-nmcli.xml.in index ae3a388b..9aa1751e 100644 --- a/src/nmcli/gen-metadata-nm-settings-nmcli.xml.in +++ b/src/nmcli/gen-metadata-nm-settings-nmcli.xml.in @@ -629,7 +629,7 @@ alias="type" nmcli-description="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)." format="string" - 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" /> + values="6lowpan, 802-11-olpc-mesh, 802-11-wireless, 802-3-ethernet, adsl, bluetooth, bond, bridge, cdma, dummy, generic, gsm, hsr, infiniband, ip-tunnel, ipvlan, 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" /> <property name="interface-name" alias="ifname" nmcli-description="The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). For software devices this specifies the name of the created device. For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface." @@ -702,6 +702,17 @@ nmcli-description="If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping." format="integer" values="0 - 600" /> + <property name="ip-ping-timeout" + nmcli-description="If greater than zero, delay success of IP addressing until either the specified timeout (in seconds) is reached, or a target IP address replies to a ping. The property specifies the timeout for the "ip-ping-addresses". This property is incompatible with "gateway-ping-timeout", you cannot set these two properties at the same time." + format="integer" + values="0 - 600" /> + <property name="ip-ping-addresses" + nmcli-description="The property specifies a list of target IP addresses for pinging. When multiple targets are set, NetworkManager will start multiple ping processes in parallel. This property can only be set if connection.ip-ping-timeout is set. The ip-ping-timeout is used to delay the success of IP addressing until either the specified timeout (in seconds) is reached, or an target IP address replies to a ping. Configuring "ip-ping-addresses" may delay reaching the systemd's network-online.target due to waiting for the ping operations to complete or timeout." + format="list of IPv4 or IPv6 addresses" /> + <property name="ip-ping-addresses-require-all" + nmcli-description="The property determines whether it is sufficient for any ping check to succeed among "ip-ping-addresses", or if all ping checks must succeed for "ip-ping-addresses"." + format="choice (NMTernary)" + values="default (-1), false/no (0), true/yes (1)" /> <property name="metered" nmcli-description="Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately." format="ternary" @@ -1085,6 +1096,10 @@ <property name="channels-combined" format="integer" values="0 - 4294967295" /> + <property name="fec-mode" + nmcli-description="The Forward Error Correction(FEC) encoding modes to set. Not all devices support all options. May be any combination of auto, off, rs, baser, llrs." + format="flags (NMSettingEthtoolFecMode)" + values="auto (0x2), off (0x4), rs (0x8), baser (0x10), llrs (0x20)" /> </setting> <setting name="generic" > <property name="device-handler" @@ -1149,6 +1164,40 @@ <property name="initial-eps-bearer-apn" nmcli-description="For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network. Setting this parameter implies initial-eps-bearer-configure to be TRUE." format="string" /> + <property name="initial-eps-bearer-username" + nmcli-description="For LTE modems, this sets the username for the initial EPS bearer that is set up when attaching to the network. Setting this parameter implies initial-eps-bearer-configure to be TRUE." + format="string" /> + <property name="initial-eps-bearer-password" + nmcli-description="For LTE modems, this sets the password for the initial EPS bearer that is set up when attaching to the network. Setting this parameter implies initial-eps-bearer-configure to be TRUE." + format="string" /> + <property name="initial-eps-bearer-password-flags" + nmcli-description="Flags indicating how to handle the "initial-eps-bearer-password" property." + format="flags (NMSettingSecretFlags)" + values="none (0x0), agent-owned (0x1), not-saved (0x2), not-required (0x4)" /> + <property name="initial-eps-bearer-noauth" + nmcli-description="For LTE modems, this sets NOAUTH authentication method for the initial EPS bearer that is set up when attaching to the network. If TRUE, do not require the other side to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE." + format="boolean" + values="true/yes/on, false/no/off" /> + <property name="initial-eps-bearer-refuse-eap" + nmcli-description="For LTE modems, this disables EAP authentication method for the initial EPS bearer that is set up when attaching to the network." + format="boolean" + values="true/yes/on, false/no/off" /> + <property name="initial-eps-bearer-refuse-pap" + nmcli-description="For LTE modems, this disables PAP authentication method for the initial EPS bearer that is set up when attaching to the network." + format="boolean" + values="true/yes/on, false/no/off" /> + <property name="initial-eps-bearer-refuse-chap" + nmcli-description="For LTE modems, this disables CHAP authentication method for the initial EPS bearer that is set up when attaching to the network." + format="boolean" + values="true/yes/on, false/no/off" /> + <property name="initial-eps-bearer-refuse-mschap" + nmcli-description="For LTE modems, this disables MSCHAP authentication method for the initial EPS bearer that is set up when attaching to the network." + format="boolean" + values="true/yes/on, false/no/off" /> + <property name="initial-eps-bearer-refuse-mschapv2" + nmcli-description="For LTE modems, this disables MSCHAPV2 authentication method for the initial EPS bearer that is set up when attaching to the network." + format="boolean" + values="true/yes/on, false/no/off" /> </setting> <setting name="hostname" > <property name="priority" @@ -1276,7 +1325,7 @@ format="string" values="auto, link-local, manual, shared, disabled" /> <property name="dns" - nmcli-description="Array of IP addresses of DNS servers. 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." + nmcli-description="Array of DNS servers. Each server can be specified either as a plain IP address (optionally followed by a "#" and the SNI server name for DNS over TLS) or with a URI syntax. When it is specified as an URI, the following forms are supported: dns+udp://ADDRESS[:PORT], dns+tls://ADDRESS[:PORT][SERVERNAME] . When using the URI syntax, IPv6 addresses must be enclosed in square brackets ('[', ']')." format="list of IPv4 addresses" /> <property name="dns-search" nmcli-description="List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. 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. 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)." @@ -1318,6 +1367,10 @@ nmcli-description="Whether the DHCP client will send RELEASE message when bringing the connection down. The default value is "default" (-1). When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as FALSE." format="ternary" values="true/yes/on, false/no/off, default/unknown" /> + <property name="routed-dns" + nmcli-description="Whether to add routes for DNS servers. When enabled, NetworkManager adds a route for each DNS server that is associated with this connection either statically (defined in the connection profile) or dynamically (for example, retrieved via DHCP). The route guarantees that the DNS server is reached via this interface. When set to "default" (-1), the value from global configuration is used; if no global default is defined, this feature is disabled." + format="choice (NMSettingIPConfigRoutedDns)" + values="default (-1), no (0), yes (1)" /> <property name="ignore-auto-routes" nmcli-description="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." format="boolean" @@ -1342,9 +1395,13 @@ values="0 - 2147483647" special-values="default (0), infinity (2147483647)" /> <property name="dhcp-send-hostname" - nmcli-description="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." + nmcli-description="Since 1.52 this property is deprecated and is only used as fallback value for dhcp-send-hostname if it's set to 'default'. This is only done to avoid breaking existing configurations, the new property should be used from now on." format="boolean" values="true/yes/on, false/no/off" /> + <property name="dhcp-send-hostname-v2" + nmcli-description="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. The default value is default (-1). In this case the global value from NetworkManager configuration is looked up. If it's not set, the value from dhcp-send-hostname-deprecated, which defaults to TRUE, is used for backwards compatibility. In the future this will change and, in absence of a global default, it will always fallback to TRUE." + format="choice (NMTernary)" + values="default (-1), false/no (0), true/yes (1)" /> <property name="dhcp-hostname" nmcli-description="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." format="string" /> @@ -1376,10 +1433,14 @@ <property name="dhcp-vendor-class-identifier" nmcli-description="The Vendor Class Identifier DHCP option (60). Special characters in the data string may be escaped using C-style escapes, nevertheless this property cannot contain nul bytes. If the per-profile value is unspecified (the default), a global connection default gets consulted. If still unspecified, the DHCP option is not sent to the server." format="string" /> + <property name="dhcp-ipv6-only-preferred" + nmcli-description="Controls the "IPv6-Only Preferred" DHCPv4 option (RFC 8925). When set to "yes" (1), the host adds the option to the parameter request list; if the DHCP server sends the option back, the host stops the DHCP client for the time interval specified in the option. Enable this feature if the host supports an IPv6-only mode, i.e. either all applications are IPv6-only capable or there is a form of 464XLAT deployed. When set to "default" (-1), the actual value is looked up in the global configuration; if not specified, it defaults to "no" (0). If the connection has IPv6 method set to "disabled", this property does not have effect and the "IPv6-Only Preferred" option is always disabled." + format="choice (NMSettingIP4DhcpIpv6OnlyPreferred)" + values="default (-1), no (0), yes (1)" /> <property name="link-local" - nmcli-description="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. 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"." + nmcli-description="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. 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". Since 1.52, when set to "fallback", a link-local address is obtained if no other IPv4 address is set." format="choice (NMSettingIP4LinkLocal)" - values="default (0), auto (1), disabled (2), enabled (3)" /> + values="default (0), auto (1), disabled (2), enabled (3), fallback (4)" /> <property name="dhcp-reject-servers" nmcli-description="Array of servers from which DHCP offers must be rejected. This property is useful to avoid getting a lease from misconfigured or rogue servers. 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"). This property is currently not implemented for DHCPv6." format="list of IPv4 addresses" /> @@ -1387,6 +1448,14 @@ nmcli-description="VPN connections will default to add the route automatically unless this setting is set to FALSE. For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect." format="ternary" values="true/yes/on, false/no/off, default/unknown" /> + <property name="shared-dhcp-range" + nmcli-description="This option allows you to specify a custom DHCP range for the shared connection method. The value is expected to be in `<START_ADDRESS>,<END_ADDRESS>` format. The range should be part of network set by ipv4.address option and it should not contain network address or broadcast address. If this option is not specified, the DHCP range will be automatically determined based on the interface address. The range will be selected to be adjacent to the interface address, either before or after it, with the larger possible range being preferred. The range will be adjusted to fill the available address space, except for networks with a prefix length greater than 24, which will be treated as if they have a prefix length of 24." + format="string" /> + <property name="shared-dhcp-lease-time" + nmcli-description="This option allows you to specify a custom DHCP lease time for the shared connection method in seconds. The value should be either a number between 120 and 31536000 (one year) If this option is not specified, 3600 (one hour) is used. Special values are 0 for default value of 1 hour and 2147483647 (MAXINT32) for infinite lease time." + format="integer" + values="0 - 2147483647" + special-values="default (0), infinity (2147483647)" /> </setting> <setting name="ipv6" > <property name="method" @@ -1394,7 +1463,7 @@ format="string" values="ignore, auto, dhcp, link-local, manual, shared, disabled" /> <property name="dns" - nmcli-description="Array of IP addresses of DNS servers. 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." + nmcli-description="Array of DNS servers. Each server can be specified either as a plain IP address (optionally followed by a "#" and the SNI server name for DNS over TLS) or with a URI syntax. When it is specified as an URI, the following forms are supported: dns+udp://ADDRESS[:PORT], dns+tls://ADDRESS[:PORT][SERVERNAME] . When using the URI syntax, IPv6 addresses must be enclosed in square brackets ('[', ']')." format="list of IPv6 addresses" /> <property name="dns-search" nmcli-description="List of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names. 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. 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)." @@ -1436,6 +1505,10 @@ nmcli-description="Whether the DHCP client will send RELEASE message when bringing the connection down. The default value is "default" (-1). When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as FALSE." format="ternary" values="true/yes/on, false/no/off, default/unknown" /> + <property name="routed-dns" + nmcli-description="Whether to add routes for DNS servers. When enabled, NetworkManager adds a route for each DNS server that is associated with this connection either statically (defined in the connection profile) or dynamically (for example, retrieved via DHCP). The route guarantees that the DNS server is reached via this interface. When set to "default" (-1), the value from global configuration is used; if no global default is defined, this feature is disabled." + format="choice (NMSettingIPConfigRoutedDns)" + values="default (-1), no (0), yes (1)" /> <property name="ignore-auto-routes" nmcli-description="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." format="boolean" @@ -1499,9 +1572,13 @@ values="0 - 2147483647" special-values="default (0), infinity (2147483647)" /> <property name="dhcp-send-hostname" - nmcli-description="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." + nmcli-description="Since 1.52 this property is deprecated and is only used as fallback value for dhcp-send-hostname if it's set to 'default'. This is only done to avoid breaking existing configurations, the new property should be used from now on." format="boolean" values="true/yes/on, false/no/off" /> + <property name="dhcp-send-hostname-v2" + nmcli-description="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. The default value is default (-1). In this case the global value from NetworkManager configuration is looked up. If it's not set, the value from dhcp-send-hostname-deprecated, which defaults to TRUE, is used for backwards compatibility. In the future this will change and, in absence of a global default, it will always fallback to TRUE." + format="choice (NMTernary)" + values="default (-1), false/no (0), true/yes (1)" /> <property name="dhcp-hostname" nmcli-description="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." format="string" /> @@ -1517,6 +1594,25 @@ nmcli-description="Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode. When set, the token is used as IPv6 interface identifier instead of the hardware address. This only applies to addresses from stateless autoconfiguration, not to IPv6 link local addresses." format="string" /> </setting> + <setting name="ipvlan" > + <property name="parent" + alias="dev" + nmcli-description="If given, specifies the parent interface name or parent connection UUID from which this IPVLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property." + format="string" /> + <property name="mode" + alias="mode" + nmcli-description="The IPVLAN mode. Valid values: l2 (1), l3 (2), l3s (3)" + format="choice (NMSettingIpvlanMode)" + values="l2 (1), l3 (2), l3s (3)" /> + <property name="private" + nmcli-description="Whether the interface should be put in private mode." + format="boolean" + values="true/yes/on, false/no/off" /> + <property name="vepa" + nmcli-description="Whether the interface should be put in VEPA mode." + format="boolean" + values="true/yes/on, false/no/off" /> + </setting> <setting name="link" > <property name="gso-max-segments" nmcli-description="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." |