diff options
| author | Michael Biebl <biebl@debian.org> | 2024-12-25 20:36:29 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2024-12-25 20:36:29 +0100 |
| commit | e465722b908aa870bdc293b9a417d3c15294aa6d (patch) | |
| tree | 7c959d3b73f427d6c40522a7464eaa4531ef2f05 /man | |
| parent | 56928734cbcf1d3a02fae4f152a541df1b04e04a (diff) | |
New upstream version 1.50.1 upstream/1.50.1
Diffstat (limited to 'man')
| -rw-r--r-- | man/NetworkManager-dispatcher.8 | 356 | ||||
| -rw-r--r-- | man/NetworkManager-wait-online.service.8 | 202 | ||||
| -rw-r--r-- | man/NetworkManager.8 | 289 | ||||
| -rw-r--r-- | man/NetworkManager.conf.5 | 1672 | ||||
| -rw-r--r-- | man/nm-cloud-setup.8 | 561 | ||||
| -rw-r--r-- | man/nm-initrd-generator.8 | 234 | ||||
| -rw-r--r-- | man/nm-online.1 | 117 | ||||
| -rw-r--r-- | man/nm-openvswitch.7 | 236 | ||||
| -rw-r--r-- | man/nm-settings-dbus.5 | 6524 | ||||
| -rw-r--r-- | man/nm-settings-ifcfg-rh.5 | 3764 | ||||
| -rw-r--r-- | man/nm-settings-keyfile.5 | 836 | ||||
| -rw-r--r-- | man/nm-settings-nmcli.5 | 6495 | ||||
| -rw-r--r-- | man/nmcli-examples.7 | 835 | ||||
| -rw-r--r-- | man/nmcli.1 | 2159 | ||||
| -rw-r--r-- | man/nmtui.1 | 76 |
15 files changed, 0 insertions, 24356 deletions
diff --git a/man/NetworkManager-dispatcher.8 b/man/NetworkManager-dispatcher.8 deleted file mode 100644 index 3d3ba776..00000000 --- a/man/NetworkManager-dispatcher.8 +++ /dev/null @@ -1,356 +0,0 @@ -'\" t -.\" Title: NetworkManager-dispatcher -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: Network management daemons -.\" Source: NetworkManager-dispatcher 1.50.0 -.\" Language: English -.\" -.TH "NETWORKMANAGER\-DISPATCHER" "8" "" "NetworkManager\-dispatcher 1\&" "Network management daemons" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -NetworkManager-dispatcher \- Dispatch user scripts for NetworkManager -.SH "SYNOPSIS" -.HP \w'\fBNetworkManager\ \fR\fB[OPTIONS...]\fR\ 'u -\fBNetworkManager \fR\fB[OPTIONS...]\fR -.SH "DESCRIPTION" -.PP -NetworkManager\-dispatcher service is a D\-Bus activated service that runs user provided scripts upon certain changes in NetworkManager\&. -.PP -NetworkManager\-dispatcher will execute scripts in the -/{etc,usr/lib}/NetworkManager/dispatcher\&.d -directory or subdirectories in alphabetical order in response to network events\&. Each script should be a regular executable file owned by root\&. Furthermore, it must not be writable by group or other, and not setuid\&. -.PP -Each script receives two arguments, the first being the interface name of the device an operation just happened on, and second the action\&. For device actions, the interface is the name of the kernel interface suitable for IP configuration\&. Thus it is either VPN_IP_IFACE, DEVICE_IP_IFACE, or DEVICE_IFACE, as applicable\&. For the -\fIhostname\fR -action the device name is always -"none"\&. For -\fIconnectivity\-change\fR -and -\fIdns\-change\fR -it is empty\&. -.PP -The actions are: -.PP -\fIpre\-up\fR -.RS 4 -The interface is connected to the network but is not yet fully activated\&. Scripts acting on this event must be placed or symlinked into the -/etc/NetworkManager/dispatcher\&.d/pre\-up\&.d -directory, and NetworkManager will wait for script execution to complete before indicating to applications that the interface is fully activated\&. -.RE -.PP -\fIup\fR -.RS 4 -The interface has been activated\&. -.RE -.PP -\fIpre\-down\fR -.RS 4 -The interface will be deactivated but has not yet been disconnected from the network\&. Scripts acting on this event must be placed or symlinked into the -/etc/NetworkManager/dispatcher\&.d/pre\-down\&.d -directory, and NetworkManager will wait for script execution to complete before disconnecting the interface from its network\&. Note that this event is not emitted for forced disconnections, like when carrier is lost or a wireless signal fades\&. It is only emitted when there is an opportunity to cleanly handle a network disconnection event\&. -.RE -.PP -\fIdown\fR -.RS 4 -The interface has been deactivated\&. -.RE -.PP -\fIvpn\-pre\-up\fR -.RS 4 -The VPN is connected to the network but is not yet fully activated\&. Scripts acting on this event must be placed or symlinked into the -/etc/NetworkManager/dispatcher\&.d/pre\-up\&.d -directory, and NetworkManager will wait for script execution to complete before indicating to applications that the VPN is fully activated\&. -.RE -.PP -\fIvpn\-up\fR -.RS 4 -A VPN connection has been activated\&. -.RE -.PP -\fIvpn\-pre\-down\fR -.RS 4 -The VPN will be deactivated but has not yet been disconnected from the network\&. Scripts acting on this event must be placed or symlinked into the -/etc/NetworkManager/dispatcher\&.d/pre\-down\&.d -directory, and NetworkManager will wait for script execution to complete before disconnecting the VPN from its network\&. Note that this event is not emitted for forced disconnections, like when the VPN terminates unexpectedly or general connectivity is lost\&. It is only emitted when there is an opportunity to cleanly handle a VPN disconnection event\&. -.RE -.PP -\fIvpn\-down\fR -.RS 4 -A VPN connection has been deactivated\&. -.RE -.PP -\fIhostname\fR -.RS 4 -The system hostname has been updated\&. Use gethostname(2) to retrieve it\&. The interface name (first argument) is empty and no environment variable is set for this action\&. -.RE -.PP -\fIdhcp4\-change\fR -.RS 4 -The DHCPv4 lease has changed (renewed, rebound, etc)\&. -.RE -.PP -\fIdhcp6\-change\fR -.RS 4 -The DHCPv6 lease has changed (renewed, rebound, etc)\&. -.RE -.PP -\fIconnectivity\-change\fR -.RS 4 -The network connectivity state has changed (no connectivity, went online, etc)\&. -.RE -.PP -\fIreapply\fR -.RS 4 -The connection was reapplied on the device\&. -.RE -.PP -\fIdns\-change\fR -.RS 4 -The DNS configuration has changed\&. This action is raised even if NetworkManager is configured to not manage resolv\&.conf (for example, via dns=none)\&. In such case, the dispatch script can discover the DNS configuration provided by currently active connections by looking at file -/run/NetworkManager/resolv\&.conf -.RE -.PP -\fIdevice\-add\fR -.RS 4 -This action is called when a connection of type -generic -has the -generic\&.device\-handler -property set\&. The property indicates the name of a dispatcher script to be executed in directory -/{etc,usr/lib}/NetworkManager/dispatcher\&.d/device\&. Note that differently from other actions, only one script is executed\&. -.sp -The script needs to perform any action needed to create the device for the generic connection\&. On successful termination, the script returns zero\&. Otherwise, it returns a non\-zero value to indicate an error\&. The script can return values to NetworkManager by writing to standard output; each line should contain a key name followed by the equal sign \*(Aq=\*(Aq and a key value\&. The keys understood at the moment are: -.PP -\fIIFINDEX\fR -.RS 4 -Indicates the interface index of the interface created by the script\&. This key is required when the script succeeds; if it is not set, the activation will fail\&. The key is ignored in case of script failure\&. -.RE -.PP -\fIERROR\fR -.RS 4 -Specifies an error message indicating the cause of the script failure\&. It is ignored when the script succeeds\&. -.RE -.sp -Since the dispatcher service captures stdout for parsing those keys, anything written to stdout will not appear in the dispatcher service journal log\&. Use stderr if you want to print messages to the journal (for example, for debugging)\&. Only the first 8KiB of stdout are considered and among those, only the first 64 lines; the rest is ignored\&. -.RE -.PP -\fIdevice\-delete\fR -.RS 4 -This action is the counterpart of -device\-add -and is called to delete the device for a generic connection\&. All the aspects described for -device\-add -also apply to this action, with the only exception that key -\fIIFINDEX\fR -is ignored\&. It is not necessary to delete the kernel link in the handler because NetworkManager already does that; therefore the action is useful for any additional cleanup needed\&. -.RE -.PP -The environment contains more information about the interface and the connection\&. The following variables are available for the use in the dispatcher scripts: -.PP -\fINM_DISPATCHER_ACTION\fR -.RS 4 -The dispatcher action like "up" or "dhcp4\-change", identical to the first command line argument\&. Since NetworkManager 1\&.12\&.0\&. -.RE -.PP -\fICONNECTION_UUID\fR -.RS 4 -The UUID of the connection profile\&. -.RE -.PP -\fICONNECTION_ID\fR -.RS 4 -The name (ID) of the connection profile\&. -.RE -.PP -\fICONNECTION_DBUS_PATH\fR -.RS 4 -The NetworkManager D\-Bus path of the connection\&. -.RE -.PP -\fICONNECTION_FILENAME\fR -.RS 4 -The backing file name of the connection profile (if any)\&. -.RE -.PP -\fICONNECTION_EXTERNAL\fR -.RS 4 -If "1", this indicates that the connection describes a network configuration created outside of NetworkManager\&. -.RE -.PP -\fIDEVICE_IFACE\fR -.RS 4 -The interface name of the control interface of the device\&. Depending on the device type, this differs from -\fIDEVICE_IP_IFACE\fR\&. For example for ADSL devices, this could be \*(Aqatm0\*(Aq or for WWAN devices it might be \*(AqttyUSB0\*(Aq\&. -.RE -.PP -\fIDEVICE_IP_IFACE\fR -.RS 4 -The IP interface name of the device\&. This is the network interface on which IP addresses and routes will be configured\&. -.RE -.PP -\fIIP4_ADDRESS_N\fR -.RS 4 -The IPv4 address in the format "address/prefix gateway", where N is a number from 0 to (# IPv4 addresses \- 1)\&. gateway item in this variable is deprecated, use IP4_GATEWAY instead\&. -.RE -.PP -\fIIP4_NUM_ADDRESSES\fR -.RS 4 -The variable contains the number of IPv4 addresses the script may expect\&. -.RE -.PP -\fIIP4_GATEWAY\fR -.RS 4 -The gateway IPv4 address in traditional numbers\-and\-dots notation\&. -.RE -.PP -\fIIP4_ROUTE_N\fR -.RS 4 -The IPv4 route in the format "address/prefix next\-hop metric", where N is a number from 0 to (# IPv4 routes \- 1)\&. -.RE -.PP -\fIIP4_NUM_ROUTES\fR -.RS 4 -The variable contains the number of IPv4 routes the script may expect\&. -.RE -.PP -\fIIP4_NAMESERVERS\fR -.RS 4 -The variable contains a space\-separated list of the DNS servers\&. -.RE -.PP -\fIIP4_DOMAINS\fR -.RS 4 -The variable contains a space\-separated list of the search domains\&. -.RE -.PP -\fIDHCP4_<dhcp\-option\-name>\fR -.RS 4 -If the connection used DHCP for address configuration, the received DHCP configuration is passed in the environment using standard DHCP option names, prefixed with "DHCP4_", like "DHCP4_HOST_NAME=foobar"\&. -.RE -.PP -\fIIP6_<name> and DHCP6_<name>\fR -.RS 4 -The same variables as for IPv4 are available for IPv6, but the prefixes are IP6_ and DHCP6_ instead\&. -.RE -.PP -\fICONNECTIVITY_STATE\fR -.RS 4 -The network connectivity state, which can take the values defined by the NMConnectivityState type, from the org\&.freedesktop\&.NetworkManager D\-Bus API: -UNKNOWN, -NONE, -PORTAL, -LIMITED -or -FULL\&. Note: this variable will only be set for connectivity\-change actions\&. -.RE -.PP -In case of VPN, VPN_IP_IFACE is set, and IP4_*, IP6_* variables with VPN prefix are exported too, like VPN_IP4_ADDRESS_0, VPN_IP4_NUM_ADDRESSES\&. -.PP -The content of the -user -setting for the connection being activated is also passed via environment variables\&. Each key is stored in a variable with name -CONNECTION_USER_ -concatenated with the encoding of the key name\&. The encoding works as follows: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -lowercase letters become uppercase -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -uppercase letters are prefixed with an underscore -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -numbers do not change -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -a dot is replaced with a double underscore -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -any other character is encoded with an underscore followed by its 3\-digit octal representation -.RE -.sp -For example, key -test\&.foo\-Bar2 -is stored in a variable named -CONNECTION_USER_TEST__FOO_055_BAR2\&. -.PP -Dispatcher scripts are run one at a time, but asynchronously from the main NetworkManager process, and will be killed if they run for too long\&. If your script might take arbitrarily long to complete, you should spawn a child process and have the parent return immediately\&. Scripts that are symbolic links pointing inside the -/etc/NetworkManager/dispatcher\&.d/no\-wait\&.d/ -directory are run immediately, without waiting for the termination of previous scripts, and in parallel\&. Also beware that once a script is queued, it will always be run, even if a later event renders it obsolete\&. (Eg, if an interface goes up, and then back down again quickly, it is possible that one or more "up" scripts will be run after the interface has gone down\&.) -.SH "BUGS" -.PP -Please report any bugs you find in NetworkManager at the -\m[blue]\fBNetworkManager issue tracker\fR\m[]\&\s-2\u[1]\d\s+2\&. -.SH "SEE ALSO" -.PP -\m[blue]\fBNetworkManager home page\fR\m[]\&\s-2\u[2]\d\s+2, -\fBNetworkManager\fR(8), -.SH "NOTES" -.IP " 1." 4 -NetworkManager issue tracker -.RS 4 -\%https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/issues -.RE -.IP " 2." 4 -NetworkManager home page -.RS 4 -\%https://networkmanager.dev -.RE diff --git a/man/NetworkManager-wait-online.service.8 b/man/NetworkManager-wait-online.service.8 deleted file mode 100644 index bf50078b..00000000 --- a/man/NetworkManager-wait-online.service.8 +++ /dev/null @@ -1,202 +0,0 @@ -'\" t -.\" Title: NetworkManager-wait-online.service -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: Network management daemons -.\" Source: NetworkManager-wait-online.service 1.50.0 -.\" Language: English -.\" -.TH "NETWORKMANAGER\-WAIT\-ONLINE\&" "8" "" "NetworkManager\-wait\-online\&" "Network management daemons" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -NetworkManager-wait-online.service \- Wait for the network to come online -.SH "DESCRIPTION" -.PP -The -NetworkManager\-wait\-online -service is a -oneshot -systemd service that delays reaching the -network\-online -target until NetworkManager reports that the startup is completed on the D\-Bus\&. -.PP -When the system boots, for example, remote mounts defined in -/etc/fstab, require that the network is up\&. For this, these systemd units contain the -After=network\-online\&.target -setting to order themselves after this target\&. -NetworkManager\-wait\-online -ensures that the -network\-online -target is reached only after the network is available\&. -.PP -Optimally, all services on the host react dynamically to network changes and systemd services do not need to be configured to start after reaching the -network\-online -target\&. In this case, -NetworkManager\-wait\-online\&.service -has no effect and does not delay the boot time\&. On the other hand, if you encounter a long boot time due to the delay of -NetworkManager\-wait\-online, investigate the services that require network access and fix them\&. -.PP -Except for the time out value in the -NetworkManager\-wait\-online\&.service -unit, you cannot configure this service\&. Instead, settings in NetworkManager and the connection profiles affect the behavior: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Startup is not complete as long as NetworkManager profiles are in an activating state\&. During boot, NetworkManager starts profiles with the -connection\&.autoconnect=yes -setting\&. If activation fails, NetworkManager retries the activation depending on the value of the -connection\&.autoconnect\-retries -setting\&. -.sp -NetworkManager reports startup complete when all profiles and devices are either activated or in a disconnect state and no further events are expected\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -When a device reaches the activate state depends on its configuration\&. For example, with a profile that has both IPv4 and IPv6 enabled, by default, NetworkManager considers the device as fully activated already when only one of the address families is ready\&. -.sp -The -ipv4\&.may\-fail -and -ipv6\&.may\-fail -settings control this behavior\&. Additionally, the following settings influence when the two address families complete: -ipv4\&.required\-timeout, -ipv6\&.required\-timeout, -ipv4\&.dhcp\-timeout, and -ipv6\&.ra\-timeout\&. For details, see -\fBnm-settings-nmcli\fR(5)\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -NetworkManager cannot set IP addresses on bridge and bond devices that have ports that do not auto\-activate\&. Because of this configuration error, -NetworkManager\-wait\-online -blocks until the service reaches its timeout value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Dispatcher scripts for the -pre\-up -event run at a late stage during activation of a profile\&. These scripts block the activation for when NetworkManager considers the profile fully activated\&. For details, see -\fBNetworkManager-dispatcher\fR(8)\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -The property -connection\&.wait\-activation\-delay -adds an additional delay during activation and delays startup complete\&. This setting works around certain cases where a device is known to not be ready for a certain amount of time\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -The property -connection\&.wait\-device\-timeout -in the connection profiles cause a delay until the waiting devices appear\&. This is useful if the driver takes a longer time to detect the networking interfaces\&. This setting is similar to the -connection\&.gateway\-ping\-timeout -property\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -With Wi\-Fi devices, NetworkManager needs to wait for the first scan result to know which networks are available\&. That adds a delay\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -With Ethernet devices, NetworkManager waits for the carrier until the value in -[device*]\&.carrier\-wait\-timeout -is reached\&. This is because some devices take a long time to detect the carrier\&. Consequently, booting with cable unplugged, unnecessarily delays -NetworkManager\-wait\-online\&.service\&. -.RE -.SH "BUGS" -.PP -Please report any bugs in NetworkManager at the -\m[blue]\fBNetworkManager issue tracker\fR\m[]\&\s-2\u[1]\d\s+2\&. -.SH "SEE ALSO" -.PP -\m[blue]\fBNetworkManager home page\fR\m[]\&\s-2\u[2]\d\s+2, -\fBNetworkManager\fR(8), -\fBnm-online\fR(1), the -network\-online\&.target -description in -\fBsystemd.special\fR(7) -.SH "NOTES" -.IP " 1." 4 -NetworkManager issue tracker -.RS 4 -\%https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/issues -.RE -.IP " 2." 4 -NetworkManager home page -.RS 4 -\%https://networkmanager.dev -.RE diff --git a/man/NetworkManager.8 b/man/NetworkManager.8 deleted file mode 100644 index b0e09a78..00000000 --- a/man/NetworkManager.8 +++ /dev/null @@ -1,289 +0,0 @@ -'\" t -.\" Title: NetworkManager -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: Network management daemons -.\" Source: NetworkManager 1.50.0 -.\" Language: English -.\" -.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.50\&.0" "Network management daemons" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -NetworkManager \- network management daemon -.SH "SYNOPSIS" -.HP \w'\fBNetworkManager\ \fR\fB[OPTIONS...]\fR\ 'u -\fBNetworkManager \fR\fB[OPTIONS...]\fR -.SH "DESCRIPTION" -.PP -The NetworkManager daemon attempts to make networking configuration and operation as painless and automatic as possible by managing the primary network connection and other network interfaces, like Ethernet, Wi\-Fi, and Mobile Broadband devices\&. NetworkManager will connect any network device when a connection for that device becomes available, unless that behavior is disabled\&. Information about networking is exported via a D\-Bus interface to any interested application, providing a rich API with which to inspect and control network settings and operation\&. -.SH "DISPATCHER SCRIPTS" -.PP -NetworkManager\-dispatcher service can execute scripts for the user in response to network events\&. See -\fBNetworkManager-dispatcher\fR(8) -manual\&. -.SH "OPTIONS" -.PP -The following options are understood: -.PP -\fB\-\-version\fR | \fB\-V\fR -.RS 4 -Print the NetworkManager software version and exit\&. -.RE -.PP -\fB\-\-help\fR | \fB\-h\fR -.RS 4 -Print NetworkManager\*(Aqs available options and exit\&. -.RE -.PP -\fB\-\-no\-daemon\fR | \fB\-n\fR -.RS 4 -Do not daemonize\&. -.RE -.PP -\fB\-\-debug\fR | \fB\-d\fR -.RS 4 -Do not daemonize, and direct log output to the controlling terminal in addition to syslog\&. -.RE -.PP -\fB\-\-pid\-file\fR | \fB\-p\fR -.RS 4 -Specify location of a PID file\&. The PID file is used for storing PID of the running process and prevents running multiple instances\&. -.RE -.PP -\fB\-\-state\-file\fR -.RS 4 -Specify file for storing state of the NetworkManager persistently\&. If not specified, the default value of -/var/lib/NetworkManager/NetworkManager\&.state -is used\&. -.RE -.PP -\fB\-\-config\fR -.RS 4 -Specify configuration file to set up various settings for NetworkManager\&. If not specified, the default value of -/etc/NetworkManager/NetworkManager\&.conf -is used with a fallback to the older \*(Aqnm\-system\-settings\&.conf\*(Aq if located in the same directory\&. See -\fBNetworkManager.conf\fR(5) -for more information on configuration file\&. -.RE -.PP -\fB\-\-configure\-and\-quit\fR [initrd] -.RS 4 -Quit after all devices reach a stable state\&. The optional -initrd -parameter enables mode, where no processes are left running after NetworkManager stops, which is useful for running from an initial ramdisk on rearly boot\&. -.RE -.PP -\fB\-\-plugins\fR -.RS 4 -List plugins used to manage system\-wide connection settings\&. This list has preference over plugins specified in the configuration file\&. See -main\&.plugins -setting in -\fBNetworkManager.conf\fR(5) -for supported options\&. -.RE -.PP -\fB\-\-log\-level\fR -.RS 4 -Sets how much information NetworkManager sends to the log destination (usually syslog\*(Aqs "daemon" facility)\&. By default, only informational, warning, and error messages are logged\&. See the section on -logging -in -\fBNetworkManager.conf\fR(5) -for more information\&. -.RE -.PP -\fB\-\-log\-domains\fR -.RS 4 -A comma\-separated list specifying which operations are logged to the log destination (usually syslog)\&. By default, most domains are logging\-enabled\&. See the section on -logging -in -\fBNetworkManager.conf\fR(5) -for more information\&. -.RE -.PP -\fB\-\-print\-config\fR -.RS 4 -Print the NetworkManager configuration to stdout and exit\&. See -\fBNetworkManager.conf\fR(5)\&. This does not include connection profiles\&. View them with -\fBnmcli connection\fR\&. -.sp -This reads configuration files from disk\&. If NetworkManager is currently running, make sure that it has the same configuration loaded\&. -.RE -.SH "UDEV PROPERTIES" -.PP -\fBudev\fR(7) -device manager is used for the network device discovery\&. The following property influences how NetworkManager manages the devices: -.PP -\fINM_UNMANAGED\fR -.RS 4 -If set to -"1" -or -"true", the device is configured as unmanaged by NetworkManager\&. Note that the user still can explicitly overrule this configuration via means like -\fBnmcli device set "$DEVICE" managed yes\fR -or -"device*\&.managed=1" -in NetworkManager\&.conf\&. -.RE -.PP -\fIID_NET_MANAGED_BY\fR -.RS 4 -If -\fINM_UNMANAGED\fR -is set, this has no effect\&. Otherwise, if the attribute is set to anything but -"org\&.freedesktop\&.NetworkManager", the device is unmanaged\&. -.RE -.PP -\fINM_AUTO_DEFAULT_LINK_LOCAL_ONLY\fR -.RS 4 -If set to -"1" -or -"true", the automatically generated connections "Wired connection N" will only enable link local addressing for IPv4 and IPv6\&. This can be useful on thunderbolt devices or host\-to\-host USB devices\&. -.RE -.PP -\fIID_NET_AUTO_LINK_LOCAL_ONLY\fR -.RS 4 -Honored and treated the same as if -\fINM_AUTO_DEFAULT_LINK_LOCAL_ONLY\fR -were set\&. -.RE -.PP -\fIID_NET_DHCP_BROADCAST\fR -.RS 4 -If set to -"1" -or -"true", use broadcast requests for DHCPv4 offers\&. This can make sense of devices that can\*(Aqt handle unicast messages until being configured\&. -.RE -.SH "SIGNALS" -.PP -NetworkManager process handles the following signals: -.PP -\fISIGHUP\fR -.RS 4 -The signal causes a reload of NetworkManager\*(Aqs configuration\&. Note that not all configuration parameters can be changed at runtime and therefore some changes may be applied only after the next restart of the daemon\&. A SIGHUP also involves further reloading actions, like doing a DNS update and restarting the DNS plugin\&. The latter can be useful for example when using the dnsmasq plugin and changing its configuration in -/etc/NetworkManager/dnsmasq\&.d\&. However, it also means this will shortly interrupt name resolution\&. In the future, there may be further actions added\&. A SIGHUP means to update NetworkManager configuration and reload everything that is supported\&. Note that this does not reload connections from disk\&. For that there is a D\-Bus API and nmcli\*(Aqs reload action -.RE -.PP -\fISIGUSR1\fR -.RS 4 -The signal forces a rewrite of DNS configuration\&. Contrary to SIGHUP, this does not restart the DNS plugin and will not interrupt name resolution\&. When NetworkManager is not managing DNS, the signal forces a restart of operations that depend on the DNS configuration (like the resolution of the system hostname via reverse DNS, or the resolution of WireGuard peers); therefore, it can be used to tell NetworkManager that the content of resolv\&.conf was changed externally\&. In the future, further actions may be added\&. A SIGUSR1 means to write out data like resolv\&.conf, or refresh a cache\&. It is a subset of what is done for SIGHUP without reloading configuration from disk\&. -.RE -.PP -\fISIGUSR2\fR -.RS 4 -The signal has no effect at the moment but is reserved for future use\&. -.RE -.PP -An alternative to a signal to reload configuration is the Reload D\-Bus call\&. It allows for more fine\-grained selection of what to reload, it only returns after the reload is complete, and it is guarded by PolicyKit\&. -.SH "DEBUGGING" -.PP -NetworkManager only configures your system\&. So when your networking setup doesn\*(Aqt work as expected, the first step is to look at your system to understand what is actually configured, and whether that is correct\&. The second step is to find out how to tell NetworkManager to do the right thing\&. -.PP -You can for example try to -\fBping\fR -hosts (by IP address or DNS name), look at -\fBip link show\fR, -\fBip address show\fR -and -\fBip route show\fR, and look at -/etc/resolv\&.conf -for name resolution issues\&. Also look at the connection profiles that you have configured in NetworkManager (\fBnmcli connection\fR -and -\fBnmcli connection show "$PROFILE"\fR) and the configured interfaces (\fBnmcli device\fR)\&. -.PP -If that does not suffice, look at the logfiles of NetworkManager\&. NetworkManager logs to syslog, so depending on your system configuration you can call -\fBjournalctl\fR -to get the logs\&. By default, NetworkManager logs are not verbose and thus not very helpful for investigating a problem in detail\&. You can change the logging level at runtime with -\fBnmcli general logging level TRACE domains ALL\fR\&. But usually a better way is to collect full logs from the start, by configuring -level=TRACE -in NetworkManager\&.conf\&. See -\fBNetworkManager.conf\fR(5) -manual\&. Note that trace logs of NetworkManager are verbose and systemd\-journald might rate limit some lines\&. Possibly disable rate limiting first with the -RateLimitIntervalSec -and -RateLimitBurst -options of journald (see -\fBjournald.conf\fR(5) -manual)\&. -.PP -NetworkManager does not log any secrets\&. However, you are advised to check whether anything private sensitive gets logged before posting\&. When reporting an issue, provide complete logs and avoid modifications (for privacy) that distort the meaning\&. -.SH "/VAR/LIB/NETWORKMANAGER/SECRET_KEY AND /ETC/MACHINE\-ID" -.PP -The identity of a machine is important as various settings depend on it\&. For example, -ipv6\&.addr\-gen\-mode=stable -and -ethernet\&.cloned\-mac\-address=stable -generate identifiers by hashing the machine\*(Aqs identity\&. See also the -connection\&.stable\-id -connection property which is a per\-profile seed that gets hashed with the machine identity for generating such addresses and identifiers\&. -.PP -If you backup and restore a machine, the identity of the machine probably should be preserved\&. In that case, preserve the files -/var/lib/NetworkManager/secret_key -and -/etc/machine\-id\&. On the other hand, if you clone a virtual machine, you probably want that the clone has a different identity\&. There is already existing tooling on Linux for handling -/etc/machine\-id -(see -\fBmachine-id\fR(5))\&. -.PP -The identity of the machine is determined by the -/var/lib/NetworkManager/secret_key\&. If such a file does not exist, NetworkManager will create a file with random content\&. To generate a new identity just delete the file and after restart a new file will be created\&. The file should be read\-only to root and contain at least 16 bytes that will be used to seed the various places where a stable identifier is used\&. -.PP -Since 1\&.16\&.0, NetworkManager supports a version 2 of secret\-keys\&. For such keys -/var/lib/NetworkManager/secret_key -starts with ASCII -"nm\-v2:" -followed by at least 32 bytes of random data\&. Also, recent versions of NetworkManager always create such kinds of secret\-keys, when the file does not yet exist\&. With version 2 of the secret\-key, -/etc/machine\-id -is also hashed as part of the generation for addresses and identifiers\&. The advantage is that you can keep -/var/lib/NetworkManager/secret_key -stable, and only regenerate -/etc/machine\-id -when cloning a VM\&. -.SH "BUGS" -.PP -Please report any bugs you find in NetworkManager at the -\m[blue]\fBNetworkManager issue tracker\fR\m[]\&\s-2\u[1]\d\s+2\&. -.SH "SEE ALSO" -.PP -\m[blue]\fBNetworkManager home page\fR\m[]\&\s-2\u[2]\d\s+2, -\fBNetworkManager.conf\fR(5), -\fBNetworkManager-dispatcher\fR(8), -\fBNetworkManager-wait-online.service\fR(8), -\fBnmcli\fR(1), -\fBnmcli-examples\fR(7), -\fBnm-online\fR(1), -\fBnm-settings-nmcli\fR(5), -\fBnm-applet\fR(1), -\fBnm-connection-editor\fR(1), -\fBudev\fR(7) -.SH "NOTES" -.IP " 1." 4 -NetworkManager issue tracker -.RS 4 -\%https://gitlab.freedesktop.org/NetworkManager/NetworkManager/-/issues -.RE -.IP " 2." 4 -NetworkManager home page -.RS 4 -\%https://networkmanager.dev -.RE diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5 deleted file mode 100644 index 681e640e..00000000 --- a/man/NetworkManager.conf.5 +++ /dev/null @@ -1,1672 +0,0 @@ -'\" t -.\" Title: NetworkManager.conf -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: Configuration -.\" Source: NetworkManager 1.50.0 -.\" Language: English -.\" -.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.50\&.0" "Configuration" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -NetworkManager.conf \- NetworkManager configuration file -.SH "SYNOPSIS" -.PP -/etc/NetworkManager/NetworkManager\&.conf, -/etc/NetworkManager/conf\&.d/\fIname\fR\&.conf, -/run/NetworkManager/conf\&.d/\fIname\fR\&.conf, -/usr/lib/NetworkManager/conf\&.d/\fIname\fR\&.conf, -/var/lib/NetworkManager/NetworkManager\-intern\&.conf -.SH "DESCRIPTION" -.PP -NetworkManager\&.conf -is the configuration file for NetworkManager\&. It is used to set up various aspects of NetworkManager\*(Aqs behavior\&. The location of the main file and configuration directories may be changed through use of the -\fB\-\-config\fR, -\fB\-\-config\-dir\fR, -\fB\-\-system\-config\-dir\fR, and -\fB\-\-intern\-config\fR -argument for NetworkManager, respectively\&. -.PP -If a default -NetworkManager\&.conf -is provided by your distribution\*(Aqs packages, you should not modify it, since your changes may get overwritten by package updates\&. Instead, you can add additional -\&.conf -files to the -/etc/NetworkManager/conf\&.d -directory\&. These will be read in order, with later files overriding earlier ones\&. Packages might install further configuration snippets to -/usr/lib/NetworkManager/conf\&.d\&. This directory is parsed first, even before -NetworkManager\&.conf\&. Scripts can also put per\-boot configuration into -/run/NetworkManager/conf\&.d\&. This directory is parsed second, also before -NetworkManager\&.conf\&. The loading of a file -/run/NetworkManager/conf\&.d/\fIname\fR\&.conf -can be prevented by adding a file -/etc/NetworkManager/conf\&.d/\fIname\fR\&.conf\&. Likewise, a file -/usr/lib/NetworkManager/conf\&.d/\fIname\fR\&.conf -can be shadowed by putting a file of the same name to either -/etc/NetworkManager/conf\&.d -or -/run/NetworkManager/conf\&.d\&. -.PP -NetworkManager can overwrite certain user configuration options via D\-Bus or other internal operations\&. In this case it writes those changes to -/var/lib/NetworkManager/NetworkManager\-intern\&.conf\&. This file is not intended to be modified by the user, but it is read last and can shadow user configuration from -NetworkManager\&.conf\&. -.PP -Certain settings from the configuration can be reloaded at runtime either by sending SIGHUP signal or via D\-Bus\*(Aq Reload call\&. -.PP -NetworkManager does not require any configuration in -NetworkManager\&.conf\&. Depending on your use case, you may remove all files to restore the default configuration (factory reset)\&. But note that your distribution or other packages may drop configuration snippets for NetworkManager, such that they are part of the factory default\&. -.SH "FILE FORMAT" -.PP -The configuration file format is so\-called key file (sort of ini\-style format)\&. It consists of sections (groups) of key\-value pairs\&. Lines beginning with a \*(Aq#\*(Aq and blank lines are considered comments\&. Sections are started by a header line containing the section enclosed in \*(Aq[\*(Aq and \*(Aq]\*(Aq, and ended implicitly by the start of the next section or the end of the file\&. Each key\-value pair must be contained in a section\&. -.PP -For keys that take a list of devices as their value, you can specify devices by their MAC addresses or interface names, or "*" to specify all devices\&. See -the section called \(lqDevice List Format\(rq -below\&. -.PP -A simple configuration file looks like this: -.sp -.if n \{\ -.RS 4 -.\} -.nf -[main] -plugins=keyfile -.fi -.if n \{\ -.RE -.\} -.PP -As an extension to the normal keyfile format, you can also append a value to a previously\-set list\-valued key by doing: -.sp -.if n \{\ -.RS 4 -.\} -.nf -plugins+=another\-plugin -plugins\-=remove\-me -.fi -.if n \{\ -.RE -.\} -.sp -.SH "MAIN SECTION" -.PP -\fIplugins\fR -.RS 4 -Lists system settings plugin names separated by \*(Aq,\*(Aq\&. These plugins are used to read and write system\-wide connection profiles\&. When multiple plugins are specified, the connections are read from all listed plugins\&. When writing connections, the plugins will be asked to save the connection in the order listed here; if the first plugin cannot write out that connection type (or can\*(Aqt write out any connections) the next plugin is tried, etc\&. If none of the plugins can save the connection, an error is returned to the user\&. -.sp -The default value and the number of available plugins is distro\-specific\&. See -the section called \(lqPLUGINS\(rq -below for the available plugins\&. Note that NetworkManager\*(Aqs native -keyfile -plugin is always appended to the end of this list (if it doesn\*(Aqt already appear earlier in the list)\&. -.RE -.PP -\fImonitor\-connection\-files\fR -.RS 4 -This setting is deprecated and has no effect\&. Profiles from disk are never automatically reloaded\&. Use for example -nmcli connection (re)load -for that\&. -.RE -.PP -\fIauth\-polkit\fR -.RS 4 -Whether the system uses PolicyKit for authorization\&. If -true, non\-root requests are authorized using PolicyKit\&. Requests from root (user ID zero) are always granted without asking PolicyKit\&. If -false, all requests will be allowed and PolicyKit is not used\&. If set to -root\-only -PolicyKit is not used and all requests except root are denied\&. The default value is -true\&. -.RE -.PP -\fIdhcp\fR -.RS 4 -This key sets up what DHCP client NetworkManager will use\&. Allowed values depend on build configuration and typically include -internal -and -dhcpcd\&. Support for unmaintained -dhclient -client has been deprecated and disabled by default\&. -.sp -The -internal -client is built\-in, while other options may require an external DHCP client to be installed\&. -.sp -If this key is missing, -internal -is used with a fallback to other suppored clients in this order: -internal, -dhcpcd, -dhclient\&. -.RE -.PP -\fIno\-auto\-default\fR -.RS 4 -Specify devices for which NetworkManager shouldn\*(Aqt create default wired connection (Auto eth0)\&. By default, NetworkManager creates a temporary wired connection for any Ethernet device that is managed and doesn\*(Aqt have a connection configured\&. List a device in this option to inhibit creating the default connection for the device\&. May have the special value -* -to apply to all devices\&. -.sp -When the default wired connection is deleted or saved to a new persistent connection by a plugin, the device is added to a list in the file -/var/lib/NetworkManager/no\-auto\-default\&.state -to prevent creating the default connection for that device again\&. -.sp -See -the section called \(lqDevice List Format\(rq -for the syntax how to specify a device\&. -.sp -Example: -.sp -.if n \{\ -.RS 4 -.\} -.nf -no\-auto\-default=00:22:68:5c:5d:c4,00:1e:65:ff:aa:ee -no\-auto\-default=eth0,eth1 -no\-auto\-default=* -.fi -.if n \{\ -.RE -.\} -.sp -.RE -.PP -\fIignore\-carrier\fR -.RS 4 -This setting is deprecated for the per\-device setting -ignore\-carrier -which overwrites this setting if specified (See -\fIignore\-carrier\fR)\&. Otherwise, it is a list of matches to specify for which device carrier should be ignored\&. See -the section called \(lqDevice List Format\(rq -for the syntax how to specify a device\&. Note that controller types like bond, bridge, and team ignore carrier by default\&. You can however revert that default using the "except:" specifier (or better, use the per\-device setting instead of the deprecated setting)\&. -.RE -.PP -\fIassume\-ipv6ll\-only\fR -.RS 4 -Specify devices for which NetworkManager will try to generate a connection based on initial configuration when the device only has an IPv6 link\-local address\&. -.sp -See -the section called \(lqDevice List Format\(rq -for the syntax how to specify a device\&. -.RE -.PP -\fIconfigure\-and\-quit\fR -.RS 4 -This option is no longer useful to configure in NetworkManager\&.conf file\&. It can however also be configured on the command line with the same values, where it has some use\&. -.sp -When set to \*(Aqinitrd\*(Aq, NetworkManager does not connect to D\-Bus and quits after configuring the network\&. This is an implementation detail how the NetworkManager module of dracut can run NetworkManager\&. An alternative to this is having NetworkManager as a systemd service with D\-Bus in initrd\&. -.sp -The value \*(Aqtrue\*(Aq is unsupported since version 1\&.36\&. Previously this was a mode where NetworkManager would quit after configuring the network and run helper processes for DHCP and SLAAC\&. -.sp -Otherwise, NetworkManager runs a system service with D\-Bus and does not quit during normal operation\&. -.RE -.PP -\fIhostname\-mode\fR -.RS 4 -Set the management mode of the hostname\&. This parameter will affect only the transient hostname\&. If a valid static hostname is set, NetworkManager will skip the update of the hostname despite the value of this option\&. An hostname empty or equal to \*(Aqlocalhost\*(Aq, \*(Aqlocalhost6\*(Aq, \*(Aqlocalhost\&.localdomain\*(Aq or \*(Aqlocalhost6\&.localdomain\*(Aq is considered invalid\&. -.sp -default: NetworkManager will update the hostname with the one provided via DHCP or reverse DNS lookup of the IP address on the connection with the default route or on any connection with the property hostname\&.only\-from\-default set to \*(Aqfalse\*(Aq\&. Connections are considered in order of increasing value of the -hostname\&.priority -property\&. In case multiple connections have the same priority, connections activated earlier are considered first\&. If no hostname can be determined in such way, the hostname will be updated to the last one set outside NetworkManager or to \*(Aqlocalhost\&.localdomain\*(Aq\&. -.sp -dhcp: this is similar to \*(Aqdefault\*(Aq, with the difference that after trying to get the DHCP hostname, reverse DNS lookup is not done\&. Note that selecting this option is equivalent to setting the property \*(Aqhostname\&.from\-dns\-lookup\*(Aq to \*(Aqfalse\*(Aq globally for all connections in NetworkManager\&.conf\&. -.sp -none: NetworkManager will not manage the transient hostname and will never set it\&. -.RE -.PP -\fIdns\fR -.RS 4 -Set the DNS processing mode\&. -.sp -If the key is unspecified, -default -is used, unless -/etc/resolv\&.conf -is a symlink to -/run/systemd/resolve/stub\-resolv\&.conf, -/run/systemd/resolve/resolv\&.conf, -/lib/systemd/resolv\&.conf -or -/usr/lib/systemd/resolv\&.conf\&. In that case, -systemd\-resolved -is chosen automatically\&. -.sp -default: NetworkManager will update -/etc/resolv\&.conf -to reflect the nameservers provided by currently active connections\&. The -rc\-manager -setting (below) controls how this is done\&. -.sp -dnsmasq: NetworkManager will run dnsmasq as a local caching nameserver, using "Conditional Forwarding" if you are connected to a VPN, and then update -resolv\&.conf -to point to the local nameserver\&. It is possible to pass custom options to the dnsmasq instance by adding them to files in the "/etc/NetworkManager/dnsmasq\&.d/" directory\&. Note that when multiple upstream servers are available, dnsmasq will initially contact them in parallel and then use the fastest to respond, probing again other servers after some time\&. This behavior can be modified passing the \*(Aqall\-servers\*(Aq or \*(Aqstrict\-order\*(Aq options to dnsmasq (see the manual page for more details)\&. -.sp -systemd\-resolved: NetworkManager will push the DNS configuration to systemd\-resolved -.sp -none: NetworkManager will not modify resolv\&.conf\&. This implies -rc\-manager\ \&unmanaged -.sp -Note that the plugins -dnsmasq -and -systemd\-resolved -are caching local nameservers\&. Hence, when NetworkManager writes -/run/NetworkManager/resolv\&.conf -and -/etc/resolv\&.conf -(according to -rc\-manager -setting below), the name server there will be localhost only\&. NetworkManager also writes a file -/run/NetworkManager/no\-stub\-resolv\&.conf -that contains the original name servers pushed to the DNS plugin\&. -.sp -When using -dnsmasq -and -systemd\-resolved, per\-connection added dns servers will always be queried using the device the connection has been activated on\&. -.RE -.PP -\fIrc\-manager\fR -.RS 4 -Set the -resolv\&.conf -management mode\&. This option is about how NetworkManager writes to -/etc/resolv\&.conf, if at all\&. The default value depends on NetworkManager build options, and this version of NetworkManager was build with a default of "auto"\&. Regardless of this setting, NetworkManager will always write its version of resolv\&.conf to its runtime state directory as -/run/NetworkManager/resolv\&.conf\&. -.sp -If you configure -dns=none -or make -/etc/resolv\&.conf -immutable with -chattr +i, NetworkManager will ignore this setting and always choose -unmanaged -(below)\&. -.sp -auto: if systemd\-resolved plugin is configured via the -dns -setting or if it gets detected as main DNS plugin, NetworkManager will update systemd\-resolved without touching -/etc/resolv\&.conf\&. Alternatively, if -resolvconf -or -netconfig -are enabled at compile time and the respective binary is found, NetworkManager will automatically use it\&. Note that if you install or uninstall these binaries, you need to reload the -rc\-manager -setting with SIGHUP or -systemctl reload NetworkManager\&. As last fallback it uses the -symlink -option (see next)\&. -.sp -symlink: If -/etc/resolv\&.conf -is a regular file or does not exist, NetworkManager will write the file directly\&. If -/etc/resolv\&.conf -is instead a symlink, NetworkManager will leave it alone\&. Unless the symlink points to the internal file -/run/NetworkManager/resolv\&.conf, in which case the symlink will be updated to emit an inotify notification\&. This allows the user to conveniently instruct NetworkManager not to manage -/etc/resolv\&.conf -by replacing it with a symlink\&. -.sp -file: NetworkManager will write -/etc/resolv\&.conf -as regular file\&. If it finds a symlink to an existing target, it will follow the symlink and update the target instead\&. In no case will an existing symlink be replaced by a file\&. Note that older versions of NetworkManager behaved differently and would replace dangling symlinks with a plain file\&. -.sp -resolvconf: NetworkManager will run resolvconf to update the DNS configuration\&. -.sp -netconfig: NetworkManager will run netconfig to update the DNS configuration\&. -.sp -unmanaged: don\*(Aqt touch -/etc/resolv\&.conf\&. -.sp -none: deprecated alias for -symlink\&. -.RE -.PP -\fIsystemd\-resolved\fR -.RS 4 -Additionally, send the connection DNS configuration to -systemd\-resolved\&. Defaults to "true"\&. -.sp -Note that this setting has no effect if the main -\fIdns\fR -plugin is already -systemd\-resolved\&. It is complementary to the -\fIdns\fR -setting to configure systemd\-resolved alongside the main plugin\&. -.sp -If systemd\-resolved is enabled, either via this setting or the main DNS plugin, the connectivity check resolves the hostname per\-device\&. -.RE -.PP -\fIdebug\fR -.RS 4 -Comma separated list of options to aid debugging\&. This value will be combined with the environment variable -NM_DEBUG\&. Currently, the following values are supported: -.sp -RLIMIT_CORE: set ulimit \-c unlimited to write out core dumps\&. Beware, that a core dump can contain sensitive information such as passwords or configuration settings\&. -.sp -fatal\-warnings: set g_log_set_always_fatal() to core dump on warning messages from glib\&. This is equivalent to the \-\-g\-fatal\-warnings command line option\&. -.RE -.PP -\fIautoconnect\-retries\-default\fR -.RS 4 -The number of times a connection activation should be automatically tried before switching to another one\&. This value applies only to connections that can auto\-connect and have a -connection\&.autoconnect\-retries -property set to \-1\&. If not specified, connections will be tried 4 times\&. Setting this value to 1 means to try activation once, without retry\&. -.RE -.PP -\fIfirewall\-backend\fR -.RS 4 -The firewall backend for configuring masquerading with shared mode\&. Set to either -iptables, -nftables -or -none\&. -iptables -and -nftables -require -iptables -and -nft -application, respectively\&. -none -means to skip firewall configuration if the users wish to manage firewall themselves\&. If unspecified, it will be auto detected\&. -.RE -.PP -\fIiwd\-config\-path\fR -.RS 4 -If the value is "auto" (the default), IWD is queried for its current state directory when it appears on D\-Bus \-\- the directory where IWD keeps its network configuration files \-\- usually /var/lib/iwd\&. NetworkManager will then attempt to write copies of new or modified Wi\-Fi connection profiles, converted into the IWD format, into this directory thus making IWD connection properties editable\&. NM will overwrite existing files without preserving their contents\&. -.sp -The path can also be overridden by pointing to a specific existing and writable directory\&. On the other hand setting this to an empty string or any other value disables the profile conversion mechanism\&. -.sp -This mechanism allows editing connection profile settings such as the 802\&.1x configuration using NetworkManager clients\&. Without it such changes have no effect in IWD\&. -.RE -.PP -\fImigrate\-ifcfg\-rh\fR -.RS 4 -Whether NetworkManager tries to automatically convert any connection profile stored in ifcfg\-rh format to the keyfile format\&. Support for ifcfg\-rh is deprecated and will be eventually removed\&. If enabled, the migration is performed at every startup of the daemon\&. The default value is -false\&. -.RE -.SH "KEYFILE SECTION" -.PP -This section contains keyfile\-plugin\-specific options, and is normally only used when you are not using any other distro\-specific plugin\&. -.PP -.PP -\fIhostname\fR -.RS 4 -This key is deprecated and has no effect since the hostname is now stored in -/etc/hostname -or other system configuration files according to build options\&. -.RE -.PP -\fIpath\fR -.RS 4 -The location where keyfiles are read and stored\&. This defaults to "/etc/NetworkManager/system\-connections"\&. -.RE -.PP -\fIrename\fR -.RS 4 -NetworkManager automatically chooses a filename when storing a new profile to disk\&. That name depends on the profile\*(Aqs name (connection\&.id)\&. When updating a profile\*(Aqs name, the file is not renamed to not break scripts that rely on the filename for the profile\&. By setting this option to "true", NetworkManager renames the keyfile on update of the profile, to follow the profile\*(Aqs name\&. This defaults to "false"\&. -.RE -.PP -\fIunmanaged\-devices\fR -.RS 4 -Set devices that should be ignored by NetworkManager\&. -.sp -A device unmanaged due to this option is strictly unmanaged and cannot be overruled by using the API like -\fBnmcli device set $IFNAME managed yes\fR\&. Also, a device that is unmanaged for other reasons, like an udev rule, cannot be made managed with this option (e\&.g\&. by using an -except: -specifier)\&. These two points make it different from the -device*\&.managed -option which for that reason may be a better choice\&. -.sp -See -the section called \(lqDevice List Format\(rq -for the syntax on how to specify a device\&. -.sp -Example: -.sp -.if n \{\ -.RS 4 -.\} -.nf -unmanaged\-devices=interface\-name:em4 -unmanaged\-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface\-name:eth2 -.fi -.if n \{\ -.RE -.\} -.sp -.RE -.SH "IFUPDOWN SECTION" -.PP -This section contains ifupdown\-specific options and thus only has effect when using the -ifupdown -plugin\&. -.PP -.PP -\fImanaged\fR -.RS 4 -If set to -true, then interfaces listed in -/etc/network/interfaces -are managed by NetworkManager\&. If set to -false, then any interface listed in -/etc/network/interfaces -will be ignored by NetworkManager\&. Remember that NetworkManager controls the default route, so because the interface is ignored, NetworkManager may assign the default route to some other interface\&. -.sp -The default value is -false\&. -.RE -.SH "LOGGING SECTION" -.PP -This section controls NetworkManager\*(Aqs logging\&. Logging is very important to understand what NetworkManager is doing\&. When you report a bug, do not unnecessarily filter or limit the log file\&. Just enable -level=TRACE -and -domains=ALL -to collect everything\&. -.PP -The recommended way for enabling logging is with a file -/etc/NetworkManager/conf\&.d/95\-logging\&.conf -that contains -.sp -.if n \{\ -.RS 4 -.\} -.nf -[logging] -level=TRACE -domains=ALL -.fi -.if n \{\ -.RE -.\} -.sp -and restart the daemon with -\fBsystemctl restart NetworkManager\fR\&. Then reproduce the problem\&. You can find the logs in syslog (for example -\fBjournalctl\fR, or -\fBjournalctl \-u NetworkManager\fR -to show only logs from NetworkManager)\&. -.PP -Any settings here are overridden by the -\fB\-\-log\-level\fR -and -\fB\-\-log\-domains\fR -command\-line options\&. Logging can also be reconfigured at runtime with -\fBnmcli general logging level "$LEVEL" domains "$DOMAINS"\fR\&. However, often it is interesting to get a complete log from the start\&. Especially, when debugging an issue, enable debug logging in NetworkManager\&.conf and restart the service to enable verbose logging early on\&. -.PP -By setting -\fBnm\&.debug\fR -on the kernel command line (either from -/run/NetworkManager/proc\-cmdline -or -/proc/cmdline), debug logging is enabled\&. This overrides both the command\-line options and the settings from NetworkManager\&.conf\&. -.PP -NetworkManager\*(Aqs logging aims not to contain private sensitive data and you should be fine sharing the debug logs\&. Still, there will be IP addresses and your network setup, if you consider that private then review the log before sharing\&. However, try not to mangle the logfile in a way that distorts the meaning too much\&. -.PP -NetworkManager uses syslog or systemd\-journald, depending on configuration\&. In any case, debug logs are verbose and might be rate limited or filtered by the logging daemon\&. For systemd\-journald, see -RateLimitIntervalSec -and -RateLimitBurst -in -journald\&.conf -manual for how to disable that\&. -.PP -.PP -\fIlevel\fR -.RS 4 -The default logging verbosity level\&. One of -OFF, -ERR, -WARN, -INFO, -DEBUG, -TRACE, in order of verbosity\&. -.sp -OFF -disables all logging\&. -INFO -is the default verbosity for regular operation\&. -TRACE -is for debugging\&. -.sp -The other levels are in most cases not useful\&. For example, -DEBUG -is between -TRACE -and -INFO, but it\*(Aqs too verbose for regular operation and lacks possibly interesting messages for debugging\&. Almost always, when debugging an issue or reporting a bug, collect full level -TRACE -logs to get the full picture\&. -.RE -.PP -\fIdomains\fR -.RS 4 -Filter the messages by their topic\&. When debugging an issue, it\*(Aqs better to collect all logs (ALL -domain) upfront\&. The unnecessary parts can always be ignored later\&. -.sp -In the uncommon case to tune out certain topics, the following log domains are available: PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT, SYSTEMD, VPN_PLUGIN, PROXY\&. -.sp -In addition, these special domains can be used: NONE, ALL, DEFAULT, DHCP, IP\&. -.sp -You can specify per\-domain log level overrides by adding a colon and a log level to any domain\&. E\&.g\&., "WIFI:DEBUG,WIFI_SCAN:OFF"\&. Another example is -ALL,VPN_PLUGIN:TRACE -to enable all the logging there is (see about -VPN_PLUGIN -below)\&. -.RE -.PP -.RS 4 -.PP -Domain descriptions: -.RS 4 -PLATFORM : OS (platform) operations -.RE -.RS 4 -RFKILL : RFKill subsystem operations -.RE -.RS 4 -ETHER : Ethernet device operations -.RE -.RS 4 -WIFI : Wi\-Fi device operations -.RE -.RS 4 -BT : Bluetooth operations -.RE -.RS 4 -MB : Mobile broadband operations -.RE -.RS 4 -DHCP4 : DHCP for IPv4 -.RE -.RS 4 -DHCP6 : DHCP for IPv6 -.RE -.RS 4 -PPP : Point\-to\-point protocol operations -.RE -.RS 4 -WIFI_SCAN : Wi\-Fi scanning operations -.RE -.RS 4 -IP4 : IPv4\-related operations -.RE -.RS 4 -IP6 : IPv6\-related operations -.RE -.RS 4 -AUTOIP4 : AutoIP operations -.RE -.RS 4 -DNS : Domain Name System related operations -.RE -.RS 4 -VPN : Virtual Private Network connections and operations -.RE -.RS 4 -SHARING : Connection sharing\&. With TRACE level log queries for dnsmasq instance -.RE -.RS 4 -SUPPLICANT : WPA supplicant related operations -.RE -.RS 4 -AGENTS : Secret agents operations and communication -.RE -.RS 4 -SETTINGS : Settings/config service operations -.RE -.RS 4 -SUSPEND : Suspend/resume -.RE -.RS 4 -CORE : Core daemon and policy operations -.RE -.RS 4 -DEVICE : Activation and general interface operations -.RE -.RS 4 -OLPC : OLPC Mesh device operations -.RE -.RS 4 -WIMAX : WiMAX device operations -.RE -.RS 4 -INFINIBAND : InfiniBand device operations -.RE -.RS 4 -FIREWALL : FirewallD related operations -.RE -.RS 4 -ADSL : ADSL device operations -.RE -.RS 4 -BOND : Bonding operations -.RE -.RS 4 -VLAN : VLAN operations -.RE -.RS 4 -BRIDGE : Bridging operations -.RE -.RS 4 -DBUS_PROPS : D\-Bus property changes -.RE -.RS 4 -TEAM : Teaming operations -.RE -.RS 4 -CONCHECK : Connectivity check -.RE -.RS 4 -DCB : Data Center Bridging (DCB) operations -.RE -.RS 4 -DISPATCH : Dispatcher scripts -.RE -.RS 4 -AUDIT : Audit records -.RE -.RS 4 -SYSTEMD : Messages from internal libsystemd -.RE -.RS 4 -VPN_PLUGIN : logging messages from VPN plugins -.RE -.RS 4 -PROXY : logging messages for proxy handling -.RE -.RS 4 - -.RE -.RS 4 -NONE : when given by itself logging is disabled -.RE -.RS 4 -ALL : all log domains -.RE -.RS 4 -DEFAULT : default log domains -.RE -.RS 4 -DHCP : shortcut for "DHCP4,DHCP6" -.RE -.RS 4 -IP : shortcut for "IP4,IP6" -.RE -.RS 4 - -.RE -.RS 4 -HW : deprecated alias for "PLATFORM" -.RE -.PP -In general, the logfile should not contain passwords or private data\&. However, you are always advised to check the file before posting it online or attaching to a bug report\&. -VPN_PLUGIN -is special as it might reveal private information of the VPN plugins with verbose levels\&. Therefore this domain will be excluded when setting -ALL -or -DEFAULT -to more verbose levels then -INFO\&. -.RE -.PP -\fIbackend\fR -.RS 4 -The logging backend\&. Supported values are "syslog" and "journal"\&. When NetworkManager is started with "\-\-debug" in addition all messages will be printed to stderr\&. If unspecified, the default is "syslog"\&. -.RE -.PP -\fIaudit\fR -.RS 4 -Whether the audit records are delivered to auditd, the audit daemon\&. If -false, audit records will be sent only to the NetworkManager logging system\&. If set to -true, they will be also sent to auditd\&. The default value is -false\&. -.RE -.SH "CONNECTION SECTION" -.PP -Specify default values for connections\&. -.PP -Such default values are only consulted if the corresponding per\-connection property explicitly allows for that\&. That means, all these properties correspond to a property of the connection profile (for example -connection\&.mud\-url)\&. Only if the per\-profile property is set to a special value that indicates to use the default, the default value from NetworkManager\&.conf is consulted\&. It depends on the property, which is the special value that indicates fallback to the default, but it usually is something like empty, unset values or special numeric values like 0 or \-1\&. That means the effectively used value can first always be configured for each profile, and these default values only matter if the per\-profile values explicitly indicates to use the default from -NetworkManager\&.conf\&. -.PP -Note that while nmcli supports various aliases and convenience features for configuring properties, the settings in this section do not\&. For example, enum values usually only can be configured via their numeric magic number\&. -.PP -Example: -.sp -.if n \{\ -.RS 4 -.\} -.nf -[connection] -ipv6\&.ip6\-privacy=0 -.fi -.if n \{\ -.RE -.\} -.sp -.SS "Supported Properties" -.PP -Not all properties can be overwritten, only the following properties are supported to have their default values configured (see -\fBnm-settings-nmcli\fR(5) -for details)\&. -.PP - - -.PP -\fI802\-1x\&.auth\-timeout\fR -.RS 4 -.RE -.PP -\fIcdma\&.mtu\fR -.RS 4 -.RE -.PP -\fIconnection\&.auth\-retries\fR -.RS 4 -If left unspecified, the default value is 3 tries before failing the connection\&. -.RE -.PP -\fIconnection\&.autoconnect\-ports\fR -.RS 4 -.RE -.PP -\fIconnection\&.autoconnect\-slaves\fR -.RS 4 -This is deprecated, please use "connection\&.autoconnect\-ports" instead\&. -.RE -.PP -\fIconnection\&.down\-on\-poweroff\fR -.RS 4 -Whether the connection will be brought down before the system is powered off\&. -.RE -.PP -\fIconnection\&.mud\-url\fR -.RS 4 -If unspecified, MUD URL defaults to -"none"\&. -.RE -.PP -\fIconnection\&.lldp\fR -.RS 4 -.RE -.PP -\fIconnection\&.llmnr\fR -.RS 4 -If unspecified, the ultimate default values depends on the DNS plugin\&. With systemd\-resolved the default currently is "yes" (2) and for all other plugins "no" (0)\&. -.RE -.PP -\fIconnection\&.mdns\fR -.RS 4 -Currently only the systemd\-resolve DNS plugin supports this setting\&. If the setting is unspecified both in the profile and in the global default here, then the default is determined by systemd\-resolved\&. See -MulticastDNS= -in -\fBresolved.conf\fR(5)\&. -.RE -.PP -\fIconnection\&.mptcp\-flags\fR -.RS 4 -If unspecified, the fallback is 0x22 ("enabled,subflow")\&. Note that if sysctl -/proc/sys/net/mptcp/enabled -is disabled, NetworkManager will still not configure endpoints\&. -.RE -.PP -\fIconnection\&.dns\-over\-tls\fR -.RS 4 -If unspecified, the ultimate default values depends on the DNS plugin\&. With systemd\-resolved the default currently is global setting and for all other plugins "no" (0)\&. -.RE -.PP -\fIconnection\&.stable\-id\fR -.RS 4 -.RE -.PP -\fIethernet\&.cloned\-mac\-address\fR -.RS 4 -If left unspecified, it defaults to "preserve"\&. -.RE -.PP -\fIethernet\&.generate\-mac\-address\-mask\fR -.RS 4 -.RE -.PP -\fIethernet\&.mtu\fR -.RS 4 -If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints\&. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or the MTU is not reconfigured during activation\&. -.RE -.PP -\fIethernet\&.wake\-on\-lan\fR -.RS 4 -.RE -.PP -\fIgsm\&.mtu\fR -.RS 4 -.RE -.PP -\fIhostname\&.from\-dhcp\fR -.RS 4 -.RE -.PP -\fIhostname\&.from\-dns\-lookup\fR -.RS 4 -.RE -.PP -\fIhostname\&.only\-from\-default\fR -.RS 4 -.RE -.PP -\fIhostname\&.priority\fR -.RS 4 -.RE -.PP -\fIinfiniband\&.mtu\fR -.RS 4 -If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints\&. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or the MTU is left unspecified on activation\&. -.RE -.PP -\fIip\-tunnel\&.mtu\fR -.RS 4 -If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints\&. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or a default of 1500\&. -.RE -.PP -\fIipv4\&.dad\-timeout\fR -.RS 4 -.RE -.PP -\fIipv4\&.dhcp\-client\-id\fR -.RS 4 -.RE -.PP -\fIipv4\&.dhcp\-dscp\fR -.RS 4 -.RE -.PP -\fIipv4\&.dhcp\-iaid\fR -.RS 4 -If left unspecified, it defaults to "ifname"\&. -.RE -.PP -\fIipv4\&.dhcp\-hostname\-flags\fR -.RS 4 -If left unspecified, the value 3 (fqdn\-encoded,fqdn\-serv\-update) is used\&. -.RE -.PP -\fIipv4\&.dhcp\-send\-release\fR -.RS 4 -Whether the DHCP client will send RELEASE message when bringing the connection down\&. -.RE -.PP -\fIipv4\&.dhcp\-timeout\fR -.RS 4 -If left unspecified, the default value for the interface type is used\&. -.RE -.PP -\fIipv4\&.dhcp\-vendor\-class\-identifier\fR -.RS 4 -If left unspecified, the default is to not send the DHCP option to the server\&. -.RE -.PP -\fIipv4\&.dns\-priority\fR -.RS 4 -If unspecified or zero, use 50 for VPN profiles and 100 for other profiles\&. -.RE -.PP -\fIipv4\&.required\-timeout\fR -.RS 4 -.RE -.PP -\fIipv4\&.link\-local\fR -.RS 4 -If left unspecified, fallback to "auto" which makes it dependent on "ipv4\&.method" setting\&. -.RE -.PP -\fIipv4\&.route\-metric\fR -.RS 4 -.RE -.PP -\fIipv4\&.route\-table\fR -.RS 4 -If left unspecified, routes are only added to the main table\&. Note that this is different from explicitly selecting the main table 254, because of how NetworkManager removes extraneous routes from the tables\&. -.RE -.PP -\fIipv6\&.addr\-gen\-mode\fR -.RS 4 -If the per\-profile setting is either "default" or "default\-or\-eui64", the global default is used\&. If the default is unspecified, the fallback value is either "stable\-privacy" or "eui64", depending on whether the per\-profile setting is "default" or "default\-or\-eui64, respectively\&. -.RE -.PP -\fIipv6\&.ra\-timeout\fR -.RS 4 -If left unspecified, the default value depends on the sysctl solicitation settings\&. -.RE -.PP -\fIipv6\&.dhcp\-duid\fR -.RS 4 -If left unspecified, it defaults to "lease"\&. -.RE -.PP -\fIipv6\&.dhcp\-iaid\fR -.RS 4 -If left unspecified, it defaults to "ifname"\&. -.RE -.PP -\fIipv6\&.dhcp\-hostname\-flags\fR -.RS 4 -If left unspecified, the value 1 (fqdn\-serv\-update) is used\&. -.RE -.PP -\fIipv6\&.dhcp\-send\-release\fR -.RS 4 -Whether the DHCP client will send RELEASE message when bringing the connection down\&. -.RE -.PP -\fIipv6\&.dhcp\-timeout\fR -.RS 4 -If left unspecified, the default value for the interface type is used\&. -.RE -.PP -\fIipv6\&.dns\-priority\fR -.RS 4 -If unspecified or zero, use 50 for VPN profiles and 100 for other profiles\&. -.RE -.PP -\fIipv6\&.ip6\-privacy\fR -.RS 4 -If -ipv6\&.ip6\-privacy -is unset, use the content of "/proc/sys/net/ipv6/conf/default/use_tempaddr" as last fallback\&. -.RE -.PP -\fIipv6\&.temp\-valid\-lifetime\fR -.RS 4 -If -ipv6\&.temp\-valid\-lifetime -is unset, use the content of "/proc/sys/net/ipv6/conf/default/temp_valid_lft" as last fallback\&. -.RE -.PP -\fIipv6\&.temp\-preferred\-lifetime\fR -.RS 4 -If -ipv6\&.temp\-preferred\-lifetime -is unset, use the content of "/proc/sys/net/ipv6/conf/default/temp_prefered_lft" as last fallback\&. -.RE -.PP -\fIipv6\&.required\-timeout\fR -.RS 4 -.RE -.PP -\fIipv6\&.route\-metric\fR -.RS 4 -.RE -.PP -\fIipv6\&.route\-table\fR -.RS 4 -If left unspecified, routes are only added to the main table\&. Note that this is different from explicitly selecting the main table 254, because of how NetworkManager removes extraneous routes from the tables\&. -.RE -.PP -\fIloopback\&.mtu\fR -.RS 4 -If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints\&. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or the MTU is left unspecified on activation\&. -.RE -.PP -\fImacsec\&.offload\fR -.RS 4 -.RE -.PP -\fIsriov\&.autoprobe\-drivers\fR -.RS 4 -If left unspecified, drivers are autoprobed when the SR\-IOV VF gets created\&. -.RE -.PP -\fIvpn\&.timeout\fR -.RS 4 -If left unspecified, default value of 60 seconds is used\&. -.RE -.PP -\fIwifi\&.ap\-isolation\fR -.RS 4 -If left unspecified, AP isolation is disabled\&. -.RE -.PP -\fIwifi\&.cloned\-mac\-address\fR -.RS 4 -If left unspecified, it defaults to "preserve"\&. -.RE -.PP -\fIwifi\&.generate\-mac\-address\-mask\fR -.RS 4 -.RE -.PP -\fIwifi\&.mac\-address\-randomization\fR -.RS 4 -If left unspecified, MAC address randomization is disabled\&. This setting is deprecated for -wifi\&.cloned\-mac\-address\&. -.RE -.PP -\fIwifi\&.mtu\fR -.RS 4 -If configured explicitly to 0, the MTU is not reconfigured during device activation unless it is required due to IPv6 constraints\&. If left unspecified, a DHCP/IPv6 SLAAC provided value is used or a default of 1500\&. -.RE -.PP -\fIwifi\&.powersave\fR -.RS 4 -If left unspecified, the default value "ignore" will be used\&. -.RE -.PP -\fIwifi\-sec\&.pmf\fR -.RS 4 -If left unspecified, the default value "optional" will be used\&. -.RE -.PP -\fIwifi\-sec\&.fils\fR -.RS 4 -If left unspecified, the default value "optional" will be used\&. -.RE -.PP -\fIwifi\&.wake\-on\-wlan\fR -.RS 4 -.RE -.PP -\fIwireguard\&.mtu\fR -.RS 4 -.RE - -.SS "Sections" -.PP -You can configure multiple -connection -sections, by having different sections with a name that all start with "connection"\&. Example: -.sp -.if n \{\ -.RS 4 -.\} -.nf -[connection] -ipv6\&.ip6\-privacy=0 -connection\&.autoconnect\-ports=1 -vpn\&.timeout=120 - -[connection\-wifi\-wlan0] -match\-device=interface\-name:wlan0 -ipv4\&.route\-metric=50 - -[connection\-wifi\-other] -match\-device=type:wifi -ipv4\&.route\-metric=55 -ipv6\&.ip6\-privacy=1 -.fi -.if n \{\ -.RE -.\} -.PP -The sections within one file are considered in order of appearance, with the exception that the -[connection] -section is always considered last\&. In the example above, this order is -[connection\-wifi\-wlan0], -[connection\-wlan\-other], and -[connection]\&. When checking for a default configuration value, the sections are searched until the requested value is found\&. In the example above, "ipv4\&.route\-metric" for wlan0 interface is set to 50, and for all other Wi\-Fi typed interfaces to 55\&. Also, Wi\-Fi devices would have IPv6 private addresses enabled by default, but other devices would have it disabled\&. Note that also "wlan0" gets "ipv6\&.ip6\-privacy=1", because although the section "[connection\-wifi\-wlan0]" matches the device, it does not contain that property and the search continues\&. -.PP -When having different sections in multiple files, sections from files that are read later have higher priority\&. So within one file the priority of the sections is top\-to\-bottom\&. Across multiple files later definitions take precedence\&. -.PP -The following properties further control how a connection section applies\&. -.PP -\fImatch\-device\fR -.RS 4 -An optional device spec that restricts when the section applies\&. See -the section called \(lqDevice List Format\(rq -for the possible values\&. -.RE -.PP -\fIstop\-match\fR -.RS 4 -An optional boolean value which defaults to -no\&. If the section matches (based on -match\-device), further sections will not be considered even if the property in question is not present\&. In the example above, if -[connection\-wifi\-wlan0] -would have -stop\-match -set to -yes, the device -wlan0 -would have -ipv6\&.ip6\-privacy -property unspecified\&. That is, the search for the property would not continue in the connection sections -[connection\-wifi\-other] -or -[connection]\&. -.RE -.SH "DEVICE SECTION" -.PP -Contains per\-device persistent configuration\&. -.PP -Example: -.sp -.if n \{\ -.RS 4 -.\} -.nf -[device] -match\-device=interface\-name:eth3 -managed=1 -.fi -.if n \{\ -.RE -.\} -.sp -.SS "Supported Properties" -.PP -The following properties can be configured per\-device\&. -.PP -\fImanaged\fR -.RS 4 -Whether the device is managed or not\&. A device can be marked as managed via udev rules (ENV{NM_UNMANAGED}), or via setting plugins (keyfile\&.unmanaged\-devices)\&. This is yet another way\&. Note that this configuration can be overruled at runtime via D\-Bus\&. Also, it has higher priority then udev rules\&. -.RE -.PP -\fIcarrier\-wait\-timeout\fR -.RS 4 -Specify the timeout for waiting for carrier in milliseconds\&. The default is 6000 milliseconds\&. This setting exists because certain drivers/hardware can take a long time to detect whether the cable is plugged in\&. -.sp -When the device loses carrier, NetworkManager does not react immediately\&. Instead, it waits for this timeout before considering the link lost\&. -.sp -Also, on startup, NetworkManager considers the device as busy for this time, as long as the device has no carrier\&. This delays startup\-complete signal and NetworkManager\-wait\-online\&. Configuring this too high means to block NetworkManager\-wait\-online longer than necessary when booting with cable unplugged\&. Configuring it too low, means that NetworkManager will declare startup\-complete too soon, although carrier is about to come and auto\-activation to kick in\&. Note that if a profile only has static IP configuration or Layer 3 configuration disabled, then it can already autoconnect without carrier on the device\&. Once such a profile reaches full activated state, startup\-complete is considered as reached even if the device has no carrier yet\&. -.RE -.PP -\fIignore\-carrier\fR -.RS 4 -Specify devices for which NetworkManager will (partially) ignore the carrier state\&. Normally, for device types that support carrier\-detect, such as Ethernet and InfiniBand, NetworkManager will only allow a connection to be activated on the device if carrier is present (ie, a cable is plugged in), and it will deactivate the device if carrier drops for more than a few seconds\&. -.sp -A device with carrier ignored will allow activating connections on that device even when it does not have carrier, provided that the connection uses only statically\-configured IP addresses\&. Additionally, it will allow any active connection (whether static or dynamic) to remain active on the device when carrier is lost\&. -.sp -Note that the "carrier" property of NMDevices and device D\-Bus interfaces will still reflect the actual device state; it\*(Aqs just that NetworkManager will not make use of that information\&. -.sp -Master types like bond, bridge and team ignore carrier by default, while other device types react on carrier changes by default\&. -.sp -This setting overwrites the deprecated -main\&.ignore\-carrier -setting above\&. -.RE -.PP -\fIkeep\-configuration\fR -.RS 4 -On startup, NetworkManager tries to not interfere with interfaces that are already configured\&. It does so by generating a in\-memory connection based on the interface current configuration\&. -.sp -If this generated connection matches one of the existing persistent connections, the persistent connection gets activated\&. If there is no match, the generated connection gets activated as "external", which means that the connection is considered as active, but NetworkManager doesn\*(Aqt actually touch the interface\&. -.sp -It is possible to disable this behavior by setting -keep\-configuration -to -no\&. In this way, on startup NetworkManager always tries to activate the most suitable persistent connection (the one with highest autoconnect\-priority or, in case of a tie, the one activated most recently)\&. -.sp -Note that when NetworkManager gets restarted, it stores the previous state in -/run/NetworkManager; in particular it saves the UUID of the connection that was previously active so that it can be activated again after the restart\&. Therefore, -keep\-configuration -does not have any effect on service restart\&. -.RE -.PP -\fIallowed\-connections\fR -.RS 4 -A list of connections that can be activated on the device\&. See -the section called \(lqConnection List Format\(rq -for the syntax to specify a connection\&. If this option is not specified, all connections can be potentially activated on the device, provided that the connection type and other settings match\&. -.sp -A notable use case for this is to filter which connections can be activated based on how they were created; see the -origin -keyword in -the section called \(lqConnection List Format\(rq\&. -.RE -.PP -\fIwifi\&.scan\-rand\-mac\-address\fR -.RS 4 -Configures MAC address randomization of a Wi\-Fi device during scanning\&. This defaults to -yes -in which case a random, locally\-administered MAC address will be used\&. The setting -wifi\&.scan\-generate\-mac\-address\-mask -allows to influence the generated MAC address to use certain vendor OUIs\&. If disabled, the MAC address during scanning is left unchanged to whatever is configured\&. For the configured MAC address while the device is associated, see instead the per\-connection setting -wifi\&.cloned\-mac\-address\&. -.RE -.PP -\fIwifi\&.backend\fR -.RS 4 -Specify the Wi\-Fi backend used for the device\&. Currently, supported are -wpa_supplicant -and -iwd -(experimental)\&. If unspecified, the default is "wpa_supplicant"\&. -.RE -.PP -\fIwifi\&.scan\-generate\-mac\-address\-mask\fR -.RS 4 -Like the per\-connection settings -ethernet\&.generate\-mac\-address\-mask -and -wifi\&.generate\-mac\-address\-mask, this allows to configure the generated MAC addresses during scanning\&. See -\fBnm-settings-nmcli\fR(5) -for details\&. -.RE -.PP -\fIwifi\&.iwd\&.autoconnect\fR -.RS 4 -If -wifi\&.backend -is -iwd, setting this to -false -forces IWD\*(Aqs autoconnect mechanism to be disabled for this device and connections will only be initiated by NetworkManager whether commanded by a client or automatically\&. Leaving it -true -(default) stops NetworkManager from automatically initiating connections and allows IWD to use its network ranking and scanning logic to decide the best networks to autoconnect to next\&. Connections\*(Aq -autoconnect\-priority, -autoconnect\-retries -settings will be ignored\&. Other settings like -permissions -or -multi\-connect -may interfere with IWD connection attempts\&. -.RE -.PP -\fIsriov\-num\-vfs\fR -.RS 4 -Specify the number of virtual functions (VF) to enable for a PCI physical device that supports single\-root I/O virtualization (SR\-IOV)\&. -.RE -.SS "Sections" -.PP -The -[device] -section works the same as the -[connection] -section\&. That is, multiple sections that all start with the prefix "device" can be specified\&. The settings "match\-device" and "stop\-match" are available to match a device section on a device\&. The order of multiple sections is also top\-down within the file and later files overwrite previous settings\&. See -\(lqSections\(rq under the section called \(lqCONNECTION SECTION\(rq -for details\&. -.SH "CONNECTIVITY SECTION" -.PP -This section controls NetworkManager\*(Aqs optional connectivity checking functionality\&. This allows NetworkManager to detect whether or not the system can actually access the internet or whether it is behind a captive portal\&. -.PP -Connectivity checking serves two purposes\&. For one, it exposes a connectivity state on D\-Bus, which other applications may use\&. For example, Gnome\*(Aqs portal helper uses this as signal to show a captive portal login page\&. The other use is that default\-route of devices without global connectivity get a penalty of +20000 to the route\-metric\&. This has the purpose to give a better default\-route to devices that have global connectivity\&. For example, when being connected to WWAN and to a Wi\-Fi network which is behind a captive portal, WWAN still gets preferred until login\&. -.PP -Note that your distribution might set -/proc/sys/net/ipv4/conf/*/rp_filter -to strict filtering\&. That works badly with per\-device connectivity checking, which uses SO_BINDDEVICE to send requests on all devices\&. A strict rp_filter setting will reject any response and the connectivity check on all but the best route will fail\&. -.PP -.PP -\fIenabled\fR -.RS 4 -Whether connectivity check is enabled\&. Note that to enable connectivity check, a valid uri must also be configured\&. The value defaults to true, but since the uri is unset by default, connectivity check may be disabled\&. The main purpose of this option is to have a single flag to disable connectivity check\&. Note that this setting can also be set via D\-Bus API at runtime\&. In that case, the value gets stored in -/var/lib/NetworkManager/NetworkManager\-intern\&.conf -file\&. -.RE -.PP -\fIuri\fR -.RS 4 -The URI of a web page to periodically request when connectivity is being checked\&. This page should return the header "X\-NetworkManager\-Status" with a value of "online"\&. Alternatively, its body content should be set to "NetworkManager is online"\&. The body content check can be controlled by the -response -option\&. If this option is blank or missing, connectivity checking is disabled\&. -.RE -.PP -\fIinterval\fR -.RS 4 -Specified in seconds; controls how often connectivity is checked when a network connection exists\&. If set to 0 connectivity checking is disabled\&. If missing, the default is 300 seconds\&. -.RE -.PP -\fItimeout\fR -.RS 4 -Specified in seconds; controls how long to wait for a response before connectivity is marked as limited\&. If missing, the default is 20 seconds\&. -.RE -.PP -\fIresponse\fR -.RS 4 -If set, controls what body content NetworkManager checks for when requesting the URI for connectivity checking\&. Note that this only compares that the HTTP response starts with the specifid text, it does not compare the exact string\&. This behavior might change in the future, so avoid relying on it\&. If missing, the response defaults to "NetworkManager is online"\&. If set to empty, the HTTP server is expected to answer with status code 204 or send no data\&. -.RE -.SH "GLOBAL\-DNS SECTION" -.PP -This section specifies DNS settings that are applied globally, in addition to connection\-specific ones\&. -.PP -.PP -\fIsearches\fR -.RS 4 -A list of search domains to be used during hostname lookup\&. -.RE -.PP -\fIoptions\fR -.RS 4 -A list of options to be passed to the hostname resolver\&. -.RE -.SH "GLOBAL\-DNS\-DOMAIN SECTIONS" -.PP -Sections with a name starting with the "global\-dns\-domain\-" prefix allow to define global DNS configuration for specific domains\&. The part of section name after "global\-dns\-domain\-" specifies the domain name a section applies to (for example, a section could be named "global\-dns\-domain\-foobar\&.com")\&. More specific domains have the precedence over less specific ones and the default domain is represented by the wildcard "*"\&. To be valid, global DNS domains must include a section for the default domain "*"\&. When the global DNS domains are valid, the name servers and domains defined globally override the ones from active connections\&. -.PP -.PP -\fIservers\fR -.RS 4 -A list of addresses of DNS servers to be used for the given domain\&. -.RE -.PP -\fIoptions\fR -.RS 4 -A list of domain\-specific DNS options\&. Not used at the moment\&. -.RE -.SH "\&.CONFIG SECTIONS" -.PP -This is a special section that contains options which apply to the configuration file that contains the option\&. -.PP -.PP -\fIenable\fR -.RS 4 -Defaults to "true"\&. If "false", the configuration file will be skipped during loading\&. Note that the main configuration file -NetworkManager\&.conf -cannot be disabled\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -# always skip loading the config file -[\&.config] -enable=false -.fi -.if n \{\ -.RE -.\} -.sp -You can also match against the version of NetworkManager\&. For example the following are valid configurations: -.sp -.if n \{\ -.RS 4 -.\} -.nf -# only load on version 1\&.0\&.6 -[\&.config] -enable=nm\-version:1\&.0\&.6 - -# load on all versions 1\&.0\&.x, but not 1\&.2\&.x -[\&.config] -enable=nm\-version:1\&.0 - -# only load on versions >= 1\&.1\&.6\&. This does not match -# with version 1\&.2\&.0 or 1\&.4\&.4\&. Only the last digit is considered\&. -[\&.config] -enable=nm\-version\-min:1\&.1\&.6 - -# only load on versions >= 1\&.2\&. Contrary to the previous -# example, this also matches with 1\&.2\&.0, 1\&.2\&.10, 1\&.4\&.4, etc\&. -[\&.config] -enable=nm\-version\-min:1\&.2 - -# Match against the maximum allowed version\&. The example matches -# versions 1\&.2\&.0, 1\&.2\&.2, 1\&.2\&.4\&. Again, only the last version digit -# is allowed to be smaller\&. So this would not match on 1\&.1\&.10\&. -[\&.config] -enable=nm\-version\-max:1\&.2\&.6 -.fi -.if n \{\ -.RE -.\} -.sp -You can also match against the value of the environment variable -NM_CONFIG_ENABLE_TAG, like: -.sp -.if n \{\ -.RS 4 -.\} -.nf -# only load the file when running NetworkManager with -# environment variable "NM_CONFIG_ENABLE_TAG=TAG1" -[\&.config] -enable=env:TAG1 -.fi -.if n \{\ -.RE -.\} -.sp -More then one match can be specified\&. The configuration will be enabled if one of the predicates matches ("or")\&. The special prefix "except:" can be used to negate the match\&. Note that if one except\-predicate matches, the entire configuration will be disabled\&. In other words, a except predicate always wins over other predicates\&. If the setting only consists of "except:" matches and none of the negative conditions are satisfied, the configuration is still enabled\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -# enable the configuration either when the environment variable -# is present or the version is at least 1\&.2\&.0\&. -[\&.config] -enable=env:TAG2,nm\-version\-min:1\&.2 - -# enable the configuration for version >= 1\&.2\&.0, but disable -# it when the environment variable is set to "TAG3" -[\&.config] -enable=except:env:TAG3,nm\-version\-min:1\&.2 - -# enable the configuration on >= 1\&.3, >= 1\&.2\&.6, and >= 1\&.0\&.16\&. -# Useful if a certain feature is only present since those releases\&. -[\&.config] -enable=nm\-version\-min:1\&.3,nm\-version\-min:1\&.2\&.6,nm\-version\-min:1\&.0\&.16 -.fi -.if n \{\ -.RE -.\} -.sp -.RE -.SH "PLUGINS" -.PP -Settings plugins for reading and writing connection profiles\&. The number of available plugins is distribution specific\&. -.PP -\fIkeyfile\fR -.RS 4 -The -keyfile -plugin is the generic plugin that supports all the connection types and capabilities that NetworkManager has\&. It writes files out in an \&.ini\-style format in -/etc/NetworkManager/system\-connections\&. See -\fBnm-settings-keyfile\fR(5) -for details about the file format\&. -.sp -The stored connection file may contain passwords, secrets and private keys in plain text, so it will be made readable only to root, and the plugin will ignore files that are readable or writable by any user or group other than root\&. See "Secret flag types" in -\fBnm-settings-nmcli\fR(5) -for how to avoid storing passwords in plain text\&. -.sp -This plugin is always active, and will automatically be used to store any connections that aren\*(Aqt supported by any other active plugin\&. -.RE -.PP -\fIifcfg\-rh\fR -.RS 4 -This plugin is now deprecated; it can be used on the Fedora and Red Hat Enterprise Linux distributions to read and write configuration from the standard -/etc/sysconfig/network\-scripts/ifcfg\-* -files\&. It currently supports reading Ethernet, Wi\-Fi, InfiniBand, VLAN, Bond, Bridge, and Team connections\&. Enabling -ifcfg\-rh -implicitly enables -ibft -plugin, if it is available\&. This can be disabled by adding -no\-ibft\&. See -/usr/share/doc/initscripts/sysconfig\&.txt -and -\fBnm-settings-ifcfg-rh\fR(5) -for more information about the ifcfg file format\&. -.RE -.PP -\fIifupdown\fR -.RS 4 -This plugin is used on the Debian and Ubuntu distributions, and reads Ethernet and Wi\-Fi connections from -/etc/network/interfaces\&. -.sp -This plugin is read\-only; any connections (of any type) added from within NetworkManager when you are using this plugin will be saved using the -keyfile -plugin instead\&. -.RE -.PP -\fIibft\fR, \fIno\-ibft\fR -.RS 4 -These plugins are deprecated and their selection has no effect\&. This is now handled by nm\-initrd\-generator\&. -.RE -.PP -\fIifcfg\-suse\fR, \fIifnet\fR -.RS 4 -These plugins are deprecated and their selection has no effect\&. The -keyfile -plugin should be used instead\&. -.RE -.SH "APPENDIX" -.SS "Device List Format" -.PP -The configuration options -main\&.no\-auto\-default, -main\&.ignore\-carrier, -keyfile\&.unmanaged\-devices, -connection*\&.match\-device -and -device*\&.match\-device -select devices based on a list of matchings\&. Devices can be specified using the following format: -.PP -.PP -* -.RS 4 -Matches every device\&. -.RE -.PP -IFNAME -.RS 4 -Case sensitive match of interface name of the device\&. Globbing is not supported\&. -.RE -.PP -HWADDR -.RS 4 -Match the permanent MAC address of the device\&. Globbing is not supported -.RE -.PP -interface\-name:IFNAME, interface\-name:~IFNAME -.RS 4 -Case sensitive match of interface name of the device\&. Simple globbing is supported with -* -and -?\&. Ranges and escaping is not supported\&. -.RE -.PP -interface\-name:=IFNAME -.RS 4 -Case sensitive match of interface name of the device\&. Globbing is disabled and -IFNAME -is taken literally\&. -.RE -.PP -mac:HWADDR -.RS 4 -Match the permanent MAC address of the device\&. Globbing is not supported -.RE -.PP -s390\-subchannels:HWADDR -.RS 4 -Match the device based on the subchannel address\&. Globbing is not supported -.RE -.PP -type:TYPE -.RS 4 -Match the device type\&. Valid type names are as reported by "nmcli \-f GENERAL\&.TYPE device show"\&. Globbing is not supported\&. -.RE -.PP -driver:DRIVER -.RS 4 -Match the device driver as reported by "nmcli \-f GENERAL\&.DRIVER,GENERAL\&.DRIVER\-VERSION device show"\&. "DRIVER" must match the driver name exactly and does not support globbing\&. Optionally, a driver version may be specified separated by \*(Aq/\*(Aq\&. Globbing is supported for the version\&. -.RE -.PP -dhcp\-plugin:DHCP -.RS 4 -Match the configured DHCP plugin "main\&.dhcp"\&. -.RE -.PP -except:SPEC -.RS 4 -Negative match of a device\&. -SPEC -must be explicitly qualified with a prefix such as -interface\-name:\&. A negative match has higher priority then the positive matches above\&. -.sp -If there is a list consisting only of negative matches, the behavior is the same as if there is also match\-all\&. That means, if none of all the negative matches is satisfied, the overall result is still a positive match\&. That means, -"except:interface\-name:eth0" -is the same as -"*,except:interface\-name:eth0"\&. -.RE -.PP -SPEC[,;]SPEC -.RS 4 -Multiple specs can be concatenated with commas or semicolons\&. The order does not matter as matches are either inclusive or negative (except:), with negative matches having higher priority\&. -.sp -Backslash is supported to escape the separators \*(Aq;\*(Aq and \*(Aq,\*(Aq, and to express special characters such as newline (\*(Aq\en\*(Aq), tabulator (\*(Aq\et\*(Aq), whitespace (\*(Aq\es\*(Aq) and backslash (\*(Aq\e\e\*(Aq)\&. The globbing of interface names cannot be escaped\&. Whitespace is not a separator but will be trimmed between two specs (unless escaped as \*(Aq\es\*(Aq)\&. -.RE -.PP -Example: -.sp -.if n \{\ -.RS 4 -.\} -.nf -interface\-name:em4 -mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface\-name:eth2 -interface\-name:vboxnet*,except:interface\-name:vboxnet2 -*,except:mac:00:22:68:1c:59:b1 -.fi -.if n \{\ -.RE -.\} -.sp -.SS "Connection List Format" -.PP -Connections can be specified using the following format: -.PP -.PP -* -.RS 4 -Matches every connection\&. -.RE -.PP -uuid:UUID -.RS 4 -Match the connection by UUID, for example -"uuid:83037490\-1d17\-4986\-a397\-01f1db3a7fc2" -.RE -.PP -id=ID -.RS 4 -Match the connection by name\&. -.RE -.PP -origin:ORIGIN -.RS 4 -Match the connection by origin, stored in the -org\&.freedesktop\&.NetworkManager\&.origin -tag of the user setting\&. For example, use -"except:origin:nm\-initrd\-generator" -to forbid activation of connections created by the initrd generator\&. -.RE -.PP -except:SPEC -.RS 4 -Negative match of a connection\&. A negative match has higher priority then the positive matches above\&. -.sp -If there is a list consisting only of negative matches, the behavior is the same as if there is also match\-all\&. That means, if none of all the negative matches is satisfied, the overall result is still a positive match\&. -.RE -.PP -SPEC[,;]SPEC -.RS 4 -Multiple specs can be concatenated with commas or semicolons\&. The order does not matter as matches are either inclusive or negative (except:), with negative matches having higher priority\&. -.sp -Backslash is supported to escape the separators \*(Aq;\*(Aq and \*(Aq,\*(Aq, and to express special characters such as newline (\*(Aq\en\*(Aq), tabulator (\*(Aq\et\*(Aq), whitespace (\*(Aq\es\*(Aq) and backslash (\*(Aq\e\e\*(Aq)\&. Whitespace is not a separator but will be trimmed between two specs (unless escaped as \*(Aq\es\*(Aq)\&. -.RE -.SH "SEE ALSO" -.PP -\fBNetworkManager\fR(8), -\fBnmcli\fR(1), -\fBnmcli-examples\fR(7), -\fBnm-online\fR(1), -\fBnm-settings-nmcli\fR(5), -\fBnm-applet\fR(1), -\fBnm-connection-editor\fR(1) diff --git a/man/nm-cloud-setup.8 b/man/nm-cloud-setup.8 deleted file mode 100644 index a3f1f202..00000000 --- a/man/nm-cloud-setup.8 +++ /dev/null @@ -1,561 +0,0 @@ -'\" t -.\" Title: nm-cloud-setup -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: Automatic Network Configuration in Cloud with NetworkManager -.\" Source: NetworkManager 1.50.0 -.\" Language: English -.\" -.TH "NM\-CLOUD\-SETUP" "8" "" "NetworkManager 1\&.50\&.0" "Automatic Network Configuratio" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nm-cloud-setup \- Overview of Automatic Network Configuration in Cloud -.SH "OVERVIEW" -.PP -When running a virtual machine in a public cloud environment, it is desirable to automatically configure the network of that VM\&. In simple setups, the VM only has one network interface and the public cloud supports automatic configuration via DHCP, DHCP6 or IPv6 autoconf\&. However, the virtual machine might have multiple network interfaces, or multiple IP addresses and IP subnets on one interface which cannot be configured via DHCP\&. Also, the administrator may reconfigure the network while the machine is running\&. NetworkManager\*(Aqs nm\-cloud\-setup is a tool that automatically picks up such configuration in cloud environments and updates the network configuration of the host\&. -.PP -Multiple cloud providers are supported\&. See -the section called \(lqSUPPORTED CLOUD PROVIDERS\(rq\&. -.SH "USE" -.PP -The goal of nm\-cloud\-setup is to be configuration\-less and work automatically\&. All you need is to opt\-in to the desired cloud providers (see -the section called \(lqENVIRONMENT VARIABLES\(rq) and run -\fB/usr/libexec/nm\-cloud\-setup\fR\&. -.PP -Usually this is done by enabling the nm\-cloud\-setup\&.service systemd service and let it run periodically\&. For that there is both a nm\-cloud\-setup\&.timer systemd timer and a NetworkManager dispatcher script\&. -.SH "DETAILS" -.PP -nm\-cloud\-setup configures the network by fetching the configuration from the well\-known meta data server of the cloud provider\&. That means, it already needs the network configured to the point where it can reach the meta data server\&. Commonly that means, that a simple connection profile is activated that possibly uses DHCP to get the primary IP address\&. NetworkManager will create such a profile for ethernet devices automatically if it is not configured otherwise via -"no\-auto\-default" -setting in NetworkManager\&.conf\&. One possible alternative may be to create such an initial profile with -\fBnmcli device connect "$DEVICE"\fR -or -\fBnmcli connection add type ethernet \&.\&.\&.\fR\&. -.PP -By setting the user\-data -org\&.freedesktop\&.nm\-cloud\-setup\&.skip=yes -on the profile, nm\-cloud\-setup will skip the device\&. -.PP -nm\-cloud\-setup modifies the run time configuration akin to -\fBnmcli device modify\fR\&. With this approach, the configuration is not persisted and only preserved until the device disconnects\&. -.SS "/usr/libexec/nm\-cloud\-setup" -.PP -The binary -\fB/usr/libexec/nm\-cloud\-setup\fR -does most of the work\&. It supports no command line arguments but can be configured via environment variables\&. See -the section called \(lqENVIRONMENT VARIABLES\(rq -for the supported environment variables\&. -.PP -By default, all cloud providers are disabled unless you opt\-in by enabling one or several providers\&. If cloud providers are enabled, the program tries to fetch the host\*(Aqs configuration from a meta data server of the cloud via HTTP\&. If configuration could be not fetched, no cloud provider are detected and the program quits\&. If host configuration is obtained, the corresponding cloud provider is successfully detected\&. Then the network of the host will be configured\&. -.PP -It is intended to re\-run nm\-cloud\-setup every time when the configuration (maybe) changes\&. The tool is idempotent, so it should be OK to also run it more often than necessary\&. You could run -\fB/usr/libexec/nm\-cloud\-setup\fR -directly\&. However it may be preferable to restart the nm\-cloud\-setup systemd service instead or use the timer or dispatcher script to run it periodically (see below)\&. -.SS "nm\-cloud\-setup\&.service systemd unit" -.PP -Usually -\fB/usr/libexec/nm\-cloud\-setup\fR -is not run directly, but only by -\fBsystemctl restart nm\-cloud\-setup\&.service\fR\&. This ensures that the tool only runs once at any time\&. It also allows to integrate with the nm\-cloud\-setup systemd timer, and to enable/disable the service via systemd\&. -.PP -As you need to set environment variable to configure nm\-cloud\-setup binary, you can do so via systemd override files\&. Try -\fBsystemctl edit nm\-cloud\-setup\&.service\fR\&. -.SS "nm\-cloud\-setup\&.timer systemd timer" -.PP -\fB/usr/libexec/nm\-cloud\-setup\fR -is intended to run whenever an update is necessary\&. For example, during boot when when changing the network configuration of the virtual machine via the cloud provider\&. -.PP -One way to do this, is by enabling the nm\-cloud\-setup\&.timer systemd timer with -\fBsystemctl enable \-\-now nm\-cloud\-setup\&.timer\fR\&. -.SS "/usr/lib/NetworkManager/dispatcher\&.d/90\-nm\-cloud\-setup\&.sh" -.PP -There is also a NetworkManager dispatcher script that will run for example when an interface is activated by NetworkManager\&. Together with the nm\-cloud\-setup\&.timer systemd timer this script is to automatically pick up changes to the network\&. -.PP -The dispatcher script will do nothing, unless the systemd service is enabled\&. To use the dispatcher script you should therefor run -\fBsystemctl enable nm\-cloud\-setup\&.service\fR -once\&. -.SH "ENVIRONMENT VARIABLES" -.PP -The following environment variables are used to configure -\fB/usr/libexec/nm\-cloud\-setup\fR\&. You may want to configure them with a drop\-in for the systemd service\&. For example by calling -\fBsystemctl edit nm\-cloud\-setup\&.service\fR -and configuring -[Service] Environment=, as described in -\fBsystemd.exec\fR(5) -manual\&. -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -NM_CLOUD_SETUP_LOG: control the logging verbosity\&. Set it to one of -TRACE, -DEBUG, -INFO, -WARN, -ERR -or -OFF\&. The program will print message on stdout and the default level is -WARN\&. When run as systemd service, the log will be collected by journald can can be seen with -\fBjournalctl\fR\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -NM_CLOUD_SETUP_AZURE: boolean, whether Microsoft Azure support is enabled\&. Defaults to -no\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -NM_CLOUD_SETUP_EC2: boolean, whether Amazon EC2 (AWS) support is enabled\&. Defaults to -no\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -NM_CLOUD_SETUP_GCP: boolean, whether Google GCP support is enabled\&. Defaults to -no\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -NM_CLOUD_SETUP_ALIYUN: boolean, whether Alibaba Cloud (Aliyun) support is enabled\&. Defaults to -no\&. -.RE -.SH "DEBUGGING" -.PP -Enable debug logging by setting -NM_CLOUD_SETUP_LOG -environment variable to -TRACE\&. -.PP -In the common case where nm\-cloud\-setup is running as systemd service, this can be done via -\fBsystemctl edit nm\-cloud\-setup\&.service\fR -and add -Environment=NM_CLOUD_SETUP_LOG=TRACE -to the -[Service] -section\&. Afterwards, the log can be found in syslog via -journalctl\&. You may also want to enable debug logging in NetworkManager as descibed in the DEBUGGING section in -\fBNetworkManager\fR(5) -manual\&. When sharing logs, it\*(Aqs best to share complete logs and not preemptively filter for NetworkManager or nm\-cloud\-setup logs\&. -.SH "EXAMPLE SETUP FOR CONFIGURING AND PREDEPLOYING NM\-CLOUD\-SETUP" -.PP -As detailed before, nm\-cloud\-setup needs to be explicitly enabled\&. As it runs as a systemd service and timer, that basically means to enable and configure those\&. This can be done by dropping the correct files and symlinks to disk\&. -.PP -The following example enables nm\-cloud\-setup for Amazon EC2 cloud: -.sp -.if n \{\ -.RS 4 -.\} -.nf -dnf install \-y NetworkManager\-cloud\-setup - -mkdir \-p /etc/systemd/system/nm\-cloud\-setup\&.service\&.d -cat > /etc/systemd/system/nm\-cloud\-setup\&.service\&.d/10\-enable\-ec2\&.conf << EOF -[Service] -Environment=NM_CLOUD_SETUP_EC2=yes -EOF - -# systemctl enable nm\-cloud\-setup\&.service -mkdir \-p /etc/systemd/system/NetworkManager\&.service\&.wants/ -ln \-s /usr/lib/systemd/system/nm\-cloud\-setup\&.service /etc/systemd/system/NetworkManager\&.service\&.wants/nm\-cloud\-setup\&.service - -# systemctl enable nm\-cloud\-setup\&.timer -mkdir \-p /etc/systemd/system/timers\&.target\&.wants/ -ln \-s /etc/systemd/system/timers\&.target\&.wants/nm\-cloud\-setup\&.timer /usr/lib/systemd/system/nm\-cloud\-setup\&.timer - -# systemctl daemon\-reload - -.fi -.if n \{\ -.RE -.\} -.sp -.SH "SUPPORTED CLOUD PROVIDERS" -.SS "Amazon EC2 (AWS)" -.PP -For AWS, the tools tries to fetch configuration from -http://169\&.254\&.169\&.254/\&. Currently, it only configures IPv4 and does nothing about IPv6\&. It will do the following\&. -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -First fetch -http://169\&.254\&.169\&.254/latest/meta\-data/ -to determine whether the expected API is present\&. This determines whether EC2 environment is detected and whether to proceed to configure the host using EC2 meta data\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Fetch -http://169\&.254\&.169\&.254/2018\-09\-24/meta\-data/network/interfaces/macs/ -to get the list of available interface\&. Interfaces are identified by their MAC address\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Then for each interface fetch -http://169\&.254\&.169\&.254/2018\-09\-24/meta\-data/network/interfaces/macs/$MAC/subnet\-ipv4\-cidr\-block -and -http://169\&.254\&.169\&.254/2018\-09\-24/meta\-data/network/interfaces/macs/$MAC/local\-ipv4s\&. Thereby we get a list of local IPv4 addresses and one CIDR subnet block\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Then nm\-cloud\-setup iterates over all interfaces for which it could fetch IP configuration\&. If no ethernet device for the respective MAC address is found, it is skipped\&. Also, if the device is currently not activated in NetworkManager or if the currently activated profile has a user\-data -org\&.freedesktop\&.nm\-cloud\-setup\&.skip=yes, it is skipped\&. -.sp -If only one interface and one address is configured, then the tool does nothing and leaves the automatic configuration that was obtained via DHCP\&. -.sp -Otherwise, the tool will change the runtime configuration of the device\&. -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Add static IPv4 addresses for all the configured addresses from -local\-ipv4s -with prefix length according to -subnet\-ipv4\-cidr\-block\&. For example, we might have here 2 IP addresses like -"172\&.16\&.5\&.3/24,172\&.16\&.5\&.4/24"\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Choose a route table 30400 + the index of the interface and add a default route -0\&.0\&.0\&.0/0\&. The gateway is the first IP address in the CIDR subnet block\&. For example, we might get a route -"0\&.0\&.0\&.0/0 172\&.16\&.5\&.1 10 table=30400"\&. -.sp -Also choose a route table 30200 + the interface index\&. This contains a direct routes to the subnets of this interface\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Finally, add a policy routing rule for each address\&. For example -"priority 30200 from 172\&.16\&.5\&.3/32 table 30200, priority 30200 from 172\&.16\&.5\&.4/32 table 30200"\&. and -"priority 30400 from 172\&.16\&.5\&.3/32 table 30400, priority 30400 from 172\&.16\&.5\&.4/32 table 30400" -The 30200+ rules select the table to reach the subnet directly, while the 30400+ rules use the default route\&. Also add a rule -"priority 30350 table main suppress_prefixlength 0"\&. This has a priority between the two previous rules and causes a lookup of routes in the main table while ignoring the default route\&. The purpose of this is so that other specific routes in the main table are honored over the default route in table 30400+\&. -.RE -.sp -With above example, this roughly corresponds for interface -eth0 -to -\fBnmcli device modify "eth0" ipv4\&.addresses "172\&.16\&.5\&.3/24,172\&.16\&.5\&.4/24" ipv4\&.routes "172\&.16\&.5\&.0/24 0\&.0\&.0\&.0 10 table=30200, 0\&.0\&.0\&.0/0 172\&.16\&.5\&.1 10 table=30400" ipv4\&.routing\-rules "priority 30200 from 172\&.16\&.5\&.3/32 table 30200, priority 30200 from 172\&.16\&.5\&.4/32 table 30200, priority 20350 table main suppress_prefixlength 0, priority 30400 from 172\&.16\&.5\&.3/32 table 30400, priority 30400 from 172\&.16\&.5\&.4/32 table 30400"\fR\&. Note that this replaces the previous addresses, routes and rules with the new information\&. But also note that this only changes the run time configuration of the device\&. The connection profile on disk is not affected\&. -.RE -.SS "Google Cloud Platform (GCP)" -.PP -For GCP, the meta data is fetched from URIs starting with -http://metadata\&.google\&.internal/computeMetadata/v1/ -with a HTTP header -"Metadata\-Flavor: Google"\&. Currently, the tool only configures IPv4 and does nothing about IPv6\&. It will do the following\&. -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -First fetch -http://metadata\&.google\&.internal/computeMetadata/v1/instance/id -to detect whether the tool runs on Google Cloud Platform\&. Only if the platform is detected, it will continue fetching the configuration\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Fetch -http://metadata\&.google\&.internal/computeMetadata/v1/instance/network\-interfaces/ -to get the list of available interface indexes\&. These indexes can be used for further lookups\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Then, for each interface fetch -http://metadata\&.google\&.internal/computeMetadata/v1/instance/network\-interfaces/$IFACE_INDEX/mac -to get the corresponding MAC address of the found interfaces\&. The MAC address is used to identify the device later on\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Then, for each interface with a MAC address fetch -http://metadata\&.google\&.internal/computeMetadata/v1/instance/network\-interfaces/$IFACE_INDEX/forwarded\-ips/ -and then all the found IP addresses at -http://metadata\&.google\&.internal/computeMetadata/v1/instance/network\-interfaces/$IFACE_INDEX/forwarded\-ips/$FIPS_INDEX\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -At this point, we have a list of all interfaces (by MAC address) and their configured IPv4 addresses\&. -.sp -For each device, we lookup the currently applied connection in NetworkManager\&. That implies, that the device is currently activated in NetworkManager\&. If no such device was in NetworkManager, or if the profile has user\-data -org\&.freedesktop\&.nm\-cloud\-setup\&.skip=yes, we skip the device\&. Now for each found IP address we add a static route "$FIPS_ADDR/32 0\&.0\&.0\&.0 100 type=local" and reapply the change\&. -.sp -The effect is not unlike calling -\fBnmcli device modify "$DEVICE" ipv4\&.routes "$FIPS_ADDR/32 0\&.0\&.0\&.0 100 type=local [,\&.\&.\&.]"\fR -for all relevant devices and all found addresses\&. -.RE -.SS "Microsoft Azure" -.PP -For Azure, the meta data is fetched from URIs starting with -http://169\&.254\&.169\&.254/metadata/instance -with a URL parameter -"?format=text&api\-version=2017\-04\-02" -and a HTTP header -"Metadata:true"\&. Currently, the tool only configures IPv4 and does nothing about IPv6\&. It will do the following\&. -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -First fetch -http://169\&.254\&.169\&.254/metadata/instance?format=text&api\-version=2017\-04\-02 -to detect whether the tool runs on Azure Cloud\&. Only if the platform is detected, it will continue fetching the configuration\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Fetch -http://169\&.254\&.169\&.254/metadata/instance/network/interface/?format=text&api\-version=2017\-04\-02 -to get the list of available interface indexes\&. These indexes can be used for further lookups\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Then, for each interface fetch -http://169\&.254\&.169\&.254/metadata/instance/network/interface/$IFACE_INDEX/macAddress?format=text&api\-version=2017\-04\-02 -to get the corresponding MAC address of the found interfaces\&. The MAC address is used to identify the device later on\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Then, for each interface with a MAC address fetch -http://169\&.254\&.169\&.254/metadata/instance/network/interface/$IFACE_INDEX/ipv4/ipAddress/?format=text&api\-version=2017\-04\-02 -to get the list of (indexes of) IP addresses on that interface\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Then, for each IP address index fetch the address at -http://169\&.254\&.169\&.254/metadata/instance/network/interface/$IFACE_INDEX/ipv4/ipAddress/$ADDR_INDEX/privateIpAddress?format=text&api\-version=2017\-04\-02\&. Also fetch the size of the subnet and prefix for the interface from -http://169\&.254\&.169\&.254/metadata/instance/network/interface/$IFACE_INDEX/ipv4/subnet/0/address/?format=text&api\-version=2017\-04\-02\&. and -http://169\&.254\&.169\&.254/metadata/instance/network/interface/$IFACE_INDEX/ipv4/subnet/0/prefix/?format=text&api\-version=2017\-04\-02\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -At this point, we have a list of all interfaces (by MAC address) and their configured IPv4 addresses\&. -.sp -Then the tool configures the system like doing for AWS environment\&. That is, using source based policy routing with the tables/rules 30200/30400\&. -.RE -.SS "Alibaba Cloud (Aliyun)" -.PP -For Aliyun, the tools tries to fetch configuration from -http://100\&.100\&.100\&.200/\&. Currently, it only configures IPv4 and does nothing about IPv6\&. It will do the following\&. -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -First fetch -http://100\&.100\&.100\&.200/2016\-01\-01/meta\-data/ -to determine whether the expected API is present\&. This determines whether Aliyun environment is detected and whether to proceed to configure the host using Aliyun meta data\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Fetch -http://100\&.100\&.100\&.200/2016\-01\-01/meta\-data/network/interfaces/macs/ -to get the list of available interface\&. Interfaces are identified by their MAC address\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Then for each interface fetch -http://100\&.100\&.100\&.200/2016\-01\-01/meta\-data/network/interfaces/macs/$MAC/vpc\-cidr\-block, -http://100\&.100\&.100\&.200/2016\-01\-01/meta\-data/network/interfaces/macs/$MAC/private\-ipv4s, -http://100\&.100\&.100\&.200/2016\-01\-01/meta\-data/network/interfaces/macs/$MAC/netmask -and -http://100\&.100\&.100\&.200/2016\-01\-01/meta\-data/network/interfaces/macs/$MAC/gateway\&. Thereby we get a list of private IPv4 addresses, one CIDR subnet block and private IPv4 addresses prefix\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Then nm\-cloud\-setup iterates over all interfaces for which it could fetch IP configuration\&. If no ethernet device for the respective MAC address is found, it is skipped\&. Also, if the device is currently not activated in NetworkManager or if the currently activated profile has a user\-data -org\&.freedesktop\&.nm\-cloud\-setup\&.skip=yes, it is skipped\&. Also, there is only one interface and one IP address, the tool does nothing\&. -.sp -Then the tool configures the system like doing for AWS environment\&. That is, using source based policy routing with the tables/rules 30200/30400\&. One difference to AWS is that the gateway is also fetched via metadata instead of using the first IP address in the subnet\&. -.RE -.SH "SEE ALSO" -.PP -\fBNetworkManager\fR(8) -\fBnmcli\fR(1) diff --git a/man/nm-initrd-generator.8 b/man/nm-initrd-generator.8 deleted file mode 100644 index 2dfe8e69..00000000 --- a/man/nm-initrd-generator.8 +++ /dev/null @@ -1,234 +0,0 @@ -'\" t -.\" Title: nm-initrd-generator -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: System Administration -.\" Source: NetworkManager 1.50.0 -.\" Language: English -.\" -.TH "NM\-INITRD\-GENERATOR" "8" "" "NetworkManager 1\&.50\&.0" "System Administration" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nm-initrd-generator \- early boot NetworkManager configuration generator -.SH "SYNOPSIS" -.HP \w'\fBnm\-initrd\-generator\fR\ 'u -\fBnm\-initrd\-generator\fR [\fIOPTIONS\fR...] \-\- [\fICMDLINE\fR...] -.SH "DESCRIPTION" -.PP -\fBnm\-initrd\-generator\fR -scans the command line for options relevant to network configuration and creates configuration files for an early instance of NetworkManager run from the initial ramdisk during early boot\&. -.SH "OPTIONS" -.PP -\fB\-c\fR | \fB\-\-connections\-dir\fR \fIpath\fR -.RS 4 -Output connection directory\&. -.RE -.PP -\fB\-p\fR | \fB\-\-persistent\-connections\-dir\fR \fIpath\fR -.RS 4 -Persistent connection directory\&. If it exists, rd\&.neednet will not cause a default connection to be generated in absence of other options\&. -.RE -.PP -\fB\-i\fR | \fB\-\-initrd\-data\-dir\fR \fIpath\fR -.RS 4 -Output directory for initrd data (e\&.g\&. hostname)\&. -.RE -.PP -\fB\-d\fR | \fB\-\-sysfs\-dir\fR \fIpath\fR -.RS 4 -The sysfs mount point\&. -.RE -.PP -\fB\-r\fR | \fB\-\-run\-config\-dir\fR \fIpath\fR -.RS 4 -Output directory for config files\&. -.RE -.PP -\fB\-s\fR | \fB\-\-stdout\fR -.RS 4 -Dump connections to standard output\&. Useful for debugging\&. -.RE -.PP -\fICMDLINE\fR -.RS 4 -The options that appear on the kernel command line\&. The following options are recognized: -.RS 4 -\fBip\fR -.RE -.RS 4 -\fBrd\&.route\fR -.RE -.RS 4 -\fBbridge\fR -.RE -.RS 4 -\fBbond\fR -.RE -.RS 4 -\fBteam\fR -.RE -.RS 4 -\fBvlan\fR -.RE -.RS 4 -\fBib\&.pkey\fR -.RE -.RS 4 -\fBbootdev\fR -.RE -.RS 4 -\fBnameserver\fR -.RE -.RS 4 -\fBnet\&.ifnames\fR -.RE -.RS 4 -\fBrd\&.peerdns\fR -.RE -.RS 4 -\fBrd\&.iscsi\&.ibft\fR -.RE -.RS 4 -\fBrd\&.bootif\fR -.RE -.RS 4 -\fBrd\&.neednet\fR -.RE -.RS 4 -\fBrd\&.ethtool\fR -.RE -.RS 4 -\fBrd\&.net\&.timeout\&.dhcp\fR -.RE -.RS 4 -\fBrd\&.net\&.dhcp\&.retry\fR -.RE -.RS 4 -\fBrd\&.net\&.dhcp\&.vendor\-class\fR -.RE -.RS 4 -\fBrd\&.net\&.dhcp\&.dscp\fR -.RE -.RS 4 -\fBrd\&.net\&.timeout\&.carrier\fR -.RE -.RS 4 -\fBrd\&.znet\fR -.RE -.RS 4 -\fBrd\&.znet_ifname\fR -.RE -.RS 4 -\fBBOOTIF\fR -.RE -Please consult the -\fBdracut.cmdline\fR(7) -manual for the documentation of the precise format of the values supported\&. -.RE -.SH "DIFFERENCES FROM THE NETWORK\-LEGACY DRACUT MODULE" -.PP -\fBnm\-initrd\-generator\fR -generates a set of connections that are then configured by the NetworkManager instance running in the initrd\&. There are some differences in behavior compared to the network\-legacy dracut module: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -When an interface is configured with a static address and a gateway, the network\-legacy module waits that the gateway responds to arping requests before proceeding, while NetworkManager doesn\*(Aqt\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -network\-legacy configures interfaces one by one in the order in which they are announced by udev\&. If multiple interfaces specify a hostname (from command line or from DHCP), the one from the last interface activated wins\&. With NetworkManager, hostnames from command line have higher precedence over ones from DHCP, and the last that appears in the command line wins\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -NetworkManager supports the -\fBib\&.pkey\fR=\fIPARENT\fR\&.\fIPKEY\fR -argument to set up an Infiniband partition on IPoIB parent device -\fIPARENT\fR -using the specified partition key -\fIPKEY\fR\&. The partition key must be in hexadecimal notation without leading "0x", for example "ib\&.pkey=ib0\&.8004"\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -NetworkManager supports the -\fBrd\&.ethtool\fR=\fIINTERFACE\fR:\fIAUTONEG\fR:\fISPEED\fR -kernel command line option to set up ethtool NIC configuration parameters -\fIAUTONEG\fR -and -\fISPEED\fR\&. The -\fIINTERFACE\fR -being configured must be specified, and the other parameters are optional and can be left blank\&. When -\fISPEED\fR -is set, duplex mode is automatically set to \*(Aqfull\*(Aq\&. -\fIINTERFACE\fR -accepts string values, -\fIAUTONEG\fR -accepts boolean values (true and false / on or off / 0 or 1), and -\fISPEED\fR -accepts positive integer values\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -NetworkManager supports the -\fBrd\&.net\&.dhcp\&.dscp\fR={\fICS0\fR|\fICS4\fR|\fICS6\fR} kernel command line option to set a specific DSCP (TOS) value in the IP header of DHCP messages\&. -.RE -.SH "EXIT STATUS" -.PP -\fBnm\-initrd\-generator\fR -exits with status 0\&. It ignores unrecognized options and prints an error message if it encounters a malformed option\&. -.SH "SEE ALSO" -.PP -\fBdracut.cmdline\fR(7), -\fBNetworkManager\fR(8)\&. diff --git a/man/nm-online.1 b/man/nm-online.1 deleted file mode 100644 index b43ffd69..00000000 --- a/man/nm-online.1 +++ /dev/null @@ -1,117 +0,0 @@ -'\" t -.\" Title: nm-online -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: General Commands Manual -.\" Source: NetworkManager 1.50.0 -.\" Language: English -.\" -.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.50\&.0" "General Commands Manual" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nm-online \- ask NetworkManager whether the network is connected -.SH "SYNOPSIS" -.HP \w'\fBnm\-online\fR\ 'u -\fBnm\-online\fR [\fIOPTIONS\fR...] -.SH "DESCRIPTION" -.PP -\fBnm\-online\fR -is a utility to find out whether we are online\&. It is done by asking NetworkManager about its status\&. When run, -\fBnm\-online\fR -waits until NetworkManager reports an active connection, or specified timeout expires\&. On exit, the returned status code should be checked (see the return codes below)\&. -.PP -This tool is not very useful to call directly\&. It is however used by -NetworkManager\-wait\-online\&.service -with -\-\-wait\-for\-startup -argument (see -\fBNetworkManager-wait-online.service\fR(8))\&. -.PP -By default, connections have the -ipv4\&.may\-fail -and -ipv6\&.may\-fail -properties set to -yes; this means that NetworkManager waits for one of the two address families to complete configuration before considering the connection activated\&. If you need a specific address family configured before -network\-online\&.target -is reached, set the corresponding -may\-fail -property to -no\&. -.SH "OPTIONS" -.PP -\fB\-h\fR | \fB\-\-help\fR -.RS 4 -Print help information\&. -.RE -.PP -\fB\-q\fR | \fB\-\-quiet\fR -.RS 4 -Don\*(Aqt print anything\&. -.RE -.PP -\fB\-s\fR | \fB\-\-wait\-for\-startup\fR -.RS 4 -Wait for NetworkManager startup to complete, rather than waiting for network connectivity specifically\&. Startup is considered complete once NetworkManager has activated (or attempted to activate) every auto\-activate connection which is available given the current network state\&. This corresponds to the moment when NetworkManager logs -"startup complete"\&. This mode is generally only useful at boot time\&. After startup has completed, -\fBnm\-online \-s\fR -will just return immediately, regardless of the current network state\&. -.sp -There are various ways to affect when startup complete is reached\&. For details see -\fBNetworkManager-wait-online.service\fR(8)\&. -.RE -.PP -\fB\-t\fR | \fB\-\-timeout\fR \fIseconds\fR -.RS 4 -Time to wait for a connection, in seconds\&. If the option is not provided, the environment variable -NM_ONLINE_TIMEOUT -is honored\&. The default timeout is 30 seconds\&. -.RE -.PP -\fB\-x\fR | \fB\-\-exit\fR -.RS 4 -Exit immediately if NetworkManager is not running or connecting\&. -.RE -.SH "EXIT STATUS" -.PP -\fBnm\-online\fR -exits with status 0 if it succeeds, a value greater than 0 is returned if an error occurs\&. -.PP -\fB0\fR -.RS 4 -Success \(en already online or connection established within given timeout\&. -.RE -.PP -\fB1\fR -.RS 4 -Offline or not online within given timeout\&. -.RE -.PP -\fB2\fR -.RS 4 -Unknown or unspecified error\&. -.RE -.SH "SEE ALSO" -.PP -\fBnmcli\fR(1), -\fBNetworkManager\fR(8), -\fBNetworkManager-wait-online.service\fR(8)\&. diff --git a/man/nm-openvswitch.7 b/man/nm-openvswitch.7 deleted file mode 100644 index 294ac00c..00000000 --- a/man/nm-openvswitch.7 +++ /dev/null @@ -1,236 +0,0 @@ -'\" t -.\" Title: nm-openvswitch -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: Open vSwitch support overview -.\" Source: NetworkManager 1.50.0 -.\" Language: English -.\" -.TH "NM\-OPENVSWITCH" "7" "" "NetworkManager 1\&.50\&.0" "Open vSwitch support overview" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nm-openvswitch \- overview of NetworkManager Open vSwitch support -.SH "OVERVIEW" -.PP -NetworkManager includes basic Open vSwitch support, good enough to be capable of setting up simple Open vSwitch configurations\&. It is not extensive and does not expose all functionality of Open vSwitch provides\&. For large or complicated deployments users are advised to use native tools shipped with Open vSwitch\&. This document seeks to provide overview of functionality currently provided by NetworkManager, its capabilities and limitations\&. -.PP -First and foremost: NetworkManager applies the configuration by modifying the OVSDB directly\&. Its configuration model follows the OVSDB database model closely and it does not provide the level of abstraction -\fBovs\-vsctl\fR -provides\&. -.PP -In practical terms it means the following: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -NetworkManager only ever talks to a single OVSDB instance via an UNIX domain socket\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -The configuration is made up of Bridges, Ports and Interfaces\&. Interfaces are always attached to Ports, and Ports are always attached to Bridges\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -NetworkManager only creates Bridges, Ports and Interfaces you ask it to\&. Unlike -\fBovs\-vsctl\fR, it doesn\*(Aqt create the local interface nor its port automatically\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -You can\*(Aqt attach Interface directly to a Bridge\&. You always need a Port, even if it has just one interface\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -There are no VLANs\&. The VLAN tagging is enabled by setting a -ovs\-port\&.tag -property on a Port\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -There are no bonds either\&. The bonding is enabled by enslaving multiple Interfaces to a Port and configured by setting properties on a port\&. -.RE -.sp -.SS "Bridges" -.PP -Bridges are represented by connections of ovs\-bridge -type\&. Due to the limitations of OVSDB, "empty" Bridges (with no Ports) can\*(Aqt exist\&. NetworkManager inserts the records for Bridges into OVSDB when a Port is attached\&. -.SS "Ports" -.PP -Ports are represented by connections of ovs\-port -type\&. Due to the limitations of OVSDB, "empty" Ports (with no Interfaces) can\*(Aqt exist\&. Ports can also be configured to do VLAN tagging or Bonding\&. NetworkManager inserts the records for Ports into OVSDB when an Interface is attached\&. Ports must be attached to a Bridge\&. -.SS "Interfaces" -.PP -Interfaces are represented by a connections attached to a Port\&. The system interfaces (that have a corresponding Linux link) have a respective -connection\&.type -of the link (e\&.g\&. "wired", "bond", "dummy", etc\&.)\&. Other interfaces ("internal" or "patch" interfaces) are of ovs\-interface type\&. The OVSDB entries are inserted upon attachment to a Port\&. -.SH "EXAMPLES" -.PP -\fBExample\ \&1.\ \&Creating a Bridge with a single internal Interface\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli conn add type ovs\-bridge conn\&.interface bridge0\fR -Connection \*(Aqovs\-bridge\-bridge0\*(Aq (d10fc64d\-1d48\-4394\-a1b8\-e1aea72f27d5) successfully added\&. -$ \fBnmcli conn add type ovs\-port conn\&.interface port0 controller bridge0\fR -Connection \*(Aqovs\-port\-port0\*(Aq (5ae22bae\-bba4\-4815\-9ade\-7e635633e1f0) successfully added\&. -$ \fBnmcli conn add type ovs\-interface port\-type ovs\-port conn\&.interface iface0 \e - controller port0 ipv4\&.method manual ipv4\&.address 192\&.0\&.2\&.1/24\fR -Connection \*(Aqovs\-interface\-iface0\*(Aq (3640d2a1\-a2fd\-4718\-92f1\-cffadb5b6cdc) successfully added\&. -.fi -.if n \{\ -.RE -.\} -.PP -As said above, you need to create a Port even for a single interface\&. Also, before you add the Interface, the Bridge and Port devices appear active, but are not configured in OVSDB yet\&. You can inspect the results with -\fBovs\-vsctl show\fR\&. -.PP -\fBExample\ \&2.\ \&Adding a Linux interface to a Bridge\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli conn add type ovs\-port conn\&.interface port1 controller bridge0\fR -Connection \*(Aqovs\-port\-port1\*(Aq (67d041eb\-8e7b\-4458\-afee\-a1d07c9c4552) successfully added\&. -$ \fBnmcli conn add type ethernet conn\&.interface eth0 controller port1\fR -Connection \*(Aqovs\-slave\-eth0\*(Aq (d459c45c\-cf78\-4c1c\-b4b7\-505e71379624) successfully added\&. -.fi -.if n \{\ -.RE -.\} -.PP -Again, you need a port\&. -.PP -\fBExample\ \&3.\ \&Creating a VLAN\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli conn add type ovs\-port conn\&.interface port2 controller bridge0 ovs\-port\&.tag 120\fR -Connection \*(Aqovs\-port\-port2\*(Aq (3994c093\-4ef7\-4549\-a4fd\-627b831c3cb8) successfully added\&. -$ \fBnmcli conn add type ethernet conn\&.interface eth1 controller port2\fR -Connection \*(Aqovs\-slave\-eth1\*(Aq (099be06e\-71ad\-484d\-8d5a\-fcadc5f207f5) successfully added\&. -.fi -.if n \{\ -.RE -.\} -.PP -It\*(Aqs just a port with a tag\&. -.PP -\fBExample\ \&4.\ \&Creating a Bond\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli conn add type ovs\-port conn\&.interface bond0 controller bridge0\fR -Connection \*(Aqovs\-port\-bond0\*(Aq (d154ebf9\-e999\-4e1b\-a084\-a3de53d25d8a) successfully added\&. -$ \fBnmcli conn add type ethernet conn\&.interface eth2 controller bond0\fR -Connection \*(Aqovs\-slave\-eth2\*(Aq (475ac1bf\-30b2\-4534\-a877\-27f33f58b082) successfully added\&. -$ \fBnmcli conn add type ethernet conn\&.interface eth3 controller bond0\fR -Connection \*(Aqovs\-slave\-eth3\*(Aq (8dedeecb\-ed12\-482b\-b77a\-24a4fb835136) successfully added\&. -.fi -.if n \{\ -.RE -.\} -.PP -It\*(Aqs just a Port with multiple interfaces\&. See nm\-settings\-nmcli manual for Bonding options you can use with "nmcli c add" or "nmcli c modify"\&. You could even set a VLAN tag on the same Port to do VLAN tagging and bonding at the same time\&. -.SH "BUGS" -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Not all Open vSwitch capabilities are supported\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Open vSwitch devices don\*(Aqt expose many useful properties on D\-Bus\&. -.RE -.PP -Probably many more\&. -.SH "SEE ALSO" -.PP -\m[blue]\fBRFC 7047: The Open vSwitch Database Management Protocol\fR\m[]\&\s-2\u[1]\d\s+2, -\fBovs-vsctl\fR(8), -\fBovs-vswitchd.conf.db\fR(5), -\fBnm-settings-nmcli\fR(5), -\fBnmcli\fR(1) -.SH "NOTES" -.IP " 1." 4 -RFC 7047: The Open vSwitch Database Management Protocol -.RS 4 -\%https://www.rfc-editor.org/rfc/rfc7047.txt -.RE diff --git a/man/nm-settings-dbus.5 b/man/nm-settings-dbus.5 deleted file mode 100644 index 9186c3ca..00000000 --- a/man/nm-settings-dbus.5 +++ /dev/null @@ -1,6524 +0,0 @@ -'\" t -.\" Title: nm-settings-dbus -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: Configuration -.\" Source: NetworkManager 1.50.0 -.\" Language: English -.\" -.TH "NM\-SETTINGS\-DBUS" "5" "" "NetworkManager 1\&.50\&.0" "Configuration" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nm-settings-dbus \- Description of settings and properties of NetworkManager connection profiles on the D\-Bus API -.SH "DESCRIPTION" -.PP -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 be applied and an active network connection will be established\&. Users are free to create as many connection profiles as they see fit\&. Thus they are flexible in having various network configurations for different networking needs\&. The connection profiles are handled by NetworkManager via -\fIsettings service\fR -and are exported on D\-Bus (\fI/org/freedesktop/NetworkManager/Settings/<num>\fR -objects)\&. The conceptual objects can be described as follows: -.PP -Connection (profile) -.RS 4 -A specific, encapsulated, independent group of settings describing all the configuration required to connect to a specific network\&. It is referred to by a unique identifier called the UUID\&. A connection is tied to a one specific device type, but not necessarily a specific hardware device\&. It is composed of one or more -\fISettings\fR -objects\&. -.RE -.PP -Setting -.RS 4 -A group of related key/value pairs describing a specific piece of a -\fIConnection (profile)\fR\&. Settings keys and allowed values are described in the tables below\&. Keys are also referred to as properties\&. Developers can find the setting objects and their properties in the libnm\-core sources\&. Look for the -\fB*_class_init\fR -functions near the bottom of each setting source file\&. -.RE -.PP -The settings and properties shown in tables below list all available connection configuration options\&. However, note that not all settings are applicable to all connection types\&. NetworkManager provides a command\-line tool -\fInmcli\fR -that allows direct configuration of the settings and properties according to a connection profile type\&. -\fInmcli\fR -connection editor has also a built\-in -\fIdescribe\fR -command that can display description of particular settings and properties of this page\&. -.SS "connection setting" -.PP -General Connection Profile Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -auth\-retries -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -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\&. - -Currently, this only applies to 802\-1x authentication\&. -T} -T{ -autoconnect -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -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\&. - -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\&. - -Note that autoconnect is not implemented for VPN profiles\&. See "secondaries" as an alternative to automatically connect VPN profiles\&. - -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\&. - -Depending on "connection\&.multi\-connect", a profile can (auto)connect only once at a time or multiple times\&. -T} -T{ -autoconnect\-ports -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -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\&. -T} -T{ -autoconnect\-priority -T}:T{ -int32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -autoconnect\-retries -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -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\&. -T} -T{ -autoconnect\-slaves -T}:T{ -NMSettingConnectionAutoconnectSlaves (int32) -T}:T{ -\ \& -T}:T{ -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\-slaves is read to determine the real value\&. If it is default as well, this fallbacks to 0\&. - -Deprecated 1\&.46\&. Use "autoconnect\-ports" instead, this is just an alias\&. -T} -T{ -controller -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Interface name of the controller device or UUID of the controller connection\&. -T} -T{ -dns\-over\-tls -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Whether DNSOverTls (dns\-over\-tls) is enabled for the connection\&. DNSOverTls is a technology which uses TLS to encrypt dns traffic\&. - -The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don\*(Aqt ever use DNSOverTls\&. If unspecified "default" depends on the plugin used\&. Systemd\-resolved uses global setting\&. - -This feature requires a plugin which supports DNSOverTls\&. Otherwise, the setting has no effect\&. One such plugin is dns\-systemd\-resolved\&. -T} -T{ -down\-on\-poweroff -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Whether the connection will be brought down before the system is powered off\&. The default value is \-1 (default)\&. When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as 0 (no)\&. -T} -T{ -gateway\-ping\-timeout -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping\&. -T} -T{ -id -T}:T{ -string -T}:T{ -\ \& -T}:T{ -A human readable unique identifier for the connection, like "Work Wi\-Fi" or "T\-Mobile 3G"\&. -T} -T{ -interface\-name -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -lldp -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Whether LLDP is enabled for the connection\&. -T} -T{ -llmnr -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Whether Link\-Local Multicast Name Resolution (LLMNR) is enabled for the connection\&. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link\&. - -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")\&. - -This feature requires a plugin which supports LLMNR\&. Otherwise, the setting has no effect\&. One such plugin is dns\-systemd\-resolved\&. -T} -T{ -master -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Interface name of the controller device or UUID of the controller connection\&. - -Deprecated 1\&.46\&. Use "controller" instead, this is just an alias\&. -T} -T{ -mdns -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Whether mDNS is enabled for the connection\&. - -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\&. - -This feature requires a plugin which supports mDNS\&. Otherwise, the setting has no effect\&. Currently the only supported DNS plugin is systemd\-resolved\&. For systemd\-resolved, the default is configurable via MulticastDNS= setting in resolved\&.conf\&. -T} -T{ -metered -T}:T{ -NMMetered (int32) -T}:T{ -\ \& -T}:T{ -Whether the connection is metered\&. - -When updating this property on a currently activated connection, the change takes effect immediately\&. -T} -T{ -mptcp\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Whether to configure MPTCP endpoints and the address flags\&. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints\&. Note that IPv4 loopback addresses (127\&.0\&.0\&.0/8), IPv4 link local addresses (169\&.254\&.0\&.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6\&.ip6\-privacy) will be excluded from being configured as endpoints\&. - -If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered\&. - -The "enabled" (0x2) flag means that MPTCP handling is enabled\&. This flag can also be implied from the presence of other flags\&. - -Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on\&. NetworkManager does not change the sysctl and this is up to the administrator or distribution\&. To configure endpoints even if the sysctl is disabled, "also\-without\-sysctl" (0x4) flag can be used\&. In that case, NetworkManager doesn\*(Aqt look at the sysctl and configures endpoints regardless\&. - -Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0\&.0\&.0\&.0/0 or ::/0) in the main routing table\&. The flag "also\-without\-default\-route" (0x8) can override that\&. - -When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80)\&. See ip\-mptcp(8) manual for additional information about the flags\&. - -If the flags are zero (0x0), the global connection default from NetworkManager\&.conf is honored\&. If still unspecified, the fallback is "enabled,subflow"\&. Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl\&. - -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\&. - -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)\&. -T} -T{ -mud\-url -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer\-recommended network policies for IoT devices\&. It is transmitted as a DHCPv4 or DHCPv6 option\&. The value must be a valid URL starting with "https://"\&. - -The special value "none" is allowed to indicate that no MUD URL is used\&. - -If the per\-profile value is unspecified (the default), a global connection default gets consulted\&. If still unspecified, the ultimate default is "none"\&. -T} -T{ -multi\-connect -T}:T{ -int32 -T}:T{ -0 -T}:T{ -Specifies whether the profile can be active multiple times at a particular moment\&. The value is of type NMConnectionMultiConnect\&. -T} -T{ -permissions -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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"\&. - -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\&. -T} -T{ -port\-type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Setting name of the device type of this port\*(Aqs controller connection (eg, "bond"), or NULL if this connection is not a port\&. -T} -T{ -read\-only -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -This property is deprecated and has no meaning\&. - -This property is deprecated since version 1\&.44\&.This property is deprecated and has no meaning\&. -T} -T{ -secondaries -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -List of connection UUIDs that should be activated when the base connection itself is activated\&. Currently, only VPN connections are supported\&. -T} -T{ -slave\-type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Setting name of the device type of this port\*(Aqs controller connection (eg, "bond"), or NULL if this connection is not a port\&. - -Deprecated 1\&.46\&. Use "port\-type" instead, this is just an alias\&. -T} -T{ -stable\-id -T}:T{ -string -T}:T{ -\ \& -T}:T{ -This represents the identity of the connection used for various purposes\&. It allows to configure multiple profiles to share the identity\&. Also, the stable\-id can contain placeholders that are substituted dynamically and deterministically depending on the context\&. - -The stable\-id is used for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. It is also used to derive the DHCP client identifier with ipv4\&.dhcp\-client\-id=stable, the DHCPv6 DUID with ipv6\&.dhcp\-duid=stable\-[llt,ll,uuid] and the DHCP IAID with ipv4\&.iaid=stable and ipv6\&.iaid=stable\&. - -Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm\&. For example, a per\-host key is commonly also included, so that different systems end up generating different IDs\&. Or with ipv6\&.addr\-gen\-mode=stable\-privacy, also the device\*(Aqs name is included, so that different interfaces yield different addresses\&. The per\-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key\&. See NetworkManager(8) manual about the secret\-key and the host identity\&. - -The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at 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\*(Aqs 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 \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}\-${BOOT}\-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates\&. - -If the value is unset, a global connection default is consulted\&. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile\&. -T} -T{ -timestamp -T}:T{ -uint64 -T}:T{ -0 -T}:T{ -The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated\&. - -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)\&. -T} -T{ -type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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)\&. -T} -T{ -uuid -T}:T{ -string -T}:T{ -\ \& -T}:T{ -A universally unique identifier for the connection, for example generated with libuuid\&. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network\&. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re\-created when the Wi\-Fi SSID, mobile broadband network provider, or "type" property changes\&. - -The UUID must be in the format "2815492f\-7e56\-435e\-b2e9\-246bd7cdc664" (ie, contains only hexadecimal characters and "\-")\&. -T} -T{ -wait\-activation\-delay -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Time in milliseconds to wait for connection to be considered activated\&. The wait will start after the pre\-up dispatcher event\&. - -The value 0 means no wait time\&. The default value is \-1, which currently has the same meaning as no wait time\&. -T} -T{ -wait\-device\-timeout -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -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\&. - -The value 0 means no wait time\&. The default value is \-1, which currently has the same meaning as no wait time\&. -T} -T{ -zone -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The trust level of a the connection\&. Free form case\-insensitive string (for example "Home", "Work", "Public")\&. NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall\&. - -When updating this property on a currently activated connection, the change takes effect immediately\&. -T} -.TE -.sp 1 -.SS "6lowpan setting" -.PP -6LoWPAN Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l. -T{ -parent -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created\&. -T} -.TE -.sp 1 -.SS "802\-1x setting" -.PP -IEEE 802\&.1x Authentication Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -altsubject\-matches -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -List of strings to be matched against the altSubjectName of the certificate presented by the authentication server\&. If the list is empty, no verification of the server certificate\*(Aqs altSubjectName is performed\&. -T} -T{ -anonymous\-identity -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Anonymous identity string for EAP authentication methods\&. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP\-TTLS\&. -T} -T{ -auth\-timeout -T}:T{ -int32 -T}:T{ -0 -T}:T{ -A timeout for the authentication\&. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds\&. -T} -T{ -ca\-cert -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -Contains the CA certificate if used by the EAP method specified in the "eap" property\&. - -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\*(Aqs 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\&. - -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\&. -T} -T{ -ca\-cert\-password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The password used to access the CA certificate stored in "ca\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. -T} -T{ -ca\-cert\-password\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "ca\-cert\-password" property\&. -T} -T{ -ca\-path -T}:T{ -string -T}:T{ -\ \& -T}:T{ -UTF\-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca\-cert" property\&. - -If NMSetting8021x:system\-ca\-certs is enabled and the built\-in CA path is an existing directory, then this setting is ignored\&. -T} -T{ -client\-cert -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -Contains the client certificate if used by the EAP method specified in the "eap" property\&. - -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\*(Aqs 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\&. -T} -T{ -client\-cert\-password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The password used to access the client certificate stored in "client\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. -T} -T{ -client\-cert\-password\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "client\-cert\-password" property\&. -T} -T{ -domain\-match -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Constraint for server domain name\&. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server\&. If a matching dNSName is found, this constraint is met\&. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison\&. Multiple valid FQDNs can be passed as a ";" delimited list\&. -T} -T{ -domain\-suffix\-match -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Constraint for server domain name\&. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server\&. If a matching dNSName is found, this constraint is met\&. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison\&. Since version 1\&.24, multiple valid FQDNs can be passed as a ";" delimited list\&. -T} -T{ -eap -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -identity -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Identity string for EAP authentication methods\&. Often the user\*(Aqs user or login name\&. -T} -T{ -openssl\-ciphers -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Define openssl_ciphers for wpa_supplicant\&. Openssl sometimes moves ciphers among SECLEVELs, thus compiled\-in default value in wpa_supplicant (as modified by some linux distributions) sometimes prevents to connect to old servers that do not support new protocols\&. -T} -T{ -optional -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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\&. -T} -T{ -pac\-file -T}:T{ -string -T}:T{ -\ \& -T}:T{ -UTF\-8 encoded file path containing PAC for EAP\-FAST\&. -T} -T{ -password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -UTF\-8 encoded password used for EAP authentication methods\&. If both the "password" property and the "password\-raw" property are specified, "password" is preferred\&. -T} -T{ -password\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "password" property\&. -T} -T{ -password\-raw -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -password\-raw\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "password\-raw" property\&. -T} -T{ -phase1\-auth\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -phase1\-fast\-provisioning -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -phase1\-peaplabel -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -phase1\-peapver -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -phase2\-altsubject\-matches -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication\&. If the list is empty, no verification of the server certificate\*(Aqs altSubjectName is performed\&. -T} -T{ -phase2\-auth -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -phase2\-autheap -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -phase2\-ca\-cert -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2\-auth" or "phase2\-autheap" properties\&. - -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\*(Aqs 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\&. - -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\&. -T} -T{ -phase2\-ca\-cert\-password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The password used to access the "phase2" CA certificate stored in "phase2\-ca\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. -T} -T{ -phase2\-ca\-cert\-password\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "phase2\-ca\-cert\-password" property\&. -T} -T{ -phase2\-ca\-path -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. - -If NMSetting8021x:system\-ca\-certs is enabled and the built\-in CA path is an existing directory, then this setting is ignored\&. -T} -T{ -phase2\-client\-cert -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2\-auth" or "phase2\-autheap" properties\&. - -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\*(Aqs 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\&. -T} -T{ -phase2\-client\-cert\-password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The password used to access the "phase2" client certificate stored in "phase2\-client\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. -T} -T{ -phase2\-client\-cert\-password\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "phase2\-client\-cert\-password" property\&. -T} -T{ -phase2\-domain\-match -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Constraint for server domain name\&. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication\&. If a matching dNSName is found, this constraint is met\&. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison\&. Multiple valid FQDNs can be passed as a ";" delimited list\&. -T} -T{ -phase2\-domain\-suffix\-match -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Constraint for server domain name\&. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication\&. If a matching dNSName is found, this constraint is met\&. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison\&. Since version 1\&.24, multiple valid FQDNs can be passed as a ";" delimited list\&. -T} -T{ -phase2\-private\-key -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -Contains the "phase 2" inner private key when the "phase2\-auth" or "phase2\-autheap" property is set to "tls"\&. - -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\*(Aqs 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\&. -T} -T{ -phase2\-private\-key\-password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The password used to decrypt the "phase 2" private key specified in the "phase2\-private\-key" property when the private key either uses the path scheme, or is a PKCS#12 format key\&. -T} -T{ -phase2\-private\-key\-password\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "phase2\-private\-key\-password" property\&. -T} -T{ -phase2\-subject\-match -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and should not be used\&. - -This property is deprecated since version 1\&.2\&.Use "phase2\-domain\-suffix\-match" instead\&. -T} -T{ -pin -T}:T{ -string -T}:T{ -\ \& -T}:T{ -PIN used for EAP authentication methods\&. -T} -T{ -pin\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "pin" property\&. -T} -T{ -private\-key -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -Contains the private key when the "eap" property is set to "tls"\&. - -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\*(Aqs 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\&. - -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\&. -T} -T{ -private\-key\-password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The password used to decrypt the private key specified in the "private\-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key\&. -T} -T{ -private\-key\-password\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "private\-key\-password" property\&. -T} -T{ -subject\-match -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Substring to be matched against the subject of the certificate presented by the authentication server\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and should not be used\&. - -This property is deprecated since version 1\&.2\&.Use "phase2\-domain\-suffix\-match" instead\&. -T} -T{ -system\-ca\-certs -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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)\&. -T} -.TE -.sp 1 -.SS "adsl setting" -.PP -ADSL Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -encapsulation -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Encapsulation of ADSL connection\&. Can be "vcmux" or "llc"\&. -T} -T{ -password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Password used to authenticate with the ADSL service\&. -T} -T{ -password\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "password" property\&. -T} -T{ -protocol -T}:T{ -string -T}:T{ -\ \& -T}:T{ -ADSL connection protocol\&. Can be "pppoa", "pppoe" or "ipoatm"\&. -T} -T{ -username -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Username used to authenticate with the ADSL service\&. -T} -T{ -vci -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -VCI of ADSL connection -T} -T{ -vpi -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -VPI of ADSL connection -T} -.TE -.sp 1 -.SS "bluetooth setting" -.PP -Bluetooth Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l. -T{ -bdaddr -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -The Bluetooth address of the device\&. -T} -T{ -type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Either "dun" for Dial\-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile\&. -T} -.TE -.sp 1 -.SS "bond setting" -.PP -Bonding Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l. -T{ -interface\-name -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Deprecated in favor of connection\&.interface\-name, but can be used for backward\-compatibility with older daemons, to set the bond\*(Aqs interface name\&. -T} -T{ -options -T}:T{ -dict of string to string -T}:T{ -{\*(Aqmode\*(Aq: \*(Aqbalance\-rr\*(Aq} -T}:T{ -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])\&. -T} -.TE -.sp 1 -.SS "bridge setting" -.PP -Bridging Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -ageing\-time -T}:T{ -uint32 -T}:T{ -300 -T}:T{ -The Ethernet MAC address aging time, in seconds\&. -T} -T{ -forward\-delay -T}:T{ -uint32 -T}:T{ -15 -T}:T{ -The Spanning Tree Protocol (STP) forwarding delay, in seconds\&. -T} -T{ -group\-address -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -If specified, The MAC address of the multicast group this bridge uses for STP\&. - -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\&. -T} -T{ -group\-forward\-mask -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\*(Aqt have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP\&. -T} -T{ -hello\-time -T}:T{ -uint32 -T}:T{ -2 -T}:T{ -The Spanning Tree Protocol (STP) hello time, in seconds\&. -T} -T{ -interface\-name -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Deprecated in favor of connection\&.interface\-name, but can be used for backward\-compatibility with older daemons, to set the bridge\*(Aqs interface name\&. -T} -T{ -mac\-address -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -If specified, the MAC address of bridge\&. When creating a new bridge, this MAC address will be set\&. - -If this field is left unspecified, the "ethernet\&.cloned\-mac\-address" is referred instead to generate the initial MAC address\&. Note that setting "ethernet\&.cloned\-mac\-address" anyway overwrites the MAC address of the bridge later while activating the bridge\&. - -This property is deprecated since version 1\&.12\&.Use the "cloned\-mac\-address" property instead\&. -T} -T{ -max\-age -T}:T{ -uint32 -T}:T{ -20 -T}:T{ -The Spanning Tree Protocol (STP) maximum message age, in seconds\&. -T} -T{ -multicast\-hash\-max -T}:T{ -uint32 -T}:T{ -4096 -T}:T{ -Set maximum size of multicast hash table (value must be a power of 2)\&. -T} -T{ -multicast\-last\-member\-count -T}:T{ -uint32 -T}:T{ -2 -T}:T{ -Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received\&. -T} -T{ -multicast\-last\-member\-interval -T}:T{ -uint64 -T}:T{ -100 -T}:T{ -Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received\&. -T} -T{ -multicast\-membership\-interval -T}:T{ -uint64 -T}:T{ -26000 -T}:T{ -Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received\&. -T} -T{ -multicast\-querier -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Enable or disable sending of multicast queries by the bridge\&. If not specified the option is disabled\&. -T} -T{ -multicast\-querier\-interval -T}:T{ -uint64 -T}:T{ -25500 -T}:T{ -If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries\&. -T} -T{ -multicast\-query\-interval -T}:T{ -uint64 -T}:T{ -12500 -T}:T{ -Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase\&. -T} -T{ -multicast\-query\-response\-interval -T}:T{ -uint64 -T}:T{ -1000 -T}:T{ -Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge\&. -T} -T{ -multicast\-query\-use\-ifaddr -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If enabled the bridge\*(Aqs own IP address is used as the source address for IGMP queries otherwise the default of 0\&.0\&.0\&.0 is used\&. -T} -T{ -multicast\-router -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Sets bridge\*(Aqs multicast router\&. Multicast\-snooping must be enabled for this option to work\&. - -Supported values are: \*(Aqauto\*(Aq, \*(Aqdisabled\*(Aq, \*(Aqenabled\*(Aq to which kernel assigns the numbers 1, 0, and 2, respectively\&. If not specified the default value is \*(Aqauto\*(Aq (1)\&. -T} -T{ -multicast\-snooping -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -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\&. -T} -T{ -multicast\-startup\-query\-count -T}:T{ -uint32 -T}:T{ -2 -T}:T{ -Set the number of IGMP queries to send during startup phase\&. -T} -T{ -multicast\-startup\-query\-interval -T}:T{ -uint64 -T}:T{ -3125 -T}:T{ -Sets the time (in deciseconds) between queries sent out at startup to determine membership information\&. -T} -T{ -priority -T}:T{ -uint32 -T}:T{ -32768 -T}:T{ -Sets the Spanning Tree Protocol (STP) priority for this bridge\&. Lower values are "better"; the lowest priority bridge will be elected the root bridge\&. -T} -T{ -stp -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -Controls whether Spanning Tree Protocol (STP) is enabled for this bridge\&. -T} -T{ -vlan\-default\-pvid -T}:T{ -uint32 -T}:T{ -1 -T}:T{ -The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames\&. -T} -T{ -vlan\-filtering -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Control whether VLAN filtering is enabled on the bridge\&. -T} -T{ -vlan\-protocol -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If specified, the protocol used for VLAN filtering\&. - -Supported values are: \*(Aq802\&.1Q\*(Aq, \*(Aq802\&.1ad\*(Aq\&. If not specified the default value is \*(Aq802\&.1Q\*(Aq\&. -T} -T{ -vlan\-stats\-enabled -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Controls whether per\-VLAN stats accounting is enabled\&. -T} -T{ -vlans -T}:T{ -array of vardict -T}:T{ -\ \& -T}:T{ -Array of bridge VLAN objects\&. In addition to the VLANs specified here, the bridge will also have the default\-pvid VLAN configured by the bridge\&.vlan\-default\-pvid property\&. - -In nmcli the VLAN list can be specified with the following syntax: - -$vid [pvid] [untagged] [, $vid [pvid] [untagged]]\&.\&.\&. - -where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash\&. -T} -.TE -.sp 1 -.SS "bridge\-port setting" -.PP -Bridge Port Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -hairpin\-mode -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on\&. -T} -T{ -path\-cost -T}:T{ -uint32 -T}:T{ -100 -T}:T{ -The Spanning Tree Protocol (STP) port cost for destinations via this port\&. -T} -T{ -priority -T}:T{ -uint32 -T}:T{ -32 -T}:T{ -The Spanning Tree Protocol (STP) priority of this bridge port\&. -T} -T{ -vlans -T}:T{ -array of vardict -T}:T{ -\ \& -T}:T{ -Array of bridge VLAN objects\&. In addition to the VLANs specified here, the port will also have the default\-pvid VLAN configured on the bridge by the bridge\&.vlan\-default\-pvid property\&. - -In nmcli the VLAN list can be specified with the following syntax: - -$vid [pvid] [untagged] [, $vid [pvid] [untagged]]\&.\&.\&. - -where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash\&. -T} -.TE -.sp 1 -.SS "cdma setting" -.PP -CDMA\-based Mobile Broadband Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -mtu -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. -T} -T{ -number -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The number to dial to establish the connection to the CDMA\-based mobile broadband network, if any\&. If not specified, the default number (#777) is used when required\&. -T} -T{ -password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The password used to authenticate with the network, if required\&. Many providers do not require a password, or accept any password\&. But if a password is required, it is specified here\&. -T} -T{ -password\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "password" property\&. -T} -T{ -username -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The username used to authenticate with the network, if required\&. Many providers do not require a username, or accept any username\&. But if a username is required, it is specified here\&. -T} -.TE -.sp 1 -.SS "dcb setting" -.PP -Data Center Bridging Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -app\-fcoe\-flags -T}:T{ -NMSettingDcbFlags (uint32) -T}:T{ -\ \& -T}:T{ -Specifies the NMSettingDcbFlags for the DCB FCoE application\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. -T} -T{ -app\-fcoe\-mode -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The FCoE controller mode; either "fabric" or "vn2vn"\&. - -Since 1\&.34, NULL is the default and means "fabric"\&. Before 1\&.34, NULL was rejected as invalid and the default was "fabric"\&. -T} -T{ -app\-fcoe\-priority -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -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 0x1 (enable) flag\&. -T} -T{ -app\-fip\-flags -T}:T{ -NMSettingDcbFlags (uint32) -T}:T{ -\ \& -T}:T{ -Specifies the NMSettingDcbFlags for the DCB FIP application\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. -T} -T{ -app\-fip\-priority -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -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 0x1 (enable) flag\&. -T} -T{ -app\-iscsi\-flags -T}:T{ -NMSettingDcbFlags (uint32) -T}:T{ -\ \& -T}:T{ -Specifies the NMSettingDcbFlags for the DCB iSCSI application\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. -T} -T{ -app\-iscsi\-priority -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -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 0x1 (enable) flag\&. -T} -T{ -priority\-bandwidth -T}:T{ -array of uint32 -T}:T{ -\ \& -T}:T{ -An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the percentage of bandwidth of the priority\*(Aqs assigned group that the priority may use\&. The sum of all percentages for priorities which belong to the same group must total 100 percents\&. -T} -T{ -priority\-flow\-control -T}:T{ -array of uint32 -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -priority\-flow\-control\-flags -T}:T{ -NMSettingDcbFlags (uint32) -T}:T{ -\ \& -T}:T{ -Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC)\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. -T} -T{ -priority\-group\-bandwidth -T}:T{ -array of uint32 -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -priority\-group\-flags -T}:T{ -NMSettingDcbFlags (uint32) -T}:T{ -\ \& -T}:T{ -Specifies the NMSettingDcbFlags for DCB Priority Groups\&. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing)\&. -T} -T{ -priority\-group\-id -T}:T{ -array of uint32 -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -priority\-strict\-bandwidth -T}:T{ -array of uint32 -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -priority\-traffic\-class -T}:T{ -array of uint32 -T}:T{ -\ \& -T}:T{ -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\&. -T} -.TE -.sp 1 -.SS "dummy setting" -.PP -Dummy Link Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -. -.TE -.sp 1 -.SS "ethtool setting" -.PP -Ethtool Ethernet Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -. -.TE -.sp 1 -.SS "generic setting" -.PP -Generic Link Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l. -T{ -device\-handler -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Name of the device handler that will be invoked to add and delete the device for this connection\&. The name can only contain ASCII alphanumeric characters and \*(Aq\-\*(Aq, \*(Aq_\*(Aq, \*(Aq\&.\*(Aq\&. It cannot start with \*(Aq\&.\*(Aq\&. - -See the NetworkManager\-dispatcher(8) man page for more details about how to write the device handler\&. - -By setting this property the generic connection becomes "virtual", meaning that it can be activated without an existing device; the device will be created at the time the connection is started by invoking the device\-handler\&. -T} -.TE -.sp 1 -.SS "gsm setting" -.PP -GSM\-based Mobile Broadband Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -apn -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\*(Aqs mobile broadband plan\&. The APN may only be composed of the characters a\-z, 0\-9, \&., and \- per GSM 03\&.60 Section 14\&.9\&. - -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\&. -T} -T{ -auto\-config -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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\&. -T} -T{ -device\-id -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The device unique identifier (as given by the WWAN management service) which this connection applies to\&. If given, the connection will only apply to the specified device\&. -T} -T{ -home\-only -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -When TRUE, only connections to the home network will be allowed\&. Connections to roaming networks will not be made\&. -T} -T{ -initial\-eps\-bearer\-apn -T}:T{ -string -T}:T{ -\ \& -T}:T{ -For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network\&. Setting this parameter implies initial\-eps\-bearer\-configure to be TRUE\&. -T} -T{ -initial\-eps\-bearer\-configure -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -For LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection\&. It is inferred TRUE if initial\-eps\-bearer\-apn is set\&. -T} -T{ -mtu -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. -T} -T{ -network\-id -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The Network ID (GSM LAI format, ie MCC\-MNC) to force specific network registration\&. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network\&. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible\&. -T} -T{ -number -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Legacy setting that used to help establishing PPP data sessions for GSM\-based modems\&. - -This property is deprecated since version 1\&.16\&.User\-provided values for this setting are no longer used\&. -T} -T{ -password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The password used to authenticate with the network, if required\&. Many providers do not require a password, or accept any password\&. But if a password is required, it is specified here\&. -T} -T{ -password\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "password" property\&. -T} -T{ -pin -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If the SIM is locked with a PIN it must be unlocked before any other operations are requested\&. Specify the PIN here to allow operation of the device\&. -T} -T{ -pin\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "pin" property\&. -T} -T{ -sim\-id -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The SIM card unique identifier (as given by the WWAN management service) which this connection applies to\&. If given, the connection will apply to any device also allowed by "device\-id" which contains a SIM card matching the given identifier\&. -T} -T{ -sim\-operator\-id -T}:T{ -string -T}:T{ -\ \& -T}:T{ -A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to\&. If given, the connection will apply to any device also allowed by "device\-id" and "sim\-id" which contains a SIM card provisioned by the given operator\&. -T} -T{ -username -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The username used to authenticate with the network, if required\&. Many providers do not require a username, or accept any username\&. But if a username is required, it is specified here\&. -T} -.TE -.sp 1 -.SS "hsr setting" -.PP -HSR/PRP Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -multicast\-spec -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The last byte of supervision address\&. -T} -T{ -port1 -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The port1 interface name of the HSR\&. This property is mandatory\&. -T} -T{ -port2 -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The port2 interface name of the HSR\&. This property is mandatory\&. -T} -T{ -prp -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -The protocol used by the interface, whether it is PRP or HSR\&. -T} -.TE -.sp 1 -.SS "infiniband setting" -.PP -Infiniband Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -mac\-address -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -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)\&. -T} -T{ -mtu -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. -T} -T{ -p\-key -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -The InfiniBand p\-key to use for this device\&. A value of \-1 means to use the default p\-key (aka "the p\-key at index 0")\&. Otherwise, it is a 16\-bit unsigned integer, whose high bit 0x8000 is set if it is a "full membership" p\-key\&. The values 0 and 0x8000 are not allowed\&. - -With the p\-key set, the interface name is always "$parent\&.$p_key"\&. Setting "connection\&.interface\-name" to another name is not supported\&. - -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\&. -T} -T{ -parent -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The interface name of the parent device of this device\&. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac\-address"\&. -T} -T{ -transport\-mode -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The IP\-over\-InfiniBand transport mode\&. Either "datagram" or "connected"\&. -T} -.TE -.sp 1 -.SS "ipv4 setting" -.PP -IPv4 Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -address\-data -T}:T{ -array of vardict -T}:T{ -\ \& -T}:T{ -Array of IPv4 addresses\&. Each address dictionary contains at least \*(Aqaddress\*(Aq and \*(Aqprefix\*(Aq entries, containing the IP address as a string, and the prefix length as a uint32\&. Additional attributes may also exist on some addresses\&. -T} -T{ -addresses -T}:T{ -array of array of uint32 -T}:T{ -\ \& -T}:T{ -Deprecated in favor of the \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq properties, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq\&. -Array of IPv4 address structures\&. Each IPv4 address structure is composed of 3 32\-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 \- 32), and last the IPv4 gateway (network byte order)\&. The gateway may be left as 0 if no gateway exists for that subnet\&. -T} -T{ -auto\-route\-ext\-gw -T}:T{ -NMTernary (int32) -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -dad\-timeout -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -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\&. - -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\&. -T} -T{ -dhcp\-client\-id -T}:T{ -string -T}:T{ -\ \& -T}:T{ -A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options\&. When the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary client ID, in which case the first byte is assumed to be the \*(Aqtype\*(Aq field as per RFC 2132 section 9\&.14 and the remaining bytes may be an hardware address (e\&.g\&. \*(Aq01:xx:xx:xx:xx:xx:xx\*(Aq where 1 is the Ethernet ARP type and the rest is a MAC address)\&. If the property is not a hex string it is considered as a non\-hardware\-address client ID and the \*(Aqtype\*(Aq field is set to 0\&. - -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\&. - -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\&. - -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\&. - -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\&. - -The special value "none" prevents any client identifier from being sent\&. Note that this is normally not recommended\&. - -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\*(Aqt sent any client\-id otherwise\&. -T} -T{ -dhcp\-dscp -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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"\&. - -The property is currently valid only for IPv4, and it is supported only by the "internal" DHCP plugin\&. -T} -T{ -dhcp\-fqdn -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -dhcp\-hostname -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -dhcp\-hostname\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags for the DHCP hostname and FQDN\&. - -Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are 0x1 (fqdn\-serv\-update), 0x2 (fqdn\-encoded) and 0x4 (fqdn\-no\-update)\&. When no FQDN flag is set and 0x8 (fqdn\-clear\-flags) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and 0x8 (fqdn\-clear\-flags) is not set, the standard FQDN flags are set in the request: 0x1 (fqdn\-serv\-update), 0x2 (fqdn\-encoded) for IPv4 and 0x1 (fqdn\-serv\-update) for IPv6\&. - -When this property is set to the default value 0x0 (none), a global default is looked up in NetworkManager configuration\&. If that value is unset or also 0x0 (none), then the standard FQDN flags described above are sent in the DHCP requests\&. -T} -T{ -dhcp\-iaid -T}:T{ -string -T}:T{ -\ \& -T}:T{ -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. - -For DHCPv4, the IAID is only used with "ipv4\&.dhcp\-client\-id" values "duid" and "ipv6\-duid" to generate the client\-id\&. - -For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin\&. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address\&. - -The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device\&. -T} -T{ -dhcp\-reject\-servers -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -dhcp\-send\-hostname -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -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\&. -T} -T{ -dhcp\-send\-release -T}:T{ -NMTernary (int32) -T}:T{ -\ \& -T}:T{ -Whether the DHCP client will send RELEASE message when bringing the connection down\&. The default value is \-1 (default)\&. When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as FALSE\&. -T} -T{ -dhcp\-timeout -T}:T{ -int32 -T}:T{ -0 -T}:T{ -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)\&. - -Set to 2147483647 (MAXINT32) for infinity\&. -T} -T{ -dhcp\-vendor\-class\-identifier -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -dns -T}:T{ -array of uint32 -T}:T{ -\ \& -T}:T{ -Array of IP addresses of DNS servers (as network\-byte\-order integers) -T} -T{ -dns\-data -T}:T{ -array of strings -T}:T{ -\ \& -T}:T{ -Array of DNS name servers\&. This replaces the deprecated "dns" property\&. Each name server can also contain a DoT server name\&. -T} -T{ -dns\-options -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -Array of DNS options to be added to resolv\&.conf\&. - -NULL means that the options are unset and left at the default\&. In this case NetworkManager will use default options\&. This is distinct from an empty list of properties\&. - -The following options are directly added to resolv\&.conf: "attempts", "debug", "edns0", "inet6", "ip6\-bytestring", "ip6\-dotint", "ndots", "no\-aaaa", "no\-check\-names", "no\-ip6\-dotint", "no\-reload", "no\-tld\-query", "rotate", "single\-request", "single\-request\-reopen", "timeout", "trust\-ad", "use\-vc"\&. See the resolv\&.conf(5) man page for a detailed description of these options\&. - -In addition, NetworkManager supports the special options "_no\-add\-edns0" and "_no\-add\-trust\-ad"\&. They are not added to resolv\&.conf, and can be used to prevent the automatic addition of options "edns0" and "trust\-ad" when using caching DNS plugins (see below)\&. - -The "trust\-ad" setting is only honored if the profile contributes name servers to resolv\&.conf, and if all contributing profiles have "trust\-ad" enabled\&. - -When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added, unless "_no\-add\-edns0" and "_no\-add\-trust\-ad" are present\&. -T} -T{ -dns\-priority -T}:T{ -int32 -T}:T{ -0 -T}:T{ -DNS servers priority\&. - -The relative priority for DNS servers specified by this setting\&. A lower numerical value is better (higher priority)\&. - -Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used\&. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles\&. - -Zero selects a globally configured default value\&. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections\&. - -Note that the priority is to order DNS settings for multiple active connections\&. It does not disambiguate multiple DNS servers within the same connection profile\&. - -When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices\&. - -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\&. - -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 \*(Aq~\&.\*(Aq 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\&. -T} -T{ -dns\-search -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -List of DNS search domains\&. Domains starting with a tilde (\*(Aq~\*(Aq) are considered \*(Aqrouting\*(Aq domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names\&. - -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)\&. -T} -T{ -gateway -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The gateway associated with this configuration\&. This is only meaningful if "addresses" is also set\&. - -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\&. - -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"\&. -T} -T{ -ignore\-auto\-dns -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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\&. -T} -T{ -ignore\-auto\-routes -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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\&. -T} -T{ -link\-local -T}:T{ -int32 -T}:T{ -0 -T}:T{ -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"\&. -T} -T{ -may\-fail -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -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\&. -T} -T{ -method -T}:T{ -string -T}:T{ -\ \& -T}:T{ -IP configuration method\&. - -NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link\-local"\&. See the subclass\-specific documentation for other values\&. - -In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration\&. The "ignore\-auto\-routes" and "ignore\-auto\-dns" properties modify this behavior\&. - -For methods that imply no upstream network, such as "shared" or "link\-local", these properties must be empty\&. - -For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10\&.42\&.x\&.0/24 is chosen\&. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared\&. -T} -T{ -never\-default -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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\&. -T} -T{ -replace\-local\-rule -T}:T{ -NMTernary (int32) -T}:T{ -\ \& -T}:T{ -Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. -T} -T{ -required\-timeout -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds\&. - -This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail\&. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e\&.g\&. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active\&. - -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\&. - -A zero value means that no required timeout is present, \-1 means the default value (either configuration ipvx\&.required\-timeout override or zero)\&. -T} -T{ -route\-data -T}:T{ -array of vardict -T}:T{ -\ \& -T}:T{ -Array of IPv4 routes\&. Each route dictionary contains at least \*(Aqdest\*(Aq and \*(Aqprefix\*(Aq entries, containing the destination IP address as a string, and the prefix length as a uint32\&. Most routes will also have a \*(Aqnext\-hop\*(Aq entry, containing the next hop IP address as a string\&. If the route has a \*(Aqmetric\*(Aq entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device)\&. Additional attributes may also exist on some routes\&. -T} -T{ -route\-metric -T}:T{ -int64 -T}:T{ -\-1 -T}:T{ -The default metric for routes that don\*(Aqt explicitly specify a metric\&. The default value \-1 means that the metric is chosen automatically based on the device type\&. The metric applies to dynamic routes, manual (static) routes that don\*(Aqt have an explicit metric setting, address prefix routes, and the default route\&. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default)\&. Hence, setting this property to zero effectively mean setting it to 1024\&. For IPv4, zero is a regular value for the metric\&. -T} -T{ -route\-table -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Enable policy routing (source routing) and set the routing table used when adding routes\&. - -This affects all routes, including device\-routes, IPv4LL, DHCP, SLAAC, default\-routes and static routes\&. But note that static routes can individually overwrite the setting by explicitly specifying a non\-zero routing table\&. - -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\&. - -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\&. -T} -T{ -routes -T}:T{ -array of array of uint32 -T}:T{ -\ \& -T}:T{ -Deprecated in favor of the \*(Aqroute\-data\*(Aq property, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqroute\-data\*(Aq\&. -Array of IPv4 route structures\&. Each IPv4 route structure is composed of 4 32\-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 \- 32), the third being the next\-hop (network byte order) if any, and the fourth being the route metric\&. If the metric is 0, NM will choose an appropriate default metric for the device\&. (There is no way to explicitly specify an actual metric of 0 with this property\&.) -T} -T{ -routing\-rules -T}:T{ -array of \*(Aqa{sv}\*(Aq -T}:T{ -\ \& -T}:T{ -Array of dictionaries for routing rules\&. Each routing rule supports the following options: action (y), dport\-end (q), dport\-start (q), family (i), from (s), from\-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport\-end (q), sport\-start (q), supress\-prefixlength (i), table (u), to (s), tos (y), to\-len (y), range\-end (u), range\-start (u)\&. -T} -.TE -.sp 1 -.SS "ipv6 setting" -.PP -IPv6 Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -addr\-gen\-mode -T}:T{ -int32 -T}:T{ -3 -T}:T{ -Configure the method for creating the IPv6 interface identifier of addresses for RFC4862 IPv6 Stateless Address Autoconfiguration and IPv6 Link Local\&. - -The permitted values are: 0 (eui64), 1 (stable\-privacy)\&. 2 (default\-or\-eui64) or 3 (default)\&. - -If the property is set to "eui64", the addresses will be generated using the interface token derived from the hardware address\&. This makes the host part of the address constant, making it possible to track the host\*(Aqs presence when it changes networks\&. The address changes when the interface hardware is replaced\&. If a duplicate address is detected, there is no fallback to generate another address\&. When configured, the "ipv6\&.token" is used instead of the MAC address to generate addresses for stateless autoconfiguration\&. - -If the property is set to "stable\-privacy", the interface identifier is generated as specified by RFC7217\&. This works by hashing a host specific key (see NetworkManager(8) manual), the interface name, the connection\*(Aqs "connection\&.stable\-id" property and the address prefix\&. This improves privacy by making it harder to use the address to track the host\*(Aqs presence as every prefix and network has a different identifier\&. Also, the address is stable when the network interface hardware is replaced\&. - -The special values "default" and "default\-or\-eui64" will fallback to the global connection default as documented in the NetworkManager\&.conf(5) manual\&. If the global default is not specified, the fallback value is "stable\-privacy" or "eui64", respectively\&. - -For libnm, the property defaults to "default" since 1\&.40\&. Previously it used to default to "stable\-privacy"\&. On D\-Bus, the absence of an addr\-gen\-mode setting equals "default"\&. For keyfile plugin, the absence of the setting on disk means "default\-or\-eui64" so that the property doesn\*(Aqt change on upgrade from older versions\&. - -Note that this setting is distinct from the Privacy Extensions as configured by "ip6\-privacy" property and it does not affect the temporary addresses configured with this option\&. -T} -T{ -address\-data -T}:T{ -array of vardict -T}:T{ -\ \& -T}:T{ -Array of IPv6 addresses\&. Each address dictionary contains at least \*(Aqaddress\*(Aq and \*(Aqprefix\*(Aq entries, containing the IP address as a string, and the prefix length as a uint32\&. Additional attributes may also exist on some addresses\&. -T} -T{ -addresses -T}:T{ -array of legacy IPv6 address struct (a(ayuay)) -T}:T{ -\ \& -T}:T{ -Deprecated in favor of the \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq properties, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqaddress\-data\*(Aq and \*(Aqgateway\*(Aq\&. -Array of IPv6 address structures\&. Each IPv6 address structure is composed of an IPv6 address, a prefix length (0 \- 128), and an IPv6 gateway address\&. The gateway may be zeroed out if no gateway exists for that subnet\&. -T} -T{ -auto\-route\-ext\-gw -T}:T{ -NMTernary (int32) -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -dad\-timeout -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -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\&. - -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\&. -T} -T{ -dhcp\-dscp -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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"\&. - -The property is currently valid only for IPv4, and it is supported only by the "internal" DHCP plugin\&. -T} -T{ -dhcp\-duid -T}:T{ -string -T}:T{ -\ \& -T}:T{ -A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315)\&. The DUID is carried in the Client Identifier option\&. If the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option\&. - -The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection\&. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system\-wide dhclient lease file\&. If still no DUID is found, or another dhcp client is used, a global and permanent DUID\-UUID (RFC 6355) will be generated based on the machine\-id\&. - -The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device\&. In order to try providing a stable DUID\-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk\&. - -The special values "stable\-llt", "stable\-ll" and "stable\-uuid" will generate a DUID of the corresponding type, derived from the connection\*(Aqs stable\-id and a per\-host unique key\&. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable\-id, in case this profile gets activated on multiple devices\&. So, the link\-layer address of "stable\-ll" and "stable\-llt" will be a generated address derived from the stable id\&. The DUID\-LLT time value in the "stable\-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt")\&. - -When the property is unset, the global value provided for "ipv6\&.dhcp\-duid" is used\&. If no global value is provided, the default "lease" value is assumed\&. -T} -T{ -dhcp\-hostname -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -dhcp\-hostname\-flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags for the DHCP hostname and FQDN\&. - -Currently, this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are 0x1 (fqdn\-serv\-update), 0x2 (fqdn\-encoded) and 0x4 (fqdn\-no\-update)\&. When no FQDN flag is set and 0x8 (fqdn\-clear\-flags) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and 0x8 (fqdn\-clear\-flags) is not set, the standard FQDN flags are set in the request: 0x1 (fqdn\-serv\-update), 0x2 (fqdn\-encoded) for IPv4 and 0x1 (fqdn\-serv\-update) for IPv6\&. - -When this property is set to the default value 0x0 (none), a global default is looked up in NetworkManager configuration\&. If that value is unset or also 0x0 (none), then the standard FQDN flags described above are sent in the DHCP requests\&. -T} -T{ -dhcp\-iaid -T}:T{ -string -T}:T{ -\ \& -T}:T{ -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. - -For DHCPv4, the IAID is only used with "ipv4\&.dhcp\-client\-id" values "duid" and "ipv6\-duid" to generate the client\-id\&. - -For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin\&. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address\&. - -The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device\&. -T} -T{ -dhcp\-pd\-hint -T}:T{ -string -T}:T{ -\ \& -T}:T{ -A IPv6 address followed by a slash and a prefix length\&. If set, the value is sent to the DHCPv6 server as hint indicating the prefix delegation (IA_PD) we want to receive\&. To only hint a prefix length without prefix, set the address part to the zero address (for example "::/60")\&. -T} -T{ -dhcp\-reject\-servers -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -dhcp\-send\-hostname -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -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\&. -T} -T{ -dhcp\-send\-release -T}:T{ -NMTernary (int32) -T}:T{ -\ \& -T}:T{ -Whether the DHCP client will send RELEASE message when bringing the connection down\&. The default value is \-1 (default)\&. When the default value is specified, then the global value from NetworkManager configuration is looked up, if not set, it is considered as FALSE\&. -T} -T{ -dhcp\-timeout -T}:T{ -int32 -T}:T{ -0 -T}:T{ -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)\&. - -Set to 2147483647 (MAXINT32) for infinity\&. -T} -T{ -dns -T}:T{ -array of byte array -T}:T{ -\ \& -T}:T{ -Array of IP addresses of DNS servers (in network byte order) -T} -T{ -dns\-data -T}:T{ -array of strings -T}:T{ -\ \& -T}:T{ -Array of DNS name servers\&. This replaces the deprecated "dns" property\&. Each name server can also contain a DoT server name\&. -T} -T{ -dns\-options -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -Array of DNS options to be added to resolv\&.conf\&. - -NULL means that the options are unset and left at the default\&. In this case NetworkManager will use default options\&. This is distinct from an empty list of properties\&. - -The following options are directly added to resolv\&.conf: "attempts", "debug", "edns0", "inet6", "ip6\-bytestring", "ip6\-dotint", "ndots", "no\-aaaa", "no\-check\-names", "no\-ip6\-dotint", "no\-reload", "no\-tld\-query", "rotate", "single\-request", "single\-request\-reopen", "timeout", "trust\-ad", "use\-vc"\&. See the resolv\&.conf(5) man page for a detailed description of these options\&. - -In addition, NetworkManager supports the special options "_no\-add\-edns0" and "_no\-add\-trust\-ad"\&. They are not added to resolv\&.conf, and can be used to prevent the automatic addition of options "edns0" and "trust\-ad" when using caching DNS plugins (see below)\&. - -The "trust\-ad" setting is only honored if the profile contributes name servers to resolv\&.conf, and if all contributing profiles have "trust\-ad" enabled\&. - -When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added, unless "_no\-add\-edns0" and "_no\-add\-trust\-ad" are present\&. -T} -T{ -dns\-priority -T}:T{ -int32 -T}:T{ -0 -T}:T{ -DNS servers priority\&. - -The relative priority for DNS servers specified by this setting\&. A lower numerical value is better (higher priority)\&. - -Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used\&. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles\&. - -Zero selects a globally configured default value\&. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections\&. - -Note that the priority is to order DNS settings for multiple active connections\&. It does not disambiguate multiple DNS servers within the same connection profile\&. - -When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices\&. - -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\&. - -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 \*(Aq~\&.\*(Aq 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\&. -T} -T{ -dns\-search -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -List of DNS search domains\&. Domains starting with a tilde (\*(Aq~\*(Aq) are considered \*(Aqrouting\*(Aq domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names\&. - -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)\&. -T} -T{ -gateway -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The gateway associated with this configuration\&. This is only meaningful if "addresses" is also set\&. - -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\&. - -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"\&. -T} -T{ -ignore\-auto\-dns -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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\&. -T} -T{ -ignore\-auto\-routes -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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\&. -T} -T{ -ip6\-privacy -T}:T{ -NMSettingIP6ConfigPrivacy (int32) -T}:T{ -\ \& -T}:T{ -Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941\&. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI\-64\&. This enhances privacy, but could cause problems in some applications, on the other hand\&. The permitted values are: \-1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses)\&. - -Having a per\-connection setting set to "\-1" (default) means fallback to global configuration "ipv6\&.ip6\-privacy"\&. If it\*(Aqs also unspecified or set to "\-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr"\&. - -Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr\-gen\-mode" property\*(Aqs "stable\-privacy" setting as another way of avoiding host tracking with IPv6 addresses\&. -T} -T{ -may\-fail -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -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\&. -T} -T{ -method -T}:T{ -string -T}:T{ -\ \& -T}:T{ -IP configuration method\&. - -NMSettingIP4Config and NMSettingIP6Config both support "disabled", "auto", "manual", and "link\-local"\&. See the subclass\-specific documentation for other values\&. - -In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration\&. The "ignore\-auto\-routes" and "ignore\-auto\-dns" properties modify this behavior\&. - -For methods that imply no upstream network, such as "shared" or "link\-local", these properties must be empty\&. - -For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10\&.42\&.x\&.0/24 is chosen\&. Note that the shared method must be configured on the interface which shares the internet to a subnet, not on the uplink which is shared\&. -T} -T{ -mtu -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -never\-default -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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\&. -T} -T{ -ra\-timeout -T}:T{ -int32 -T}:T{ -0 -T}:T{ -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\&. - -Set to 2147483647 (MAXINT32) for infinity\&. -T} -T{ -replace\-local\-rule -T}:T{ -NMTernary (int32) -T}:T{ -\ \& -T}:T{ -Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. -T} -T{ -required\-timeout -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds\&. - -This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail\&. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e\&.g\&. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active\&. - -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\&. - -A zero value means that no required timeout is present, \-1 means the default value (either configuration ipvx\&.required\-timeout override or zero)\&. -T} -T{ -route\-data -T}:T{ -array of vardict -T}:T{ -\ \& -T}:T{ -Array of IPv6 routes\&. Each route dictionary contains at least \*(Aqdest\*(Aq and \*(Aqprefix\*(Aq entries, containing the destination IP address as a string, and the prefix length as a uint32\&. Most routes will also have a \*(Aqnext\-hop\*(Aq entry, containing the next hop IP address as a string\&. If the route has a \*(Aqmetric\*(Aq entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device)\&. Additional attributes may also exist on some routes\&. -T} -T{ -route\-metric -T}:T{ -int64 -T}:T{ -\-1 -T}:T{ -The default metric for routes that don\*(Aqt explicitly specify a metric\&. The default value \-1 means that the metric is chosen automatically based on the device type\&. The metric applies to dynamic routes, manual (static) routes that don\*(Aqt have an explicit metric setting, address prefix routes, and the default route\&. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default)\&. Hence, setting this property to zero effectively mean setting it to 1024\&. For IPv4, zero is a regular value for the metric\&. -T} -T{ -route\-table -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Enable policy routing (source routing) and set the routing table used when adding routes\&. - -This affects all routes, including device\-routes, IPv4LL, DHCP, SLAAC, default\-routes and static routes\&. But note that static routes can individually overwrite the setting by explicitly specifying a non\-zero routing table\&. - -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\&. - -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\&. -T} -T{ -routes -T}:T{ -array of legacy IPv6 route struct (a(ayuayu)) -T}:T{ -\ \& -T}:T{ -Deprecated in favor of the \*(Aqroute\-data\*(Aq property, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqroute\-data\*(Aq\&. -Array of IPv6 route structures\&. Each IPv6 route structure is composed of an IPv6 address, a prefix length (0 \- 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric\&. If the metric is 0, NM will choose an appropriate default metric for the device\&. -T} -T{ -routing\-rules -T}:T{ -array of \*(Aqa{sv}\*(Aq -T}:T{ -\ \& -T}:T{ -Array of dictionaries for routing rules\&. Each routing rule supports the following options: action (y), dport\-end (q), dport\-start (q), family (i), from (s), from\-len (y), fwmark (u), fwmask (u), iifname (s), invert (b), ipproto (s), oifname (s), priority (u), sport\-end (q), sport\-start (q), supress\-prefixlength (i), table (u), to (s), tos (y), to\-len (y), range\-end (u), range\-start (u)\&. -T} -T{ -temp\-preferred\-lifetime -T}:T{ -int32 -T}:T{ -0 -T}:T{ -The preferred lifetime of autogenerated temporary addresses, in seconds\&. - -Having a per\-connection setting set to "0" (default) means fallback to global configuration "ipv6\&.temp\-preferred\-lifetime" setting"\&. If it\*(Aqs also unspecified or set to "0", fallback to read "/proc/sys/net/ipv6/conf/default/temp_prefered_lft"\&. -T} -T{ -temp\-valid\-lifetime -T}:T{ -int32 -T}:T{ -0 -T}:T{ -The valid lifetime of autogenerated temporary addresses, in seconds\&. - -Having a per\-connection setting set to "0" (default) means fallback to global configuration "ipv6\&.temp\-valid\-lifetime" setting"\&. If it\*(Aqs also unspecified or set to "0", fallback to read "/proc/sys/net/ipv6/conf/default/temp_valid_lft"\&. -T} -T{ -token -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Configure the token for draft\-chown\-6man\-tokenised\-ipv6\-identifiers\-02 IPv6 tokenized interface identifiers\&. Useful with eui64 addr\-gen\-mode\&. - -When set, the token is used as IPv6 interface identifier instead of the hardware address\&. This only applies to addresses from stateless autoconfiguration, not to IPv6 link local addresses\&. -T} -.TE -.sp 1 -.SS "ip\-tunnel setting" -.PP -IP Tunneling Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -encapsulation\-limit -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -flags -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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), 0x20 (ip6\-use\-orig\-fwmark)\&. They are valid only for IPv6 tunnels\&. -T} -T{ -flow\-label -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The flow label to assign to tunnel packets\&. This property applies only to IPv6 tunnels\&. -T} -T{ -fwmark -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The fwmark value to assign to tunnel packets\&. This property can be set to a non zero value only on VTI and VTI6 tunnels\&. -T} -T{ -input\-key -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE)\&. If empty, no key is used\&. -T} -T{ -local -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address\&. -T} -T{ -mode -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The tunneling mode\&. Valid values: 1 (ipip), 2 (gre), 3 (sit), 4 (isatap), 5 (vti), 6 (ip6ip6), 7 (ipip6), 8 (ip6gre), 9 (vti6), 10 (gretap) and 11 (ip6gretap) -T} -T{ -mtu -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments\&. -T} -T{ -output\-key -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE)\&. If empty, no key is used\&. -T} -T{ -parent -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface\&. -T} -T{ -path\-mtu\-discovery -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -Whether to enable Path MTU Discovery on this tunnel\&. -T} -T{ -remote -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address\&. -T} -T{ -tos -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets\&. -T} -T{ -ttl -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The TTL to assign to tunneled packets\&. 0 is a special value meaning that packets inherit the TTL value\&. -T} -.TE -.sp 1 -.SS "macsec setting" -.PP -MACSec Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -encrypt -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -Whether the transmitted traffic must be encrypted\&. -T} -T{ -mka\-cak -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The pre\-shared CAK (Connectivity Association Key) for MACsec Key Agreement\&. Must be a string of 32 hexadecimal characters\&. -T} -T{ -mka\-cak\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "mka\-cak" property\&. -T} -T{ -mka\-ckn -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The pre\-shared CKN (Connectivity\-association Key Name) for MACsec Key Agreement\&. Must be a string of hexadecimal characters with a even length between 2 and 64\&. -T} -T{ -mode -T}:T{ -int32 -T}:T{ -0 -T}:T{ -Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained\&. -T} -T{ -offload -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Specifies the MACsec offload mode\&. - -0 (off) disables MACsec offload\&. - -1 (phy) and 2 (mac) request offload respectively to the PHY or to the MAC; if the selected mode is not available, the connection will fail\&. - -\-1 (default) uses the global default value specified in NetworkManager configuration; if no global default is defined, the built\-in default is 0 (off)\&. -T} -T{ -parent -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created\&. If this property is not specified, the connection must contain an "802\-3\-ethernet" setting with a "mac\-address" property\&. -T} -T{ -port -T}:T{ -int32 -T}:T{ -1 -T}:T{ -The port component of the SCI (Secure Channel Identifier), between 1 and 65534\&. -T} -T{ -send\-sci -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -Specifies whether the SCI (Secure Channel Identifier) is included in every packet\&. -T} -T{ -validation -T}:T{ -int32 -T}:T{ -2 -T}:T{ -Specifies the validation mode for incoming frames\&. -T} -.TE -.sp 1 -.SS "macvlan setting" -.PP -MAC VLAN Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -mode -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device\&. -T} -T{ -parent -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If given, specifies the parent interface name or parent connection UUID from which this MAC\-VLAN interface should be created\&. If this property is not specified, the connection must contain an "802\-3\-ethernet" setting with a "mac\-address" property\&. -T} -T{ -promiscuous -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -Whether the interface should be put in promiscuous mode\&. -T} -T{ -tap -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Whether the interface should be a MACVTAP\&. -T} -.TE -.sp 1 -.SS "match setting" -.PP -Match settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -driver -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -A list of driver names to match\&. Each element is a shell wildcard pattern\&. - -See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the pattern\&. -T} -T{ -interface\-name -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -A list of interface names to match\&. Each element is a shell wildcard pattern\&. - -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, "&\e\e!a" is an mandatory match for literally "!a"\&. -T} -T{ -kernel\-command\-line -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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\&. - -See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the match\&. -T} -T{ -path -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -A list of paths to match against the ID_PATH udev property of devices\&. ID_PATH represents the topological persistent path of a device\&. It typically contains a subsystem string (pci, usb, platform, etc\&.) and a subsystem\-specific identifier\&. - -For PCI devices the path has the form "pci\-$domain:$bus:$device\&.$function", where each variable is an hexadecimal value; for example "pci\-0000:0a:00\&.0"\&. - -The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli \-f general\&.path device show $dev")\&. - -Each element of the list is a shell wildcard pattern\&. - -See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the pattern\&. -T} -.TE -.sp 1 -.SS "802\-11\-olpc\-mesh setting" -.PP -OLPC Wireless Mesh Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l. -T{ -channel -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Channel on which the mesh network to join is located\&. -T} -T{ -dhcp\-anycast\-address -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -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\&. - -This is currently only implemented by dhclient DHCP plugin\&. -T} -T{ -ssid -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -SSID of the mesh network to join\&. -T} -.TE -.sp 1 -.SS "ovs\-bridge setting" -.PP -OvsBridge Link Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -datapath\-type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The data path type\&. One of "system", "netdev" or empty\&. -T} -T{ -fail\-mode -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The bridge failure mode\&. One of "secure", "standalone" or empty\&. -T} -T{ -mcast\-snooping\-enable -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Enable or disable multicast snooping\&. -T} -T{ -rstp\-enable -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Enable or disable RSTP\&. -T} -T{ -stp\-enable -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Enable or disable STP\&. -T} -.TE -.sp 1 -.SS "ovs\-dpdk setting" -.PP -OvsDpdk Link Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -devargs -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Open vSwitch DPDK device arguments\&. -T} -T{ -n\-rxq -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Open vSwitch DPDK number of rx queues\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue\&. -T} -T{ -n\-rxq\-desc -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -n\-txq\-desc -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -.TE -.sp 1 -.SS "ovs\-interface setting" -.PP -Open vSwitch Interface Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l. -T{ -ofport\-request -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The interface type\&. Either "internal", "system", "patch", "dpdk", or empty\&. -T} -.TE -.sp 1 -.SS "ovs\-patch setting" -.PP -OvsPatch Link Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l. -T{ -peer -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Specifies the name of the interface for the other side of the patch\&. The patch on the other side must also set this interface as peer\&. -T} -.TE -.sp 1 -.SS "ovs\-port setting" -.PP -OvsPort Link Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -bond\-downdelay -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The time port must be inactive in order to be considered down\&. -T} -T{ -bond\-mode -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Bonding mode\&. One of "active\-backup", "balance\-slb", or "balance\-tcp"\&. -T} -T{ -bond\-updelay -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The time port must be active before it starts forwarding traffic\&. -T} -T{ -lacp -T}:T{ -string -T}:T{ -\ \& -T}:T{ -LACP mode\&. One of "active", "off", or "passive"\&. -T} -T{ -tag -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The VLAN tag in the range 0\-4095\&. -T} -T{ -trunks -T}:T{ -array of vardict -T}:T{ -\ \& -T}:T{ -A list of VLAN ranges that this port trunks\&. - -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\&. -T} -T{ -vlan\-mode -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The VLAN mode\&. One of "access", "native\-tagged", "native\-untagged", "trunk", "dot1q\-tunnel" or unset\&. -T} -.TE -.sp 1 -.SS "ppp setting" -.PP -Point\-to\-Point Protocol Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -baud -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -crtscts -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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\&. -T} -T{ -lcp\-echo\-failure -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -lcp\-echo\-interval -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -mppe\-stateful -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, stateful MPPE is used\&. See pppd documentation for more information on stateful MPPE\&. -T} -T{ -mru -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -mtu -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, instruct pppd to send packets no larger than the specified size\&. -T} -T{ -no\-vj\-comp -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, Van Jacobsen TCP header compression will not be requested\&. -T} -T{ -noauth -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -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\&. -T} -T{ -nobsdcomp -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, BSD compression will not be requested\&. -T} -T{ -nodeflate -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, "deflate" compression will not be requested\&. -T} -T{ -refuse\-chap -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, the CHAP authentication method will not be used\&. -T} -T{ -refuse\-eap -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, the EAP authentication method will not be used\&. -T} -T{ -refuse\-mschap -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, the MSCHAP authentication method will not be used\&. -T} -T{ -refuse\-mschapv2 -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, the MSCHAPv2 authentication method will not be used\&. -T} -T{ -refuse\-pap -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, the PAP authentication method will not be used\&. -T} -T{ -require\-mppe -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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\&. -T} -T{ -require\-mppe\-128 -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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\&. -T} -.TE -.sp 1 -.SS "pppoe setting" -.PP -PPP\-over\-Ethernet Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -parent -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If given, specifies the parent interface name on which this PPPoE connection should be created\&. If this property is not specified, the connection is activated on the interface specified in "interface\-name" of NMSettingConnection\&. -T} -T{ -password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Password used to authenticate with the PPPoE service\&. -T} -T{ -password\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "password" property\&. -T} -T{ -service -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service\&. For most providers, this should be left blank\&. It is only required if there are multiple access concentrators or a specific service is known to be required\&. -T} -T{ -username -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Username used to authenticate with the PPPoE service\&. -T} -.TE -.sp 1 -.SS "proxy setting" -.PP -WWW Proxy Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -browser\-only -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Whether the proxy configuration is for browser only\&. -T} -T{ -method -T}:T{ -int32 -T}:T{ -0 -T}:T{ -Method for proxy configuration, Default is 0 (none) -T} -T{ -pac\-script -T}:T{ -string -T}:T{ -\ \& -T}:T{ -PAC script for the connection\&. This is an UTF\-8 encoded javascript code that defines a FindProxyForURL() function\&. -T} -T{ -pac\-url -T}:T{ -string -T}:T{ -\ \& -T}:T{ -PAC URL for obtaining PAC file\&. -T} -.TE -.sp 1 -.SS "serial setting" -.PP -Serial Link Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -baud -T}:T{ -uint32 -T}:T{ -57600 -T}:T{ -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\&. -T} -T{ -bits -T}:T{ -uint32 -T}:T{ -8 -T}:T{ -Byte\-width of the serial communication\&. The 8 in "8n1" for example\&. -T} -T{ -parity -T}:T{ -byte -T}:T{ -\ \& -T}:T{ -The connection parity: 69 (ASCII \*(AqE\*(Aq) for even parity, 111 (ASCII \*(Aqo\*(Aq) for odd, 110 (ASCII \*(Aqn\*(Aq) for none\&. -T} -T{ -send\-delay -T}:T{ -uint64 -T}:T{ -0 -T}:T{ -Time to delay between each byte sent to the modem, in microseconds\&. -T} -T{ -stopbits -T}:T{ -uint32 -T}:T{ -1 -T}:T{ -Number of stop bits for communication on the serial port\&. Either 1 or 2\&. The 1 in "8n1" for example\&. -T} -.TE -.sp 1 -.SS "sriov setting" -.PP -SR\-IOV settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -autoprobe\-drivers -T}:T{ -NMTernary (int32) -T}:T{ -\ \& -T}:T{ -Whether to autoprobe virtual functions by a compatible driver\&. - -If set to 1 (true), 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\&. - -If set to 0 (false), VFs will not be claimed and no network interfaces will be created for them\&. - -When set to \-1 (default), the global default is used; in case the global default is unspecified it is assumed to be 1 (true)\&. -T} -T{ -eswitch\-encap\-mode -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Select the eswitch encapsulation support\&. - -Currently it\*(Aqs only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF\&. - -If set to \-1 (preserve) (default) the eswitch encap\-mode won\*(Aqt be modified by NetworkManager\&. -T} -T{ -eswitch\-inline\-mode -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Select the eswitch inline\-mode of the device\&. Some HWs need the VF driver to put part of the packet headers on the TX descriptor so the e\-switch can do proper matching and steering\&. - -Currently it\*(Aqs only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF\&. - -If set to \-1 (preserve) (default) the eswitch inline\-mode won\*(Aqt be modified by NetworkManager\&. -T} -T{ -eswitch\-mode -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Select the eswitch mode of the device\&. Currently it\*(Aqs only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF\&. - -If set to \-1 (preserve) (default) the eswitch mode won\*(Aqt be modified by NetworkManager\&. -T} -T{ -total\-vfs -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The total number of virtual functions to create\&. - -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\*(Aqt add a sriov setting to the connection\&. -T} -T{ -vfs -T}:T{ -array of vardict -T}:T{ -\ \& -T}:T{ -Array of virtual function descriptors\&. - -Each VF descriptor is a dictionary mapping attribute names to GVariant values\&. The \*(Aqindex\*(Aq entry is mandatory for each VF\&. - -When represented as string a VF is in the form: - -"INDEX [ATTR=VALUE[ ATTR=VALUE]\&.\&.\&.]"\&. - -for example: - -"2 mac=00:11:22:33:44:55 spoof\-check=true"\&. - -Multiple VFs can be specified using a comma as separator\&. Currently, the following attributes are supported: mac, spoof\-check, trust, min\-tx\-rate, max\-tx\-rate, vlans\&. - -The "vlans" attribute is represented as a semicolon\-separated list of VLAN descriptors, where each descriptor has the form - -"ID[\&.PRIORITY[\&.PROTO]]"\&. - -PROTO can be either \*(Aqq\*(Aq for 802\&.1Q (the default) or \*(Aqad\*(Aq for 802\&.1ad\&. -T} -.TE -.sp 1 -.SS "tc setting" -.PP -Linux Traffic Control Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l. -T{ -qdiscs -T}:T{ -array of vardict -T}:T{ -\ \& -T}:T{ -Array of TC queueing disciplines\&. - -When the "tc" setting is present, qdiscs from this property are applied upon activation\&. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net\&.core\&.default_qdisc" sysctl\&. - -If the "tc" setting is not present, NetworkManager doesn\*(Aqt touch the qdiscs present on the interface\&. -T} -T{ -tfilters -T}:T{ -array of vardict -T}:T{ -\ \& -T}:T{ -Array of TC traffic filters\&. - -When the "tc" setting is present, filters from this property are applied upon activation\&. If the property is empty, NetworkManager removes all the filters\&. - -If the "tc" setting is not present, NetworkManager doesn\*(Aqt touch the filters present on the interface\&. -T} -.TE -.sp 1 -.SS "team setting" -.PP -Teaming Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -config -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The JSON configuration for the team network interface\&. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd\&. If not specified, the default configuration is used\&. See man teamd\&.conf for the format details\&. -T} -T{ -interface\-name -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Deprecated in favor of connection\&.interface\-name, but can be used for backward\-compatibility with older daemons, to set the team\*(Aqs interface name\&. -T} -T{ -link\-watchers -T}:T{ -array of vardict -T}:T{ -\ \& -T}:T{ -Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher\&. Available link watchers are \*(Aqethtool\*(Aq, \*(Aqnsna_ping\*(Aq and \*(Aqarp_ping\*(Aq and it is specified in the dictionary with the key \*(Aqname\*(Aq\&. Available keys are: ethtool: \*(Aqdelay\-up\*(Aq, \*(Aqdelay\-down\*(Aq, \*(Aqinit\-wait\*(Aq; nsna_ping: \*(Aqinit\-wait\*(Aq, \*(Aqinterval\*(Aq, \*(Aqmissed\-max\*(Aq, \*(Aqtarget\-host\*(Aq; arp_ping: all the ones in nsna_ping and \*(Aqsource\-host\*(Aq, \*(Aqvalidate\-active\*(Aq, \*(Aqvalidate\-inactive\*(Aq, \*(Aqsend\-always\*(Aq\&. See teamd\&.conf man for more details\&. -T} -T{ -mcast\-rejoin\-count -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Corresponds to the teamd mcast_rejoin\&.count\&. -T} -T{ -mcast\-rejoin\-interval -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Corresponds to the teamd mcast_rejoin\&.interval\&. -T} -T{ -notify\-peers\-count -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Corresponds to the teamd notify_peers\&.count\&. -T} -T{ -notify\-peers\-interval -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Corresponds to the teamd notify_peers\&.interval\&. -T} -T{ -runner -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Corresponds to the teamd runner\&.name\&. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random"\&. -T} -T{ -runner\-active -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -Corresponds to the teamd runner\&.active\&. -T} -T{ -runner\-agg\-select\-policy -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Corresponds to the teamd runner\&.agg_select_policy\&. -T} -T{ -runner\-fast\-rate -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Corresponds to the teamd runner\&.fast_rate\&. -T} -T{ -runner\-hwaddr\-policy -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Corresponds to the teamd runner\&.hwaddr_policy\&. -T} -T{ -runner\-min\-ports -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Corresponds to the teamd runner\&.min_ports\&. -T} -T{ -runner\-sys\-prio -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Corresponds to the teamd runner\&.sys_prio\&. -T} -T{ -runner\-tx\-balancer -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Corresponds to the teamd runner\&.tx_balancer\&.name\&. -T} -T{ -runner\-tx\-balancer\-interval -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Corresponds to the teamd runner\&.tx_balancer\&.interval\&. -T} -T{ -runner\-tx\-hash -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -Corresponds to the teamd runner\&.tx_hash\&. -T} -.TE -.sp 1 -.SS "team\-port setting" -.PP -Team Port Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -config -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The JSON configuration for the team port\&. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd\&. If not specified, the default configuration is used\&. See man teamd\&.conf for the format details\&. -T} -T{ -lacp\-key -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Corresponds to the teamd ports\&.PORTIFNAME\&.lacp_key\&. -T} -T{ -lacp\-prio -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Corresponds to the teamd ports\&.PORTIFNAME\&.lacp_prio\&. -T} -T{ -link\-watchers -T}:T{ -array of vardict -T}:T{ -\ \& -T}:T{ -Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher\&. Available link watchers are \*(Aqethtool\*(Aq, \*(Aqnsna_ping\*(Aq and \*(Aqarp_ping\*(Aq and it is specified in the dictionary with the key \*(Aqname\*(Aq\&. Available keys are: ethtool: \*(Aqdelay\-up\*(Aq, \*(Aqdelay\-down\*(Aq, \*(Aqinit\-wait\*(Aq; nsna_ping: \*(Aqinit\-wait\*(Aq, \*(Aqinterval\*(Aq, \*(Aqmissed\-max\*(Aq, \*(Aqtarget\-host\*(Aq; arp_ping: all the ones in nsna_ping and \*(Aqsource\-host\*(Aq, \*(Aqvalidate\-active\*(Aq, \*(Aqvalidate\-inactive\*(Aq, \*(Aqsend\-always\*(Aq\&. See teamd\&.conf man for more details\&. -T} -T{ -prio -T}:T{ -int32 -T}:T{ -0 -T}:T{ -Corresponds to the teamd ports\&.PORTIFNAME\&.prio\&. -T} -T{ -queue\-id -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Corresponds to the teamd ports\&.PORTIFNAME\&.queue_id\&. When set to \-1 means the parameter is skipped from the json config\&. -T} -T{ -sticky -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Corresponds to the teamd ports\&.PORTIFNAME\&.sticky\&. -T} -.TE -.sp 1 -.SS "tun setting" -.PP -Tunnel Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -group -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The group ID which will own the device\&. If set to NULL everyone will be able to use the device\&. -T} -T{ -mode -T}:T{ -uint32 -T}:T{ -1 -T}:T{ -The operating mode of the virtual device\&. Allowed values are 1 (tun) to create a layer 3 device and 2 (tap) to create an Ethernet\-like layer 2 one\&. -T} -T{ -multi\-queue -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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\&. -T} -T{ -owner -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The user ID which will own the device\&. If set to NULL everyone will be able to use the device\&. -T} -T{ -pi -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets\&. -T} -T{ -vnet\-hdr -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header\&. -T} -.TE -.sp 1 -.SS "user setting" -.PP -General User Profile Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l. -T{ -data -T}:T{ -dict of string to string -T}:T{ -{} -T}:T{ -A dictionary of key/value pairs with user data\&. This data is ignored by NetworkManager and can be used at the users discretion\&. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length\&. -T} -.TE -.sp 1 -.SS "vlan setting" -.PP -VLAN Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -egress\-priority\-map -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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"\&. -T} -T{ -flags -T}:T{ -NMVlanFlags (uint32) -T}:T{ -\ \& -T}:T{ -One or more flags which control the behavior and features of the VLAN interface\&. Flags include 0x1 (reorder\-headers) (reordering of output packet headers), 0x2 (gvrp) (use of the GVRP protocol), and 0x4 (loose\-binding) (loose binding of the interface to its controller device\*(Aqs operating state)\&. 0x8 (mvrp) (use of the MVRP protocol)\&. - -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\&. -T} -T{ -id -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -ingress\-priority\-map -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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"\&. -T} -T{ -interface\-name -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Deprecated in favor of connection\&.interface\-name, but can be used for backward\-compatibility with older daemons, to set the vlan\*(Aqs interface name\&. -T} -T{ -parent -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created\&. If this property is not specified, the connection must contain an "802\-3\-ethernet" setting with a "mac\-address" property\&. -T} -T{ -protocol -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Specifies the VLAN protocol to use for encapsulation\&. - -Supported values are: \*(Aq802\&.1Q\*(Aq, \*(Aq802\&.1ad\*(Aq\&. If not specified the default value is \*(Aq802\&.1Q\*(Aq\&. -T} -.TE -.sp 1 -.SS "vpn setting" -.PP -VPN Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -data -T}:T{ -dict of string to string -T}:T{ -{} -T}:T{ -Dictionary of key/value pairs of VPN plugin specific data\&. Both keys and values must be strings\&. -T} -T{ -persistent -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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\&. -T} -T{ -secrets -T}:T{ -dict of string to string -T}:T{ -{} -T}:T{ -Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys\&. Both keys and values must be strings\&. -T} -T{ -service\-type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -D\-Bus service name of the VPN plugin that this setting uses to connect to its network\&. i\&.e\&. org\&.freedesktop\&.NetworkManager\&.vpnc for the vpnc plugin\&. -T} -T{ -timeout -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -user\-name -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If the VPN connection requires a user name for authentication, that name should be provided here\&. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty\&. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection\&. -T} -.TE -.sp 1 -.SS "vrf setting" -.PP -VRF settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l. -T{ -table -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The routing table for this VRF\&. -T} -.TE -.sp 1 -.SS "vxlan setting" -.PP -VXLAN Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -ageing -T}:T{ -uint32 -T}:T{ -300 -T}:T{ -Specifies the lifetime in seconds of FDB entries learnt by the kernel\&. -T} -T{ -destination\-port -T}:T{ -uint32 -T}:T{ -8472 -T}:T{ -Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint\&. -T} -T{ -id -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use\&. -T} -T{ -l2\-miss -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Specifies whether netlink LL ADDR miss notifications are generated\&. -T} -T{ -l3\-miss -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Specifies whether netlink IP ADDR miss notifications are generated\&. -T} -T{ -learning -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database\&. -T} -T{ -limit -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Specifies the maximum number of FDB entries\&. A value of zero means that the kernel will store unlimited entries\&. -T} -T{ -local -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If given, specifies the source IP address to use in outgoing packets\&. -T} -T{ -parent -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If given, specifies the parent interface name or parent connection UUID\&. -T} -T{ -proxy -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Specifies whether ARP proxy is turned on\&. -T} -T{ -remote -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join\&. -T} -T{ -rsc -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -Specifies whether route short circuit is turned on\&. -T} -T{ -source\-port\-max -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint\&. -T} -T{ -source\-port\-min -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint\&. -T} -T{ -tos -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Specifies the TOS value to use in outgoing packets\&. -T} -T{ -ttl -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Specifies the time\-to\-live value to use in outgoing packets\&. -T} -.TE -.sp 1 -.SS "wifi\-p2p setting" -.PP -Wi\-Fi P2P Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l. -T{ -peer -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The P2P device that should be connected to\&. Currently, this is the only way to create or join a group\&. -T} -T{ -wfd\-ies -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -The Wi\-Fi Display (WFD) Information Elements (IEs) to set\&. - -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\&. -T} -T{ -wps\-method -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating which mode of WPS is to be used\&. - -There\*(Aqs little point in changing the default setting as NetworkManager will automatically determine the best method to use\&. -T} -.TE -.sp 1 -.SS "wimax setting" -.PP -WiMax Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l. -T{ -mac\-address -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -If specified, this connection will only apply to the WiMAX device whose MAC address matches\&. This property does not change the MAC address of the device (known as MAC spoofing)\&. - -This property is deprecated since version 1\&.2\&.WiMAX is no longer supported\&. -T} -T{ -network\-name -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Network Service Provider (NSP) name of the WiMAX network this connection should use\&. - -This property is deprecated since version 1\&.2\&.WiMAX is no longer supported\&. -T} -.TE -.sp 1 -.SS "802\-3\-ethernet setting" -.PP -Wired Ethernet Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -accept\-all\-mac\-addresses -T}:T{ -NMTernary (int32) -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -assigned\-mac\-address -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The new field for the cloned MAC address\&. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable"\&. This field replaces the deprecated "cloned\-mac\-address" on D\-Bus, which can only contain explicit hardware addresses\&. Note that this property only exists in D\-Bus API\&. libnm and nmcli continue to call this property "cloned\-mac\-address"\&. -T} -T{ -auto\-negotiate -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -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\&. -T} -T{ -cloned\-mac\-address -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -This D\-Bus field is deprecated in favor of "assigned\-mac\-address" which is more flexible and allows specifying special variants like "random"\&. For libnm and nmcli, this field is called "cloned\-mac\-address"\&. -T} -T{ -duplex -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -generate\-mac\-address\-mask -T}:T{ -string -T}:T{ -\ \& -T}:T{ -With "cloned\-mac\-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally\-administered, unicast MAC address is created\&. This property allows to specify that certain bits are fixed\&. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address\&. - -If the property is NULL, it is eligible to be overwritten by a default connection setting\&. If the value is still NULL or an empty string, the default is to create a locally\-administered, unicast MAC address\&. - -If the value contains one MAC address, this address is used as mask\&. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization\&. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm\&. - -If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized\&. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized\&. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally\-administered, burned\-in MAC address\&. - -If the value contains more than one additional MAC addresses, one of them is chosen randomly\&. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered\&. -T} -T{ -mac\-address -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -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)\&. -T} -T{ -mac\-address\-blacklist -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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)\&. -T} -T{ -mac\-address\-denylist -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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)\&. -T} -T{ -mtu -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. -T} -T{ -port -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -s390\-nettype -T}:T{ -string -T}:T{ -\ \& -T}:T{ -s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems\&. -T} -T{ -s390\-options -T}:T{ -dict of string to string -T}:T{ -{} -T}:T{ -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])\&. - -Currently, NetworkManager itself does nothing with this information\&. However, s390utils ships a udev rule which parses this information and applies it to the interface\&. -T} -T{ -s390\-subchannels -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -speed -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -wake\-on\-lan -T}:T{ -uint32 -T}:T{ -1 -T}:T{ -The NMSettingWiredWakeOnLan options to enable\&. Not all devices support all options\&. May be any combination of 0x2 (phy), 0x4 (unicast), 0x8 (multicast), 0x10 (broadcast), 0x20 (arp), 0x40 (magic) or the special values 0x1 (default) (to use global settings) and 0x8000 (ignore) (to disable management of Wake\-on\-LAN in NetworkManager)\&. -T} -T{ -wake\-on\-lan\-password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -.TE -.sp 1 -.SS "wireguard setting" -.PP -WireGuard Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -fwmark -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. - -Note that "ip4\-auto\-default\-route" or "ip6\-auto\-default\-route" enabled, implies to automatically choose a fwmark\&. -T} -T{ -ip4\-auto\-default\-route -T}:T{ -NMTernary (int32) -T}:T{ -\ \& -T}:T{ -Whether to enable special handling of the IPv4 default route\&. If enabled, the IPv4 default route from wireguard\&.peer\-routes will be placed to a dedicated routing\-table and two policy routing rules will be added\&. The fwmark number is also used as routing\-table for the default\-route, and if fwmark is zero, an unused fwmark/table is chosen automatically\&. This corresponds to what wg\-quick does with Table=auto and what WireGuard calls "Improved Rule\-based Routing"\&. - -Note that for this automatism to work, you usually don\*(Aqt want to set ipv4\&.gateway, because that will result in a conflicting default route\&. - -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\&. -T} -T{ -ip6\-auto\-default\-route -T}:T{ -NMTernary (int32) -T}:T{ -\ \& -T}:T{ -Like ip4\-auto\-default\-route, but for the IPv6 default route\&. -T} -T{ -listen\-port -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The listen\-port\&. If listen\-port is not specified, the port will be chosen randomly when the interface comes up\&. -T} -T{ -mtu -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments\&. - -If zero a default MTU is used\&. Note that contrary to wg\-quick\*(Aqs MTU setting, this does not take into account the current routes at the time of activation\&. -T} -T{ -peer\-routes -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -Whether to automatically add routes for the AllowedIPs ranges of the peers\&. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4\&.route\-table and ipv6\&.route\-table\&. Usually you want this automatism enabled\&. If FALSE, no such routes are added automatically\&. In this case, the user may want to configure static routes in ipv4\&.routes and ipv6\&.routes, respectively\&. - -Note that if the peer\*(Aqs AllowedIPs is "0\&.0\&.0\&.0/0" or "::/0" and the profile\*(Aqs ipv4\&.never\-default or ipv6\&.never\-default setting is enabled, the peer route for this peer won\*(Aqt be added automatically\&. -T} -T{ -peers -T}:T{ -array of \*(Aqa{sv}\*(Aq -T}:T{ -\ \& -T}:T{ -Array of dictionaries for the WireGuard peers\&. -T} -T{ -private\-key -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The 256 bit private\-key in base64 encoding\&. -T} -T{ -private\-key\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "private\-key" property\&. -T} -.TE -.sp 1 -.SS "802\-11\-wireless setting" -.PP -Wi\-Fi Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -ap\-isolation -T}:T{ -NMTernary (int32) -T}:T{ -\ \& -T}:T{ -Configures AP isolation, which prevents communication between wireless devices connected to this AP\&. This property can be set to a value different from \-1 (default) only when the interface is configured in AP mode\&. - -If set to 1 (true), 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\&. - -If set to 0 (false), devices can talk to each other\&. - -When set to \-1 (default), the global default is used; in case the global default is unspecified it is assumed to be 0 (false)\&. -T} -T{ -assigned\-mac\-address -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The new field for the cloned MAC address\&. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable"\&. This field replaces the deprecated "cloned\-mac\-address" on D\-Bus, which can only contain explicit hardware addresses\&. Note that this property only exists in D\-Bus API\&. libnm and nmcli continue to call this property "cloned\-mac\-address"\&. -T} -T{ -band -T}:T{ -string -T}:T{ -\ \& -T}:T{ -802\&.11 frequency band of the network\&. One of "a" for 5GHz 802\&.11a or "bg" for 2\&.4GHz 802\&.11\&. This will lock associations to the Wi\-Fi network to the specific band, i\&.e\&. if "a" is specified, the device will not associate with the same network in the 2\&.4GHz band even if the network\*(Aqs settings are compatible\&. This setting depends on specific driver capability and may not work with all drivers\&. -T} -T{ -bssid -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -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\&. - -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\&. -T} -T{ -channel -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -channel\-width -T}:T{ -int32 -T}:T{ -0 -T}:T{ -Specifies width of the wireless channel in Access Point (AP) mode\&. - -When set to 0 (auto) (the default), the channel width is automatically determined\&. At the moment, this means that the safest (smallest) width is chosen\&. - -If the value is not 0 (auto), then the \*(Aqchannel\*(Aq property must also be set\&. When using the 2\&.4GHz band, the width can be at most 40MHz\&. - -This property can be set to a value different from 0 (auto) only when the interface is configured in AP mode\&. -T} -T{ -cloned\-mac\-address -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -This D\-Bus field is deprecated in favor of "assigned\-mac\-address" which is more flexible and allows specifying special variants like "random"\&. For libnm and nmcli, this field is called "cloned\-mac\-address"\&. -T} -T{ -generate\-mac\-address\-mask -T}:T{ -string -T}:T{ -\ \& -T}:T{ -With "cloned\-mac\-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally\-administered, unicast MAC address is created\&. This property allows to specify that certain bits are fixed\&. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address\&. - -If the property is NULL, it is eligible to be overwritten by a default connection setting\&. If the value is still NULL or an empty string, the default is to create a locally\-administered, unicast MAC address\&. - -If the value contains one MAC address, this address is used as mask\&. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization\&. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm\&. - -If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized\&. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized\&. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally\-administered, burned\-in MAC address\&. - -If the value contains more than one additional MAC addresses, one of them is chosen randomly\&. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered\&. -T} -T{ -hidden -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -If TRUE, indicates that the network is a non\-broadcasting network that hides its SSID\&. This works both in infrastructure and AP mode\&. - -In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe\-scanning the SSID\&. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution\&. - -In AP mode, the created network does not broadcast its SSID\&. - -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\&. -T} -T{ -mac\-address -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -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)\&. -T} -T{ -mac\-address\-blacklist -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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")\&. -T} -T{ -mac\-address\-denylist -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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")\&. -T} -T{ -mac\-address\-randomization -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -One of 0 (default) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), 1 (never) (never randomize the MAC address), or 2 (always) (always randomize the MAC address)\&. - -This property is deprecated since version 1\&.4\&.Use the "cloned\-mac\-address" property instead\&. -T} -T{ -mode -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Wi\-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap"\&. If blank, infrastructure is assumed\&. -T} -T{ -mtu -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. -T} -T{ -powersave -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -One of 2 (disable) (disable Wi\-Fi power saving), 3 (enable) (enable Wi\-Fi power saving), 1 (ignore) (don\*(Aqt touch currently configure setting) or 0 (default) (use the globally configured value)\&. All other values are reserved\&. -T} -T{ -rate -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -This property is not implemented and has no effect\&. - -This property is deprecated since version 1\&.44\&.This property is not implemented and has no effect\&. -T} -T{ -security -T}:T{ -\ \& -T}:T{ -\ \& -T}:T{ -This property is deprecated and has no effect\&. For backwards compatibility, it can be set to "802\-11\-wireless\-security" if the profile has a wireless security setting\&. -T} -T{ -seen\-bssids -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi\-Fi network\&. NetworkManager internally tracks previously seen BSSIDs\&. The property is only meant for reading and reflects the BSSID list of NetworkManager\&. The changes you make to this property will not be preserved\&. - -This is not a regular property that the user would configure\&. Instead, NetworkManager automatically sets the seen BSSIDs and tracks them internally in "/var/lib/NetworkManager/seen\-bssids" file\&. -T} -T{ -ssid -T}:T{ -byte array -T}:T{ -\ \& -T}:T{ -SSID of the Wi\-Fi network\&. Must be specified\&. -T} -T{ -tx\-power -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -This property is not implemented and has no effect\&. - -This property is deprecated since version 1\&.44\&.This property is not implemented and has no effect\&. -T} -T{ -wake\-on\-wlan -T}:T{ -uint32 -T}:T{ -1 -T}:T{ -The NMSettingWirelessWakeOnWLan options to enable\&. Not all devices support all options\&. May be any combination of 0x2 (any), 0x4 (disconnect), 0x8 (magic), 0x10 (gtk\-rekey\-failure), 0x20 (eap\-identity\-request), 0x40 (4way\-handshake), 0x80 (rfkill\-release), 0x100 (tcp) or the special values 0x1 (default) (to use global settings) and 0x8000 (ignore) (to disable management of Wake\-on\-LAN in NetworkManager)\&. -T} -.TE -.sp 1 -.SS "802\-11\-wireless\-security setting" -.PP -Wi\-Fi Security Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -auth\-alg -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -fils -T}:T{ -int32 -T}:T{ -0 -T}:T{ -Indicates whether Fast Initial Link Setup (802\&.11ai) must be enabled for the connection\&. One of 0 (default) (use global default value), 1 (disable) (disable FILS), 2 (optional) (enable FILS if the supplicant and the access point support it) or 3 (required) (enable FILS and fail if not supported)\&. When set to 0 (default) and no global default is set, FILS will be optionally enabled\&. -T} -T{ -group -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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"\&. -T} -T{ -key\-mgmt -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Key management used for the connection\&. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa\-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa\-eap" (WPA2 + WPA3 enterprise) or "wpa\-eap\-suite\-b\-192" (WPA3 enterprise only)\&. - -This property must be set for any Wi\-Fi connection that uses security\&. -T} -T{ -leap\-password -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The login password for legacy LEAP connections (ie, key\-mgmt = "ieee8021x" and auth\-alg = "leap")\&. -T} -T{ -leap\-password\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "leap\-password" property\&. -T} -T{ -leap\-username -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The login username for legacy LEAP connections (ie, key\-mgmt = "ieee8021x" and auth\-alg = "leap")\&. -T} -T{ -pairwise -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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"\&. -T} -T{ -pmf -T}:T{ -int32 -T}:T{ -0 -T}:T{ -Indicates whether Protected Management Frames (802\&.11w) must be enabled for the connection\&. One of 0 (default) (use global default value), 1 (disable) (disable PMF), 2 (optional) (enable PMF if the supplicant and the access point support it) or 3 (required) (enable PMF and fail if not supported)\&. When set to 0 (default) and no global default is set, PMF will be optionally enabled\&. -T} -T{ -proto -T}:T{ -array of string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -psk -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Pre\-Shared\-Key for WPA networks\&. For WPA\-PSK, it\*(Aqs either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802\&.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character\&. The WPA3\-Personal networks use a passphrase of any length for SAE authentication\&. -T} -T{ -psk\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "psk" property\&. -T} -T{ -wep\-key\-flags -T}:T{ -NMSettingSecretFlags (uint32) -T}:T{ -\ \& -T}:T{ -Flags indicating how to handle the "wep\-key0", "wep\-key1", "wep\-key2", and "wep\-key3" properties\&. -T} -T{ -wep\-key\-type -T}:T{ -NMWepKeyType (uint32) -T}:T{ -\ \& -T}:T{ -Controls the interpretation of WEP keys\&. Allowed values are 1 (key), in which case the key is either a 10\- or 26\-character hexadecimal string, or a 5\- or 13\-character ASCII password; or 2 (passphrase), 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\&. -T} -T{ -wep\-key0 -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Index 0 WEP key\&. This is the WEP key used in most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. -T} -T{ -wep\-key1 -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Index 1 WEP key\&. This WEP index is not used by most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. -T} -T{ -wep\-key2 -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Index 2 WEP key\&. This WEP index is not used by most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. -T} -T{ -wep\-key3 -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Index 3 WEP key\&. This WEP index is not used by most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. -T} -T{ -wep\-tx\-keyidx -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -wps\-method -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -Flags indicating which mode of WPS is to be used if any\&. - -There\*(Aqs little point in changing the default setting as NetworkManager will automatically determine whether it\*(Aqs feasible to start WPS enrollment from the Access Point capabilities\&. - -WPS can be disabled by setting this property to a value of 1\&. -T} -.TE -.sp 1 -.SS "wpan setting" -.PP -IEEE 802\&.15\&.4 (WPAN) MAC Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -channel -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -IEEE 802\&.15\&.4 channel\&. A positive integer or \-1, meaning "do not set, use whatever the device is already set to"\&. -T} -T{ -mac\-address -T}:T{ -string -T}:T{ -\ \& -T}:T{ -If specified, this connection will only apply to the IEEE 802\&.15\&.4 (WPAN) MAC layer device whose permanent MAC address matches\&. -T} -T{ -page -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -IEEE 802\&.15\&.4 channel page\&. A positive integer or \-1, meaning "do not set, use whatever the device is already set to"\&. -T} -T{ -pan\-id -T}:T{ -uint32 -T}:T{ -65535 -T}:T{ -IEEE 802\&.15\&.4 Personal Area Network (PAN) identifier\&. -T} -T{ -short\-address -T}:T{ -uint32 -T}:T{ -65535 -T}:T{ -Short IEEE 802\&.15\&.4 address to be used within a restricted environment\&. -T} -.TE -.sp 1 -.SS "bond\-port setting" -.PP -Bond Port Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l. -T{ -prio -T}:T{ -int32 -T}:T{ -0 -T}:T{ -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\&. -T} -T{ -queue\-id -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -The queue ID of this bond port\&. The maximum value of queue ID is the number of TX queues currently active in device\&. -T} -.TE -.sp 1 -.SS "hostname setting" -.PP -Hostname settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -from\-dhcp -T}:T{ -NMTernary (int32) -T}:T{ -\ \& -T}:T{ -Whether the system hostname can be determined from DHCP on this connection\&. - -When set to \-1 (default), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be 1 (true)\&. -T} -T{ -from\-dns\-lookup -T}:T{ -NMTernary (int32) -T}:T{ -\ \& -T}:T{ -Whether the system hostname can be determined from reverse DNS lookup of addresses on this device\&. - -When set to \-1 (default), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be 1 (true)\&. -T} -T{ -only\-from\-default -T}:T{ -NMTernary (int32) -T}:T{ -\ \& -T}:T{ -If set to 1 (true), 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)\&. - -If set to 0 (false), the hostname can be set from this device even if it doesn\*(Aqt have the default route\&. - -When set to \-1 (default), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be 0 (false)\&. -T} -T{ -priority -T}:T{ -int32 -T}:T{ -0 -T}:T{ -The relative priority of this connection to determine the system hostname\&. A lower numerical value is better (higher priority)\&. A connection with higher priority is considered before connections with lower priority\&. - -If the value is zero, it can be overridden by a global value from NetworkManager configuration\&. If the property doesn\*(Aqt have a value in the global configuration, the value is assumed to be 100\&. - -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\&. -T} -.TE -.sp 1 -.SS "link setting" -.PP -Link settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -gro\-max\-size -T}:T{ -int64 -T}:T{ -\-1 -T}:T{ -The maximum size of a packet built by the Generic Receive Offload stack for this device\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. -T} -T{ -gso\-max\-segments -T}:T{ -int64 -T}:T{ -\-1 -T}:T{ -The maximum segments of a Generic Segment Offload packet the device should accept\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. -T} -T{ -gso\-max\-size -T}:T{ -int64 -T}:T{ -\-1 -T}:T{ -The maximum size of a Generic Segment Offload packet the device should accept\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. -T} -T{ -tx\-queue\-length -T}:T{ -int64 -T}:T{ -\-1 -T}:T{ -The size of the transmit queue for the device, in number of packets\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. -T} -.TE -.sp 1 -.SS "loopback setting" -.PP -Loopback Link Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l. -T{ -mtu -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. -T} -.TE -.sp 1 -.SS "ovs\-external\-ids setting" -.PP -OVS External IDs Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l. -T{ -data -T}:T{ -dict of string to string -T}:T{ -{} -T}:T{ -A dictionary of key/value pairs with external\-ids for OVS\&. -T} -.TE -.sp 1 -.SS "ovs\-other\-config setting" -.PP -OVS Other Config Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l. -T{ -data -T}:T{ -dict of string to string -T}:T{ -{} -T}:T{ -A dictionary of key/value pairs with other_config settings for OVS\&. See also "other_config" in the "ovs\-vswitchd\&.conf\&.db" manual for the keys that OVS supports\&. -T} -.TE -.sp 1 -.SS "veth setting" -.PP -Veth Settings\&. -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l. -T{ -peer -T}:T{ -string -T}:T{ -\ \& -T}:T{ -This property specifies the peer interface name of the veth\&. This property is mandatory\&. -T} -.TE -.sp 1 -.SS "Secret flag types:" -.PP -Each password or secret property in a setting has an associated -\fIflags\fR -property that describes how to handle that secret\&. The -\fIflags\fR -property is a bitfield that contains zero or more of the following values logically OR\-ed together\&. -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -0x0 (none) \- the system is responsible for providing and storing this secret\&. This may be required so that secrets are already available before the user logs in\&. It also commonly means that the secret will be stored in plain text on disk, accessible to root only\&. For example via the keyfile settings plugin as described in the "PLUGINS" section in -\fBNetworkManager.conf\fR(5)\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -0x1 (agent\-owned) \- a user\-session secret agent is responsible for providing and storing this secret; when it is required, agents will be asked to provide it\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -0x2 (not\-saved) \- this secret should not be saved but should be requested from the user each time it is required\&. This flag should be used for One\-Time\-Pad secrets, PIN codes from hardware tokens, or if the user simply does not want to save the secret\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -0x4 (not\-required) \- in some situations it cannot be automatically determined that a secret is required or not\&. This flag hints that the secret is not required and should not be requested from the user\&. -.RE -.SH "FILES" -.PP -/etc/NetworkManager/system\-connections -or distro plugin\-specific location -.SH "SEE ALSO" -.PP -\fBnm-settings-nmcli\fR(5), -\fBnm-settings-keyfile\fR(5), -\fBNetworkManager\fR(8), -\fBnmcli\fR(1), -\fBnmcli-examples\fR(7), -\fBNetworkManager.conf\fR(5) diff --git a/man/nm-settings-ifcfg-rh.5 b/man/nm-settings-ifcfg-rh.5 deleted file mode 100644 index 9df982c2..00000000 --- a/man/nm-settings-ifcfg-rh.5 +++ /dev/null @@ -1,3764 +0,0 @@ -'\" t -.\" Title: nm-settings-ifcfg-rh -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: Configuration -.\" Source: NetworkManager 1.50.0 -.\" Language: English -.\" -.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.50\&.0" "Configuration" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nm-settings-ifcfg-rh \- Description of \fIifcfg\-rh\fR settings plugin -.SH "DESCRIPTION" -.PP -NetworkManager is based on the concept of connection profiles that contain network configuration (see -\fBnm-settings-nmcli\fR(5) -for details)\&. The profiles can be stored in various formats\&. NetworkManager uses plugins for reading and writing the data\&. The plugins can be configured in -\fBNetworkManager.conf\fR(5)\&. -.PP -The -\fIifcfg\-rh\fR -plugin is used on the Fedora and Red Hat Enterprise Linux distributions to read/write configuration from/to the traditional -/etc/sysconfig/network\-scripts/ifcfg\-* -files\&. Each NetworkManager connection maps to one -ifcfg\-* -file, with possible usage of -keys\-* -for passwords, -route\-* -for static IPv4 routes and -route6\-* -for static IPv6 routes\&. The plugin currently supports reading and writing Ethernet, Wi\-Fi, InfiniBand, VLAN, Bond, Bridge, and Team connections\&. Unsupported connection types (such as WWAN, PPPoE, VPN, or ADSL) are handled by -\fIkeyfile\fR -plugin (\fBnm-settings-keyfile\fR(5))\&. The main reason for using -\fIifcfg\-rh\fR -plugin is the compatibility with legacy configurations for -\fIifup\fR -and -\fIifdown\fR -(initscripts)\&. -.SH "FILE FORMAT" -.PP -The -\fIifcfg\-rh\fR -config format is a simple text file containing VARIABLE="value" lines\&. The format is described in -sysconfig\&.txt -of -\fIinitscripts\fR -package\&. Note that the configuration files may be sourced by -\fIinitscripts\fR, so they must be valid shell scripts\&. That means, for instance, that -# -character can be used for comments, strings with spaces must be quoted, special characters must be escaped, etc\&. -.PP -Users can create or modify the -\fIifcfg\-rh\fR -connection files manually, even if that is not the recommended way of managing the profiles\&. However, if they choose to do that, they must inform NetworkManager about their changes (for example via -\fInmcli con (re)load\fR)\&. -.PP -\fBSome ifcfg-rh configuration examples:\fR. -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fBSimple DHCP ethernet configuration:\fR -NAME=ethernet -UUID=1c4ddf70\-01bf\-46d6\-b04f\-47e842bd98da -TYPE=Ethernet -BOOTPROTO=dhcp -DEFROUTE=yes -PEERDNS=yes -PEERROUTES=yes -IPV4_FAILURE_FATAL=no -ONBOOT=yes - -.fi -.if n \{\ -.RE -.\} - -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fBSimple ethernet configuration with static IP:\fR -TYPE=Ethernet -BOOTPROTO=none -IPADDR=10\&.1\&.0\&.25 -PREFIX=24 -GATEWAY=10\&.1\&.0\&.1 -DEFROUTE=yes -IPV4_FAILURE_FATAL=no -IPV6INIT=yes -IPV6_AUTOCONF=yes -IPV6_DEFROUTE=yes -IPV6_PEERDNS=yes -IPV6_PEERROUTES=yes -IPV6_FAILURE_FATAL=no -NAME=ethernet\-em2 -UUID=51bb3904\-c0fc\-4dfe\-83b2\-0a71e7928c13 -DEVICE=em2 -ONBOOT=yes - -.fi -.if n \{\ -.RE -.\} - -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fBWPA2 Enterprise WLAN (TTLS with inner MSCHAPV2 authentication):\fR -ESSID="CompanyWLAN" -MODE=Managed -KEY_MGMT=WPA\-EAP -TYPE=Wireless -IEEE_8021X_EAP_METHODS=TTLS -IEEE_8021X_IDENTITY=joe -IEEE_8021X_PASSWORD_FLAGS=ask -IEEE_8021X_INNER_AUTH_METHODS=MSCHAPV2 -IEEE_8021X_CA_CERT=/home/joe/\&.cert/company\&.crt -BOOTPROTO=dhcp -DEFROUTE=yes -PEERDNS=yes -PEERROUTES=yes -IPV4_FAILURE_FATAL=no -IPV6INIT=no -NAME=MyCompany -UUID=f79848ff\-11a6\-4810\-9e1a\-99039dea84c4 -ONBOOT=yes - -.fi -.if n \{\ -.RE -.\} - -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fBBridge and bridge port configuration:\fR -ifcfg\-bridge: ifcfg\-bridge\-port: -NAME=bridge NAME=bridge007\-port\-eth0 -UUID=4be99ce0\-c5b2\-4764\-8b77\-ec226e440125 UUID=3ad56c4a\-47e1\-419b\-b0d4\-8ad86eb967a3 -DEVICE=bridge007 DEVICE=eth0 -STP=yes ONBOOT=yes -TYPE=Bridge TYPE=Ethernet -BRIDGING_OPTS=priority=32768 BRIDGE=bridge007 -ONBOOT=yes -BOOTPROTO=dhcp - - -.fi -.if n \{\ -.RE -.\} - -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fBBonding configuration:\fR -ifcfg\-BOND: ifcfg\-BOND\-port: -NAME=BOND NAME=BOND\-port -UUID=b41888aa\-924c\-450c\-b0f8\-85a4f0a51b4a UUID=9bb048e4\-286a\-4cc3\-b104\-007dbd20decb -DEVICE=bond100 DEVICE=eth0 -BONDING_OPTS="mode=balance\-rr miimon=100" ONBOOT=yes -TYPE=Bond TYPE=Ethernet -BONDING_MASTER=yes MASTER=bond100 -ONBOOT=yes SLAVE=yes -BOOTPROTO=dhcp - - -.fi -.if n \{\ -.RE -.\} - -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fBTeam and team port configuration:\fR -ifcfg\-my_team0: -DEVICE=team0 -TEAM_CONFIG="{ \e"device\e": \e"team0\e", \e"runner\e": {\e"name\e": \e"roundrobin\e"}, \e"ports\e": {\e"eth1\e": {}, \e"eth2\e": {}} }" -DEVICETYPE=Team -BOOTPROTO=dhcp -NAME=team0\-profile -UUID=1d3460a0\-7b37\-457f\-a300\-fe8d92da4807 -ONBOOT=yes - -ifcfg\-my_team0_port1: -NAME=team0\-port1 -UUID=d5aed298\-c567\-4cc1\-b808\-6d38ecef9e64 -DEVICE=eth1 -ONBOOT=yes -TEAM_MASTER=team0 -DEVICETYPE=TeamPort - -ifcfg\-my_team0_port2: -NAME=team0\-port2 -UUID=94e75f4e\-e5ad\-401c\-8962\-31e0ae5d2215 -DEVICE=eth2 -ONBOOT=yes -TEAM_MASTER=team0 -DEVICETYPE=TeamPort - -.fi -.if n \{\ -.RE -.\} - -The UUID values in the config files must be unique\&. You can use -\fIuuidgen\fR -command line tool to generate such values\&. Alternatively, you can leave out UUID entirely\&. In that case NetworkManager will generate a UUID based on the file name\&. -.SH "DIFFERENCES AGAINST INITSCRIPTS" -.PP -The main differences of NetworkManager ifcfg\-rh plugin and traditional initscripts are: -.PP -\fBNM_CONTROLLED=yes|no\fR -.RS 4 -NM_CONTROLLED is NetworkManager\-specific variable used by NetworkManager for determining whether the device of the -\fIifcfg\fR -file should be managed\&. NM_CONTROLLED=yes is supposed if the variable is not present in the file\&. Note that if you have more -\fIifcfg\fR -files for a single device, NM_CONTROLLED=no in one of the files will cause the device not to be managed\&. The profile may not even be the active one\&. -.RE -.PP -\fBNew variables\fR -.RS 4 -NetworkManager has introduced some new variable, not present in initscripts, to be able to store data for its new features\&. The variables are marked as extensions in the tables below\&. -.RE -.PP -\fBSemantic change of variables and differences\fR -.RS 4 -NetworkManager changes the semantics for a few variables and there are other behavioral differences\&. -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -PEERDNS -\- initscripts interpret PEERDNS=no to mean "never touch resolv\&.conf"\&. NetworkManager interprets it to say "never add automatic (DHCP, PPP, VPN, etc\&.) nameservers to resolv\&.conf"\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -ONBOOT -\- initscripts use ONBOOT=yes to mark the devices that are to be activated during boot\&. NetworkManager extends this to also mean that this profile can be used for auto\-connecting at any time\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -BOOTPROTO -\- NetworkManager supports traditional values -\fInone\fR -(static), -\fIdhcp\fR\&. But it also allows additional values to enable new addressing methods\&. They are -\fIautoip\fR -for IPv4 link\-local addressing using Avahi daemon and -\fIshared\fR -for connection sharing\&. When -\fIshared\fR -is used, NetworkManager assigns the interface 10\&.42\&.0\&.1, or it uses the first static address, if configured\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -HWADDR -\- initscripts compare the currently set hardware address of a device, while NetworkManager considers the permanent one\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -NOZEROCONF -\- initscripts add an on\-link route to 169\&.254\&.0\&.0/16 for ethernet profiles that don\*(Aqt explicitly opt\-out by setting -NOZEROCONF -variable\&. NetworkManager does not do that\&. Instead a static, manual route with scope=253 (link) should be added to get that behavior\&. -.RE -.RE -.PP -See the next section for detailed mapping of NetworkManager properties and -\fIifcfg\-rh\fR -variables\&. Variable names, format and usage differences in NetworkManager and initscripts are documented in the tables below\&. -.SH "DETAILS" -.PP -\fIifcfg\-rh\fR -plugin variables marked with -\fI(+)\fR -are NetworkManager specific extensions not understood by traditional initscripts\&. -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&1.\ \&802\-11\-wireless setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -ssid -T}:T{ -ESSID -T}:T{ -\ \& -T}:T{ -SSID of Wi\-Fi network\&.\fB - -Example: \fRESSID="Quick Net" -T} -T{ -mode -T}:T{ -MODE -T}:T{ -\ \& -T}:T{ -Wi\-Fi network mode\&.\fB - -Allowed values: \fRAd\-Hoc, Managed (Auto) [case insensitive] -T} -T{ -band -T}:T{ -BAND\fI(+)\fR -T}:T{ -\ \& -T}:T{ -BAND alone is honored, but CHANNEL overrides BAND since it implies a band\&.\fB - -Example: \fRBAND=bg\fB - -Allowed values: \fRa, bg -T} -T{ -channel -T}:T{ -CHANNEL -T}:T{ -\ \& -T}:T{ -Channel used for the Wi\-Fi communication\&. Channels greater than 14 mean "a" band, otherwise the band is "bg"\&.\fB - -Example: \fRCHANNEL=6 -T} -T{ -bssid -T}:T{ -BSSID\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Restricts association only to a single AP\&.\fB - -Example: \fRBSSID=00:1E:BD:64:83:21 -T} -T{ -rate -T}:T{ -(none) -T}:T{ -\ \& -T}:T{ -This property is deprecated and not handled by ifcfg\-rh plugin\&. -T} -T{ -tx\-power -T}:T{ -(none) -T}:T{ -\ \& -T}:T{ -This property is deprecated and not handled by ifcfg\-rh plugin\&. -T} -T{ -mac\-address -T}:T{ -HWADDR -T}:T{ -\ \& -T}:T{ -Hardware address of the device in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:14:5A:05)\&. Note that for initscripts this is the current MAC address of the device as found during ifup\&. For NetworkManager this is the permanent MAC address\&. Or in case no permanent MAC address exists, the MAC address initially configured on the device\&. -T} -T{ -cloned\-mac\-address -T}:T{ -MACADDR -T}:T{ -\ \& -T}:T{ -Cloned (spoofed) MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:14:5A:99)\&. -T} -T{ -generate\-mac\-address\-mask -T}:T{ -GENERATE_MAC_ADDRESS_MASK\fI(+)\fR -T}:T{ -\ \& -T}:T{ -the MAC address mask for generating randomized and stable cloned\-mac\-address\&. -T} -T{ -mac\-address\-blacklist -T}:T{ -HWADDR_BLACKLIST\fI(+)\fR -T}:T{ -\ \& -T}:T{ -It denies usage of the connection for any device whose address is listed\&. -T} -T{ -mac\-address\-denylist -T}:T{ -HWADDR_BLACKLIST\fI(+)\fR -T}:T{ -\ \& -T}:T{ -It denies usage of the connection for any device whose address is listed\&. -T} -T{ -seen\-bssids -T}:T{ -(none) -T}:T{ -\ \& -T}:T{ -This is not a regular property that would be configured by the user\&. It is not handled by ifcfg\-rh plugin\&. -T} -T{ -mtu -T}:T{ -MTU -T}:T{ -\ \& -T}:T{ -MTU of the wireless interface\&. -T} -T{ -hidden -T}:T{ -SSID_HIDDEN\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Whether the network hides the SSID\&. -T} -T{ -powersave -T}:T{ -POWERSAVE\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Enables or disables Wi\-Fi power saving\&.\fB - -Example: \fRPOWERSAVE=enable\fB - -Allowed values: \fRdefault, ignore, enable, disable -T} -T{ -mac\-address\-randomization -T}:T{ -MAC_ADDRESS_RANDOMIZATION\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Enables or disables Wi\-Fi MAC address randomization\&.\fB - -Example: \fRMAC_ADDRESS_RANDOMIZATION=always\fB - -Allowed values: \fRdefault, never, always -T} -T{ -ap\-isolation -T}:T{ -AP_ISOLATION\fI(+)\fR -T}:T{ -missing variable means global default -T}:T{ -Whether AP isolation is enabled\fB - -Allowed values: \fR"yes", "no" -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&2.\ \&802\-11\-wireless\-security setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -key\-mgmt -T}:T{ -KEY_MGMT\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Key management method\&.\fB - -Allowed values: \fRnone, ieee8021x, owe, wpa\-psk, sae, wpa\-eap, wpa\-eap\-suite\-b\-192 -T} -T{ -wep\-tx\-keyidx -T}:T{ -DEFAULTKEY -T}:T{ -1 -T}:T{ -Index of active WEP key\&. Note that in ifcfg format the index starts counting at 1, while NetworkManager API otherwise is zero based\&.\fB - -Allowed values: \fR1, 2, 3, 4 -T} -T{ -auth\-alg -T}:T{ -SECURITYMODE\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Authentication algorithm for WEP\&.\fB - -Allowed values: \fRrestricted, open, leap -T} -T{ -proto -T}:T{ -WPA_ALLOW_WPA\fI(+)\fR, WPA_ALLOW_WPA2\fI(+)\fR -T}:T{ -no -T}:T{ -Allowed WPA protocols, WPA and WPA2 (RSN)\&.\fB - -Allowed values: \fRyes, no -T} -T{ -pairwise -T}:T{ -CIPHER_PAIRWISE\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Restrict pairwise encryption algorithms, specified as a space separated list\&.\fB - -Allowed values: \fRCCMP, TKIP -T} -T{ -group -T}:T{ -CIPHER_GROUP\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Restrict group/broadcast encryption algorithms, specified as a space separated list\&.\fB - -Allowed values: \fRCCMP, TKIP, WEP40, WEP104 -T} -T{ -pmf -T}:T{ -PMF\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Enables or disables PMF (802\&.11w)\fB - -Example: \fRPMF=required\fB - -Allowed values: \fRdefault, disable, optional, required -T} -T{ -leap\-username -T}:T{ -IEEE_8021X_IDENTITY\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Login name for LEAP\&. -T} -T{ -wep\-key0 -T}:T{ -KEY1, KEY_PASSPHRASE1\fI(+)\fR -T}:T{ -\ \& -T}:T{ -The first WEP key (used in most networks)\&. See also DEFAULTKEY for key index\&. -T} -T{ -wep\-key1 -T}:T{ -KEY2, KEY_PASSPHRASE2\fI(+)\fR -T}:T{ -\ \& -T}:T{ -WEP key with index 1\&. See also DEFAULTKEY for key index\&. -T} -T{ -wep\-key2 -T}:T{ -KEY3, KEY_PASSPHRASE3\fI(+)\fR -T}:T{ -\ \& -T}:T{ -WEP key with index 2\&. See also DEFAULTKEY for key index\&. -T} -T{ -wep\-key3 -T}:T{ -KEY4, KEY_PASSPHRASE4\fI(+)\fR -T}:T{ -\ \& -T}:T{ -WEP key with index 3\&. See also DEFAULTKEY for key index\&. -T} -T{ -wep\-key\-flags -T}:T{ -WEP_KEY_FLAGS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Password flags for KEY<i>, KEY_PASSPHRASE<i> password\&. (see the section called \(lqSecret flags\(rq for _FLAGS values) -T} -T{ -psk -T}:T{ -WPA_PSK -T}:T{ -\ \& -T}:T{ -Pre\-Shared\-Key for WPA networks\&. -T} -T{ -psk\-flags -T}:T{ -WPA_PSK_FLAGS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Password flags for WPA_PSK_FLAGS\&. (see the section called \(lqSecret flags\(rq for _FLAGS values)\fB - -Example: \fRWPA_PSK_FLAGS=user -T} -T{ -leap\-password -T}:T{ -IEEE_8021X_PASSWORD\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Password for LEAP\&. It can also go to "key\-" lookaside file, or it can be owned by a secret agent\&. -T} -T{ -leap\-password\-flags -T}:T{ -IEEE_8021X_PASSWORD_FLAGS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Password flags for IEEE_8021X_PASSWORD_FLAGS\&. (see the section called \(lqSecret flags\(rq for _FLAGS values) -T} -T{ -wep\-key\-type -T}:T{ -KEY<i> or KEY_PASSPHRASE<i>\fI(+)\fR; KEY_TYPE\fI(+)\fR -T}:T{ -\ \& -T}:T{ -KEY is used for "key" type (10 or 26 hexadecimal characters, or 5 or 13 character string prefixed with "s:")\&. KEY_PASSPHRASE is used for WEP passphrases\&. KEY_TYPE specifies the key type and can be either \*(Aqkey\*(Aq or \*(Aqpassphrase\*(Aq\&. KEY_TYPE is redundant and can be omitted\&.\fB - -Example: \fRKEY1=s:ahoj, KEY1=0a1c45bc02, KEY_PASSPHRASE1=mysupersecretkey -T} -T{ -wps\-method -T}:T{ -WPS_METHOD -T}:T{ -\ \& -T}:T{ -Used to control the WPS methods to be used Valid values are "default", "auto", "disabled", "pin" and "pbc"\&. If omitted, whatver the AP announces is used\&.\fB - -Example: \fRWPS_METHOD=disabled, WPS_METHOD="pin pbc" -T} -T{ -fils -T}:T{ -FILS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Enables or disables FILS (802\&.11ai)\fB - -Example: \fRFILS=required\fB - -Allowed values: \fRdefault, disable, optional, required -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&3.\ \&802\-1x setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -eap -T}:T{ -IEEE_8021X_EAP_METHODS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -EAP method for 802\&.1X authentication\&.\fB - -Example: \fRIEEE_8021X_EAP_METHODS=PEAP\fB - -Allowed values: \fR"LEAP", "PWD", "TLS", "PEAP", "TTLS", "FAST" -T} -T{ -identity -T}:T{ -IEEE_8021X_IDENTITY\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Identity for EAP authentication methods\&.\fB - -Example: \fRIEEE_8021X_IDENTITY=itsme -T} -T{ -anonymous\-identity -T}:T{ -IEEE_8021X_ANON_IDENTITY\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Anonymous identity for EAP authentication methods\&. -T} -T{ -pac\-file -T}:T{ -IEEE_8021X_PAC_FILE\fI(+)\fR -T}:T{ -\ \& -T}:T{ -File with PAC (Protected Access Credential) for EAP\-FAST\&.\fB - -Example: \fRIEEE_8021X_PAC_FILE=/home/joe/my\-fast\&.pac -T} -T{ -ca\-cert -T}:T{ -IEEE_8021X_CA_CERT\fI(+)\fR -T}:T{ -\ \& -T}:T{ -CA certificate for EAP\&.\fB - -Example: \fRIEEE_8021X_CA_CERT=/home/joe/cacert\&.crt -T} -T{ -ca\-path -T}:T{ -IEEE_8021X_CA_PATH\fI(+)\fR -T}:T{ -\ \& -T}:T{ -The search path for the certificate\&. -T} -T{ -subject\-match -T}:T{ -IEEE_8021X_SUBJECT_MATCH\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Substring to match subject of server certificate against\&.\fB - -Example: \fRIEEE_8021X_SUBJECT_MATCH="Red Hat" -T} -T{ -altsubject\-matches -T}:T{ -IEEE_8021X_ALTSUBJECT_MATCHES\fI(+)\fR -T}:T{ -\ \& -T}:T{ -List of strings to be matched against the altSubjectName\&.\fB - -Example: \fRIEEE_8021X_ALTSUBJECT_MATCHES="s1\&.domain\&.cc" -T} -T{ -domain\-suffix\-match -T}:T{ -IEEE_8021X_DOMAIN_SUFFIX_MATCH\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Suffix to match domain of server certificate against\&. -T} -T{ -domain\-match -T}:T{ -IEEE_8021X_DOMAIN_MATCH\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Value to match domain of server certificate against\&. -T} -T{ -client\-cert -T}:T{ -IEEE_8021X_CLIENT_CERT\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Client certificate for EAP\&.\fB - -Example: \fRIEEE_8021X_CLIENT_CERT=/home/joe/mycert\&.crt -T} -T{ -phase1\-peapver -T}:T{ -IEEE_8021X_PEAP_VERSION\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Use to force a specific PEAP version\&.\fB - -Allowed values: \fR0, 1 -T} -T{ -phase1\-peaplabel -T}:T{ -IEEE_8021X_PEAP_FORCE_NEW_LABEL\fI(+)\fR -T}:T{ -no -T}:T{ -Use to force the new PEAP label during key derivation\&.\fB - -Allowed values: \fRyes, no -T} -T{ -phase1\-fast\-provisioning -T}:T{ -IEEE_8021X_FAST_PROVISIONING\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Enable in\-line provisioning of EAP\-FAST credentials\&.\fB - -Example: \fRIEEE_8021X_FAST_PROVISIONING="allow\-auth allow\-unauth"\fB - -Allowed values: \fRspace\-separated list of these values [allow\-auth, allow\-unauth] -T} -T{ -phase1\-auth\-flags -T}:T{ -IEEE_8021X_PHASE1_AUTH_FLAGS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Authentication flags for the supplicant\fB - -Example: \fRIEEE_8021X_PHASE1_AUTH_FLAGS="tls\-1\-0\-disable tls\-1\-1\-disable"\fB - -Allowed values: \fRspace\-separated list of authentication flags names -T} -T{ -phase2\-auth -T}:T{ -IEEE_8021X_INNER_AUTH_METHODS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Inner non\-EAP authentication methods for TTLS or the inner EAP authentication method for PEAP\&. IEEE_8021X_INNER_AUTH_METHODS can contain values both for \*(Aqphase2\-auth\*(Aq and \*(Aqphase2\-autheap\*(Aq properties\&.\fB - -Example: \fRIEEE_8021X_INNER_AUTH_METHODS=PAP\fB - -Allowed values: \fR"PAP", "CHAP", "MSCHAP", "MSCHAPV2", "GTC", "OTP", "MD5" and "TLS" -T} -T{ -phase2\-autheap -T}:T{ -IEEE_8021X_INNER_AUTH_METHODS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Inner EAP\-based authentication methods\&. Note that IEEE_8021X_INNER_AUTH_METHODS is also used for \*(Aqphase2\-auth\*(Aq values\&.\fB - -Example: \fRIEEE_8021X_INNER_AUTH_METHODS="MSCHAPV2 EAP\-TLS"\fB - -Allowed values: \fR"EAP\-MD5", "EAP\-MSCHAPV2", "EAP\-GTC", "EAP\-OTP" and "EAP\-TLS" -T} -T{ -phase2\-ca\-path -T}:T{ -IEEE_8021X_PHASE2_CA_PATH\fI(+)\fR -T}:T{ -\ \& -T}:T{ -The search path for the certificate\&. -T} -T{ -phase2\-subject\-match -T}:T{ -IEEE_8021X_PHASE2_SUBJECT_MATCH\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Substring to match subject of server certificate against\&.\fB - -Example: \fRIEEE_8021X_PHASE2_SUBJECT_MATCH="Red Hat" -T} -T{ -phase2\-altsubject\-matches -T}:T{ -IEEE_8021X_PHASE2_ALTSUBJECT_MATCHES\fI(+)\fR -T}:T{ -\ \& -T}:T{ -\ \& -T} -T{ -phase2\-domain\-suffix\-match -T}:T{ -IEEE_8021X_PHASE2_DOMAIN_SUFFIX_MATCH\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Suffix to match domain of server certificate for phase 2 against\&. -T} -T{ -phase2\-domain\-match -T}:T{ -IEEE_8021X_PHASE2_DOMAIN_MATCH\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Value to match domain of server certificate for phase 2 against\&. -T} -T{ -phase2\-client\-cert -T}:T{ -IEEE_8021X_INNER_CLIENT_CERT\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Client certificate for inner EAP method\&.\fB - -Example: \fRIEEE_8021X_INNER_CLIENT_CERT=/home/joe/mycert\&.crt -T} -T{ -password -T}:T{ -IEEE_8021X_PASSWORD\fI(+)\fR -T}:T{ -\ \& -T}:T{ -UTF\-8 encoded password used for EAP\&. It can also go to "key\-" lookaside file, or it can be owned by a secret agent\&. -T} -T{ -password\-flags -T}:T{ -IEEE_8021X_PASSWORD_FLAGS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Password flags for IEEE_8021X_PASSWORD password\&. (see the section called \(lqSecret flags\(rq for _FLAGS values) -T} -T{ -password\-raw -T}:T{ -IEEE_8021X_PASSWORD_RAW\fI(+)\fR -T}:T{ -\ \& -T}:T{ -password used for EAP, encoded as a hexadecimal string\&. It can also go to "key\-" lookaside file\&.\fB - -Example: \fRIEEE_8021X_PASSWORD_RAW=041c8320083aa4bf -T} -T{ -password\-raw\-flags -T}:T{ -IEEE_8021X_PASSWORD_RAW_FLAGS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -The secret flags for password\-raw\&. -T} -T{ -private\-key -T}:T{ -IEEE_8021X_PRIVATE_KEY\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Private key for EAP\-TLS\&.\fB - -Example: \fRIEEE_8021X_PRIVATE_KEY=/home/joe/mykey\&.p12 -T} -T{ -private\-key\-password -T}:T{ -IEEE_8021X_PRIVATE_KEY_PASSWORD\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Password for IEEE_8021X_PRIVATE_KEY\&. It can also go to "key\-" lookaside file, or it can be owned by a secret agent\&. -T} -T{ -private\-key\-password\-flags -T}:T{ -IEEE_8021X_PRIVATE_KEY_PASSWORD_FLAGS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Password flags for IEEE_8021X_PRIVATE_KEY_PASSWORD password\&. (see the section called \(lqSecret flags\(rq for _FLAGS values) -T} -T{ -phase2\-private\-key -T}:T{ -IEEE_8021X_INNER_PRIVATE_KEY\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Private key for inner authentication method for EAP\-TLS\&. -T} -T{ -phase2\-private\-key\-password -T}:T{ -IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Password for IEEE_8021X_INNER_PRIVATE_KEY\&. It can also go to "key\-" lookaside file, or it can be owned by a secret agent\&. -T} -T{ -phase2\-private\-key\-password\-flags -T}:T{ -IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD_FLAGS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Password flags for IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD password\&. (see the section called \(lqSecret flags\(rq for _FLAGS values) -T} -T{ -pin -T}:T{ -IEEE_8021X_PIN\fI(+)\fR -T}:T{ -\ \& -T}:T{ -The pin secret used for EAP authentication methods\&. -T} -T{ -pin\-flags -T}:T{ -IEEE_8021X_PIN_FLAGS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -The secret flags for the pin property\&. -T} -T{ -system\-ca\-certs -T}:T{ -IEEE_8021X_SYSTEM_CA_CERTS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -a boolean value\&. -T} -T{ -auth\-timeout -T}:T{ -IEEE_8021X_AUTH_TIMEOUT\fI(+)\fR -T}:T{ -0 -T}:T{ -Timeout in seconds for the 802\&.1X authentication\&. Zero means the global default or 25\&. -T} -T{ -optional -T}:T{ -IEEE_8021X_OPTIONAL\fI(+)\fR default=no -T}:T{ -\ \& -T}:T{ -whether the 802\&.1X authentication is optional -T} -T{ -openssl\-ciphers -T}:T{ -IEEE_8021X_OPENSSL_CIPHERS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Cipher string for tls setup of wpa_supplicant\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&4.\ \&802\-3\-ethernet setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -port -T}:T{ -(none) -T}:T{ -\ \& -T}:T{ -The property is not saved by the plugin\&. -T} -T{ -speed -T}:T{ -ETHTOOL_OPTS -T}:T{ -\ \& -T}:T{ -Fixed speed for the ethernet link\&. It is added as "speed" parameter in the ETHTOOL_OPTS variable\&. -T} -T{ -duplex -T}:T{ -ETHTOOL_OPTS -T}:T{ -\ \& -T}:T{ -Fixed duplex mode for the ethernet link\&. It is added as "duplex" parameter in the ETHOOL_OPTS variable\&. -T} -T{ -auto\-negotiate -T}:T{ -ETHTOOL_OPTS -T}:T{ -\ \& -T}:T{ -Whether link speed and duplex autonegotiation is enabled\&. It is not saved only if disabled and no values are provided for the "speed" and "duplex" parameters (skips link configuration)\&. -T} -T{ -mac\-address -T}:T{ -HWADDR -T}:T{ -\ \& -T}:T{ -Hardware address of the device in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:14:5A:05)\&. Note that for initscripts this is the current MAC address of the device as found during ifup\&. For NetworkManager this is the permanent MAC address\&. Or in case no permanent MAC address exists, the MAC address initially configured on the device\&. -T} -T{ -cloned\-mac\-address -T}:T{ -MACADDR -T}:T{ -\ \& -T}:T{ -Cloned (spoofed) MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:14:5A:99)\&. -T} -T{ -generate\-mac\-address\-mask -T}:T{ -GENERATE_MAC_ADDRESS_MASK\fI(+)\fR -T}:T{ -\ \& -T}:T{ -the MAC address mask for generating randomized and stable cloned\-mac\-address\&. -T} -T{ -mac\-address\-blacklist -T}:T{ -HWADDR_BLACKLIST\fI(+)\fR -T}:T{ -\ \& -T}:T{ -It denies usage of the connection for any device whose address is listed\&.\fB - -Example: \fRHWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55" -T} -T{ -mac\-address\-denylist -T}:T{ -HWADDR_BLACKLIST\fI(+)\fR -T}:T{ -\ \& -T}:T{ -It denies usage of the connection for any device whose address is listed\&.\fB - -Example: \fRHWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55" -T} -T{ -mtu -T}:T{ -MTU -T}:T{ -\ \& -T}:T{ -MTU of the interface\&. -T} -T{ -s390\-subchannels -T}:T{ -SUBCHANNELS -T}:T{ -\ \& -T}:T{ -Subchannels for IBM S390 hosts\&.\fB - -Example: \fRSUBCHANNELS=0\&.0\&.b00a,0\&.0\&.b00b,0\&.0\&.b00c -T} -T{ -s390\-nettype -T}:T{ -NETTYPE -T}:T{ -\ \& -T}:T{ -Network type of the S390 host\&.\fB - -Example: \fRNETTYPE=qeth\fB - -Allowed values: \fR"qeth", "lcs" or "ctc" -T} -T{ -s390\-options -T}:T{ -OPTIONS and PORTNAME, CTCPROTO, -T}:T{ -\ \& -T}:T{ -S390 device options\&. All options go to OPTIONS, except for "portname" and "ctcprot" that have their own variables\&. -T} -T{ -wake\-on\-lan -T}:T{ -ETHTOOL_OPTS, ETHTOOL_WAKE_ON_LAN -T}:T{ -\ \& -T}:T{ -Wake on Lan mode for ethernet\&. The setting "ignore" is expressed with "ETHTOOL_WAKE_ON_LAN=ignore"\&. Otherwise, the "ETHTOOL_OPTS" variable is set with the value "wol" and several of the characters "p|u|m|b|a|g|s|f|d" as explained in the ethtool manual page\&. -T} -T{ -wake\-on\-lan\-password -T}:T{ -ETHTOOL_OPTS -T}:T{ -\ \& -T}:T{ -Password for secure\-on based Wake\-on\-Lan\&. It is added as "sopass" parameter in the ETHTOOL_OPTS variable\&.\fB - -Example: \fRETHTOOL_OPTS="wol gs sopass 00:11:22:33:44:55" -T} -T{ -accept\-all\-mac\-addresses -T}:T{ -ACCEPT_ALL_MAC_ADDRESSES -T}:T{ -\ \& -T}:T{ -Enforce the interface to accept all the packets\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&5.\ \&bond setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l. -T{ -options -T}:T{ -BONDING_OPTS -T}:T{ -\ \& -T}:T{ -Bonding options\&.\fB - -Example: \fRBONDING_OPTS="miimon=100 mode=broadcast" -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&6.\ \&bond\-port setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l. -T{ -queue\-id -T}:T{ -BOND_PORT_QUEUE_ID\fI(+)\fR -T}:T{ -0 -T}:T{ -Queue ID\&.\fB - -Allowed values: \fR0 \- 65535 -T} -T{ -prio -T}:T{ -BOND_PORT_PRIO\fI(+)\fR -T}:T{ -0 -T}:T{ -Port priority\&.\fB - -Allowed values: \fR\-2147483648 \- 2147483647 -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&7.\ \&bridge setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -mac\-address -T}:T{ -BRIDGE_MACADDR\fI(+)\fR -T}:T{ -\ \& -T}:T{ -MAC address of the bridge\&. Note that this requires a recent kernel support, originally introduced in 3\&.15 upstream kernel) BRIDGE_MACADDR for bridges is an NM extension\&. -T} -T{ -stp -T}:T{ -STP -T}:T{ -no -T}:T{ -Span tree protocol participation\&. -T} -T{ -priority -T}:T{ -BRIDGING_OPTS: priority= -T}:T{ -32768 -T}:T{ -STP priority\&.\fB - -Allowed values: \fR0 \- 32768 -T} -T{ -forward\-delay -T}:T{ -DELAY -T}:T{ -15 -T}:T{ -STP forwarding delay\&.\fB - -Allowed values: \fR2 \- 30 -T} -T{ -hello\-time -T}:T{ -BRIDGING_OPTS: hello_time= -T}:T{ -2 -T}:T{ -STP hello time\&.\fB - -Allowed values: \fR1 \- 10 -T} -T{ -max\-age -T}:T{ -BRIDGING_OPTS: max_age= -T}:T{ -20 -T}:T{ -STP maximum message age\&.\fB - -Allowed values: \fR6 \- 40 -T} -T{ -ageing\-time -T}:T{ -BRIDGING_OPTS: ageing_time= -T}:T{ -300 -T}:T{ -Ethernet MAC ageing time\&.\fB - -Allowed values: \fR0 \- 1000000 -T} -T{ -multicast\-snooping -T}:T{ -BRIDGING_OPTS: multicast_snooping= -T}:T{ -1 -T}:T{ -IGMP snooping support\&.\fB - -Allowed values: \fR0 or 1 -T} -T{ -vlan\-filtering -T}:T{ -BRIDGING_OPTS: vlan_filtering= -T}:T{ -0 -T}:T{ -VLAN filtering support\&.\fB - -Allowed values: \fR0 or 1 -T} -T{ -vlan\-default\-pvid -T}:T{ -BRIDGING_OPTS: default_pvid= -T}:T{ -1 -T}:T{ -default VLAN PVID\&.\fB - -Allowed values: \fR0 \- 4094 -T} -T{ -vlans -T}:T{ -BRIDGE_VLANS -T}:T{ -\ \& -T}:T{ -List of VLANs on the bridge\fB - -Example: \fRBRIDGE_VLANS="1 pvid untagged,20,300\-400 untagged" -T} -T{ -group\-address -T}:T{ -BRIDGING_OPTS: group_address= -T}:T{ -\ \& -T}:T{ -STP group address\&.\fB - -Example: \fRBRIDGING_OPTS="group_address=01:80:C2:00:00:0A" -T} -T{ -vlan\-protocol -T}:T{ -BRIDGING_OPTS: vlan_protocol= -T}:T{ -\ \& -T}:T{ -VLAN filtering protocol\&.\fB - -Example: \fRBRIDGING_OPTS="vlan_protocol=802\&.1Q" -T} -T{ -vlan\-stats\-enabled -T}:T{ -BRIDGING_OPTS: vlan_stats_enabled= -T}:T{ -0 -T}:T{ -\fB - -Example: \fRBRIDGING_OPTS="vlan_stats_enabled=1" -T} -T{ -multicast\-router -T}:T{ -BRIDGING_OPTS: multicast_router= -T}:T{ -auto -T}:T{ -\fB - -Example: \fRBRIDGING_OPTS="multicast_router=enabled"\fB - -Allowed values: \fRauto, enabled, disabled -T} -T{ -multicast\-query\-use\-ifaddr -T}:T{ -BRIDGING_OPTS: multicast_query_use_ifaddr= -T}:T{ -0 -T}:T{ -\fB - -Example: \fRBRIDGING_OPTS="multicast_query\-use_ifaddr=1" -T} -T{ -multicast\-querier -T}:T{ -BRIDGING_OPTS: multicast_querier= -T}:T{ -0 -T}:T{ -\fB - -Example: \fRBRIDGING_OPTS="multicast_querier=1" -T} -T{ -multicast\-hash\-max -T}:T{ -BRIDGING_OPTS: multicast_hash_max= -T}:T{ -4096 -T}:T{ -\fB - -Example: \fRBRIDGING_OPTS="multicast_hash_max=8192" -T} -T{ -multicast\-last\-member\-count -T}:T{ -BRIDGING_OPTS: multicast_last_member_count= -T}:T{ -2 -T}:T{ -\fB - -Example: \fRBRIDGING_OPTS="multicast_last_member_count=4" -T} -T{ -multicast\-last\-member\-interval -T}:T{ -BRIDGING_OPTS: multicast_last_member_interval= -T}:T{ -100 -T}:T{ -\fB - -Example: \fRBRIDGING_OPTS="multicast_last_member_interval=200" -T} -T{ -multicast\-membership\-interval -T}:T{ -BRIDGING_OPTS: multicast_membership_interval= -T}:T{ -26000 -T}:T{ -\fB - -Example: \fRBRIDGING_OPTS="multicast_membership_interval=16000" -T} -T{ -multicast\-querier\-interval -T}:T{ -BRIDGING_OPTS: multicast_querier_interval= -T}:T{ -25500 -T}:T{ -\fB - -Example: \fRBRIDGING_OPTS="multicast_querier_interval=20000" -T} -T{ -multicast\-query\-interval -T}:T{ -BRIDGING_OPTS: multicast_query_interval= -T}:T{ -12500 -T}:T{ -\fB - -Example: \fRBRIDGING_OPTS="multicast_query_interval=22500" -T} -T{ -multicast\-query\-response\-interval -T}:T{ -BRIDGING_OPTS: multicast_query_response_interval= -T}:T{ -1000 -T}:T{ -\fB - -Example: \fRBRIDGING_OPTS="multicast_query_response_interval=2000" -T} -T{ -multicast\-startup\-query\-count -T}:T{ -BRIDGING_OPTS: multicast_startup_query_count= -T}:T{ -2 -T}:T{ -\fB - -Example: \fRBRIDGING_OPTS="multicast_startup_query_count=4" -T} -T{ -multicast\-startup\-query\-interval -T}:T{ -BRIDGING_OPTS: multicast_startup_query_interval= -T}:T{ -3125 -T}:T{ -\fB - -Example: \fRBRIDGING_OPTS="multicast_startup_query_interval=4000" -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&8.\ \&bridge\-port setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -priority -T}:T{ -BRIDGING_OPTS: priority= -T}:T{ -32 -T}:T{ -STP priority\&.\fB - -Allowed values: \fR0 \- 63 -T} -T{ -path\-cost -T}:T{ -BRIDGING_OPTS: path_cost= -T}:T{ -100 -T}:T{ -STP cost\&.\fB - -Allowed values: \fR1 \- 65535 -T} -T{ -hairpin\-mode -T}:T{ -BRIDGING_OPTS: hairpin_mode= -T}:T{ -yes -T}:T{ -Hairpin mode of the bridge port\&. -T} -T{ -vlans -T}:T{ -BRIDGE_PORT_VLANS -T}:T{ -\ \& -T}:T{ -List of VLANs on the bridge port\fB - -Example: \fRBRIDGE_PORT_VLANS="1 pvid untagged,20,300\-400 untagged" -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&9.\ \&connection setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -id -T}:T{ -NAME\fI(+)\fR -T}:T{ -\ \& -T}:T{ -User friendly name for the connection profile\&. -T} -T{ -uuid -T}:T{ -UUID\fI(+)\fR -T}:T{ -\ \& -T}:T{ -UUID for the connection profile\&. When missing, NetworkManager creates the UUID itself (by hashing the filename)\&. -T} -T{ -stable\-id -T}:T{ -STABLE_ID\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Token to generate stable IDs\&. -T} -T{ -interface\-name -T}:T{ -DEVICE -T}:T{ -\ \& -T}:T{ -Interface name of the device this profile is bound to\&. The variable can be left out when the profile should apply for more devices\&. Note that DEVICE can be required for some connection types\&. -T} -T{ -type -T}:T{ -TYPE (DEVICETYPE, DEVICE) -T}:T{ -\ \& -T}:T{ -Base type of the connection\&. DEVICETYPE is used for teaming connections\&.\fB - -Example: \fRTYPE=Ethernet; TYPE=Bond; TYPE=Bridge; DEVICETYPE=TeamPort\fB - -Allowed values: \fREthernet, Wireless, InfiniBand, Bridge, Bond, Vlan, Team, TeamPort -T} -T{ -permissions -T}:T{ -USERS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Restrict to certain users the access to this connection, and allow the connection to be active only when at least one of the specified users is logged into an active session\&.\fB - -Example: \fRUSERS="joe bob" -T} -T{ -autoconnect -T}:T{ -ONBOOT -T}:T{ -yes -T}:T{ -Whether the connection should be autoconnected (not only while booting)\&. -T} -T{ -autoconnect\-priority -T}:T{ -AUTOCONNECT_PRIORITY\fI(+)\fR -T}:T{ -0 -T}:T{ -Connection priority for automatic activation\&. Connections with higher numbers are preferred when selecting profiles for automatic activation\&.\fB - -Example: \fRAUTOCONNECT_PRIORITY=20\fB - -Allowed values: \fR\-999 to 999 -T} -T{ -autoconnect\-retries -T}:T{ -AUTOCONNECT_RETRIES\fI(+)\fR -T}:T{ -\ \& -T}:T{ -The number of times a connection should be autoactivated before giving up and switching to the next one\&.\fB - -Example: \fRAUTOCONNECT_RETRIES=1\fB - -Allowed values: \fR\-1 (use global default), 0 (forever) or a positive value -T} -T{ -multi\-connect -T}:T{ -MULTI_CONNECT\fI(+)\fR -T}:T{ -\ \& -T}:T{ -whether the profile can be active on multiple devices at a given moment\&. The values are numbers corresponding to #NMConnectionMultiConnect enum\&.\fB - -Example: \fRMULTI_CONNECT=3 -T} -T{ -zone -T}:T{ -ZONE\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Trust level of this connection\&. The string is usually used for a firewall\&.\fB - -Example: \fRZONE=Work -T} -T{ -master -T}:T{ -MASTER, MASTER_UUID, TEAM_MASTER, TEAM_MASTER_UUID, BRIDGE, BRIDGE_UUID -T}:T{ -\ \& -T}:T{ -Reference to controller connection\&. The variable used depends on the connection type and the value\&. In general, if the *_UUID variant is present, the variant without *_UUID is ignored\&. NetworkManager attempts to write both for compatibility with legacy tooling\&. -T} -T{ -slave\-type -T}:T{ -MASTER, MASTER_UUID, TEAM_MASTER, TEAM_MASTER_UUID, DEVICETYPE, BRIDGE, BRIDGE_UUID -T}:T{ -\ \& -T}:T{ -Slave type doesn\*(Aqt map directly to a variable, but it is recognized using different variables\&. MASTER and MASTER_UUID for bonding, TEAM_MASTER, TEAM_MASTER_UUID and DEVICETYPE for teaming, BRIDGE and BRIDGE_UUID for bridging\&. -T} -T{ -autoconnect\-slaves -T}:T{ -AUTOCONNECT_SLAVES\fI(+)\fR -T}:T{ -missing variable means global default -T}:T{ -Whether slaves of this connection should be auto\-connected when this connection is activated\&. -T} -T{ -secondaries -T}:T{ -SECONDARY_UUIDS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -UUID of VPN connections that should be activated together with this connection\&. -T} -T{ -gateway\-ping\-timeout -T}:T{ -GATEWAY_PING_TIMEOUT\fI(+)\fR -T}:T{ -0 -T}:T{ -If greater than zero, the IP connectivity will be checked by pinging the gateway and waiting for the specified timeout (in seconds)\&.\fB - -Example: \fRGATEWAY_PING_TIMEOUT=5 -T} -T{ -metered -T}:T{ -CONNECTION_METERED\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Whether the device is metered\fB - -Example: \fRCONNECTION_METERED=yes\fB - -Allowed values: \fRyes,no,unknown -T} -T{ -lldp -T}:T{ -LLDP\fI(+)\fR -T}:T{ -missing variable means global default -T}:T{ -whether LLDP is enabled for the connection\fB - -Example: \fRLLDP=no\fB - -Allowed values: \fRboolean value or \*(Aqrx\*(Aq -T} -T{ -auth\-retries -T}:T{ -AUTH_RETRIES\fI(+)\fR -T}:T{ -0 -T}:T{ -Number of retries for authentication\&. -T} -T{ -mdns -T}:T{ -MDNS\fI(+)\fR -T}:T{ -missing variable means global default -T}:T{ -Whether or not mDNS is enabled for the connection\fB - -Example: \fRMDNS=yes\fB - -Allowed values: \fRyes,no,resolve -T} -T{ -llmnr -T}:T{ -LLMNR\fI(+)\fR -T}:T{ -missing variable means global default -T}:T{ -Whether or not LLMNR is enabled for the connection\fB - -Example: \fRLLMNR=yes\fB - -Allowed values: \fRyes,no,resolve -T} -T{ -dns\-over\-tls -T}:T{ -DNS_OVER_TLS\fI(+)\fR -T}:T{ -missing variable means global default -T}:T{ -Whether or not DNSOverTls is enabled for the connection\fB - -Allowed values: \fRyes,no,opportunistic -T} -T{ -mptcp\-flags -T}:T{ -MPTCP_FLAGS\fI(+)\fR -T}:T{ -missing variable means global default -T}:T{ -The MPTCP flags that indicate whether MPTCP is enabled and which flags to use for the address endpoints\&.\fB - -Example: \fRMPTCP_FLAGS="signal,subflow" -T} -T{ -wait\-device\-timeout -T}:T{ -DEVTIMEOUT\fI(+)\fR -T}:T{ -\ \& -T}:T{ -for initscripts compatibility, this variable must be a whole integer\&. If necessary, NetworkManager stores also a fractional component for the milliseconds\&.\fB - -Example: \fRDEVTIMEOUT=5\fB - -Allowed values: \fRtimeout in seconds\&. -T} -T{ -mud\-url -T}:T{ -MUD_URL -T}:T{ -\ \& -T}:T{ -MUD_URL to be sent by device (See RFC 8520)\&.\fB - -Example: \fRhttps://yourdevice\&.example\&.com/model\&.json\fB - -Allowed values: \fRa valid URL that points to recommended policy for this device -T} -T{ -wait\-activation\-delay -T}:T{ -WAIT_ACTIVATION_DELAY\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Time in milliseconds to wait for connection to be considered activated\&. The wait will start after the pre\-up dispatcher event\&.\fB - -Example: \fRWAIT_ACTIVATION_DELAY=5000\fB - -Allowed values: \fRdelay in milliseconds\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&10.\ \&dcb setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -app\-fcoe\-flags -T}:T{ -DCB_APP_FCOE_ENABLE, DCB_APP_FCOE_ADVERTISE, DCB_APP_FCOE_WILLING -T}:T{ -no -T}:T{ -FCOE flags\&.\fB - -Example: \fRDCB_APP_FCOE_ENABLE=yes DCB_APP_FCOE_ADVERTISE=yes -T} -T{ -app\-fcoe\-priority -T}:T{ -DCB_APP_FCOE_PRIORITY -T}:T{ -\ \& -T}:T{ -Priority of FCoE frames\&.\fB - -Allowed values: \fR0 \- 7 -T} -T{ -app\-fcoe\-mode -T}:T{ -DCB_APP_FCOE_MODE -T}:T{ -fabric -T}:T{ -FCoE controller mode\&.\fB - -Allowed values: \fRfabric, vn2vn -T} -T{ -app\-iscsi\-flags -T}:T{ -DCB_APP_ISCSI_ENABLE, DCB_APP_ISCSI_ADVERTISE, DCB_APP_ISCSI_WILLING -T}:T{ -no -T}:T{ -iSCSI flags\&. -T} -T{ -app\-iscsi\-priority -T}:T{ -DCB_APP_ISCSI_PRIORITY -T}:T{ -\ \& -T}:T{ -Priority of iSCSI frames\&.\fB - -Allowed values: \fR0 \- 7 -T} -T{ -app\-fip\-flags -T}:T{ -DCB_APP_FIP_ENABLE, DCB_APP_FIP_ADVERTISE, DCB_APP_FIP_WILLING -T}:T{ -no -T}:T{ -FIP flags\&. -T} -T{ -app\-fip\-priority -T}:T{ -DCB_APP_FIP_PRIORITY -T}:T{ -\ \& -T}:T{ -Priority of FIP frames\&.\fB - -Allowed values: \fR0 \- 7 -T} -T{ -priority\-flow\-control\-flags -T}:T{ -DCB_PFC_ENABLE, DCB_PFC_ADVERTISE, DCB_PFC_WILLING -T}:T{ -no -T}:T{ -Priority flow control flags\&. -T} -T{ -priority\-flow\-control -T}:T{ -DCB_PFC_UP -T}:T{ -\ \& -T}:T{ -Priority flow control values\&. String of 8 "0" and "1", where "0"\&. means "do not transmit priority pause", "1" means "transmit pause"\&.\fB - -Example: \fRDCB_PFC_UP=01101110 -T} -T{ -priority\-group\-flags -T}:T{ -DCB_PG_ENABLE, DCB_PG_ADVERTISE, DCB_PG_WILLING -T}:T{ -no -T}:T{ -Priority groups flags\&. -T} -T{ -priority\-group\-id -T}:T{ -DCB_PG_ID -T}:T{ -\ \& -T}:T{ -Priority groups values\&. String of eight priorities (0 \- 7) or "f" (unrestricted)\&.\fB - -Example: \fRDCB_PG_ID=1205f173 -T} -T{ -priority\-group\-bandwidth -T}:T{ -DCB_PG_PCT -T}:T{ -\ \& -T}:T{ -Priority groups values\&. Eight bandwidths (in percent), separated with commas\&.\fB - -Example: \fRDCB_PG_PCT=10,5,10,15,10,10,10,30 -T} -T{ -priority\-bandwidth -T}:T{ -DCB_PG_UPPCT -T}:T{ -\ \& -T}:T{ -Priority values\&. Eight bandwidths (in percent), separated with commas\&. The sum of the numbers must be 100\&.\fB - -Example: \fRDCB_PG_UPPCT=7,13,10,10,15,15,10,20 -T} -T{ -priority\-strict\-bandwidth -T}:T{ -DCB_PG_STRICT -T}:T{ -\ \& -T}:T{ -Priority values\&. String of eight "0" or "1", where "0" means "may not utilize all bandwidth", "1" means "may utilize all bandwidth"\&.\fB - -Example: \fRDCB_PG_STRICT=01101110 -T} -T{ -priority\-traffic\-class -T}:T{ -DCB_PG_UP2TC -T}:T{ -\ \& -T}:T{ -Priority values\&. String of eight traffic class values (0 \- 7)\&.\fB - -Example: \fRDCB_PG_UP2TC=01623701 -T} -.TE -.sp 1 -.PP -All DCB related configuration is a NetworkManager extension\&. DCB=yes must be used explicitly to enable DCB so that the rest of the DCB_* variables can apply\&. -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&11.\ \ðtool setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -. -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&12.\ \&hostname setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -priority -T}:T{ -HOSTNAME_PRIORITY\fI(+)\fR -T}:T{ -missing variable means global value or 100 -T}:T{ -hostname priority\fB - -Example: \fRHOSTNAME_PRIORITY=50 -T} -T{ -from\-dhcp -T}:T{ -HOSTNAME_FROM_DHCP\fI(+)\fR -T}:T{ -missing variable means global default or 1 -T}:T{ -whether the system hostname can be determined from DHCP\fB - -Example: \fRHOSTNAME_FROM_DHCP=0,1 -T} -T{ -from\-dns\-lookup -T}:T{ -HOSTNAME_FROM_DNS_LOOKUP\fI(+)\fR -T}:T{ -missing variable means global default or 1 -T}:T{ -whether the system hostname can be determined from reverse DNS lookup\fB - -Example: \fRHOSTNAME_FROM_DNS_LOOKUP=0,1 -T} -T{ -only\-best\-device -T}:T{ -HOSTNAME_ONLY_FROM_DEFAULT\fI(+)\fR -T}:T{ -missing variable means global default or 1 -T}:T{ -whether the hostname can be determined only from devices with the default route\fB - -Example: \fRHOSTNAME_ONLY_FROM_DEFAULT=0,1 -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&13.\ \&hsr setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -. -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&14.\ \&infiniband setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -mac\-address -T}:T{ -HWADDR -T}:T{ -\ \& -T}:T{ -IBoIP 20\-byte hardware address of the device (in traditional hex\-digits\-and\-colons notation)\&. Note that for initscripts this is the current MAC address of the device as found during ifup\&. For NetworkManager this is the permanent MAC address\&. Or in case no permanent MAC address exists, the MAC address initially configured on the device\&.\fB - -Example: \fRHWADDR=01:02:03:04:05:06:07:08:09:0A:01:02:03:04:05:06:07:08:09:11 -T} -T{ -mtu -T}:T{ -MTU -T}:T{ -\ \& -T}:T{ -MTU of the interface\&. -T} -T{ -transport\-mode -T}:T{ -CONNECTED_MODE -T}:T{ -CONNECTED_MODE=no -T}:T{ -CONNECTED_MODE=yes for "connected" mode, CONNECTED_MODE=no for "datagram" mode -T} -T{ -p\-key -T}:T{ -PKEY_ID or PKEY_ID_NM(*) (requires PKEY=yes) -T}:T{ -PKEY=no -T}:T{ -InfiniBand P_Key\&. The value can be a hex number prefixed with "0x" or a decimal number\&. When PKEY_ID is specified, PHYSDEV must be specified\&. Note that ifcfg\-rh format will always automatically set the full membership flag 0x8000 for the PKEY_ID variable\&. To express IDs without the full membership flag, use PKEY_ID_NM\&. Note that kernel internally treats the interface as having the full membership flag set, this mainly affects the interface name\&. For the ifcfg file to be supported by initscripts\*(Aq ifup\-ib, the DEVICE= must always be set\&. NetworkManager does not require that\&.\fB - -Example: \fRPKEY=yes PKEY_ID=2 PHYSDEV=mlx4_ib0 DEVICE=mlx4_ib0\&.8002 -T} -T{ -parent -T}:T{ -PHYSDEV (PKEY=yes) -T}:T{ -PKEY=no -T}:T{ -InfiniBand parent device\&.\fB - -Example: \fRPHYSDEV=ib0 -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&15.\ \&ipv4 setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -method -T}:T{ -BOOTPROTO -T}:T{ -none -T}:T{ -Method used for IPv4 protocol configuration\&.\fB - -Allowed values: \fRnone, dhcp (bootp), static, ibft, autoip, shared -T} -T{ -dns -T}:T{ -DNS1, DNS2, \&.\&.\&. -T}:T{ -\ \& -T}:T{ -List of DNS servers\&. Even if NetworkManager supports many DNS servers, initscripts and resolver only care about the first three, usually\&.\fB - -Example: \fRDNS1=1\&.2\&.3\&.4 DNS2=10\&.0\&.0\&.254 DNS3=8\&.8\&.8\&.8 -T} -T{ -dns\-search -T}:T{ -DOMAIN -T}:T{ -\ \& -T}:T{ -List of DNS search domains\&. -T} -T{ -addresses -T}:T{ -IPADDR, PREFIX (NETMASK), IPADDR1, PREFIX1 (NETMASK1), \&.\&.\&. -T}:T{ -\ \& -T}:T{ -List of static IP addresses\&.\fB - -Example: \fRIPADDR=10\&.5\&.5\&.23 PREFIX=24 IPADDR1=1\&.1\&.1\&.2 PREFIX1=16 -T} -T{ -gateway -T}:T{ -GATEWAY -T}:T{ -\ \& -T}:T{ -Gateway IP address\&.\fB - -Example: \fRGATEWAY=10\&.5\&.5\&.1 -T} -T{ -routes -T}:T{ -ADDRESS1, NETMASK1, GATEWAY1, METRIC1, OPTIONS1, \&.\&.\&. -T}:T{ -\ \& -T}:T{ -List of static routes\&. They are not stored in ifcfg\-* file, but in route\-* file instead\&. -T} -T{ -ignore\-auto\-routes -T}:T{ -PEERROUTES\fI(+)\fR -T}:T{ -yes -T}:T{ -PEERROUTES has the opposite meaning as \*(Aqignore\-auto\-routes\*(Aq property\&. -T} -T{ -ignore\-auto\-dns -T}:T{ -PEERDNS -T}:T{ -yes -T}:T{ -PEERDNS has the opposite meaning as \*(Aqignore\-auto\-dns\*(Aq property\&. -T} -T{ -dhcp\-send\-hostname -T}:T{ -DHCP_SEND_HOSTNAME\fI(+)\fR -T}:T{ -yes -T}:T{ -Whether DHCP_HOSTNAME should be sent to the DHCP server\&. -T} -T{ -dhcp\-hostname -T}:T{ -DHCP_HOSTNAME -T}:T{ -\ \& -T}:T{ -Hostname to send to the DHCP server\&. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used\&. -T} -T{ -never\-default -T}:T{ -DEFROUTE (GATEWAYDEV in /etc/sysconfig/network) -T}:T{ -yes -T}:T{ -DEFROUTE=no tells NetworkManager that this connection should not be assigned the default route\&. DEFROUTE has the opposite meaning as \*(Aqnever\-default\*(Aq property\&. -T} -T{ -may\-fail -T}:T{ -IPV4_FAILURE_FATAL\fI(+)\fR -T}:T{ -no -T}:T{ -IPV4_FAILURE_FATAL has the opposite meaning as \*(Aqmay\-fail\*(Aq property\&. -T} -T{ -route\-metric -T}:T{ -IPV4_ROUTE_METRIC\fI(+)\fR -T}:T{ -\-1 -T}:T{ -IPV4_ROUTE_METRIC is the default IPv4 metric for routes on this connection\&. If set to \-1, a default metric based on the device type is used\&. -T} -T{ -route\-table -T}:T{ -IPV4_ROUTE_TABLE\fI(+)\fR -T}:T{ -0 -T}:T{ -IPV4_ROUTE_TABLE enables policy\-routing and sets the default routing table\&. -T} -T{ -dns\-options -T}:T{ -RES_OPTIONS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -List of DNS options to be added to /etc/resolv\&.conf\fB - -Example: \fRRES_OPTIONS=ndots:2 timeout:3 -T} -T{ -dns\-priority -T}:T{ -IPV4_DNS_PRIORITY\fI(+)\fR -T}:T{ -0 -T}:T{ -The priority for DNS servers of this connection\&. Lower values have higher priority\&. If zero, the default value will be used (50 for VPNs, 100 for other connections)\&. A negative value prevents DNS from other connections with greater values to be used\&.\fB - -Example: \fRIPV4_DNS_PRIORITY=20 -T} -T{ -auto\-route\-ext\-gw -T}:T{ -IPV4_AUTO_ROUTE_EXT_GW\fI(+)\fR -T}:T{ -yes -T}:T{ -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\&. -T} -T{ -replace\-local\-rule -T}:T{ -IPV4_REPLACE_LOCAL_RULE\fI(+)\fR -T}:T{ -no -T}:T{ -Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. -T} -T{ -dhcp\-client\-id -T}:T{ -DHCP_CLIENT_ID\fI(+)\fR -T}:T{ -\ \& -T}:T{ -A string sent to the DHCP server to identify the local machine\&. A binary value can be specified using hex notation (\*(Aqaa:bb:cc\*(Aq)\&.\fB - -Example: \fRDHCP_CLIENT_ID=ax\-srv\-1; DHCP_CLIENT_ID=01:44:44:44:44:44:44 -T} -T{ -dad\-timeout -T}:T{ -ACD_TIMEOUT\fI(+)\fR, ARPING_WAIT -T}:T{ -missing variable means global default (config override or zero) -T}:T{ -Timeout (in milliseconds for ACD_TIMEOUT or in seconds for ARPING_WAIT) for address conflict detection before configuring IPv4 addresses\&. 0 turns off the ACD completely, \-1 means default value\&.\fB - -Example: \fRACD_TIMEOUT=2000 or ARPING_WAIT=2 -T} -T{ -dhcp\-timeout -T}:T{ -IPV4_DHCP_TIMEOUT\fI(+)\fR -T}:T{ -\ \& -T}:T{ -A timeout after which the DHCP transaction fails in case of no response\&.\fB - -Example: \fRIPV4_DHCP_TIMEOUT=10 -T} -T{ -dhcp\-hostname\-flags -T}:T{ -DHCP_HOSTNAME_FLAGS -T}:T{ -\ \& -T}:T{ -flags for the DHCP hostname and FQDN properties\fB - -Example: \fRDHCP_HOSTNAME_FLAGS=5 -T} -T{ -dhcp\-fqdn -T}:T{ -DHCP_FQDN -T}:T{ -\ \& -T}:T{ -FQDN to send to the DHCP server\&. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used\&.\fB - -Example: \fRDHCP_FQDN=foo\&.bar\&.com -T} -T{ -dhcp\-vendor\-class\-identifier -T}:T{ -DHCP_VENDOR_CLASS_IDENTIFIER\fI(+)\fR -T}:T{ -\ \& -T}:T{ -The Vendor Class Identifier DHCP option (60)\&.\fB - -Example: \fRDHCP_VENDOR_CLASS_IDENTIFIER=foo -T} -T{ -link\-local -T}:T{ -IPV4_LINK_LOCAL\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Configure link\-local IP address in interaction with method\fB - -Example: \fRIPV4_LINK_LOCAL=auto -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&16.\ \&ipv6 setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -method -T}:T{ -IPV6INIT, IPV6FORWARDING, IPV6_AUTOCONF, DHCPV6C, IPV6_DISABLED -T}:T{ -IPV6INIT=yes; IPV6FORWARDING=no; IPV6_AUTOCONF=!IPV6FORWARDING, DHCPV6=no -T}:T{ -Method used for IPv6 protocol configuration\&. ignore ~ IPV6INIT=no; auto ~ IPV6_AUTOCONF=yes; dhcp ~ IPV6_AUTOCONF=no and DHCPV6C=yes; disabled ~ IPV6_DISABLED=yes -T} -T{ -dns -T}:T{ -DNS1, DNS2, \&.\&.\&. -T}:T{ -\ \& -T}:T{ -List of DNS servers\&. NetworkManager uses the variables both for IPv4 and IPv6\&. -T} -T{ -dns\-search -T}:T{ -IPV6_DOMAIN\fI(+)\fR -T}:T{ -\ \& -T}:T{ -List of DNS search domains\&. -T} -T{ -addresses -T}:T{ -IPV6ADDR, IPV6ADDR_SECONDARIES -T}:T{ -\ \& -T}:T{ -List of static IP addresses\&.\fB - -Example: \fRIPV6ADDR=ab12:9876::1 IPV6ADDR_SECONDARIES="ab12:9876::2 ab12:9876::3" -T} -T{ -gateway -T}:T{ -IPV6_DEFAULTGW -T}:T{ -\ \& -T}:T{ -Gateway IP address\&.\fB - -Example: \fRIPV6_DEFAULTGW=abbe::1 -T} -T{ -routes -T}:T{ -(none) -T}:T{ -\ \& -T}:T{ -List of static routes\&. They are not stored in ifcfg\-* file, but in route6\-* file instead in the form of command line for \*(Aqip route add\*(Aq\&. -T} -T{ -ignore\-auto\-routes -T}:T{ -IPV6_PEERROUTES\fI(+)\fR -T}:T{ -yes -T}:T{ -IPV6_PEERROUTES has the opposite meaning as \*(Aqignore\-auto\-routes\*(Aq property\&. -T} -T{ -ignore\-auto\-dns -T}:T{ -IPV6_PEERDNS\fI(+)\fR -T}:T{ -yes -T}:T{ -IPV6_PEERDNS has the opposite meaning as \*(Aqignore\-auto\-dns\*(Aq property\&. -T} -T{ -dhcp\-hostname -T}:T{ -DHCPV6_HOSTNAME -T}:T{ -\ \& -T}:T{ -Hostname to send the DHCP server\&. -T} -T{ -dhcp\-timeout -T}:T{ -IPV6_DHCP_TIMEOUT\fI(+)\fR -T}:T{ -\ \& -T}:T{ -A timeout after which the DHCP transaction fails in case of no response\&.\fB - -Example: \fRIPV6_DHCP_TIMEOUT=10 -T} -T{ -dhcp\-hostname\-flags -T}:T{ -DHCPV6_HOSTNAME_FLAGS -T}:T{ -\ \& -T}:T{ -flags for the DHCP hostname property\fB - -Example: \fRDHCPV6_HOSTNAME_FLAGS=5 -T} -T{ -never\-default -T}:T{ -IPV6_DEFROUTE\fI(+)\fR, (and IPV6_DEFAULTGW, IPV6_DEFAULTDEV in /etc/sysconfig/network) -T}:T{ -IPV6_DEFROUTE=yes (when no variable specified) -T}:T{ -IPV6_DEFROUTE=no tells NetworkManager that this connection should not be assigned the default IPv6 route\&. IPV6_DEFROUTE has the opposite meaning as \*(Aqnever\-default\*(Aq property\&. -T} -T{ -may\-fail -T}:T{ -IPV6_FAILURE_FATAL\fI(+)\fR -T}:T{ -no -T}:T{ -IPV6_FAILURE_FATAL has the opposite meaning as \*(Aqmay\-fail\*(Aq property\&. -T} -T{ -route\-metric -T}:T{ -IPV6_ROUTE_METRIC\fI(+)\fR -T}:T{ -\-1 -T}:T{ -IPV6_ROUTE_METRIC is the default IPv6 metric for routes on this connection\&. If set to \-1, a default metric based on the device type is used\&. -T} -T{ -route\-table -T}:T{ -IPV6_ROUTE_TABLE\fI(+)\fR -T}:T{ -0 -T}:T{ -IPV6_ROUTE_TABLE enables policy\-routing and sets the default routing table\&. -T} -T{ -dns\-priority -T}:T{ -IPV6_DNS_PRIORITY\fI(+)\fR -T}:T{ -0 -T}:T{ -The priority for DNS servers of this connection\&. Lower values have higher priority\&. If zero, the default value will be used (50 for VPNs, 100 for other connections)\&. A negative value prevents DNS from other connections with greater values to be used\&.\fB - -Example: \fRIPV6_DNS_PRIORITY=20 -T} -T{ -dns\-options -T}:T{ -IPV6_RES_OPTIONS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -List of DNS options to be added to /etc/resolv\&.conf\fB - -Example: \fRIPV6_RES_OPTIONS=ndots:2 timeout:3 -T} -T{ -auto\-route\-ext\-gw -T}:T{ -IPV6_AUTO_ROUTE_EXT_GW\fI(+)\fR -T}:T{ -yes -T}:T{ -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\&. -T} -T{ -replace\-local\-rule -T}:T{ -IPV6_REPLACE_LOCAL_RULE\fI(+)\fR -T}:T{ -no -T}:T{ -Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. -T} -T{ -ip6\-privacy -T}:T{ -IPV6_PRIVACY, IPV6_PRIVACY_PREFER_PUBLIC_IP\fI(+)\fR -T}:T{ -no -T}:T{ -Configure IPv6 Privacy Extensions for SLAAC (RFC4941)\&.\fB - -Example: \fRIPV6_PRIVACY=rfc3041 IPV6_PRIVACY_PREFER_PUBLIC_IP=yes\fB - -Allowed values: \fRIPV6_PRIVACY: no, yes (rfc3041 or rfc4941); IPV6_PRIVACY_PREFER_PUBLIC_IP: yes, no -T} -T{ -addr\-gen\-mode -T}:T{ -IPV6_ADDR_GEN_MODE -T}:T{ -"default\-or\-eui64" -T}:T{ -Configure IPv6 Stable Privacy addressing for SLAAC (RFC7217)\&.\fB - -Example: \fRIPV6_ADDR_GEN_MODE=stable\-privacy\fB - -Allowed values: \fRIPV6_ADDR_GEN_MODE: default, default\-or\-eui64, eui64, stable\-privacy -T} -T{ -token -T}:T{ -IPV6_TOKEN -T}:T{ -\ \& -T}:T{ -The IPv6 tokenized interface identifier token\fB - -Example: \fRIPV6_TOKEN=::53 -T} -T{ -ra\-timeout -T}:T{ -IPV6_RA_TIMEOUT\fI(+)\fR -T}:T{ -\ \& -T}:T{ -A timeout for waiting Router Advertisements in seconds\&.\fB - -Example: \fRIPV6_RA_TIMEOUT=10 -T} -T{ -dhcp\-duid -T}:T{ -DHCPV6_DUID\fI(+)\fR -T}:T{ -\ \& -T}:T{ -A string sent to the DHCPv6 server to identify the local machine\&. Apart from the special values "lease", "stable\-llt", "stable\-ll", "stable\-uuid", "llt" and "ll" a binary value in hex format is expected\&. An hex string where each octet is separated by a colon is also accepted\&.\fB - -Example: \fRDHCPV6_DUID=LL; DHCPV6_DUID=0301deadbeef0001; DHCPV6_DUID=03:01:de:ad:be:ef:00:01 -T} -T{ -dhcp\-pd\-hint -T}:T{ -DHCPV6_PD_HINT\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Hint for DHCPv6 prefix delegation\fB - -Example: \fRDHCPV6_PD_HINT=2001:db8:1111:2220::/60 DHCPV6_PD_HINT=::/60 -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&17.\ \&match setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l. -T{ -path -T}:T{ -MATCH_PATH -T}:T{ -\ \& -T}:T{ -space\-separated list of paths to match against the udev property ID_PATHS of devices\fB - -Example: \fRMATCH_PATH="pci\-0000:01:00\&.0 pci\-0000:0c:00\&.0" -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&18.\ \&ovs\-external\-ids setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -. -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&19.\ \&ovs\-other\-config setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -. -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&20.\ \&proxy setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -method -T}:T{ -PROXY_METHOD\fI(+)\fR -T}:T{ -none -T}:T{ -Method for proxy configuration\&. For "auto", WPAD is used for proxy configuration, or set the PAC file via PAC_URL or PAC_SCRIPT\&.\fB - -Allowed values: \fRnone, auto -T} -T{ -browser\-only -T}:T{ -BROWSER_ONLY\fI(+)\fR -T}:T{ -no -T}:T{ -Whether the proxy configuration is for browser only\&. -T} -T{ -pac\-url -T}:T{ -PAC_URL\fI(+)\fR -T}:T{ -\ \& -T}:T{ -URL for PAC file\&.\fB - -Example: \fRPAC_URL=http://wpad\&.mycompany\&.com/wpad\&.dat -T} -T{ -pac\-script -T}:T{ -PAC_SCRIPT\fI(+)\fR -T}:T{ -\ \& -T}:T{ -The PAC script\&. This is an UTF\-8 encoded javascript code that defines a FindProxyForURL() function\&.\fB - -Example: \fRPAC_SCRIPT="function FindProxyForURL (url, host) { return \*(AqPROXY proxy\&.example\&.com:8080; DIRECT\*(Aq; }" -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&21.\ \&sriov setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l. -T{ -total\-vfs -T}:T{ -SRIOV_TOTAL_VFS\fI(+)\fR -T}:T{ -\ \& -T}:T{ -The total number of virtual functions to create\fB - -Example: \fRSRIOV_TOTAL_VFS=16 -T} -T{ -vfs -T}:T{ -SRIOV_VF1\fI(+)\fR, SRIOV_VF2\fI(+)\fR, \&.\&.\&. -T}:T{ -\ \& -T}:T{ -SR\-IOV virtual function descriptors\fB - -Example: \fRSRIOV_VF10="mac=00:11:22:33:44:55", \&.\&.\&. -T} -T{ -autoprobe\-drivers -T}:T{ -SRIOV_AUTOPROBE_DRIVERS\fI(+)\fR -T}:T{ -missing variable means global default -T}:T{ -Whether to autoprobe virtual functions by a compatible driver\fB - -Example: \fRSRIOV_AUTOPROBE_DRIVERS=0,1 -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&22.\ \&tc setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l. -T{ -qdiscs -T}:T{ -QDISC1\fI(+)\fR, QDISC2\fI(+)\fR, \&.\&.\&., TC_COMMIT\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Queueing disciplines to set on the interface\&. When no QDISC1, QDISC2, \&.\&.\&., FILTER1, FILTER2, \&.\&.\&. keys are present, NetworkManager doesn\*(Aqt touch qdiscs and filters present on the interface, unless TC_COMMIT is set to \*(Aqyes\*(Aq\&.\fB - -Example: \fRQDISC1=ingress, QDISC2="root handle 1234: fq_codel" -T} -T{ -tfilters -T}:T{ -FILTER1\fI(+)\fR, FILTER2\fI(+)\fR, \&.\&.\&., TC_COMMIT\fI(+)\fR -T}:T{ -\ \& -T}:T{ -Traffic filters to set on the interface\&. When no QDISC1, QDISC2, \&.\&.\&., FILTER1, FILTER2, \&.\&.\&. keys are present, NetworkManager doesn\*(Aqt touch qdiscs and filters present on the interface, unless TC_COMMIT is set to \*(Aqyes\*(Aq\&.\fB - -Example: \fRFILTER1="parent ffff: matchall action simple sdata Input", \&.\&.\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&23.\ \&team setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l. -T{ -config -T}:T{ -TEAM_CONFIG -T}:T{ -\ \& -T}:T{ -Team configuration in JSON\&. See man teamd\&.conf for details\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&24.\ \&team\-port setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l. -T{ -config -T}:T{ -TEAM_PORT_CONFIG -T}:T{ -\ \& -T}:T{ -Team port configuration in JSON\&. See man teamd\&.conf for details\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&25.\ \&user setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l. -T{ -data -T}:T{ -NM_USER_* -T}:T{ -\ \& -T}:T{ -each key/value pair is stored as a separate variable with name composed by concatenating NM_USER_ with the encoded key\&. The key is encoded by substituting lowercase letters with uppercase and prepending uppercase letters with an underscore\&. A dot is encoded as a double underscore\&. Remaining characters are encoded as underscore followed by a 3 digit octal representation of the character\&.\fB - -Example: \fRNM_USER_FOO__BAR=something -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&26.\ \&vlan setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -parent -T}:T{ -DEVICE or PHYSDEV -T}:T{ -\ \& -T}:T{ -Parent interface of the VLAN\&. -T} -T{ -id -T}:T{ -VLAN_ID, DEVICE\&. -T}:T{ -\ \& -T}:T{ -VLAN identifier\&. If VLAN_ID is not set, it is attempted to be detected from the suffix of DEVICE=\&. Note that older versions of NetworkManager had a bug where they would prefer the detected ID from the DEVICE over VLAN_ID\&. -T} -T{ -flags -T}:T{ -GVRP, MVRP, VLAN_FLAGS -T}:T{ -\ \& -T}:T{ -VLAN flags\&.\fB - -Allowed values: \fR"yes or "no" for GVRP and MVRP; "LOOSE_BINDING" and "NO_REORDER_HDR" for VLAN_FLAGS -T} -T{ -protocol -T}:T{ -VLAN_PROTOCOL -T}:T{ -\ \& -T}:T{ -VLAN protocol\&.\fB - -Example: \fRVLAN_PROTOCOL="802\&.1ad" -T} -T{ -ingress\-priority\-map -T}:T{ -VLAN_INGRESS_PRIORITY_MAP -T}:T{ -\ \& -T}:T{ -Ingress priority mapping\&.\fB - -Example: \fRVLAN_INGRESS_PRIORITY_MAP=4:2,3:5 -T} -T{ -egress\-priority\-map -T}:T{ -VLAN_EGRESS_PRIORITY_MAP -T}:T{ -\ \& -T}:T{ -Egress priority mapping\&.\fB - -Example: \fRVLAN_EGRESS_PRIORITY_MAP=5:4,4:1,3:7 -T} -T{ -interface\-name -T}:T{ -PHYSDEV and VLAN_ID, or DEVICE -T}:T{ -\ \& -T}:T{ -VLAN interface name\&. If all variables are set, parent device from PHYSDEV takes precedence over DEVICE, but VLAN id from DEVICE takes precedence over VLAN_ID\&.\fB - -Example: \fRPHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0\&.12 -T} -.TE -.sp 1 -.PP -The following settings are not supported by -\fIifcfg\-rh\fR -plugin: -.PP -6lowpan, 802\-11\-olpc\-mesh, adsl, bluetooth, cdma, dummy, generic, gsm, ip\-tunnel, link, loopback, macsec, macvlan, ovs\-bridge, ovs\-dpdk, ovs\-interface, ovs\-patch, ovs\-port, ppp, pppoe, serial, tun, veth, vpn, vrf, vxlan, wifi\-p2p, wimax, wireguard, wpan -.SS "Secret flags" -.PP -Each secret property in a NetworkManager setting has an associated -\fIflags\fR -property that describes how to handle that secret\&. In the -\fIifcfg\-rh\fR -plugin variables for secret flags have a -\fI_FLAGS\fR -suffix\&. The variables contain one or more of the following values (space separated)\&. Missing (or empty) *_FLAGS variable means that the password is owned by NetworkManager\&. -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -user -\- a user\-session secret agent is responsible for providing and storing this secret; when it is required, agents will be asked to provide it\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -ask -\- the associated password is not saved but it will be requested from the user each time it is required\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -unused -\- in some situations it cannot be automatically determined that a secret is required or not\&. This flag hints that the secret is not required and should not be requested from the user\&. -.RE -.SH "FILES" -.PP -/etc/sysconfig/network\-scripts/ifcfg\-* -.PP -/etc/sysconfig/network\-scripts/keys\-* -.PP -/etc/sysconfig/network\-scripts/route\-* -.PP -/etc/sysconfig/network\-scripts/route6\-* -.PP -/usr/share/doc/initscripts/sysconfig\&.txt -.SH "SEE ALSO" -.PP -\fBnm-settings-nmcli\fR(5), -\fBnm-settings-keyfile\fR(5), -\fBNetworkManager\fR(8), -\fBNetworkManager.conf\fR(5), -\fBnmcli\fR(1), -\fBnmcli-examples\fR(7) diff --git a/man/nm-settings-keyfile.5 b/man/nm-settings-keyfile.5 deleted file mode 100644 index 95042f17..00000000 --- a/man/nm-settings-keyfile.5 +++ /dev/null @@ -1,836 +0,0 @@ -'\" t -.\" Title: nm-settings-keyfile -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: Configuration -.\" Source: NetworkManager 1.50.0 -.\" Language: English -.\" -.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.50\&.0" "Configuration" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nm-settings-keyfile \- Description of \fIkeyfile\fR settings plugin -.SH "DESCRIPTION" -.PP -NetworkManager is based on the concept of connection profiles that contain network configuration (see -\fBnm-settings-nmcli\fR(5) -for details)\&. The profiles can be stored in various formats\&. NetworkManager uses plugins for reading and writing the data\&. The plugins can be configured in -\fBNetworkManager.conf\fR(5)\&. -.PP -The -\fIkeyfile\fR -plugin is the generic plugin that supports all the connection types and capabilities that NetworkManager has\&. The files are in a \&.ini\-style format and located in -/etc/NetworkManager/system\-connections/, -/usr/lib/NetworkManager/system\-connections/ -and -/run/NetworkManager/system\-connections/\&. This plugin is always enabled and will automatically be used to store any connections that are not supported by any other active plugin\&. For security, it will ignore files that are readable or writable by any user other than \*(Aqroot\*(Aq since private keys and passphrases may be stored in plaintext inside the file\&. -.SH "FILE FORMAT" -.PP -The -\fIkeyfile\fR -config format is a simple \&.ini\-style format\&. It consists of sections (groups) of key\-value pairs\&. More information of the generic key file format can be found at -\m[blue]\fBGLib key file format\fR\m[]\&\s-2\u[1]\d\s+2 -(Lines beginning with a \*(Aq#\*(Aq are comments, lists are separated by character -; -etc\&.)\&. -.PP -Each section corresponds to a setting name as described in the settings specification (\fBnm-settings-nmcli\fR(5))\&. Each key/value pair in a section is one of the properties from the specification\&. -.PP -The majority of properties are written in the same format as the specification into the -\fIkeyfile\fR\&. However, some values are inconvenient for people to use so they are stored in the -\fIkeyfile\fR -in more readable ways\&. These properties that differ from the specification are described below\&. An example could be IP addresses that are not written as integer arrays, but more reasonably as "1\&.2\&.3\&.4/12 1\&.2\&.3\&.254"\&. Also, some lists of complex values (addresses, routes, routing\-rules), instead of using a semicolon separated list, use one key\-value pair per list element, with the key being the singular of the property name followed by the numeric index (i\&.e address1, address2, \&.\&.\&.)\&. -.PP -Users can create or modify the -\fIkeyfile\fR -connection files manually, even if that is not the recommended way of managing the profiles\&. However, if they choose to do that, they must inform NetworkManager about their changes (for example via -\fInmcli con (re)load\fR)\&. -.PP -\fBExamples of keyfile configuration\fR. -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fBA sample configuration for an ethernet network:\fR -[connection] -id=Main eth0 -uuid=27afa607\-ee36\-43f0\-b8c3\-9d245cdc4bb3 -type=802\-3\-ethernet -autoconnect=true - -[ipv4] -method=auto - -[802\-3\-ethernet] -mac\-address=00:23:5a:47:1f:71 - -.fi -.if n \{\ -.RE -.\} - -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fBA sample configuration for WPA\-EAP (PEAP with MSCHAPv2) and always\-ask secret:\fR -[connection] -id=CompanyWIFI -uuid=cdac6154\-a33b\-4b15\-9904\-666772cfa5ee -type=wifi -autoconnect=false - -[wifi] -ssid=CorpWLAN -mode=infrastructure -security=802\-11\-wireless\-security - -[wifi\-security] -key\-mgmt=wpa\-eap - -[ipv4] -method=auto - -[ipv6] -method=auto - -[802\-1x] -eap=peap; -identity=joe -ca\-cert=/home/joe/\&.cert/corp\&.crt -phase1\-peapver=1 -phase2\-auth=mschapv2 -password\-flags=2 - -.fi -.if n \{\ -.RE -.\} - -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fBA sample configuration for openvpn:\fR -[connection] -id=RedHat\-openvpn -uuid=7f9b3356\-b210\-4c0e\-8123\-bd116c9c280f -type=vpn -timestamp=1385401165 - -[vpn] -service\-type=org\&.freedesktop\&.NetworkManager\&.openvpn -connection\-type=password -password\-flags=3 -remote=ovpn\&.my\-company\&.com -cipher=AES\-256\-CBC -reneg\-seconds=0 -port=443 -username=joe -ca=/etc/openvpn/ISCA\&.pem -tls\-remote=ovpn\&.my\-company\&.com - -[ipv6] -method=auto - -[ipv4] -method=auto -ignore\-auto\-dns=true -never\-default=true - -.fi -.if n \{\ -.RE -.\} - -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fBA sample configuration for a bridge and a bridge port:\fR -[connection] [connection] -id=MainBridge id=br\-port\-1 -uuid=171ae855\-a0ab\-42b6\-bd0c\-60f5812eea9d uuid=d6e8ae98\-71f8\-4b3d\-9d2d\-2e26048fe794 -interface\-name=MainBridge interface\-name=em1 -type=bridge type=ethernet - controller=MainBridge -[bridge] port\-type=bridge -interface\-name=MainBridge - -.fi -.if n \{\ -.RE -.\} - -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fBA sample configuration for a VLAN:\fR -[connection] -id=VLAN for building 4A -uuid=8ce1c9e0\-ce7a\-4d2c\-aa28\-077dda09dd7e -interface\-name=VLAN\-4A -type=vlan - -[vlan] -interface\-name=VLAN\-4A -parent=eth0 -id=4 - -.fi -.if n \{\ -.RE -.\} -.SH "DETAILS" -.PP -\fIkeyfile\fR -plugin variables for the majority of NetworkManager properties have one\-to\-one mapping\&. It means a NetworkManager property is stored in the keyfile as a variable of the same name and in the same format\&. There are several exceptions to this rule, mainly for making keyfile syntax easier for humans\&. The exceptions handled specially by -\fIkeyfile\fR -plugin are listed below\&. Refer to -\fBnm-settings-nmcli\fR(5) -for all available settings and properties and their description\&. -.PP -\fBName aliases\fR. Some of the NetworkManager setting names are somewhat hard to type or remember\&. Therefore -\fIkeyfile\fR -introduces aliases that can be used instead of the names\&. -.RS 4 -\fIsetting name keyfile alias\fR -.RE -.RS 4 -802\-3\-ethernet = ethernet -.RE -.RS 4 -802\-11\-wireless = wifi -.RE -.RS 4 -802\-11\-wireless\-security = wifi\-security -.RE -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&1.\ \&802\-11\-wireless setting (section) -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Keyfile Variable -T}:T{ -Format -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -ssid -T}:T{ -\ \& -T}:T{ -string (or decimal\-byte list \- obsolete) -T}:T{ -SSID of Wi\-Fi network\&.\fB - -Example: \fRssid=Quick Net -T} -T{ -mac\-address -T}:T{ -\ \& -T}:T{ -usual hex\-digits\-and\-colons notation -T}:T{ -MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;162)\&. -T} -T{ -cloned\-mac\-address -T}:T{ -\ \& -T}:T{ -usual hex\-digits\-and\-colons notation -T}:T{ -Cloned MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;178)\&. -T} -T{ -mac\-address\-blacklist -T}:T{ -\ \& -T}:T{ -list of MACs (separated with semicolons) -T}:T{ -MAC address blacklist\&.\fB - -Example: \fRmac\-address\-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78 -T} -T{ -mac\-address\-denylist -T}:T{ -\ \& -T}:T{ -list of MACs (separated with semicolons) -T}:T{ -MAC address denylist\&.\fB - -Example: \fRmac\-address\-denylist= 00:22:68:12:79:A6;00:22:68:12:79:78 -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&2.\ \&802\-3\-ethernet setting (section) -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Keyfile Variable -T}:T{ -Format -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l. -T{ -mac\-address -T}:T{ -\ \& -T}:T{ -usual hex\-digits\-and\-colons notation -T}:T{ -MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;162) -T} -T{ -cloned\-mac\-address -T}:T{ -\ \& -T}:T{ -usual hex\-digits\-and\-colons notation -T}:T{ -Cloned MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;178)\&. -T} -T{ -mac\-address\-blacklist -T}:T{ -\ \& -T}:T{ -list of MACs (separated with semicolons) -T}:T{ -MAC address blacklist\&.\fB - -Example: \fRmac\-address\-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:78 -T} -T{ -mac\-address\-denylist -T}:T{ -\ \& -T}:T{ -list of MACs (separated with semicolons) -T}:T{ -MAC address denylist\&.\fB - -Example: \fRmac\-address\-denylist= 00:22:68:12:79:A6;00:22:68:12:79:78 -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&3.\ \&bridge setting (section) -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Keyfile Variable -T}:T{ -Format -T}:T{ -Description -T} -.T& -l l l l. -T{ -mac\-address -T}:T{ -\ \& -T}:T{ -usual hex\-digits\-and\-colons notation -T}:T{ -MAC address in traditional hex\-digits\-and\-colons notation, or semicolon separated list of 6 decimal bytes (obsolete)\fB - -Example: \fRmac\-address=00:22:68:12:79:A2 mac\-address=0;34;104;18;121;162; -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&4.\ \&infiniband setting (section) -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Keyfile Variable -T}:T{ -Format -T}:T{ -Description -T} -.T& -l l l l. -T{ -mac\-address -T}:T{ -\ \& -T}:T{ -usual hex\-digits\-and\-colons notation -T}:T{ -MAC address in traditional hex\-digits\-and\-colons notation, or or semicolon separated list of 20 decimal bytes (obsolete)\fB - -Example: \fRmac\-address= 80:00:00:6d:fe:80:00:00:00:00:00:00:00:02:55:00:70:33:cf:01 -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&5.\ \&ipv4 setting (section) -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Keyfile Variable -T}:T{ -Format -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -dns -T}:T{ -\ \& -T}:T{ -list of DNS IP addresses -T}:T{ -List of DNS servers\&.\fB - -Example: \fRdns=1\&.2\&.3\&.4;8\&.8\&.8\&.8;8\&.8\&.4\&.4; -T} -T{ -addresses -T}:T{ -address1, address2, \&.\&.\&. -T}:T{ -address/plen -T}:T{ -List of static IP addresses\&.\fB - -Example: \fRaddress1=192\&.168\&.100\&.100/24 address2=10\&.1\&.1\&.5/24 -T} -T{ -gateway -T}:T{ -gateway -T}:T{ -string -T}:T{ -Gateway IP addresses as a string\&.\fB - -Example: \fRgateway=192\&.168\&.100\&.1 -T} -T{ -routes -T}:T{ -route1, route2, \&.\&.\&. -T}:T{ -route/plen[,gateway,metric] -T}:T{ -List of IP routes\&.\fB - -Example: \fRroute1=8\&.8\&.8\&.0/24,10\&.1\&.1\&.1,77 route2=7\&.7\&.0\&.0/16 -T} -T{ -routes (attributes) -T}:T{ -route1_options, route2_options, \&.\&.\&. -T}:T{ -key=val[,key=val\&.\&.\&.] -T}:T{ -Attributes defined for the routes, if any\&. The supported attributes are explained in ipv4\&.routes entry in `man nm\-settings\-nmcli`\&.\fB - -Example: \fRroute1_options=mtu=1000,onlink=true -T} -T{ -routing\-rules -T}:T{ -routing\-rule1, routing\-rule2, \&.\&.\&. -T}:T{ -routing rule string -T}:T{ -Routing rules as defined with `ip rule add`, but with mandatory fixed priority\&.\fB - -Example: \fRrouting\-rule1=priority 5 from 192\&.167\&.4\&.0/24 table 45 -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&6.\ \&ipv6 setting (section) -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Keyfile Variable -T}:T{ -Format -T}:T{ -Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -dns -T}:T{ -\ \& -T}:T{ -list of DNS IP addresses -T}:T{ -List of DNS servers\&.\fB - -Example: \fRdns=2001:4860:4860::8888;2001:4860:4860::8844; -T} -T{ -addresses -T}:T{ -address1, address2, \&.\&.\&. -T}:T{ -address/plen -T}:T{ -List of static IP addresses\&.\fB - -Example: \fRaddress1=abbe::cafe/96 address2=2001::1234 -T} -T{ -gateway -T}:T{ -gateway -T}:T{ -string -T}:T{ -Gateway IP addresses as a string\&.\fB - -Example: \fRgateway=abbe::1 -T} -T{ -routes -T}:T{ -route1, route2, \&.\&.\&. -T}:T{ -route/plen[,gateway,metric] -T}:T{ -List of IP routes\&.\fB - -Example: \fRroute1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403 -T} -T{ -routes (attributes) -T}:T{ -route1_options, route2_options, \&.\&.\&. -T}:T{ -key=val[,key=val\&.\&.\&.] -T}:T{ -Attributes defined for the routes, if any\&. The supported attributes are explained in ipv6\&.routes entry in `man nm\-settings\-nmcli`\&.\fB - -Example: \fRroute1_options=mtu=1000,onlink=true -T} -T{ -routing\-rules -T}:T{ -routing\-rule1, routing\-rule2, \&.\&.\&. -T}:T{ -routing rule string -T}:T{ -Routing rules as defined with `ip rule add`, but with mandatory fixed priority\&.\fB - -Example: \fRrouting\-rule1=priority 5 from 2001:4860:4860::/64 table 45 -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&7.\ \&serial setting (section) -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Keyfile Variable -T}:T{ -Format -T}:T{ -Description -T} -.T& -l l l l. -T{ -parity -T}:T{ -\ \& -T}:T{ -\*(Aqe\*(Aq, \*(Aqo\*(Aq, or \*(Aqn\*(Aq -T}:T{ -The connection parity; even, odd, or none\&. Note that older versions of NetworkManager stored this as an integer: 69 (\*(AqE\*(Aq) for even, 111 (\*(Aqo\*(Aq) for odd, or 110 (\*(Aqn\*(Aq) for none\&.\fB - -Example: \fRparity=n -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&8.\ \&vpn setting (section) -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Keyfile Variable -T}:T{ -Format -T}:T{ -Description -T} -.T& -l l l l -l l l l. -T{ -data -T}:T{ -separate variables named after keys of the dictionary -T}:T{ -\ \& -T}:T{ -The keys of the data dictionary are used as variable names directly under [vpn] section\&.\fB - -Example: \fRremote=ovpn\&.corp\&.com cipher=AES\-256\-CBC username=joe -T} -T{ -secrets -T}:T{ -separate variables named after keys of the dictionary -T}:T{ -\ \& -T}:T{ -The keys of the secrets dictionary are used as variable names directly under [vpn\-secrets] section\&.\fB - -Example: \fRpassword=Popocatepetl -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&9.\ \&wifi\-p2p setting (section) -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Keyfile Variable -T}:T{ -Format -T}:T{ -Description -T} -.T& -l l l l. -T{ -peer -T}:T{ -\ \& -T}:T{ -usual hex\-digits\-and\-colons notation -T}:T{ -MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e\&.g\&. 0;34;104;18;121;162)\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&10.\ \&wpan setting (section) -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Keyfile Variable -T}:T{ -Format -T}:T{ -Description -T} -.T& -l l l l. -T{ -mac\-address -T}:T{ -\ \& -T}:T{ -usual hex\-digits\-and\-colons notation -T}:T{ -MAC address in hex\-digits\-and\-colons notation (e\&.g\&. 76:d8:9b:87:66:60:84:ee)\&. -T} -.TE -.sp 1 -.SS "Secret flags" -.PP -Each secret property in a NetworkManager setting has an associated -\fIflags\fR -property that describes how to handle that secret\&. In the -\fIkeyfile\fR -plugin, the value of -\fI\-flags\fR -variable is a decimal number (0 \- 7) defined as a sum of the following values: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -0 \- (NM owned) \- the system is responsible for providing and storing this secret\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -1 \- (agent\-owned) \- a user\-session secret agent is responsible for providing and storing this secret; when it is required, agents will be asked to provide it\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -2 \- (not\-saved) \- this secret should not be saved but should be requested from the user each time it is required\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -4 \- (not\-required) \- in some situations it cannot be automatically determined that a secret is required or not\&. This flag hints that the secret is not required and should not be requested from the user\&. -.RE -.SH "FILES" -.PP -/etc/NetworkManager/system\-connections/* -.SH "SEE ALSO" -.PP -\fBnm-settings-nmcli\fR(5), -\fBnm-settings-ifcfg-rh\fR(5), -\fBNetworkManager\fR(8), -\fBNetworkManager.conf\fR(5), -\fBnmcli\fR(1), -\fBnmcli-examples\fR(7) -.SH "NOTES" -.IP " 1." 4 -GLib key file format -.RS 4 -\%https://developer.gnome.org/glib/stable/glib-Key-value-file-parser.html#glib-Key-value-file-parser.description -.RE diff --git a/man/nm-settings-nmcli.5 b/man/nm-settings-nmcli.5 deleted file mode 100644 index a64a8fe3..00000000 --- a/man/nm-settings-nmcli.5 +++ /dev/null @@ -1,6495 +0,0 @@ -'\" t -.\" Title: nm-settings-nmcli -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: Configuration -.\" Source: NetworkManager 1.50.0 -.\" Language: English -.\" -.TH "NM\-SETTINGS\-NMCLI" "5" "" "NetworkManager 1\&.50\&.0" "Configuration" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nm-settings-nmcli \- Description of settings and properties of NetworkManager connection profiles for nmcli -.SH "DESCRIPTION" -.PP -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 be applied and an active network connection will be established\&. Users are free to create as many connection profiles as they see fit\&. Thus they are flexible in having various network configurations for different networking needs\&. -.PP -NetworkManager provides an API for configuring connection profiles, for activating them to configure the network, and inspecting the current network configuration\&. The command line tool -\fInmcli\fR -is a client application to NetworkManager that uses this API\&. See -\fBnmcli\fR(1) -for details\&. -.PP -With commands like -nmcli connection add, -nmcli connection modify -and -nmcli connection show, connection profiles can be created, modified and inspected\&. A profile consists of properties\&. On D\-Bus this follows the format as described by -\fBnm-settings-dbus\fR(5), while this manual page describes the settings format how they are expected by -\fInmcli\fR\&. -.PP -The settings and properties shown in tables below list all available connection configuration options\&. However, note that not all settings are applicable to all connection types\&. -\fInmcli\fR -connection editor has also a built\-in -\fIdescribe\fR -command that can display description of particular settings and properties of this page\&. -.PP -The -\fIsetting\fR -and -\fIproperty\fR -can be abbreviated provided they are unique\&. The list below also shows aliases that can be used unqualified instead of the full name\&. For example -connection\&.interface\-name -and -ifname -refer to the same property\&. -.SS "connection setting" -.PP -General Connection Profile Settings\&. -.PP -Properties: -.PP -\fBconnection\&.auth\-retries\fR -.RS 4 -The number of retries for the authentication\&. Zero means to try indefinitely; \-1 means to use a global default\&. If the global default is not set, the authentication retries for 3 times before failing the connection\&. -.sp -Currently, this only applies to 802\-1x authentication\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 2147483647 -.RE -.PP -\fBconnection\&.autoconnect\fR -.RS 4 -Alias: autoconnect -.sp -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\&. -.sp -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\&. -.sp -Note that autoconnect is not implemented for VPN profiles\&. See "secondaries" as an alternative to automatically connect VPN profiles\&. -.sp -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\&. -.sp -Depending on "connection\&.multi\-connect", a profile can (auto)connect only once at a time or multiple times\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBconnection\&.autoconnect\-ports\fR -.RS 4 -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\&. -.sp -Format: choice (NMTernary) -.sp -Valid values: default (\-1), false (0), true (1) -.RE -.PP -\fBconnection\&.autoconnect\-priority\fR -.RS 4 -The autoconnect priority in range \-999 to 999\&. If the connection is set to autoconnect, connections with higher priority will be preferred\&. The higher number means higher priority\&. Defaults to 0\&. Note that this property only matters if there are more than one candidate profile to select for autoconnect\&. In case of equal priority, the profile used most recently is chosen\&. -.sp -Format: integer -.sp -Valid values: \-999 \- 999 -.RE -.PP -\fBconnection\&.autoconnect\-retries\fR -.RS 4 -The number of times a connection should be tried when autoactivating before giving up\&. Zero means forever, \-1 means the global default (4 times if not overridden)\&. Setting this to 1 means to try activation only once before blocking autoconnect\&. Note that after a timeout, NetworkManager will try to autoconnect again\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 2147483647 -.sp -Special values: default (\-1), forever (0) -.RE -.PP -\fBconnection\&.autoconnect\-slaves\fR -.RS 4 -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\-slaves is read to determine the real value\&. If it is default as well, this fallbacks to 0\&. -.sp -Deprecated 1\&.46\&. Use "autoconnect\-ports" instead, this is just an alias\&. -.sp -Format: choice (NMSettingConnectionAutoconnectSlaves) -.sp -Valid values: default (\-1), no (0), yes (1) -.RE -.PP -\fBconnection\&.controller\fR -.RS 4 -Alias: controller -.sp -Interface name of the controller device or UUID of the controller connection\&. -.sp -Format: string -.RE -.PP -\fBconnection\&.dns\-over\-tls\fR -.RS 4 -Whether DNSOverTls (dns\-over\-tls) is enabled for the connection\&. DNSOverTls is a technology which uses TLS to encrypt dns traffic\&. -.sp -The permitted values are: "yes" (2) use DNSOverTls and disabled fallback, "opportunistic" (1) use DNSOverTls but allow fallback to unencrypted resolution, "no" (0) don\*(Aqt ever use DNSOverTls\&. If unspecified "default" depends on the plugin used\&. Systemd\-resolved uses global setting\&. -.sp -This feature requires a plugin which supports DNSOverTls\&. Otherwise, the setting has no effect\&. One such plugin is dns\-systemd\-resolved\&. -.sp -Format: choice (NMSettingConnectionDnsOverTls) -.sp -Valid values: default (\-1), no (0), opportunistic (1), yes (2) -.RE -.PP -\fBconnection\&.down\-on\-poweroff\fR -.RS 4 -Whether the connection will be brought down before the system is powered off\&. 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 "no" (0)\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fBconnection\&.gateway\-ping\-timeout\fR -.RS 4 -If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping\&. -.sp -Format: integer -.sp -Valid values: 0 \- 600 -.RE -.PP -\fBconnection\&.id\fR -.RS 4 -Alias: con\-name -.sp -A human readable unique identifier for the connection, like "Work Wi\-Fi" or "T\-Mobile 3G"\&. -.sp -Format: string -.RE -.PP -\fBconnection\&.interface\-name\fR -.RS 4 -Alias: ifname -.sp -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)\&. -.sp -For software devices this specifies the name of the created device\&. -.sp -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\&. -.sp -Format: string -.RE -.PP -\fBconnection\&.lldp\fR -.RS 4 -Whether LLDP is enabled for the connection\&. -.sp -Format: choice (NMSettingConnectionLldp) -.sp -Valid values: default (\-1), disable (0), enable\-rx/enable (1) -.RE -.PP -\fBconnection\&.llmnr\fR -.RS 4 -Whether Link\-Local Multicast Name Resolution (LLMNR) is enabled for the connection\&. LLMNR is a protocol based on the Domain Name System (DNS) packet format that allows both IPv4 and IPv6 hosts to perform name resolution for hosts on the same local link\&. -.sp -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")\&. -.sp -This feature requires a plugin which supports LLMNR\&. Otherwise, the setting has no effect\&. One such plugin is dns\-systemd\-resolved\&. -.sp -Format: choice (NMSettingConnectionLlmnr) -.sp -Valid values: default (\-1), no (0), resolve (1), yes (2) -.RE -.PP -\fBconnection\&.master\fR -.RS 4 -Alias: master -.sp -Interface name of the controller device or UUID of the controller connection\&. -.sp -Deprecated 1\&.46\&. Use "controller" instead, this is just an alias\&. -.sp -Format: string -.RE -.PP -\fBconnection\&.mdns\fR -.RS 4 -Whether mDNS is enabled for the connection\&. -.sp -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\&. -.sp -This feature requires a plugin which supports mDNS\&. Otherwise, the setting has no effect\&. Currently the only supported DNS plugin is systemd\-resolved\&. For systemd\-resolved, the default is configurable via MulticastDNS= setting in resolved\&.conf\&. -.sp -Format: choice (NMSettingConnectionMdns) -.sp -Valid values: default (\-1), no (0), resolve (1), yes (2) -.RE -.PP -\fBconnection\&.metered\fR -.RS 4 -Whether the connection is metered\&. -.sp -When updating this property on a currently activated connection, the change takes effect immediately\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fBconnection\&.mptcp\-flags\fR -.RS 4 -Whether to configure MPTCP endpoints and the address flags\&. If MPTCP is enabled in NetworkManager, it will configure the addresses of the interface as MPTCP endpoints\&. Note that IPv4 loopback addresses (127\&.0\&.0\&.0/8), IPv4 link local addresses (169\&.254\&.0\&.0/16), the IPv6 loopback address (::1), IPv6 link local addresses (fe80::/10), IPv6 unique local addresses (ULA, fc00::/7) and IPv6 privacy extension addresses (rfc3041, ipv6\&.ip6\-privacy) will be excluded from being configured as endpoints\&. -.sp -If "disabled" (0x1), MPTCP handling for the interface is disabled and no endpoints are registered\&. -.sp -The "enabled" (0x2) flag means that MPTCP handling is enabled\&. This flag can also be implied from the presence of other flags\&. -.sp -Even when enabled, MPTCP handling will by default still be disabled unless "/proc/sys/net/mptcp/enabled" sysctl is on\&. NetworkManager does not change the sysctl and this is up to the administrator or distribution\&. To configure endpoints even if the sysctl is disabled, "also\-without\-sysctl" (0x4) flag can be used\&. In that case, NetworkManager doesn\*(Aqt look at the sysctl and configures endpoints regardless\&. -.sp -Even when enabled, NetworkManager will only configure MPTCP endpoints for a certain address family, if there is a unicast default route (0\&.0\&.0\&.0/0 or ::/0) in the main routing table\&. The flag "also\-without\-default\-route" (0x8) can override that\&. -.sp -When MPTCP handling is enabled then endpoints are configured with the specified address flags "signal" (0x10), "subflow" (0x20), "backup" (0x40), "fullmesh" (0x80)\&. See ip\-mptcp(8) manual for additional information about the flags\&. -.sp -If the flags are zero (0x0), the global connection default from NetworkManager\&.conf is honored\&. If still unspecified, the fallback is "enabled,subflow"\&. Note that this means that MPTCP is by default done depending on the "/proc/sys/net/mptcp/enabled" sysctl\&. -.sp -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\&. -.sp -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)\&. -.sp -Format: flags (NMMptcpFlags) -.sp -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) -.RE -.PP -\fBconnection\&.mud\-url\fR -.RS 4 -If configured, set to a Manufacturer Usage Description (MUD) URL that points to manufacturer\-recommended network policies for IoT devices\&. It is transmitted as a DHCPv4 or DHCPv6 option\&. The value must be a valid URL starting with "https://"\&. -.sp -The special value "none" is allowed to indicate that no MUD URL is used\&. -.sp -If the per\-profile value is unspecified (the default), a global connection default gets consulted\&. If still unspecified, the ultimate default is "none"\&. -.sp -Format: string -.RE -.PP -\fBconnection\&.multi\-connect\fR -.RS 4 -Specifies whether the profile can be active multiple times at a particular moment\&. The value is of type NMConnectionMultiConnect\&. -.sp -Format: choice (NMConnectionMultiConnect) -.sp -Valid values: default (0), single (1), manual\-multiple (2), multiple (3) -.RE -.PP -\fBconnection\&.permissions\fR -.RS 4 -An array of strings defining what access a given user has to this connection\&. If this is NULL or empty, all users are allowed to access this connection; otherwise users are allowed if and only if they are in this list\&. When this is not empty, the connection can be active only when one of the specified users is logged into an active session\&. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah"\&. -.sp -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\&. -.sp -Format: list of strings -.RE -.PP -\fBconnection\&.port\-type\fR -.RS 4 -Alias: port\-type -.sp -Setting name of the device type of this port\*(Aqs controller connection (eg, "bond"), or NULL if this connection is not a port\&. -.sp -Format: string -.sp -Valid values: bond, bridge, ovs\-bridge, ovs\-port, team, vrf -.RE -.PP -\fBconnection\&.secondaries\fR -.RS 4 -List of connection UUIDs that should be activated when the base connection itself is activated\&. Currently, only VPN connections are supported\&. -.sp -Format: list of strings -.RE -.PP -\fBconnection\&.slave\-type\fR -.RS 4 -Alias: slave\-type -.sp -Setting name of the device type of this port\*(Aqs controller connection (eg, "bond"), or NULL if this connection is not a port\&. -.sp -Deprecated 1\&.46\&. Use "port\-type" instead, this is just an alias\&. -.sp -Format: string -.sp -Valid values: bond, bridge, ovs\-bridge, ovs\-port, team, vrf -.RE -.PP -\fBconnection\&.stable\-id\fR -.RS 4 -This represents the identity of the connection used for various purposes\&. It allows to configure multiple profiles to share the identity\&. Also, the stable\-id can contain placeholders that are substituted dynamically and deterministically depending on the context\&. -.sp -The stable\-id is used for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. It is also used to derive the DHCP client identifier with ipv4\&.dhcp\-client\-id=stable, the DHCPv6 DUID with ipv6\&.dhcp\-duid=stable\-[llt,ll,uuid] and the DHCP IAID with ipv4\&.iaid=stable and ipv6\&.iaid=stable\&. -.sp -Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm\&. For example, a per\-host key is commonly also included, so that different systems end up generating different IDs\&. Or with ipv6\&.addr\-gen\-mode=stable\-privacy, also the device\*(Aqs name is included, so that different interfaces yield different addresses\&. The per\-host key is the identity of your machine and stored in /var/lib/NetworkManager/secret_key\&. See NetworkManager(8) manual about the secret\-key and the host identity\&. -.sp -The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at 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\*(Aqs 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 \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}\-${BOOT}\-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates\&. -.sp -If the value is unset, a global connection default is consulted\&. If the value is still unset, the default is "default${CONNECTION}" go generate an ID unique per connection profile\&. -.sp -Format: string -.RE -.PP -\fBconnection\&.timestamp\fR -.RS 4 -The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated\&. -.sp -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)\&. -.sp -Format: read only -.RE -.PP -\fBconnection\&.type\fR -.RS 4 -Alias: type -.sp -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)\&. -.sp -Format: string -.sp -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 -.RE -.PP -\fBconnection\&.uuid\fR -.RS 4 -The connection\&.uuid is the real identifier of a profile\&. It cannot change and it must be unique\&. It is therefore often best to refer to a profile by UUID, for example with `nmcli connection up uuid $UUID`\&. -.sp -The UUID cannot be changed, except in offline mode\&. In that case, the special values "new", "generate" and "" are allowed to generate a new random UUID\&. -.sp -Format: a valid RFC4122 universally unique identifier (UUID)\&. -.RE -.PP -\fBconnection\&.wait\-activation\-delay\fR -.RS 4 -Time in milliseconds to wait for connection to be considered activated\&. The wait will start after the pre\-up dispatcher event\&. -.sp -The value 0 means no wait time\&. The default value is \-1, which currently has the same meaning as no wait time\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 2147483647 -.RE -.PP -\fBconnection\&.wait\-device\-timeout\fR -.RS 4 -Timeout in milliseconds to wait for device at startup\&. During boot, devices may take a while to be detected by the driver\&. This property will cause to delay NetworkManager\-wait\-online\&.service and nm\-online to give the device a chance to appear\&. This works by waiting for the given timeout until a compatible device for the profile is available and managed\&. -.sp -The value 0 means no wait time\&. The default value is \-1, which currently has the same meaning as no wait time\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 2147483647 -.RE -.PP -\fBconnection\&.zone\fR -.RS 4 -The trust level of a the connection\&. Free form case\-insensitive string (for example "Home", "Work", "Public")\&. NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall\&. -.sp -When updating this property on a currently activated connection, the change takes effect immediately\&. -.sp -Format: string -.RE -.SS "6lowpan setting" -.PP -6LoWPAN Settings\&. -.PP -Properties: -.PP -\fB6lowpan\&.parent\fR -.RS 4 -Alias: dev -.sp -If given, specifies the parent interface name or parent connection UUID from which this 6LowPAN interface should be created\&. -.sp -Format: string -.RE -.SS "802\-1x setting" -.PP -IEEE 802\&.1x Authentication Settings\&. -.PP -Properties: -.PP -\fB802\-1x\&.altsubject\-matches\fR -.RS 4 -List of strings to be matched against the altSubjectName of the certificate presented by the authentication server\&. If the list is empty, no verification of the server certificate\*(Aqs altSubjectName is performed\&. -.sp -Format: list of strings -.RE -.PP -\fB802\-1x\&.anonymous\-identity\fR -.RS 4 -Anonymous identity string for EAP authentication methods\&. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP\-TTLS\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.auth\-timeout\fR -.RS 4 -A timeout for the authentication\&. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds\&. -.sp -Format: integer -.sp -Valid values: 0 \- 2147483647 -.RE -.PP -\fB802\-1x\&.ca\-cert\fR -.RS 4 -Contains the path to the CA certificate if used by the EAP method specified in the 802\-1x\&.eap property\&. -.sp -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\&. -.sp -Note that enabling 802\-1x\&.system\-ca\-certs will override this setting to use the built\-in path, if the built\-in path is not a directory\&. -.sp -Format: filesystem path -.RE -.PP -\fB802\-1x\&.ca\-cert\-password\fR -.RS 4 -The password used to access the CA certificate stored in "ca\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.ca\-cert\-password\-flags\fR -.RS 4 -Flags indicating how to handle the "ca\-cert\-password" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fB802\-1x\&.ca\-path\fR -.RS 4 -UTF\-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca\-cert" property\&. -.sp -If NMSetting8021x:system\-ca\-certs is enabled and the built\-in CA path is an existing directory, then this setting is ignored\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.client\-cert\fR -.RS 4 -Contains the path to the client certificate if used by the EAP method specified in the 802\-1x\&.eap property\&. -.sp -Format: filesystem path -.RE -.PP -\fB802\-1x\&.client\-cert\-password\fR -.RS 4 -The password used to access the client certificate stored in "client\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.client\-cert\-password\-flags\fR -.RS 4 -Flags indicating how to handle the "client\-cert\-password" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fB802\-1x\&.domain\-match\fR -.RS 4 -Constraint for server domain name\&. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server\&. If a matching dNSName is found, this constraint is met\&. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison\&. Multiple valid FQDNs can be passed as a ";" delimited list\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.domain\-suffix\-match\fR -.RS 4 -Constraint for server domain name\&. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server\&. If a matching dNSName is found, this constraint is met\&. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison\&. Since version 1\&.24, multiple valid FQDNs can be passed as a ";" delimited list\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.eap\fR -.RS 4 -The allowed EAP method to be used when authenticating to the network with 802\&.1x\&. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast"\&. Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations\&. -.sp -Format: list of strings -.sp -Valid values: leap, md5, tls, peap, ttls, sim, fast, pwd -.RE -.PP -\fB802\-1x\&.identity\fR -.RS 4 -Identity string for EAP authentication methods\&. Often the user\*(Aqs user or login name\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.openssl\-ciphers\fR -.RS 4 -Define openssl_ciphers for wpa_supplicant\&. Openssl sometimes moves ciphers among SECLEVELs, thus compiled\-in default value in wpa_supplicant (as modified by some linux distributions) sometimes prevents to connect to old servers that do not support new protocols\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.optional\fR -.RS 4 -Whether the 802\&.1X authentication is optional\&. If TRUE, the activation will continue even after a timeout or an authentication failure\&. Setting the property to TRUE is currently allowed only for Ethernet connections\&. If set to FALSE, the activation can continue only after a successful authentication\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fB802\-1x\&.pac\-file\fR -.RS 4 -UTF\-8 encoded file path containing PAC for EAP\-FAST\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.password\fR -.RS 4 -UTF\-8 encoded password used for EAP authentication methods\&. If both the "password" property and the "password\-raw" property are specified, "password" is preferred\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.password\-flags\fR -.RS 4 -Flags indicating how to handle the "password" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fB802\-1x\&.password\-raw\fR -.RS 4 -Password used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF\-8 to be used\&. If both the "password" property and the "password\-raw" property are specified, "password" is preferred\&. -.sp -Format: bytes -.RE -.PP -\fB802\-1x\&.password\-raw\-flags\fR -.RS 4 -Flags indicating how to handle the "password\-raw" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fB802\-1x\&.phase1\-auth\-flags\fR -.RS 4 -Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options\&. The individual TLS versions can be explicitly disabled\&. TLS time checks can be also disabled\&. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it\&. The TLS options map to tls_disable_tlsv1_x and tls_disable_time_checks settings\&. See the wpa_supplicant documentation for more details\&. -.sp -Format: flags (NMSetting8021xAuthFlags) -.sp -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) -.RE -.PP -\fB802\-1x\&.phase1\-fast\-provisioning\fR -.RS 4 -Enables or disables in\-line provisioning of EAP\-FAST credentials when FAST is specified as the EAP method in the "eap" property\&. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning)\&. See the wpa_supplicant documentation for more details\&. -.sp -Format: string -.sp -Valid values: 0, 1, 2, 3 -.RE -.PP -\fB802\-1x\&.phase1\-peaplabel\fR -.RS 4 -Forces use of the new PEAP label during key derivation\&. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1\&. Set to "1" to force use of the new PEAP label\&. See the wpa_supplicant documentation for more details\&. -.sp -Format: string -.sp -Valid values: 0, 1 -.RE -.PP -\fB802\-1x\&.phase1\-peapver\fR -.RS 4 -Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property\&. When unset, the version reported by the server will be used\&. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version\&. To do so, this property may be set to "0" or "1" to force that specific PEAP version\&. -.sp -Format: string -.sp -Valid values: 0, 1 -.RE -.PP -\fB802\-1x\&.phase2\-altsubject\-matches\fR -.RS 4 -List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication\&. If the list is empty, no verification of the server certificate\*(Aqs altSubjectName is performed\&. -.sp -Format: list of strings -.RE -.PP -\fB802\-1x\&.phase2\-auth\fR -.RS 4 -Specifies the allowed "phase 2" inner authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property\&. For TTLS this property selects one of the supported non\-EAP inner methods: "pap", "chap", "mschap", "mschapv2" while "phase2\-autheap" selects an EAP inner method\&. For PEAP this selects an inner EAP method, one of: "gtc", "otp", "md5" and "tls"\&. Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details\&. Both "phase2\-auth" and "phase2\-autheap" cannot be specified\&. -.sp -Format: string -.sp -Valid values: pap, chap, mschap, mschapv2, gtc, otp, md5, tls -.RE -.PP -\fB802\-1x\&.phase2\-autheap\fR -.RS 4 -Specifies the allowed "phase 2" inner EAP\-based authentication method when TTLS is specified in the "eap" property\&. Recognized EAP\-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls"\&. Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details\&. -.sp -Format: string -.sp -Valid values: md5, mschapv2, otp, gtc, tls -.RE -.PP -\fB802\-1x\&.phase2\-ca\-cert\fR -.RS 4 -Contains the path to the "phase 2" CA certificate if used by the EAP method specified in the 802\-1x\&.phase2\-auth or 802\-1x\&.phase2\-autheap properties\&. -.sp -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\&. -.sp -Note that enabling 802\-1x\&.system\-ca\-certs will override this setting to use the built\-in path, if the built\-in path is not a directory\&. -.sp -Format: filesystem path -.RE -.PP -\fB802\-1x\&.phase2\-ca\-cert\-password\fR -.RS 4 -The password used to access the "phase2" CA certificate stored in "phase2\-ca\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.phase2\-ca\-cert\-password\-flags\fR -.RS 4 -Flags indicating how to handle the "phase2\-ca\-cert\-password" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fB802\-1x\&.phase2\-ca\-path\fR -.RS 4 -UTF\-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2\-ca\-cert" property\&. -.sp -If NMSetting8021x:system\-ca\-certs is enabled and the built\-in CA path is an existing directory, then this setting is ignored\&. -.sp -Format: filesystem path -.RE -.PP -\fB802\-1x\&.phase2\-client\-cert\fR -.RS 4 -Contains the path to the "phase 2" client certificate if used by the EAP method specified in the 802\-1x\&.phase2\-auth or 802\-1x\&.phase2\-autheap properties\&. -.sp -Format: filesystem path -.RE -.PP -\fB802\-1x\&.phase2\-client\-cert\-password\fR -.RS 4 -The password used to access the "phase2" client certificate stored in "phase2\-client\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.phase2\-client\-cert\-password\-flags\fR -.RS 4 -Flags indicating how to handle the "phase2\-client\-cert\-password" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fB802\-1x\&.phase2\-domain\-match\fR -.RS 4 -Constraint for server domain name\&. If set, this list of FQDNs is used as a match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication\&. If a matching dNSName is found, this constraint is met\&. If no dNSName values are present, this constraint is matched against SubjectName CN using the same comparison\&. Multiple valid FQDNs can be passed as a ";" delimited list\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.phase2\-domain\-suffix\-match\fR -.RS 4 -Constraint for server domain name\&. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication\&. If a matching dNSName is found, this constraint is met\&. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison\&. Since version 1\&.24, multiple valid FQDNs can be passed as a ";" delimited list\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.phase2\-private\-key\fR -.RS 4 -The path to the "phase 2" inner private key when the 802\-1x\&.phase2\-auth or 802\-1x\&.phase2\-autheap property is set to "tls"\&. -.sp -Format: filesystem path -.RE -.PP -\fB802\-1x\&.phase2\-private\-key\-password\fR -.RS 4 -The password used to decrypt the "phase 2" private key specified in the 802\-1x\&.phase2\-private\-key property\&. This is normally used by secret agents, not directly by users\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.phase2\-private\-key\-password\-flags\fR -.RS 4 -Flags indicating how to handle the "phase2\-private\-key\-password" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fB802\-1x\&.phase2\-subject\-match\fR -.RS 4 -Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and should not be used\&. -.sp -This property is deprecated since version 1\&.2\&. Use "phase2\-domain\-suffix\-match" instead\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.pin\fR -.RS 4 -PIN used for EAP authentication methods\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.pin\-flags\fR -.RS 4 -Flags indicating how to handle the "pin" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fB802\-1x\&.private\-key\fR -.RS 4 -The path to the private key when the 802\-1\&.eap property is set to "tls"\&. -.sp -Format: filesystem path -.RE -.PP -\fB802\-1x\&.private\-key\-password\fR -.RS 4 -The password used to decrypt the private key specified in the 802\-1x\&.private\-key property\&. This is normally used by secret agents, not directly by users\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.private\-key\-password\-flags\fR -.RS 4 -Flags indicating how to handle the "private\-key\-password" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fB802\-1x\&.subject\-match\fR -.RS 4 -Substring to be matched against the subject of the certificate presented by the authentication server\&. When unset, no verification of the authentication server certificate\*(Aqs subject is performed\&. This property provides little security, if any, and should not be used\&. -.sp -This property is deprecated since version 1\&.2\&. Use "phase2\-domain\-suffix\-match" instead\&. -.sp -Format: string -.RE -.PP -\fB802\-1x\&.system\-ca\-certs\fR -.RS 4 -When TRUE, overrides the "ca\-path" and "phase2\-ca\-path" properties using the system CA directory specified at configure time with the \-\-system\-ca\-path switch\&. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca\-cert" and "phase2\-ca\-cert" properties\&. If the path provided with \-\-system\-ca\-path is rather a file name (bundle of trusted CA certificates), it overrides "ca\-cert" and "phase2\-ca\-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant)\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.SS "adsl setting" -.PP -ADSL Settings\&. -.PP -Properties: -.PP -\fBadsl\&.encapsulation\fR -.RS 4 -Alias: encapsulation -.sp -Encapsulation of ADSL connection\&. Can be "vcmux" or "llc"\&. -.sp -Format: string -.sp -Valid values: vcmux, llc -.RE -.PP -\fBadsl\&.password\fR -.RS 4 -Alias: password -.sp -Password used to authenticate with the ADSL service\&. -.sp -Format: string -.RE -.PP -\fBadsl\&.password\-flags\fR -.RS 4 -Flags indicating how to handle the "password" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fBadsl\&.protocol\fR -.RS 4 -Alias: protocol -.sp -ADSL connection protocol\&. Can be "pppoa", "pppoe" or "ipoatm"\&. -.sp -Format: string -.sp -Valid values: pppoa, pppoe, ipoatm -.RE -.PP -\fBadsl\&.username\fR -.RS 4 -Alias: username -.sp -Username used to authenticate with the ADSL service\&. -.sp -Format: string -.RE -.PP -\fBadsl\&.vci\fR -.RS 4 -VCI of ADSL connection -.sp -Format: integer -.sp -Valid values: 0 \- 65536 -.RE -.PP -\fBadsl\&.vpi\fR -.RS 4 -VPI of ADSL connection -.sp -Format: integer -.sp -Valid values: 0 \- 65536 -.RE -.SS "bluetooth setting" -.PP -Bluetooth Settings\&. -.PP -Properties: -.PP -\fBbluetooth\&.bdaddr\fR -.RS 4 -Alias: addr -.sp -The Bluetooth address of the device\&. -.sp -Format: MAC address -.RE -.PP -\fBbluetooth\&.type\fR -.RS 4 -Alias: bt\-type -.sp -Either "dun" for Dial\-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile\&. -.sp -Format: string -.sp -Valid values: dun, panu, nap -.RE -.SS "bond setting" -.PP -Bonding Settings\&. -.PP -Properties: -.PP -\fBbond\&.options\fR -.RS 4 -Dictionary of key/value pairs of bonding options\&. Both keys and values must be strings\&. Option names must contain only alphanumeric characters (ie, [a\-zA\-Z0\-9])\&. -.sp -Format: list of key/value options -.RE -.SS "bridge setting" -.PP -Bridging Settings\&. -.PP -Properties: -.PP -\fBbridge\&.ageing\-time\fR -.RS 4 -Alias: ageing\-time -.sp -The Ethernet MAC address aging time, in seconds\&. -.sp -Format: integer -.sp -Valid values: 0 \- 1000000 -.RE -.PP -\fBbridge\&.forward\-delay\fR -.RS 4 -Alias: forward\-delay -.sp -The Spanning Tree Protocol (STP) forwarding delay, in seconds\&. -.sp -Format: integer -.sp -Valid values: 0 \- 30 -.RE -.PP -\fBbridge\&.group\-address\fR -.RS 4 -If specified, The MAC address of the multicast group this bridge uses for STP\&. -.sp -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\&. -.sp -Format: MAC address -.RE -.PP -\fBbridge\&.group\-forward\-mask\fR -.RS 4 -Alias: group\-forward\-mask -.sp -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\*(Aqt have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP\&. -.sp -Format: integer -.sp -Valid values: 0 \- 65535 -.RE -.PP -\fBbridge\&.hello\-time\fR -.RS 4 -Alias: hello\-time -.sp -The Spanning Tree Protocol (STP) hello time, in seconds\&. -.sp -Format: integer -.sp -Valid values: 0 \- 10 -.RE -.PP -\fBbridge\&.mac\-address\fR -.RS 4 -Alias: mac -.sp -If specified, the MAC address of bridge\&. When creating a new bridge, this MAC address will be set\&. -.sp -If this field is left unspecified, the "ethernet\&.cloned\-mac\-address" is referred instead to generate the initial MAC address\&. Note that setting "ethernet\&.cloned\-mac\-address" anyway overwrites the MAC address of the bridge later while activating the bridge\&. -.sp -This property is deprecated since version 1\&.12\&. Use the "cloned\-mac\-address" property instead\&. -.sp -Format: MAC address -.RE -.PP -\fBbridge\&.max\-age\fR -.RS 4 -Alias: max\-age -.sp -The Spanning Tree Protocol (STP) maximum message age, in seconds\&. -.sp -Format: integer -.sp -Valid values: 0 \- 40 -.RE -.PP -\fBbridge\&.multicast\-hash\-max\fR -.RS 4 -Set maximum size of multicast hash table (value must be a power of 2)\&. -.sp -Format: integer -.sp -Valid values: 1 \- 4294967295 -.RE -.PP -\fBbridge\&.multicast\-last\-member\-count\fR -.RS 4 -Set the number of queries the bridge will send before stopping forwarding a multicast group after a "leave" message has been received\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBbridge\&.multicast\-last\-member\-interval\fR -.RS 4 -Set interval (in deciseconds) between queries to find remaining members of a group, after a "leave" message is received\&. -.sp -Format: integer -.sp -Valid values: 0 \- 18446744073709551615 -.RE -.PP -\fBbridge\&.multicast\-membership\-interval\fR -.RS 4 -Set delay (in deciseconds) after which the bridge will leave a group, if no membership reports for this group are received\&. -.sp -Format: integer -.sp -Valid values: 0 \- 18446744073709551615 -.RE -.PP -\fBbridge\&.multicast\-querier\fR -.RS 4 -Enable or disable sending of multicast queries by the bridge\&. If not specified the option is disabled\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBbridge\&.multicast\-querier\-interval\fR -.RS 4 -If no queries are seen after this delay (in deciseconds) has passed, the bridge will start to send its own queries\&. -.sp -Format: integer -.sp -Valid values: 0 \- 18446744073709551615 -.RE -.PP -\fBbridge\&.multicast\-query\-interval\fR -.RS 4 -Interval (in deciseconds) between queries sent by the bridge after the end of the startup phase\&. -.sp -Format: integer -.sp -Valid values: 0 \- 18446744073709551615 -.RE -.PP -\fBbridge\&.multicast\-query\-response\-interval\fR -.RS 4 -Set the Max Response Time/Max Response Delay (in deciseconds) for IGMP/MLD queries sent by the bridge\&. -.sp -Format: integer -.sp -Valid values: 0 \- 18446744073709551615 -.RE -.PP -\fBbridge\&.multicast\-query\-use\-ifaddr\fR -.RS 4 -If enabled the bridge\*(Aqs own IP address is used as the source address for IGMP queries otherwise the default of 0\&.0\&.0\&.0 is used\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBbridge\&.multicast\-router\fR -.RS 4 -Sets bridge\*(Aqs multicast router\&. Multicast\-snooping must be enabled for this option to work\&. -.sp -Supported values are: \*(Aqauto\*(Aq, \*(Aqdisabled\*(Aq, \*(Aqenabled\*(Aq to which kernel assigns the numbers 1, 0, and 2, respectively\&. If not specified the default value is \*(Aqauto\*(Aq (1)\&. -.sp -Format: string -.sp -Valid values: auto, disabled, enabled -.RE -.PP -\fBbridge\&.multicast\-snooping\fR -.RS 4 -Alias: multicast\-snooping -.sp -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\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBbridge\&.multicast\-startup\-query\-count\fR -.RS 4 -Set the number of IGMP queries to send during startup phase\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBbridge\&.multicast\-startup\-query\-interval\fR -.RS 4 -Sets the time (in deciseconds) between queries sent out at startup to determine membership information\&. -.sp -Format: integer -.sp -Valid values: 0 \- 18446744073709551615 -.RE -.PP -\fBbridge\&.priority\fR -.RS 4 -Alias: priority -.sp -Sets the Spanning Tree Protocol (STP) priority for this bridge\&. Lower values are "better"; the lowest priority bridge will be elected the root bridge\&. -.sp -Format: integer -.sp -Valid values: 0 \- 65535 -.RE -.PP -\fBbridge\&.stp\fR -.RS 4 -Alias: stp -.sp -Controls whether Spanning Tree Protocol (STP) is enabled for this bridge\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBbridge\&.vlan\-default\-pvid\fR -.RS 4 -The default PVID for the ports of the bridge, that is the VLAN id assigned to incoming untagged frames\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4094 -.RE -.PP -\fBbridge\&.vlan\-filtering\fR -.RS 4 -Control whether VLAN filtering is enabled on the bridge\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBbridge\&.vlan\-protocol\fR -.RS 4 -If specified, the protocol used for VLAN filtering\&. -.sp -Supported values are: \*(Aq802\&.1Q\*(Aq, \*(Aq802\&.1ad\*(Aq\&. If not specified the default value is \*(Aq802\&.1Q\*(Aq\&. -.sp -Format: string -.sp -Valid values: 802\&.1Q, 802\&.1ad -.RE -.PP -\fBbridge\&.vlan\-stats\-enabled\fR -.RS 4 -Controls whether per\-VLAN stats accounting is enabled\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBbridge\&.vlans\fR -.RS 4 -Array of bridge VLAN objects\&. In addition to the VLANs specified here, the bridge will also have the default\-pvid VLAN configured by the bridge\&.vlan\-default\-pvid property\&. -.sp -In nmcli the VLAN list can be specified with the following syntax: -.sp -$vid [pvid] [untagged] [, $vid [pvid] [untagged]]\&.\&.\&. -.sp -where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash\&. -.sp -Format: list of bridge\&.vlans objects -.RE -.SS "bridge\-port setting" -.PP -Bridge Port Settings\&. -.PP -Properties: -.PP -\fBbridge\-port\&.hairpin\-mode\fR -.RS 4 -Alias: hairpin -.sp -Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBbridge\-port\&.path\-cost\fR -.RS 4 -Alias: path\-cost -.sp -The Spanning Tree Protocol (STP) port cost for destinations via this port\&. -.sp -Format: integer -.sp -Valid values: 0 \- 65535 -.RE -.PP -\fBbridge\-port\&.priority\fR -.RS 4 -Alias: priority -.sp -The Spanning Tree Protocol (STP) priority of this bridge port\&. -.sp -Format: integer -.sp -Valid values: 0 \- 63 -.RE -.PP -\fBbridge\-port\&.vlans\fR -.RS 4 -Array of bridge VLAN objects\&. In addition to the VLANs specified here, the port will also have the default\-pvid VLAN configured on the bridge by the bridge\&.vlan\-default\-pvid property\&. -.sp -In nmcli the VLAN list can be specified with the following syntax: -.sp -$vid [pvid] [untagged] [, $vid [pvid] [untagged]]\&.\&.\&. -.sp -where $vid is either a single id between 1 and 4094 or a range, represented as a couple of ids separated by a dash\&. -.sp -Format: list of bridge\-port\&.vlans objects -.RE -.SS "cdma setting" -.PP -CDMA\-based Mobile Broadband Settings\&. -.PP -Properties: -.PP -\fBcdma\&.mtu\fR -.RS 4 -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. -.sp -Format: integer -.sp -Special values: auto -.RE -.PP -\fBcdma\&.number\fR -.RS 4 -The number to dial to establish the connection to the CDMA\-based mobile broadband network, if any\&. If not specified, the default number (#777) is used when required\&. -.sp -Format: string -.RE -.PP -\fBcdma\&.password\fR -.RS 4 -Alias: password -.sp -The password used to authenticate with the network, if required\&. Many providers do not require a password, or accept any password\&. But if a password is required, it is specified here\&. -.sp -Format: string -.RE -.PP -\fBcdma\&.password\-flags\fR -.RS 4 -Flags indicating how to handle the "password" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fBcdma\&.username\fR -.RS 4 -Alias: user -.sp -The username used to authenticate with the network, if required\&. Many providers do not require a username, or accept any username\&. But if a username is required, it is specified here\&. -.sp -Format: string -.RE -.SS "dcb setting" -.PP -Data Center Bridging Settings\&. -.PP -Properties: -.PP -\fBdcb\&.app\-fcoe\-flags\fR -.RS 4 -Specifies the NMSettingDcbFlags for the DCB FCoE application\&. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4)\&. -.sp -Format: flags (NMSettingDcbFlags) -.sp -Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4) -.RE -.PP -\fBdcb\&.app\-fcoe\-mode\fR -.RS 4 -The FCoE controller mode; either "fabric" or "vn2vn"\&. -.sp -Since 1\&.34, NULL is the default and means "fabric"\&. Before 1\&.34, NULL was rejected as invalid and the default was "fabric"\&. -.sp -Format: string -.sp -Valid values: fabric, vn2vn -.RE -.PP -\fBdcb\&.app\-fcoe\-priority\fR -.RS 4 -The highest User Priority (0 \- 7) which FCoE frames should use, or \-1 for default priority\&. Only used when the "app\-fcoe\-flags" property includes the "enable" (0x1) flag\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 7 -.sp -Special values: unset (\-1) -.RE -.PP -\fBdcb\&.app\-fip\-flags\fR -.RS 4 -Specifies the NMSettingDcbFlags for the DCB FIP application\&. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4)\&. -.sp -Format: flags (NMSettingDcbFlags) -.sp -Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4) -.RE -.PP -\fBdcb\&.app\-fip\-priority\fR -.RS 4 -The highest User Priority (0 \- 7) which FIP frames should use, or \-1 for default priority\&. Only used when the "app\-fip\-flags" property includes the "enable" (0x1) flag\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 7 -.sp -Special values: unset (\-1) -.RE -.PP -\fBdcb\&.app\-iscsi\-flags\fR -.RS 4 -Specifies the NMSettingDcbFlags for the DCB iSCSI application\&. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4)\&. -.sp -Format: flags (NMSettingDcbFlags) -.sp -Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4) -.RE -.PP -\fBdcb\&.app\-iscsi\-priority\fR -.RS 4 -The highest User Priority (0 \- 7) which iSCSI frames should use, or \-1 for default priority\&. Only used when the "app\-iscsi\-flags" property includes the "enable" (0x1) flag\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 7 -.sp -Special values: unset (\-1) -.RE -.PP -\fBdcb\&.priority\-bandwidth\fR -.RS 4 -An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the percentage of bandwidth of the priority\*(Aqs assigned group that the priority may use\&. The sum of all percentages for priorities which belong to the same group must total 100 percents\&. -.sp -Format: list of integers -.sp -Valid values: 0 \- 100 -.RE -.PP -\fBdcb\&.priority\-flow\-control\fR -.RS 4 -An array of 8 boolean values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates whether or not the corresponding priority should transmit priority pause\&. -.sp -Format: list of booleans -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBdcb\&.priority\-flow\-control\-flags\fR -.RS 4 -Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC)\&. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4)\&. -.sp -Format: flags (NMSettingDcbFlags) -.sp -Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4) -.RE -.PP -\fBdcb\&.priority\-group\-bandwidth\fR -.RS 4 -An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 \- 7) and the value indicates the percentage of link bandwidth allocated to that group\&. Allowed values are 0 \- 100, and the sum of all values must total 100 percents\&. -.sp -Format: list of integers -.sp -Valid values: 0 \- 100 -.RE -.PP -\fBdcb\&.priority\-group\-flags\fR -.RS 4 -Specifies the NMSettingDcbFlags for DCB Priority Groups\&. Flags may be any combination of "enable" (0x1), "advertise" (0x2), and "willing" (0x4)\&. -.sp -Format: flags (NMSettingDcbFlags) -.sp -Valid values: none (0x0), enable (0x1), advertise (0x2), willing (0x4) -.RE -.PP -\fBdcb\&.priority\-group\-id\fR -.RS 4 -An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the Priority Group ID\&. Allowed Priority Group ID values are 0 \- 7 or 15 for the unrestricted group\&. -.sp -Format: list of integers -.sp -Valid values: 0 \- 7, 15 -.RE -.PP -\fBdcb\&.priority\-strict\-bandwidth\fR -.RS 4 -An array of 8 boolean values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group\&. -.sp -Format: list of booleans -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBdcb\&.priority\-traffic\-class\fR -.RS 4 -An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the traffic class (0 \- 7) to which the priority is mapped\&. -.sp -Format: list of integers -.sp -Valid values: 0 \- 7 -.RE -.SS "ethtool setting" -.PP -Ethtool Ethernet Settings\&. -.PP -Properties: -.PP -\fBethtool\&.channels\-combined\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.channels\-other\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.channels\-rx\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.channels\-tx\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-adaptive\-rx\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-adaptive\-tx\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-pkt\-rate\-high\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-pkt\-rate\-low\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-rx\-frames\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-rx\-frames\-high\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-rx\-frames\-irq\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-rx\-frames\-low\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-rx\-usecs\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-rx\-usecs\-high\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-rx\-usecs\-irq\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-rx\-usecs\-low\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-sample\-interval\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-stats\-block\-usecs\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-tx\-frames\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-tx\-frames\-high\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-tx\-frames\-irq\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-tx\-frames\-low\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-tx\-usecs\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-tx\-usecs\-high\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-tx\-usecs\-irq\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.coalesce\-tx\-usecs\-low\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.eee\-enabled\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-esp\-hw\-offload\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-esp\-tx\-csum\-hw\-offload\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-fcoe\-mtu\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-gro\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-gso\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-highdma\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-hw\-tc\-offload\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-l2\-fwd\-offload\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-loopback\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-lro\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-macsec\-hw\-offload\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-ntuple\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-rx\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-rx\-all\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-rx\-fcs\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-rx\-gro\-hw\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-rx\-gro\-list\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-rx\-udp\-gro\-forwarding\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-rx\-udp_tunnel\-port\-offload\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-rx\-vlan\-filter\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-rx\-vlan\-stag\-filter\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-rx\-vlan\-stag\-hw\-parse\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-rxhash\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-rxvlan\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-sg\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tls\-hw\-record\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tls\-hw\-rx\-offload\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tls\-hw\-tx\-offload\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tso\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-checksum\-fcoe\-crc\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-checksum\-ip\-generic\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-checksum\-ipv4\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-checksum\-ipv6\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-checksum\-sctp\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-esp\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-fcoe\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-gre\-csum\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-gre\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-gso\-list\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-gso\-partial\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-gso\-robust\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-ipxip4\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-ipxip6\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-nocache\-copy\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-scatter\-gather\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-scatter\-gather\-fraglist\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-sctp\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-tcp\-ecn\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-tcp\-mangleid\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-tcp\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-tcp6\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-tunnel\-remcsum\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-udp\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-udp_tnl\-csum\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-udp_tnl\-segmentation\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-tx\-vlan\-stag\-hw\-insert\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.feature\-txvlan\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.pause\-autoneg\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.pause\-rx\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.pause\-tx\fR -.RS 4 -Format: ternary -.sp -Valid values: on, off, ignore -.RE -.PP -\fBethtool\&.ring\-rx\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.ring\-rx\-jumbo\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.ring\-rx\-mini\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBethtool\&.ring\-tx\fR -.RS 4 -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.SS "generic setting" -.PP -Generic Link Settings\&. -.PP -Properties: -.PP -\fBgeneric\&.device\-handler\fR -.RS 4 -Name of the device handler that will be invoked to add and delete the device for this connection\&. The name can only contain ASCII alphanumeric characters and \*(Aq\-\*(Aq, \*(Aq_\*(Aq, \*(Aq\&.\*(Aq\&. It cannot start with \*(Aq\&.\*(Aq\&. -.sp -See the NetworkManager\-dispatcher(8) man page for more details about how to write the device handler\&. -.sp -By setting this property the generic connection becomes "virtual", meaning that it can be activated without an existing device; the device will be created at the time the connection is started by invoking the device\-handler\&. -.sp -Format: string -.RE -.SS "gsm setting" -.PP -GSM\-based Mobile Broadband Settings\&. -.PP -Properties: -.PP -\fBgsm\&.apn\fR -.RS 4 -Alias: apn -.sp -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\*(Aqs mobile broadband plan\&. The APN may only be composed of the characters a\-z, 0\-9, \&., and \- per GSM 03\&.60 Section 14\&.9\&. -.sp -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\&. -.sp -Format: string -.RE -.PP -\fBgsm\&.auto\-config\fR -.RS 4 -When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBgsm\&.device\-id\fR -.RS 4 -The device unique identifier (as given by the WWAN management service) which this connection applies to\&. If given, the connection will only apply to the specified device\&. -.sp -Format: string -.RE -.PP -\fBgsm\&.home\-only\fR -.RS 4 -When TRUE, only connections to the home network will be allowed\&. Connections to roaming networks will not be made\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBgsm\&.initial\-eps\-bearer\-apn\fR -.RS 4 -For LTE modems, this sets the APN for the initial EPS bearer that is set up when attaching to the network\&. Setting this parameter implies initial\-eps\-bearer\-configure to be TRUE\&. -.sp -Format: string -.RE -.PP -\fBgsm\&.initial\-eps\-bearer\-configure\fR -.RS 4 -For LTE modems, this setting determines whether the initial EPS bearer shall be configured when bringing up the connection\&. It is inferred TRUE if initial\-eps\-bearer\-apn is set\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBgsm\&.mtu\fR -.RS 4 -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. -.sp -Format: integer -.sp -Special values: auto -.RE -.PP -\fBgsm\&.network\-id\fR -.RS 4 -The Network ID (GSM LAI format, ie MCC\-MNC) to force specific network registration\&. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network\&. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible\&. -.sp -Format: string -.RE -.PP -\fBgsm\&.number\fR -.RS 4 -Legacy setting that used to help establishing PPP data sessions for GSM\-based modems\&. -.sp -This property is deprecated since version 1\&.16\&. User\-provided values for this setting are no longer used\&. -.sp -Format: string -.RE -.PP -\fBgsm\&.password\fR -.RS 4 -Alias: password -.sp -The password used to authenticate with the network, if required\&. Many providers do not require a password, or accept any password\&. But if a password is required, it is specified here\&. -.sp -Format: string -.RE -.PP -\fBgsm\&.password\-flags\fR -.RS 4 -Flags indicating how to handle the "password" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fBgsm\&.pin\fR -.RS 4 -If the SIM is locked with a PIN it must be unlocked before any other operations are requested\&. Specify the PIN here to allow operation of the device\&. -.sp -Format: string -.RE -.PP -\fBgsm\&.pin\-flags\fR -.RS 4 -Flags indicating how to handle the "pin" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fBgsm\&.sim\-id\fR -.RS 4 -The SIM card unique identifier (as given by the WWAN management service) which this connection applies to\&. If given, the connection will apply to any device also allowed by "device\-id" which contains a SIM card matching the given identifier\&. -.sp -Format: string -.RE -.PP -\fBgsm\&.sim\-operator\-id\fR -.RS 4 -A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to\&. If given, the connection will apply to any device also allowed by "device\-id" and "sim\-id" which contains a SIM card provisioned by the given operator\&. -.sp -Format: string -.RE -.PP -\fBgsm\&.username\fR -.RS 4 -Alias: user -.sp -The username used to authenticate with the network, if required\&. Many providers do not require a username, or accept any username\&. But if a username is required, it is specified here\&. -.sp -Format: string -.RE -.SS "hsr setting" -.PP -HSR/PRP Settings\&. -.PP -Properties: -.PP -\fBhsr\&.multicast\-spec\fR -.RS 4 -Alias: multicast\-spec -.sp -The last byte of supervision address\&. -.sp -Format: integer -.sp -Valid values: 0 \- 255 -.RE -.PP -\fBhsr\&.port1\fR -.RS 4 -Alias: port1 -.sp -The port1 interface name of the HSR\&. This property is mandatory\&. -.sp -Format: string -.RE -.PP -\fBhsr\&.port2\fR -.RS 4 -Alias: port2 -.sp -The port2 interface name of the HSR\&. This property is mandatory\&. -.sp -Format: string -.RE -.PP -\fBhsr\&.prp\fR -.RS 4 -The protocol used by the interface, whether it is PRP or HSR\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.SS "infiniband setting" -.PP -Infiniband Settings\&. -.PP -Properties: -.PP -\fBinfiniband\&.mac\-address\fR -.RS 4 -Alias: mac -.sp -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)\&. -.sp -Format: Infiniband MAC address -.RE -.PP -\fBinfiniband\&.mtu\fR -.RS 4 -Alias: mtu -.sp -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. -.sp -Format: integer -.sp -Special values: auto -.RE -.PP -\fBinfiniband\&.p\-key\fR -.RS 4 -Alias: p\-key -.sp -The InfiniBand p\-key to use for this device\&. A value of \-1 means to use the default p\-key (aka "the p\-key at index 0")\&. Otherwise, it is a 16\-bit unsigned integer, whose high bit 0x8000 is set if it is a "full membership" p\-key\&. The values 0 and 0x8000 are not allowed\&. -.sp -With the p\-key set, the interface name is always "$parent\&.$p_key"\&. Setting "connection\&.interface\-name" to another name is not supported\&. -.sp -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\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 65535 -.sp -Special values: default (\-1) -.RE -.PP -\fBinfiniband\&.parent\fR -.RS 4 -Alias: parent -.sp -The interface name of the parent device of this device\&. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac\-address"\&. -.sp -Format: string -.RE -.PP -\fBinfiniband\&.transport\-mode\fR -.RS 4 -Alias: transport\-mode -.sp -The IP\-over\-InfiniBand transport mode\&. Either "datagram" or "connected"\&. -.sp -Format: string -.sp -Valid values: datagram, connected -.RE -.SS "ipv4 setting" -.PP -IPv4 Settings\&. -.PP -Properties: -.PP -\fBipv4\&.addresses\fR -.RS 4 -Alias: ip4 -.sp -A list of IPv4 addresses and their prefix length\&. Multiple addresses can be separated by comma\&. For example "192\&.168\&.1\&.5/24, 10\&.1\&.0\&.5/24"\&. The addresses are listed in decreasing priority, meaning the first address will be the primary address\&. -.sp -Format: a comma separated list of addresses -.RE -.PP -\fBipv4\&.auto\-route\-ext\-gw\fR -.RS 4 -VPN connections will default to add the route automatically unless this setting is set to FALSE\&. -.sp -For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fBipv4\&.dad\-timeout\fR -.RS 4 -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\&. -.sp -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\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 30000 -.sp -Special values: default (\-1), off (0) -.RE -.PP -\fBipv4\&.dhcp\-client\-id\fR -.RS 4 -A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options\&. When the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary client ID, in which case the first byte is assumed to be the \*(Aqtype\*(Aq field as per RFC 2132 section 9\&.14 and the remaining bytes may be an hardware address (e\&.g\&. \*(Aq01:xx:xx:xx:xx:xx:xx\*(Aq where 1 is the Ethernet ARP type and the rest is a MAC address)\&. If the property is not a hex string it is considered as a non\-hardware\-address client ID and the \*(Aqtype\*(Aq field is set to 0\&. -.sp -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\&. -.sp -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\&. -.sp -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\&. -.sp -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\&. -.sp -The special value "none" prevents any client identifier from being sent\&. Note that this is normally not recommended\&. -.sp -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\*(Aqt sent any client\-id otherwise\&. -.sp -Format: string -.sp -Special values: mac, perm\-mac, duid, ipv6\-duid, stable, none -.RE -.PP -\fBipv4\&.dhcp\-dscp\fR -.RS 4 -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"\&. -.sp -The property is currently valid only for IPv4, and it is supported only by the "internal" DHCP plugin\&. -.sp -Format: string -.sp -Valid values: CS0, CS4, CS6 -.RE -.PP -\fBipv4\&.dhcp\-fqdn\fR -.RS 4 -If the "dhcp\-send\-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease\&. This property and "dhcp\-hostname" are mutually exclusive and cannot be set at the same time\&. -.sp -Format: string -.RE -.PP -\fBipv4\&.dhcp\-hostname\fR -.RS 4 -If the "dhcp\-send\-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease\&. This property and "dhcp\-fqdn" are mutually exclusive and cannot be set at the same time\&. -.sp -Format: string -.RE -.PP -\fBipv4\&.dhcp\-hostname\-flags\fR -.RS 4 -Flags for the DHCP hostname and FQDN\&. -.sp -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\&. -.sp -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\&. -.sp -Format: flags (NMDhcpHostnameFlags) -.sp -Valid values: none (0x0), fqdn\-serv\-update (0x1), fqdn\-encoded (0x2), fqdn\-no\-update (0x4), fqdn\-clear\-flags (0x8) -.RE -.PP -\fBipv4\&.dhcp\-iaid\fR -.RS 4 -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. -.sp -For DHCPv4, the IAID is only used with "ipv4\&.dhcp\-client\-id" values "duid" and "ipv6\-duid" to generate the client\-id\&. -.sp -For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin\&. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address\&. -.sp -The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device\&. -.sp -Format: string -.RE -.PP -\fBipv4\&.dhcp\-reject\-servers\fR -.RS 4 -Array of servers from which DHCP offers must be rejected\&. This property is useful to avoid getting a lease from misconfigured or rogue servers\&. -.sp -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")\&. -.sp -This property is currently not implemented for DHCPv6\&. -.sp -Format: list of IPv4 addresses -.RE -.PP -\fBipv4\&.dhcp\-send\-hostname\fR -.RS 4 -If TRUE, a hostname is sent to the DHCP server when acquiring a lease\&. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer\&. If the "dhcp\-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBipv4\&.dhcp\-send\-release\fR -.RS 4 -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\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fBipv4\&.dhcp\-timeout\fR -.RS 4 -A timeout for a DHCP transaction in seconds\&. If zero (the default), a globally configured default is used\&. If still unspecified, a device specific timeout is used (usually 45 seconds)\&. -.sp -Set to 2147483647 (MAXINT32) for infinity\&. -.sp -Format: integer -.sp -Valid values: 0 \- 2147483647 -.sp -Special values: default (0), infinity (2147483647) -.RE -.PP -\fBipv4\&.dhcp\-vendor\-class\-identifier\fR -.RS 4 -The Vendor Class Identifier DHCP option (60)\&. Special characters in the data string may be escaped using C\-style escapes, nevertheless this property cannot contain nul bytes\&. If the per\-profile value is unspecified (the default), a global connection default gets consulted\&. If still unspecified, the DHCP option is not sent to the server\&. -.sp -Format: string -.RE -.PP -\fBipv4\&.dns\fR -.RS 4 -Array of IP addresses of DNS servers\&. -.sp -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\&. -.sp -Format: list of IPv4 addresses -.RE -.PP -\fBipv4\&.dns\-options\fR -.RS 4 -DNS options for /etc/resolv\&.conf as described in resolv\&.conf(5) manual\&. -.sp -The currently supported options are "attempts", "debug", "edns0", "ndots", "no\-aaaa", "no\-check\-names", "no\-reload", "no\-tld\-query", "rotate", "single\-request", "single\-request\-reopen", "timeout", "trust\-ad", "use\-vc"\&. See the resolv\&.conf(5) manual\&. -.sp -Note that there is a distinction between an unset (default) list and an empty list\&. In nmcli, to unset the list set the value to ""\&. To set an empty list, set it to " "\&. Currently, an unset list has the same meaning as an empty list\&. That might change in the future\&. -.sp -The "trust\-ad" setting is only honored if the profile contributes name servers to resolv\&.conf, and if all contributing profiles have "trust\-ad" enabled\&. -.sp -When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added\&. -.sp -The valid "ipv4\&.dns\-options" and "ipv6\&.dns\-options" get merged together\&. -.sp -Format: a comma separated list of DNS options -.RE -.PP -\fBipv4\&.dns\-priority\fR -.RS 4 -DNS servers priority\&. -.sp -The relative priority for DNS servers specified by this setting\&. A lower numerical value is better (higher priority)\&. -.sp -Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used\&. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles\&. -.sp -Zero selects a globally configured default value\&. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections\&. -.sp -Note that the priority is to order DNS settings for multiple active connections\&. It does not disambiguate multiple DNS servers within the same connection profile\&. -.sp -When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices\&. -.sp -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\&. -.sp -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 \*(Aq~\&.\*(Aq 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\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.RE -.PP -\fBipv4\&.dns\-search\fR -.RS 4 -List of DNS search domains\&. Domains starting with a tilde (\*(Aq~\*(Aq) are considered \*(Aqrouting\*(Aq domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names\&. -.sp -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\&. -.sp -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)\&. -.sp -Format: list of strings -.RE -.PP -\fBipv4\&.gateway\fR -.RS 4 -Alias: gw4 -.sp -The gateway associated with this configuration\&. This is only meaningful if "addresses" is also set\&. -.sp -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\&. -.sp -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"\&. -.sp -Format: IPv4 address -.RE -.PP -\fBipv4\&.ignore\-auto\-dns\fR -.RS 4 -When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns\-search" properties, if any, are used\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBipv4\&.ignore\-auto\-routes\fR -.RS 4 -When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBipv4\&.link\-local\fR -.RS 4 -Enable and disable the IPv4 link\-local configuration independently of the ipv4\&.method configuration\&. This allows a link\-local address (169\&.254\&.x\&.y/16) to be obtained in addition to other addresses, such as those manually configured or obtained from a DHCP server\&. -.sp -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"\&. -.sp -Format: choice (NMSettingIP4LinkLocal) -.sp -Valid values: default (0), auto (1), disabled (2), enabled (3) -.RE -.PP -\fBipv4\&.may\-fail\fR -.RS 4 -If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out\&. Note that at least one IP configuration must succeed or overall network configuration will still fail\&. For example, in IPv6\-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBipv4\&.method\fR -.RS 4 -Sets the IPv4 connection method\&. You can set one of the following values: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"auto" -\- Enables automatic IPv4 address assignment from DHCP, PPP, or similar services\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"manual" -\- Enables the configuration of static IPv4 addresses on the interface\&. Note that you must set at least one IP address and subnet mask in the "ipv4\&.addresses" property\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"disabled" -\- Disables the IPv4 protocol in this connection profile\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"shared" -\- Provides network access to other computers\&. If you do not specify an IP address and subnet mask in "ipv4\&.addresses", NetworkManager assigns 10\&.42\&.x\&.1/24 to the interface\&. Additionally, NetworkManager starts a DHCP server and DNS forwarder\&. Hosts that connect to this interface will then receive an IP address from the configured range, and NetworkManager configures NAT to map client addresses to the one of the current default network connection\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"link\-local" -\- Enables link\-local addresses according to RFC 3927\&. NetworkManager assigns a random link\-local address from the 169\&.254\&.0\&.0/16 subnet to the interface\&. -.RE -.sp -Format: string -.sp -Valid values: auto, link\-local, manual, shared, disabled -.RE -.PP -\fBipv4\&.never\-default\fR -.RS 4 -If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBipv4\&.replace\-local\-rule\fR -.RS 4 -Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fBipv4\&.required\-timeout\fR -.RS 4 -The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds\&. -.sp -This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail\&. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e\&.g\&. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active\&. -.sp -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\&. -.sp -A zero value means that no required timeout is present, \-1 means the default value (either configuration ipvx\&.required\-timeout override or zero)\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 2147483647 -.sp -Special values: default (\-1), infinity (2147483647) -.RE -.PP -\fBipv4\&.route\-metric\fR -.RS 4 -The default metric for routes that don\*(Aqt explicitly specify a metric\&. The default value \-1 means that the metric is chosen automatically based on the device type\&. The metric applies to dynamic routes, manual (static) routes that don\*(Aqt have an explicit metric setting, address prefix routes, and the default route\&. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default)\&. Hence, setting this property to zero effectively mean setting it to 1024\&. For IPv4, zero is a regular value for the metric\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 4294967295 -.RE -.PP -\fBipv4\&.route\-table\fR -.RS 4 -Enable policy routing (source routing) and set the routing table used when adding routes\&. -.sp -This affects all routes, including device\-routes, IPv4LL, DHCP, SLAAC, default\-routes and static routes\&. But note that static routes can individually overwrite the setting by explicitly specifying a non\-zero routing table\&. -.sp -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\&. -.sp -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\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.sp -Special values: unspec (0), main (254) -.RE -.PP -\fBipv4\&.routes\fR -.RS 4 -A list of IPv4 destination addresses, prefix length, optional IPv4 next hop addresses, optional route metric, optional attribute\&. The valid syntax is: "ip[/prefix] [next\-hop] [metric] [attribute=val]\&.\&.\&.[,ip[/prefix]\&.\&.\&.]"\&. For example "192\&.0\&.2\&.0/24 10\&.1\&.1\&.1 77, 198\&.51\&.100\&.0/24"\&. -.sp -Various attributes are supported: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"advmss" -\- an unsigned 32 bit integer\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"cwnd" -\- an unsigned 32 bit integer\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"initcwnd" -\- an unsigned 32 bit integer\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"initrwnd" -\- an unsigned 32 bit integer\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"lock\-advmss" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"lock\-cwnd" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"lock\-initcwnd" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"lock\-initrwnd" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"lock\-mtu" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"lock\-window" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"mtu" -\- an unsigned 32 bit integer\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"onlink" -\- a boolean value\&. The onlink flag is ignored for IPv4 routes without a gateway\&. That also means, with a positive "weight" the route cannot merge with ECMP routes which are onlink and have a gateway\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"quickack" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"rto_min" -\- an unsigned 32 bit integer\&. The value is in milliseconds\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"scope" -\- an unsigned 8 bit integer\&. IPv4 only\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"src" -\- an IPv4 address\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"table" -\- an unsigned 32 bit integer\&. The default depends on ipv4\&.route\-table\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"tos" -\- an unsigned 8 bit integer\&. IPv4 only\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"type" -\- one of -unicast, -local, -blackhole, -unreachable, -prohibit, -throw\&. The default is -unicast\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"weight" -\- an unsigned 32 bit integer ranging from 0 to 256\&. A non\-zero weight indicates that the IPv4 route is an ECMP IPv4 route\&. NetworkManager will automatically merge compatible ECMP routes into multi\-hop routes\&. Setting to zero or omitting the attribute configures single hop routes that won\*(Aqt get merged\&. If the route finds no merge partner, it is configured as single hop route\&. -.sp -Note that in NetworkManager, currently all nexthops of a ECMP route must share the same "onlink" flag in order to be mergable\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"window" -\- an unsigned 32 bit integer\&. -.RE -.sp -For details see also `man ip\-route`\&. -.sp -Format: a comma separated list of routes -.RE -.PP -\fBipv4\&.routing\-rules\fR -.RS 4 -A comma separated list of routing rules for policy routing\&. The format is based on -\fBip rule add\fR -syntax and mostly compatible\&. One difference is that routing rules in NetworkManager always need a fixed priority\&. -.sp -Example: -priority 5 from 192\&.167\&.4\&.0/24 table 45 -.sp -Format: a comma separated list of routing rules -.RE -.SS "ipv6 setting" -.PP -IPv6 Settings\&. -.PP -Properties: -.PP -\fBipv6\&.addr\-gen\-mode\fR -.RS 4 -Configure method for creating the IPv6 interface identifier of addresses with RFC4862 IPv6 Stateless Address Autoconfiguration and Link Local addresses\&. -.sp -The permitted values are: "eui64" (0), "stable\-privacy" (1), "default" (3) or "default\-or\-eui64" (2)\&. -.sp -If the property is set to "eui64", the addresses will be generated using the interface token derived from hardware address\&. This makes the host part of the address to stay constant, making it possible to track the host\*(Aqs presence when it changes networks\&. The address changes when the interface hardware is replaced\&. If a duplicate address is detected, there is also no fallback to generate another address\&. When configured, the "ipv6\&.token" is used instead of the MAC address to generate addresses for stateless autoconfiguration\&. -.sp -If the property is set to "stable\-privacy", the interface identifier is generated as specified by RFC7217\&. This works by hashing a host specific key (see NetworkManager(8) manual), the interface name, the connection\*(Aqs "connection\&.stable\-id" property and the address prefix\&. This improves privacy by making it harder to use the address to track the host\*(Aqs presence and the address is stable when the network interface hardware is replaced\&. -.sp -The special values "default" and "default\-or\-eui64" will fallback to the global connection default as documented in the NetworkManager\&.conf(5) manual\&. If the global default is not specified, the fallback value is "stable\-privacy" or "eui64", respectively\&. -.sp -If not specified, when creating a new profile the default is "default"\&. -.sp -Note that this setting is distinct from the Privacy Extensions as configured by "ip6\-privacy" property and it does not affect the temporary addresses configured with this option\&. -.sp -Format: one of "eui64" (0), "stable\-privacy" (1), "default" (3) or "default\-or\-eui64" (2) -.sp -Valid values: eui64 (0), stable\-privacy (1), default\-or\-eui64 (2), default (3) -.RE -.PP -\fBipv6\&.addresses\fR -.RS 4 -Alias: ip6 -.sp -A list of IPv6 addresses and their prefix length\&. Multiple addresses can be separated by comma\&. For example "2001:db8:85a3::8a2e:370:7334/64, 2001:db8:85a3::5/64"\&. The addresses are listed in decreasing priority, meaning the first address will be the primary address\&. This can make a difference with IPv6 source address selection (RFC 6724, section 5)\&. -.sp -Format: a comma separated list of addresses -.RE -.PP -\fBipv6\&.auto\-route\-ext\-gw\fR -.RS 4 -VPN connections will default to add the route automatically unless this setting is set to FALSE\&. -.sp -For other connection types, adding such an automatic route is currently not supported and setting this to TRUE has no effect\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fBipv6\&.dhcp\-duid\fR -.RS 4 -A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315)\&. The DUID is carried in the Client Identifier option\&. If the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option\&. -.sp -The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection\&. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system\-wide dhclient lease file\&. If still no DUID is found, or another dhcp client is used, a global and permanent DUID\-UUID (RFC 6355) will be generated based on the machine\-id\&. -.sp -The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device\&. In order to try providing a stable DUID\-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk\&. -.sp -The special values "stable\-llt", "stable\-ll" and "stable\-uuid" will generate a DUID of the corresponding type, derived from the connection\*(Aqs stable\-id and a per\-host unique key\&. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable\-id, in case this profile gets activated on multiple devices\&. So, the link\-layer address of "stable\-ll" and "stable\-llt" will be a generated address derived from the stable id\&. The DUID\-LLT time value in the "stable\-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt")\&. -.sp -When the property is unset, the global value provided for "ipv6\&.dhcp\-duid" is used\&. If no global value is provided, the default "lease" value is assumed\&. -.sp -Format: string -.RE -.PP -\fBipv6\&.dhcp\-hostname\fR -.RS 4 -If the "dhcp\-send\-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease\&. This property and "dhcp\-fqdn" are mutually exclusive and cannot be set at the same time\&. -.sp -Format: string -.RE -.PP -\fBipv6\&.dhcp\-hostname\-flags\fR -.RS 4 -Flags for the DHCP hostname and FQDN\&. -.sp -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\&. -.sp -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\&. -.sp -Format: flags (NMDhcpHostnameFlags) -.sp -Valid values: none (0x0), fqdn\-serv\-update (0x1), fqdn\-encoded (0x2), fqdn\-no\-update (0x4), fqdn\-clear\-flags (0x8) -.RE -.PP -\fBipv6\&.dhcp\-iaid\fR -.RS 4 -A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The string can be a 32\-bit number (either decimal, hexadecimal or as colon separated hexadecimal numbers)\&. Alternatively it can be set to the special values "mac", "perm\-mac", "ifname" or "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. -.sp -For DHCPv4, the IAID is only used with "ipv4\&.dhcp\-client\-id" values "duid" and "ipv6\-duid" to generate the client\-id\&. -.sp -For DHCPv6, note that at the moment this property is only supported by the "internal" DHCPv6 plugin\&. The "dhclient" DHCPv6 plugin always derives the IAID from the MAC address\&. -.sp -The actually used DHCPv6 IAID for a currently activated interface is exposed in the lease information of the device\&. -.sp -Format: string -.RE -.PP -\fBipv6\&.dhcp\-pd\-hint\fR -.RS 4 -A IPv6 address followed by a slash and a prefix length\&. If set, the value is sent to the DHCPv6 server as hint indicating the prefix delegation (IA_PD) we want to receive\&. To only hint a prefix length without prefix, set the address part to the zero address (for example "::/60")\&. -.sp -Format: string -.RE -.PP -\fBipv6\&.dhcp\-send\-hostname\fR -.RS 4 -If TRUE, a hostname is sent to the DHCP server when acquiring a lease\&. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer\&. If the "dhcp\-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBipv6\&.dhcp\-send\-release\fR -.RS 4 -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\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fBipv6\&.dhcp\-timeout\fR -.RS 4 -A timeout for a DHCP transaction in seconds\&. If zero (the default), a globally configured default is used\&. If still unspecified, a device specific timeout is used (usually 45 seconds)\&. -.sp -Set to 2147483647 (MAXINT32) for infinity\&. -.sp -Format: integer -.sp -Valid values: 0 \- 2147483647 -.sp -Special values: default (0), infinity (2147483647) -.RE -.PP -\fBipv6\&.dns\fR -.RS 4 -Array of IP addresses of DNS servers\&. -.sp -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\&. -.sp -Format: list of IPv6 addresses -.RE -.PP -\fBipv6\&.dns\-options\fR -.RS 4 -DNS options for /etc/resolv\&.conf as described in resolv\&.conf(5) manual\&. -.sp -The currently supported options are "attempts", "debug", "edns0", "ndots", "no\-aaaa", "no\-check\-names", "no\-reload", "no\-tld\-query", "rotate", "single\-request", "single\-request\-reopen", "timeout", "trust\-ad", "use\-vc" and "inet6", "ip6\-bytestring", "ip6\-dotint", "no\-ip6\-dotint"\&. See the resolv\&.conf(5) manual\&. -.sp -Note that there is a distinction between an unset (default) list and an empty list\&. In nmcli, to unset the list set the value to ""\&. To set an empty list, set it to " "\&. Currently, an unset list has the same meaning as an empty list\&. That might change in the future\&. -.sp -The "trust\-ad" setting is only honored if the profile contributes name servers to resolv\&.conf, and if all contributing profiles have "trust\-ad" enabled\&. -.sp -When using a caching DNS plugin (dnsmasq or systemd\-resolved in NetworkManager\&.conf) then "edns0" and "trust\-ad" are automatically added\&. -.sp -The valid "ipv4\&.dns\-options" and "ipv6\&.dns\-options" get merged together\&. -.sp -Format: a comma separated list of DNS options -.RE -.PP -\fBipv6\&.dns\-priority\fR -.RS 4 -DNS servers priority\&. -.sp -The relative priority for DNS servers specified by this setting\&. A lower numerical value is better (higher priority)\&. -.sp -Negative values have the special effect of excluding other configurations with a greater numerical priority value; so in presence of at least one negative priority, only DNS servers from connections with the lowest priority value will be used\&. To avoid all DNS leaks, set the priority of the profile that should be used to the most negative value of all active connections profiles\&. -.sp -Zero selects a globally configured default value\&. If the latter is missing or zero too, it defaults to 50 for VPNs (including WireGuard) and 100 for other connections\&. -.sp -Note that the priority is to order DNS settings for multiple active connections\&. It does not disambiguate multiple DNS servers within the same connection profile\&. -.sp -When multiple devices have configurations with the same priority, VPNs will be considered first, then devices with the best (lowest metric) default route and then all other devices\&. -.sp -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\&. -.sp -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 \*(Aq~\&.\*(Aq 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\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.RE -.PP -\fBipv6\&.dns\-search\fR -.RS 4 -List of DNS search domains\&. Domains starting with a tilde (\*(Aq~\*(Aq) are considered \*(Aqrouting\*(Aq domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names\&. -.sp -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\&. -.sp -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)\&. -.sp -Format: list of strings -.RE -.PP -\fBipv6\&.gateway\fR -.RS 4 -Alias: gw6 -.sp -The gateway associated with this configuration\&. This is only meaningful if "addresses" is also set\&. -.sp -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\&. -.sp -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"\&. -.sp -Format: IPv6 address -.RE -.PP -\fBipv6\&.ignore\-auto\-dns\fR -.RS 4 -When "method" is set to "auto" and this property to TRUE, automatically configured name servers and search domains are ignored and only name servers and search domains specified in the "dns" and "dns\-search" properties, if any, are used\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBipv6\&.ignore\-auto\-routes\fR -.RS 4 -When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBipv6\&.ip6\-privacy\fR -.RS 4 -Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941\&. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI\-64\&. This enhances privacy, but could cause problems in some applications, on the other hand\&. The permitted values are: \-1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses)\&. -.sp -Having a per\-connection setting set to "\-1" (default) means fallback to global configuration "ipv6\&.ip6\-privacy"\&. If it\*(Aqs also unspecified or set to "\-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr"\&. -.sp -Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr\-gen\-mode" property\*(Aqs "stable\-privacy" setting as another way of avoiding host tracking with IPv6 addresses\&. -.sp -Format: choice (NMSettingIP6ConfigPrivacy) -.sp -Valid values: unknown/default (\-1), disabled (0), prefer\-public\-addr (1), prefer\-temp\-addr (2) -.RE -.PP -\fBipv6\&.may\-fail\fR -.RS 4 -If TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out\&. Note that at least one IP configuration must succeed or overall network configuration will still fail\&. For example, in IPv6\-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBipv6\&.method\fR -.RS 4 -Sets the IPv6 connection method\&. You can set one of the following values: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"auto" -\- Enables IPv6 auto\-configuration\&. By default, NetworkManager uses Router Advertisements and, if the router announces the "managed" flag, NetworkManager requests an IPv6 address and prefix from a DHCPv6 server\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"dhcp" -\- Requests an IPv6 address and prefix from a DHCPv6 server\&. Note that DHCPv6 does not have options to provide routes and the default gateway\&. As a consequence, by using the "dhcp" method, connections are limited to their own subnet\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"manual" -\- Enables the configuration of static IPv6 addresses on the interface\&. Note that you must set at least one IP address and prefix in the "ipv6\&.addresses" property\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"disabled" -\- Disables the IPv6 protocol in this connection profile\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"ignore" -\- Configures NetworkManager to make no changes to the IPv6 configuration on the interface\&. For example, you can then use the "accept_ra" feature of the kernel to accept Router Advertisements\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"shared" -\- Provides network access to other computers\&. NetworkManager requests a prefix from an upstream DHCPv6 server, assigns an address to the interface, and announces the prefix to clients that connect to this interface\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"link\-local" -\- Assigns a random link\-local address from the fe80::/64 subnet to the interface\&. -.RE -.sp - -If you set "auto", "dhcp", "manual", "ignore", or "shared", NetworkManager assigns, in addition to the global address, an IPv6 link\-local address to the interface\&. This is compliant with RFC 4291\&. -.sp -Format: string -.sp -Valid values: ignore, auto, dhcp, link\-local, manual, shared, disabled -.RE -.PP -\fBipv6\&.mtu\fR -.RS 4 -Maximum transmission unit size, in bytes\&. If zero (the default), the MTU is set automatically from router advertisements or is left equal to the link\-layer MTU\&. If greater than the link\-layer MTU, or greater than zero but less than the minimum IPv6 MTU of 1280, this value has no effect\&. -.sp -Format: integer -.sp -Special values: auto -.RE -.PP -\fBipv6\&.never\-default\fR -.RS 4 -If TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBipv6\&.ra\-timeout\fR -.RS 4 -A timeout for waiting Router Advertisements in seconds\&. If zero (the default), a globally configured default is used\&. If still unspecified, the timeout depends on the sysctl settings of the device\&. -.sp -Set to 2147483647 (MAXINT32) for infinity\&. -.sp -Format: integer -.sp -Valid values: 0 \- 2147483647 -.sp -Special values: default (0), infinity (2147483647) -.RE -.PP -\fBipv6\&.replace\-local\-rule\fR -.RS 4 -Connections will default to keep the autogenerated priority 0 local rule unless this setting is set to TRUE\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fBipv6\&.required\-timeout\fR -.RS 4 -The minimum time interval in milliseconds for which dynamic IP configuration should be tried before the connection succeeds\&. -.sp -This property is useful for example if both IPv4 and IPv6 are enabled and are allowed to fail\&. Normally the connection succeeds as soon as one of the two address families completes; by setting a required timeout for e\&.g\&. IPv4, one can ensure that even if IP6 succeeds earlier than IPv4, NetworkManager waits some time for IPv4 before the connection becomes active\&. -.sp -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\&. -.sp -A zero value means that no required timeout is present, \-1 means the default value (either configuration ipvx\&.required\-timeout override or zero)\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 2147483647 -.sp -Special values: default (\-1), infinity (2147483647) -.RE -.PP -\fBipv6\&.route\-metric\fR -.RS 4 -The default metric for routes that don\*(Aqt explicitly specify a metric\&. The default value \-1 means that the metric is chosen automatically based on the device type\&. The metric applies to dynamic routes, manual (static) routes that don\*(Aqt have an explicit metric setting, address prefix routes, and the default route\&. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default)\&. Hence, setting this property to zero effectively mean setting it to 1024\&. For IPv4, zero is a regular value for the metric\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 4294967295 -.RE -.PP -\fBipv6\&.route\-table\fR -.RS 4 -Enable policy routing (source routing) and set the routing table used when adding routes\&. -.sp -This affects all routes, including device\-routes, IPv4LL, DHCP, SLAAC, default\-routes and static routes\&. But note that static routes can individually overwrite the setting by explicitly specifying a non\-zero routing table\&. -.sp -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\&. -.sp -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\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.sp -Special values: unspec (0), main (254) -.RE -.PP -\fBipv6\&.routes\fR -.RS 4 -A list of IPv6 destination addresses, prefix length, optional IPv6 next hop addresses, optional route metric, optional attribute\&. The valid syntax is: "ip[/prefix] [next\-hop] [metric] [attribute=val]\&.\&.\&.[,ip[/prefix]\&.\&.\&.]"\&. -.sp -Various attributes are supported: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"advmss" -\- an unsigned 32 bit integer\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"cwnd" -\- an unsigned 32 bit integer\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"from" -\- an IPv6 address with optional prefix\&. IPv6 only\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"initcwnd" -\- an unsigned 32 bit integer\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"initrwnd" -\- an unsigned 32 bit integer\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"lock\-advmss" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"lock\-cwnd" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"lock\-initcwnd" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"lock\-initrwnd" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"lock\-mtu" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"lock\-window" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"mtu" -\- an unsigned 32 bit integer\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"onlink" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"quickack" -\- a boolean value\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"rto_min" -\- an unsigned 32 bit integer\&. The value is in milliseconds\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"src" -\- an IPv6 address\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"table" -\- an unsigned 32 bit integer\&. The default depends on ipv6\&.route\-table\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"type" -\- one of -unicast, -local, -blackhole, -unreachable, -prohibit, -throw\&. The default is -unicast\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -"window" -\- an unsigned 32 bit integer\&. -.RE -.sp -For details see also `man ip\-route`\&. -.sp -Format: a comma separated list of routes -.RE -.PP -\fBipv6\&.routing\-rules\fR -.RS 4 -A comma separated list of routing rules for policy routing\&. The format is based on -\fBip rule add\fR -syntax and mostly compatible\&. One difference is that routing rules in NetworkManager always need a fixed priority\&. -.sp -Example: -priority 5 from 1:2:3::5/128 table 45 -.sp -Format: a comma separated list of routing rules -.RE -.PP -\fBipv6\&.temp\-preferred\-lifetime\fR -.RS 4 -The preferred lifetime of autogenerated temporary addresses, in seconds\&. -.sp -Having a per\-connection setting set to "0" (default) means fallback to global configuration "ipv6\&.temp\-preferred\-lifetime" setting"\&. If it\*(Aqs also unspecified or set to "0", fallback to read "/proc/sys/net/ipv6/conf/default/temp_prefered_lft"\&. -.sp -Format: integer -.sp -Valid values: 0 \- 2147483647 -.sp -Special values: default (0) -.RE -.PP -\fBipv6\&.temp\-valid\-lifetime\fR -.RS 4 -The valid lifetime of autogenerated temporary addresses, in seconds\&. -.sp -Having a per\-connection setting set to "0" (default) means fallback to global configuration "ipv6\&.temp\-valid\-lifetime" setting"\&. If it\*(Aqs also unspecified or set to "0", fallback to read "/proc/sys/net/ipv6/conf/default/temp_valid_lft"\&. -.sp -Format: integer -.sp -Valid values: 0 \- 2147483647 -.sp -Special values: default (0) -.RE -.PP -\fBipv6\&.token\fR -.RS 4 -Configure the token for draft\-chown\-6man\-tokenised\-ipv6\-identifiers\-02 IPv6 tokenized interface identifiers\&. Useful with eui64 addr\-gen\-mode\&. -.sp -When set, the token is used as IPv6 interface identifier instead of the hardware address\&. This only applies to addresses from stateless autoconfiguration, not to IPv6 link local addresses\&. -.sp -Format: string -.RE -.SS "ip\-tunnel setting" -.PP -IP Tunneling Settings\&. -.PP -Properties: -.PP -\fBip\-tunnel\&.encapsulation\-limit\fR -.RS 4 -How many additional levels of encapsulation are permitted to be prepended to packets\&. This property applies only to IPv6 tunnels\&. To disable this option, add 0x1 (ip6\-ign\-encap\-limit) to ip\-tunnel flags\&. -.sp -Format: integer -.sp -Valid values: 0 \- 255 -.RE -.PP -\fBip\-tunnel\&.flags\fR -.RS 4 -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\&. -.sp -Format: flags (NMIPTunnelFlags) -.sp -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) -.RE -.PP -\fBip\-tunnel\&.flow\-label\fR -.RS 4 -The flow label to assign to tunnel packets\&. This property applies only to IPv6 tunnels\&. -.sp -Format: integer -.sp -Valid values: 0 \- 1048575 -.RE -.PP -\fBip\-tunnel\&.fwmark\fR -.RS 4 -The fwmark value to assign to tunnel packets\&. This property can be set to a non zero value only on VTI and VTI6 tunnels\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBip\-tunnel\&.input\-key\fR -.RS 4 -The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE)\&. If empty, no key is used\&. -.sp -Format: string -.RE -.PP -\fBip\-tunnel\&.local\fR -.RS 4 -Alias: local -.sp -The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address\&. -.sp -Format: string -.RE -.PP -\fBip\-tunnel\&.mode\fR -.RS 4 -Alias: mode -.sp -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) -.sp -Format: choice (NMIPTunnelMode) -.sp -Valid values: ipip (1), gre (2), sit (3), isatap (4), vti (5), ip6ip6 (6), ipip6 (7), ip6gre (8), vti6 (9), gretap (10), ip6gretap (11) -.RE -.PP -\fBip\-tunnel\&.mtu\fR -.RS 4 -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments\&. -.sp -Format: integer -.sp -Special values: auto -.RE -.PP -\fBip\-tunnel\&.output\-key\fR -.RS 4 -The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE)\&. If empty, no key is used\&. -.sp -Format: string -.RE -.PP -\fBip\-tunnel\&.parent\fR -.RS 4 -Alias: dev -.sp -If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface\&. -.sp -Format: string -.RE -.PP -\fBip\-tunnel\&.path\-mtu\-discovery\fR -.RS 4 -Whether to enable Path MTU Discovery on this tunnel\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBip\-tunnel\&.remote\fR -.RS 4 -Alias: remote -.sp -The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address\&. -.sp -Format: string -.RE -.PP -\fBip\-tunnel\&.tos\fR -.RS 4 -The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets\&. -.sp -Format: integer -.sp -Valid values: 0 \- 255 -.RE -.PP -\fBip\-tunnel\&.ttl\fR -.RS 4 -The TTL to assign to tunneled packets\&. 0 is a special value meaning that packets inherit the TTL value\&. -.sp -Format: integer -.sp -Valid values: 0 \- 255 -.RE -.SS "macsec setting" -.PP -MACSec Settings\&. -.PP -Properties: -.PP -\fBmacsec\&.encrypt\fR -.RS 4 -Alias: encrypt -.sp -Whether the transmitted traffic must be encrypted\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBmacsec\&.mka\-cak\fR -.RS 4 -Alias: cak -.sp -The pre\-shared CAK (Connectivity Association Key) for MACsec Key Agreement\&. Must be a string of 32 hexadecimal characters\&. -.sp -Format: string -.RE -.PP -\fBmacsec\&.mka\-cak\-flags\fR -.RS 4 -Flags indicating how to handle the "mka\-cak" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fBmacsec\&.mka\-ckn\fR -.RS 4 -Alias: ckn -.sp -The pre\-shared CKN (Connectivity\-association Key Name) for MACsec Key Agreement\&. Must be a string of hexadecimal characters with a even length between 2 and 64\&. -.sp -Format: string -.RE -.PP -\fBmacsec\&.mode\fR -.RS 4 -Alias: mode -.sp -Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained\&. -.sp -Format: choice (NMSettingMacsecMode) -.sp -Valid values: psk (0), eap (1) -.RE -.PP -\fBmacsec\&.offload\fR -.RS 4 -Specifies the MACsec offload mode\&. -.sp -"off" (0) disables MACsec offload\&. -.sp -"phy" (1) and "mac" (2) request offload respectively to the PHY or to the MAC; if the selected mode is not available, the connection will fail\&. -.sp -"default" (\-1) uses the global default value specified in NetworkManager configuration; if no global default is defined, the built\-in default is "off" (0)\&. -.sp -Format: choice (NMSettingMacsecOffload) -.sp -Valid values: default (\-1), off (0), phy (1), mac (2) -.RE -.PP -\fBmacsec\&.parent\fR -.RS 4 -Alias: dev -.sp -If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created\&. If this property is not specified, the connection must contain an "802\-3\-ethernet" setting with a "mac\-address" property\&. -.sp -Format: string -.RE -.PP -\fBmacsec\&.port\fR -.RS 4 -Alias: port -.sp -The port component of the SCI (Secure Channel Identifier), between 1 and 65534\&. -.sp -Format: integer -.sp -Valid values: 1 \- 65534 -.RE -.PP -\fBmacsec\&.send\-sci\fR -.RS 4 -Specifies whether the SCI (Secure Channel Identifier) is included in every packet\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBmacsec\&.validation\fR -.RS 4 -Specifies the validation mode for incoming frames\&. -.sp -Format: choice (NMSettingMacsecValidation) -.sp -Valid values: disable (0), check (1), strict (2) -.RE -.SS "macvlan setting" -.PP -MAC VLAN Settings\&. -.PP -Properties: -.PP -\fBmacvlan\&.mode\fR -.RS 4 -Alias: mode -.sp -The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device\&. -.sp -Format: choice (NMSettingMacvlanMode) -.sp -Valid values: vepa (1), bridge (2), private (3), passthru (4), source (5) -.RE -.PP -\fBmacvlan\&.parent\fR -.RS 4 -Alias: dev -.sp -If given, specifies the parent interface name or parent connection UUID from which this MAC\-VLAN interface should be created\&. If this property is not specified, the connection must contain an "802\-3\-ethernet" setting with a "mac\-address" property\&. -.sp -Format: string -.RE -.PP -\fBmacvlan\&.promiscuous\fR -.RS 4 -Whether the interface should be put in promiscuous mode\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBmacvlan\&.tap\fR -.RS 4 -Alias: tap -.sp -Whether the interface should be a MACVTAP\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.SS "match setting" -.PP -Match settings\&. -.PP -Properties: -.PP -\fBmatch\&.driver\fR -.RS 4 -A list of driver names to match\&. Each element is a shell wildcard pattern\&. -.sp -See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the pattern\&. -.sp -Format: list of strings -.RE -.PP -\fBmatch\&.interface\-name\fR -.RS 4 -A list of interface names to match\&. Each element is a shell wildcard pattern\&. -.sp -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, "&\e\e!a" is an mandatory match for literally "!a"\&. -.sp -Format: list of strings -.RE -.PP -\fBmatch\&.kernel\-command\-line\fR -.RS 4 -A list of kernel command line arguments to match\&. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark)\&. The argument must either be a single word, or an assignment (i\&.e\&. two words, joined by "=")\&. In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment\&. In the latter case, the exact assignment is looked for with right and left hand side matching\&. Wildcard patterns are not supported\&. -.sp -See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the match\&. -.sp -Format: list of strings -.RE -.PP -\fBmatch\&.path\fR -.RS 4 -A list of paths to match against the ID_PATH udev property of devices\&. ID_PATH represents the topological persistent path of a device\&. It typically contains a subsystem string (pci, usb, platform, etc\&.) and a subsystem\-specific identifier\&. -.sp -For PCI devices the path has the form "pci\-$domain:$bus:$device\&.$function", where each variable is an hexadecimal value; for example "pci\-0000:0a:00\&.0"\&. -.sp -The path of a device can be obtained with "udevadm info /sys/class/net/$dev | grep ID_PATH=" or by looking at the "path" property exported by NetworkManager ("nmcli \-f general\&.path device show $dev")\&. -.sp -Each element of the list is a shell wildcard pattern\&. -.sp -See NMSettingMatch:interface\-name for how special characters \*(Aq|\*(Aq, \*(Aq&\*(Aq, \*(Aq!\*(Aq and \*(Aq\e\e\*(Aq are used for optional and mandatory matches and inverting the pattern\&. -.sp -Format: list of strings -.RE -.SS "802\-11\-olpc\-mesh setting" -.PP -Alias: olpc\-mesh -.PP -OLPC Wireless Mesh Settings\&. -.PP -Properties: -.PP -\fB802\-11\-olpc\-mesh\&.channel\fR -.RS 4 -Alias: channel -.sp -Channel on which the mesh network to join is located\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fB802\-11\-olpc\-mesh\&.dhcp\-anycast\-address\fR -.RS 4 -Alias: dhcp\-anycast -.sp -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\&. -.sp -This is currently only implemented by dhclient DHCP plugin\&. -.sp -Format: MAC address -.RE -.PP -\fB802\-11\-olpc\-mesh\&.ssid\fR -.RS 4 -Alias: ssid -.sp -SSID of the mesh network to join\&. -.sp -Format: string -.RE -.SS "ovs\-bridge setting" -.PP -OvsBridge Link Settings\&. -.PP -Properties: -.PP -\fBovs\-bridge\&.datapath\-type\fR -.RS 4 -The data path type\&. One of "system", "netdev" or empty\&. -.sp -Format: string -.sp -Valid values: system, netdev -.RE -.PP -\fBovs\-bridge\&.fail\-mode\fR -.RS 4 -The bridge failure mode\&. One of "secure", "standalone" or empty\&. -.sp -Format: string -.sp -Valid values: secure, standalone -.RE -.PP -\fBovs\-bridge\&.mcast\-snooping\-enable\fR -.RS 4 -Enable or disable multicast snooping\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBovs\-bridge\&.rstp\-enable\fR -.RS 4 -Enable or disable RSTP\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBovs\-bridge\&.stp\-enable\fR -.RS 4 -Enable or disable STP\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.SS "ovs\-dpdk setting" -.PP -OvsDpdk Link Settings\&. -.PP -Properties: -.PP -\fBovs\-dpdk\&.devargs\fR -.RS 4 -Open vSwitch DPDK device arguments\&. -.sp -Format: string -.RE -.PP -\fBovs\-dpdk\&.n\-rxq\fR -.RS 4 -Open vSwitch DPDK number of rx queues\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures one queue\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBovs\-dpdk\&.n\-rxq\-desc\fR -.RS 4 -The rx queue size (number of rx descriptors) for DPDK ports\&. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4096 -.RE -.PP -\fBovs\-dpdk\&.n\-txq\-desc\fR -.RS 4 -The tx queue size (number of tx descriptors) for DPDK ports\&. Must be zero or a power of 2 between 1 and 4096, and supported by the hardware\&. Defaults to zero which means to leave the parameter in OVS unspecified and effectively configures 2048 descriptors\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4096 -.RE -.SS "ovs\-interface setting" -.PP -Open vSwitch Interface Settings\&. -.PP -Properties: -.PP -\fBovs\-interface\&.ofport\-request\fR -.RS 4 -Open vSwitch openflow port number\&. Defaults to zero which means that port number will not be specified and it will be chosen randomly by ovs\&. OpenFlow ports are the network interfaces for passing packets between OpenFlow processing and the rest of the network\&. OpenFlow switches connect logically to each other via their OpenFlow ports\&. -.sp -Format: integer -.sp -Valid values: 0 \- 65279 -.RE -.PP -\fBovs\-interface\&.type\fR -.RS 4 -The interface type\&. Either "internal", "system", "patch", "dpdk", or empty\&. -.sp -Format: string -.sp -Valid values: internal, system, patch, dpdk -.RE -.SS "ovs\-patch setting" -.PP -OvsPatch Link Settings\&. -.PP -Properties: -.PP -\fBovs\-patch\&.peer\fR -.RS 4 -Specifies the name of the interface for the other side of the patch\&. The patch on the other side must also set this interface as peer\&. -.sp -Format: string -.RE -.SS "ovs\-port setting" -.PP -OvsPort Link Settings\&. -.PP -Properties: -.PP -\fBovs\-port\&.bond\-downdelay\fR -.RS 4 -The time port must be inactive in order to be considered down\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBovs\-port\&.bond\-mode\fR -.RS 4 -Bonding mode\&. One of "active\-backup", "balance\-slb", or "balance\-tcp"\&. -.sp -Format: string -.sp -Valid values: active\-backup, balance\-slb, balance\-tcp -.RE -.PP -\fBovs\-port\&.bond\-updelay\fR -.RS 4 -The time port must be active before it starts forwarding traffic\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBovs\-port\&.lacp\fR -.RS 4 -LACP mode\&. One of "active", "off", or "passive"\&. -.sp -Format: string -.sp -Valid values: active, off, passive -.RE -.PP -\fBovs\-port\&.tag\fR -.RS 4 -The VLAN tag in the range 0\-4095\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4095 -.RE -.PP -\fBovs\-port\&.trunks\fR -.RS 4 -A list of VLAN ranges that this port trunks\&. -.sp -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\&. -.sp -Format: list of ovs\-port\&.trunks objects -.RE -.PP -\fBovs\-port\&.vlan\-mode\fR -.RS 4 -The VLAN mode\&. One of "access", "native\-tagged", "native\-untagged", "trunk", "dot1q\-tunnel" or unset\&. -.sp -Format: string -.sp -Valid values: access, native\-tagged, native\-untagged, trunk, dot1q\-tunnel -.RE -.SS "ppp setting" -.PP -Point\-to\-Point Protocol Settings\&. -.PP -Properties: -.PP -\fBppp\&.baud\fR -.RS 4 -If non\-zero, instruct pppd to set the serial port to the specified baudrate\&. This value should normally be left as 0 to automatically choose the speed\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBppp\&.crtscts\fR -.RS 4 -If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals\&. This value should normally be set to FALSE\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBppp\&.lcp\-echo\-failure\fR -.RS 4 -If non\-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo\-requests go unanswered by the peer\&. The "lcp\-echo\-interval" property must also be set to a non\-zero value if this property is used\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBppp\&.lcp\-echo\-interval\fR -.RS 4 -If non\-zero, instruct pppd to send an LCP echo\-request frame to the peer every n seconds (where n is the specified value)\&. Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBppp\&.mppe\-stateful\fR -.RS 4 -If TRUE, stateful MPPE is used\&. See pppd documentation for more information on stateful MPPE\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBppp\&.mru\fR -.RS 4 -If non\-zero, instruct pppd to request that the peer send packets no larger than the specified size\&. If non\-zero, the MRU should be between 128 and 16384\&. -.sp -Format: integer -.sp -Valid values: 0 \- 16384 -.RE -.PP -\fBppp\&.mtu\fR -.RS 4 -If non\-zero, instruct pppd to send packets no larger than the specified size\&. -.sp -Format: integer -.sp -Special values: auto -.RE -.PP -\fBppp\&.no\-vj\-comp\fR -.RS 4 -If TRUE, Van Jacobsen TCP header compression will not be requested\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBppp\&.noauth\fR -.RS 4 -If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client\&. If FALSE, require authentication from the remote side\&. In almost all cases, this should be TRUE\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBppp\&.nobsdcomp\fR -.RS 4 -If TRUE, BSD compression will not be requested\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBppp\&.nodeflate\fR -.RS 4 -If TRUE, "deflate" compression will not be requested\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBppp\&.refuse\-chap\fR -.RS 4 -If TRUE, the CHAP authentication method will not be used\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBppp\&.refuse\-eap\fR -.RS 4 -If TRUE, the EAP authentication method will not be used\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBppp\&.refuse\-mschap\fR -.RS 4 -If TRUE, the MSCHAP authentication method will not be used\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBppp\&.refuse\-mschapv2\fR -.RS 4 -If TRUE, the MSCHAPv2 authentication method will not be used\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBppp\&.refuse\-pap\fR -.RS 4 -If TRUE, the PAP authentication method will not be used\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBppp\&.require\-mppe\fR -.RS 4 -If TRUE, MPPE (Microsoft Point\-to\-Point Encryption) will be required for the PPP session\&. If either 64\-bit or 128\-bit MPPE is not available the session will fail\&. Note that MPPE is not used on mobile broadband connections\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBppp\&.require\-mppe\-128\fR -.RS 4 -If TRUE, 128\-bit MPPE (Microsoft Point\-to\-Point Encryption) will be required for the PPP session, and the "require\-mppe" property must also be set to TRUE\&. If 128\-bit MPPE is not available the session will fail\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.SS "pppoe setting" -.PP -PPP\-over\-Ethernet Settings\&. -.PP -Properties: -.PP -\fBpppoe\&.parent\fR -.RS 4 -Alias: parent -.sp -If given, specifies the parent interface name on which this PPPoE connection should be created\&. If this property is not specified, the connection is activated on the interface specified in "interface\-name" of NMSettingConnection\&. -.sp -Format: string -.RE -.PP -\fBpppoe\&.password\fR -.RS 4 -Alias: password -.sp -Password used to authenticate with the PPPoE service\&. -.sp -Format: string -.RE -.PP -\fBpppoe\&.password\-flags\fR -.RS 4 -Flags indicating how to handle the "password" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fBpppoe\&.service\fR -.RS 4 -Alias: service -.sp -If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service\&. For most providers, this should be left blank\&. It is only required if there are multiple access concentrators or a specific service is known to be required\&. -.sp -Format: string -.RE -.PP -\fBpppoe\&.username\fR -.RS 4 -Alias: username -.sp -Username used to authenticate with the PPPoE service\&. -.sp -Format: string -.RE -.SS "proxy setting" -.PP -WWW Proxy Settings\&. -.PP -Properties: -.PP -\fBproxy\&.browser\-only\fR -.RS 4 -Alias: browser\-only -.sp -Whether the proxy configuration is for browser only\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBproxy\&.method\fR -.RS 4 -Alias: method -.sp -Method for proxy configuration, Default is "none" (0) -.sp -Format: choice (NMSettingProxyMethod) -.sp -Valid values: none (0), auto (1) -.RE -.PP -\fBproxy\&.pac\-script\fR -.RS 4 -Alias: pac\-script -.sp -The PAC script\&. In the profile this must be an UTF\-8 encoded javascript code that defines a FindProxyForURL() function\&. When setting the property in nmcli, a filename is accepted too\&. In that case, nmcli will read the content of the file and set the script\&. The prefixes "file://" and "js://" are supported to explicitly differentiate between the two\&. -.sp -Format: string -.RE -.PP -\fBproxy\&.pac\-url\fR -.RS 4 -Alias: pac\-url -.sp -PAC URL for obtaining PAC file\&. -.sp -Format: string -.RE -.SS "serial setting" -.PP -Serial Link Settings\&. -.PP -Properties: -.PP -\fBserial\&.baud\fR -.RS 4 -Speed to use for communication over the serial port\&. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBserial\&.bits\fR -.RS 4 -Byte\-width of the serial communication\&. The 8 in "8n1" for example\&. -.sp -Format: integer -.sp -Valid values: 5 \- 8 -.RE -.PP -\fBserial\&.parity\fR -.RS 4 -Parity setting of the serial port\&. -.sp -Format: choice (NMSettingSerialParity) -.sp -Valid values: none/N/n (0), even/E/e (1), odd/O/o (2) -.RE -.PP -\fBserial\&.send\-delay\fR -.RS 4 -Time to delay between each byte sent to the modem, in microseconds\&. -.sp -Format: integer -.sp -Valid values: 0 \- 18446744073709551615 -.RE -.PP -\fBserial\&.stopbits\fR -.RS 4 -Number of stop bits for communication on the serial port\&. Either 1 or 2\&. The 1 in "8n1" for example\&. -.sp -Format: integer -.sp -Valid values: 1 \- 2 -.RE -.SS "sriov setting" -.PP -SR\-IOV settings\&. -.PP -Properties: -.PP -\fBsriov\&.autoprobe\-drivers\fR -.RS 4 -Whether to autoprobe virtual functions by a compatible driver\&. -.sp -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\&. -.sp -If set to "false" (0), VFs will not be claimed and no network interfaces will be created for them\&. -.sp -When set to "default" (\-1), the global default is used; in case the global default is unspecified it is assumed to be "true" (1)\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fBsriov\&.eswitch\-encap\-mode\fR -.RS 4 -Select the eswitch encapsulation support\&. -.sp -Currently it\*(Aqs only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF\&. -.sp -If set to "preserve" (\-1) (default) the eswitch encap\-mode won\*(Aqt be modified by NetworkManager\&. -.sp -Format: choice (NMSriovEswitchEncapMode) -.sp -Valid values: preserve (\-1), none (0), basic (1) -.RE -.PP -\fBsriov\&.eswitch\-inline\-mode\fR -.RS 4 -Select the eswitch inline\-mode of the device\&. Some HWs need the VF driver to put part of the packet headers on the TX descriptor so the e\-switch can do proper matching and steering\&. -.sp -Currently it\*(Aqs only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF\&. -.sp -If set to "preserve" (\-1) (default) the eswitch inline\-mode won\*(Aqt be modified by NetworkManager\&. -.sp -Format: choice (NMSriovEswitchInlineMode) -.sp -Valid values: preserve (\-1), none (0), link (1), network (2), transport (3) -.RE -.PP -\fBsriov\&.eswitch\-mode\fR -.RS 4 -Select the eswitch mode of the device\&. Currently it\*(Aqs only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF\&. -.sp -If set to "preserve" (\-1) (default) the eswitch mode won\*(Aqt be modified by NetworkManager\&. -.sp -Format: choice (NMSriovEswitchMode) -.sp -Valid values: preserve (\-1), legacy (0), switchdev (1) -.RE -.PP -\fBsriov\&.total\-vfs\fR -.RS 4 -The total number of virtual functions to create\&. -.sp -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\*(Aqt add a sriov setting to the connection\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBsriov\&.vfs\fR -.RS 4 -Array of virtual function descriptors\&. -.sp -Each VF descriptor is a dictionary mapping attribute names to GVariant values\&. The \*(Aqindex\*(Aq entry is mandatory for each VF\&. -.sp -When represented as string a VF is in the form: -.sp -"INDEX [ATTR=VALUE[ ATTR=VALUE]\&.\&.\&.]"\&. -.sp -for example: -.sp -"2 mac=00:11:22:33:44:55 spoof\-check=true"\&. -.sp -Multiple VFs can be specified using a comma as separator\&. Currently, the following attributes are supported: mac, spoof\-check, trust, min\-tx\-rate, max\-tx\-rate, vlans\&. -.sp -The "vlans" attribute is represented as a semicolon\-separated list of VLAN descriptors, where each descriptor has the form -.sp -"ID[\&.PRIORITY[\&.PROTO]]"\&. -.sp -PROTO can be either \*(Aqq\*(Aq for 802\&.1Q (the default) or \*(Aqad\*(Aq for 802\&.1ad\&. -.sp -Format: list of sriov\&.vfs objects -.RE -.SS "tc setting" -.PP -Linux Traffic Control Settings\&. -.PP -Properties: -.PP -\fBtc\&.qdiscs\fR -.RS 4 -Array of TC queueing disciplines\&. qdisc is a basic block in the Linux traffic control subsystem -.sp -Each qdisc can be specified by the following attributes: -.PP -\fIhandle HANDLE\fR -.RS 4 -specifies the qdisc handle\&. A qdisc, which potentially can have children, gets assigned a major number, called a \*(Aqhandle\*(Aq, leaving the minor number namespace available for classes\&. The handle is expressed as \*(Aq10:\*(Aq\&. It is customary to explicitly assign a handle to qdiscs expected to have children\&. -.RE -.PP -\fIparent HANDLE\fR -.RS 4 -specifies the handle of the parent qdisc the current qdisc must be attached to\&. -.RE -.PP -\fIroot\fR -.RS 4 -specifies that the qdisc is attached to the root of device\&. -.RE -.PP -\fIKIND\fR -.RS 4 -this is the qdisc kind\&. NetworkManager currently supports the following kinds: fq_codel, sfq, tbf\&. Each qdisc kind has a different set of parameters, described below\&. There are also some kinds like pfifo, pfifo_fast, prio supported by NetworkManager but their parameters are not supported by NetworkManager\&. -.RE -.sp -Parameters for \*(Aqfq_codel\*(Aq: -.PP -\fIlimit U32\fR -.RS 4 -the hard limit on the real queue size\&. When this limit is reached, incoming packets are dropped\&. Default is 10240 packets\&. -.RE -.PP -\fImemory_limit U32\fR -.RS 4 -sets a limit on the total number of bytes that can be queued in this FQ\-CoDel instance\&. The lower of the packet limit of the limit parameter and the memory limit will be enforced\&. Default is 32 MB\&. -.RE -.PP -\fIflows U32\fR -.RS 4 -the number of flows into which the incoming packets are classified\&. Due to the stochastic nature of hashing, multiple flows may end up being hashed into the same slot\&. Newer flows have priority over older ones\&. This parameter can be set only at load time since memory has to be allocated for the hash table\&. Default value is 1024\&. -.RE -.PP -\fItarget U32\fR -.RS 4 -the acceptable minimum standing/persistent queue delay\&. This minimum delay is identified by tracking the local minimum queue delay that packets experience\&. The unit of measurement is microsecond(us)\&. Default value is 5ms\&. -.RE -.PP -\fIinterval U32\fR -.RS 4 -used to ensure that the measured minimum delay does not become too stale\&. The minimum delay must be experienced in the last epoch of length \&.B interval\&. It should be set on the order of the worst\-case RTT through the bottleneck to give endpoints sufficient time to react\&. Default value is 100ms\&. -.RE -.PP -\fIquantum U32\fR -.RS 4 -the number of bytes used as \*(Aqdeficit\*(Aq in the fair queuing algorithm\&. Default is set to 1514 bytes which corresponds to the Ethernet MTU plus the hardware header length of 14 bytes\&. -.RE -.PP -\fIecn BOOL\fR -.RS 4 -can be used to mark packets instead of dropping them\&. ecn is turned on by default\&. -.RE -.PP -\fIce_threshold U32\fR -.RS 4 -sets a threshold above which all packets are marked with ECN Congestion Experienced\&. This is useful for DCTCP\-style congestion control algorithms that require marking at very shallow queueing thresholds\&. -.RE -.sp -Parameters for \*(Aqsfq\*(Aq: -.PP -\fIdivisor U32\fR -.RS 4 -can be used to set a different hash table size, available from kernel 2\&.6\&.39 onwards\&. The specified divisor must be a power of two and cannot be larger than 65536\&. Default value: 1024\&. -.RE -.PP -\fIlimit U32\fR -.RS 4 -Upper limit of the SFQ\&. Can be used to reduce the default length of 127 packets\&. -.RE -.PP -\fIdepth U32\fR -.RS 4 -Limit of packets per flow\&. Default to 127 and can be lowered\&. -.RE -.PP -\fIperturb_period U32\fR -.RS 4 -Interval in seconds for queue algorithm perturbation\&. Defaults to 0, which means that no perturbation occurs\&. Do not set too low for each perturbation may cause some packet reordering or losses\&. Advised value: 60 This value has no effect when external flow classification is used\&. Its better to increase divisor value to lower risk of hash collisions\&. -.RE -.PP -\fIquantum U32\fR -.RS 4 -Amount of bytes a flow is allowed to dequeue during a round of the round robin process\&. Defaults to the MTU of the interface which is also the advised value and the minimum value\&. -.RE -.PP -\fIflows U32\fR -.RS 4 -Default value is 127\&. -.RE -.sp -Parameters for \*(Aqtbf\*(Aq: -.PP -\fIrate U64\fR -.RS 4 -Bandwidth or rate\&. These parameters accept a floating point number, possibly followed by either a unit (both SI and IEC units supported), or a float followed by a percent character to specify the rate as a percentage of the device\*(Aqs speed\&. -.RE -.PP -\fIburst U32\fR -.RS 4 -Also known as buffer or maxburst\&. Size of the bucket, in bytes\&. This is the maximum amount of bytes that tokens can be available for instantaneously\&. In general, larger shaping rates require a larger buffer\&. For 10mbit/s on Intel, you need at least 10kbyte buffer if you want to reach your configured rate! -.sp -If your buffer is too small, packets may be dropped because more tokens arrive per timer tick than fit in your bucket\&. The minimum buffer size can be calculated by dividing the rate by HZ\&. -.sp -Token usage calculations are performed using a table which by default has a resolution of 8 packets\&. This resolution can be changed by specifying the cell size with the burst\&. For example, to specify a 6000 byte buffer with a 16 byte cell size, set a burst of 6000/16\&. You will probably never have to set this\&. Must be an integral power of 2\&. -.RE -.PP -\fIlimit U32\fR -.RS 4 -Limit is the number of bytes that can be queued waiting for tokens to become available\&. -.RE -.PP -\fIlatency U32\fR -.RS 4 -specifies the maximum amount of time a packet can sit in the TBF\&. The latency calculation takes into account the size of the bucket, the rate and possibly the peakrate (if set)\&. The latency and limit are mutually exclusive\&. -.RE -.sp -Format: GPtrArray(NMTCQdisc) -.RE -.PP -\fBtc\&.tfilters\fR -.RS 4 -Array of TC traffic filters\&. Traffic control can manage the packet content during classification by using filters\&. -.sp -Each tfilters can be specified by the following attributes: -.PP -\fIhandle HANDLE\fR -.RS 4 -specifies the tfilters handle\&. A filter is used by a classful qdisc to determine in which class a packet will be enqueued\&. It is important to notice that filters reside within qdiscs\&. Therefore, see qdiscs handle for detailed information\&. -.RE -.PP -\fIparent HANDLE\fR -.RS 4 -specifies the handle of the parent qdisc the current qdisc must be attached to\&. -.RE -.PP -\fIroot\fR -.RS 4 -specifies that the qdisc is attached to the root of device\&. -.RE -.PP -\fIKIND\fR -.RS 4 -this is the tfilters kind\&. NetworkManager currently supports following kinds: mirred, simple\&. Each filter kind has a different set of actions, described below\&. There are also some other kinds like matchall, basic, u32 supported by NetworkManager\&. -.RE -.sp -Actions for \*(Aqmirred\*(Aq: -.PP -\fIegress bool\fR -.RS 4 -Define whether the packet should exit from the interface\&. -.RE -.PP -\fIingress bool\fR -.RS 4 -Define whether the packet should come into the interface\&. -.RE -.PP -\fImirror bool\fR -.RS 4 -Define whether the packet should be copied to the destination space\&. -.RE -.PP -\fIredirect bool\fR -.RS 4 -Define whether the packet should be moved to the destination space\&. -.RE -.sp -Action for \*(Aqsimple\*(Aq: -.PP -\fIsdata char[32]\fR -.RS 4 -The actual string to print\&. -.RE -.sp -Format: GPtrArray(NMTCTfilter) -.RE -.SS "team setting" -.PP -Teaming Settings\&. -.PP -Properties: -.PP -\fBteam\&.config\fR -.RS 4 -Alias: config -.sp -The JSON configuration for the team network interface\&. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd\&. If not specified, the default configuration is used\&. See man teamd\&.conf for the format details\&. -.sp -Format: string -.RE -.PP -\fBteam\&.link\-watchers\fR -.RS 4 -Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher\&. Available link watchers are \*(Aqethtool\*(Aq, \*(Aqnsna_ping\*(Aq and \*(Aqarp_ping\*(Aq and it is specified in the dictionary with the key \*(Aqname\*(Aq\&. Available keys are: ethtool: \*(Aqdelay\-up\*(Aq, \*(Aqdelay\-down\*(Aq, \*(Aqinit\-wait\*(Aq; nsna_ping: \*(Aqinit\-wait\*(Aq, \*(Aqinterval\*(Aq, \*(Aqmissed\-max\*(Aq, \*(Aqtarget\-host\*(Aq; arp_ping: all the ones in nsna_ping and \*(Aqsource\-host\*(Aq, \*(Aqvalidate\-active\*(Aq, \*(Aqvalidate\-inactive\*(Aq, \*(Aqsend\-always\*(Aq\&. See teamd\&.conf man for more details\&. -.sp -Format: list of team\&.link\-watchers objects -.RE -.PP -\fBteam\&.mcast\-rejoin\-count\fR -.RS 4 -Corresponds to the teamd mcast_rejoin\&.count\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.sp -Special values: unset (\-1), disabled (0) -.RE -.PP -\fBteam\&.mcast\-rejoin\-interval\fR -.RS 4 -Corresponds to the teamd mcast_rejoin\&.interval\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.sp -Special values: unset (\-1), default (0) -.RE -.PP -\fBteam\&.notify\-peers\-count\fR -.RS 4 -Corresponds to the teamd notify_peers\&.count\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.sp -Special values: unset (\-1), disabled (0) -.RE -.PP -\fBteam\&.notify\-peers\-interval\fR -.RS 4 -Corresponds to the teamd notify_peers\&.interval\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.sp -Special values: unset (\-1), default (0) -.RE -.PP -\fBteam\&.runner\fR -.RS 4 -Corresponds to the teamd runner\&.name\&. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random"\&. -.sp -Format: string -.sp -Valid values: broadcast, roundrobin, random, activebackup, loadbalance, lacp -.RE -.PP -\fBteam\&.runner\-active\fR -.RS 4 -Corresponds to the teamd runner\&.active\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBteam\&.runner\-agg\-select\-policy\fR -.RS 4 -Corresponds to the teamd runner\&.agg_select_policy\&. -.sp -Format: string -.sp -Valid values: lacp_prio, lacp_prio_stable, bandwidth, count, port_config -.RE -.PP -\fBteam\&.runner\-fast\-rate\fR -.RS 4 -Corresponds to the teamd runner\&.fast_rate\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBteam\&.runner\-hwaddr\-policy\fR -.RS 4 -Corresponds to the teamd runner\&.hwaddr_policy\&. -.sp -Format: string -.sp -Valid values: same_all, by_active, only_active -.RE -.PP -\fBteam\&.runner\-min\-ports\fR -.RS 4 -Corresponds to the teamd runner\&.min_ports\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.sp -Special values: unset (\-1), default (1) -.RE -.PP -\fBteam\&.runner\-sys\-prio\fR -.RS 4 -Corresponds to the teamd runner\&.sys_prio\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.sp -Special values: unset (\-1), default (65535) -.RE -.PP -\fBteam\&.runner\-tx\-balancer\fR -.RS 4 -Corresponds to the teamd runner\&.tx_balancer\&.name\&. -.sp -Format: string -.sp -Valid values: basic -.RE -.PP -\fBteam\&.runner\-tx\-balancer\-interval\fR -.RS 4 -Corresponds to the teamd runner\&.tx_balancer\&.interval\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.sp -Special values: unset (\-1), default (50) -.RE -.PP -\fBteam\&.runner\-tx\-hash\fR -.RS 4 -Corresponds to the teamd runner\&.tx_hash\&. -.sp -Format: list of strings -.sp -Valid values: eth, vlan, ipv4, ipv6, ip, l3, tcp, udp, sctp, l4 -.RE -.SS "team\-port setting" -.PP -Team Port Settings\&. -.PP -Properties: -.PP -\fBteam\-port\&.config\fR -.RS 4 -Alias: config -.sp -The JSON configuration for the team port\&. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd\&. If not specified, the default configuration is used\&. See man teamd\&.conf for the format details\&. -.sp -Format: string -.RE -.PP -\fBteam\-port\&.lacp\-key\fR -.RS 4 -Corresponds to the teamd ports\&.PORTIFNAME\&.lacp_key\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.sp -Special values: unset (\-1), default (0) -.RE -.PP -\fBteam\-port\&.lacp\-prio\fR -.RS 4 -Corresponds to the teamd ports\&.PORTIFNAME\&.lacp_prio\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.sp -Special values: unset (\-1), default (255) -.RE -.PP -\fBteam\-port\&.link\-watchers\fR -.RS 4 -Link watchers configuration for the connection: each link watcher is defined by a dictionary, whose keys depend upon the selected link watcher\&. Available link watchers are \*(Aqethtool\*(Aq, \*(Aqnsna_ping\*(Aq and \*(Aqarp_ping\*(Aq and it is specified in the dictionary with the key \*(Aqname\*(Aq\&. Available keys are: ethtool: \*(Aqdelay\-up\*(Aq, \*(Aqdelay\-down\*(Aq, \*(Aqinit\-wait\*(Aq; nsna_ping: \*(Aqinit\-wait\*(Aq, \*(Aqinterval\*(Aq, \*(Aqmissed\-max\*(Aq, \*(Aqtarget\-host\*(Aq; arp_ping: all the ones in nsna_ping and \*(Aqsource\-host\*(Aq, \*(Aqvalidate\-active\*(Aq, \*(Aqvalidate\-inactive\*(Aq, \*(Aqsend\-always\*(Aq\&. See teamd\&.conf man for more details\&. -.sp -Format: list of team\-port\&.link\-watchers objects -.RE -.PP -\fBteam\-port\&.prio\fR -.RS 4 -Corresponds to the teamd ports\&.PORTIFNAME\&.prio\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.sp -Special values: unset (0), default (0) -.RE -.PP -\fBteam\-port\&.queue\-id\fR -.RS 4 -Corresponds to the teamd ports\&.PORTIFNAME\&.queue_id\&. When set to \-1 means the parameter is skipped from the json config\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.sp -Special values: unset (\-1), default (0) -.RE -.PP -\fBteam\-port\&.sticky\fR -.RS 4 -Corresponds to the teamd ports\&.PORTIFNAME\&.sticky\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.SS "tun setting" -.PP -Tunnel Settings\&. -.PP -Properties: -.PP -\fBtun\&.group\fR -.RS 4 -Alias: group -.sp -The group ID which will own the device\&. If set to NULL everyone will be able to use the device\&. -.sp -Format: string -.RE -.PP -\fBtun\&.mode\fR -.RS 4 -Alias: mode -.sp -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\&. -.sp -Format: choice (NMSettingTunMode) -.sp -Valid values: tun (1), tap (2) -.RE -.PP -\fBtun\&.multi\-queue\fR -.RS 4 -Alias: multi\-queue -.sp -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\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBtun\&.owner\fR -.RS 4 -Alias: owner -.sp -The user ID which will own the device\&. If set to NULL everyone will be able to use the device\&. -.sp -Format: string -.RE -.PP -\fBtun\&.pi\fR -.RS 4 -Alias: pi -.sp -If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBtun\&.vnet\-hdr\fR -.RS 4 -Alias: vnet\-hdr -.sp -If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.SS "vlan setting" -.PP -VLAN Settings\&. -.PP -Properties: -.PP -\fBvlan\&.egress\-priority\-map\fR -.RS 4 -Alias: egress -.sp -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"\&. -.sp -Format: list of vlan\&.egress\-priority\-map objects -.RE -.PP -\fBvlan\&.flags\fR -.RS 4 -Alias: flags -.sp -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 controller device\*(Aqs operating state)\&. "mvrp" (0x8) (use of the MVRP protocol)\&. -.sp -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\&. -.sp -Format: flags (NMVlanFlags) -.sp -Valid values: reorder\-headers (0x1), gvrp (0x2), loose\-binding (0x4), mvrp (0x8) -.RE -.PP -\fBvlan\&.id\fR -.RS 4 -Alias: id -.sp -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\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4095 -.RE -.PP -\fBvlan\&.ingress\-priority\-map\fR -.RS 4 -Alias: ingress -.sp -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"\&. -.sp -Format: list of vlan\&.ingress\-priority\-map objects -.RE -.PP -\fBvlan\&.parent\fR -.RS 4 -Alias: dev -.sp -If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created\&. If this property is not specified, the connection must contain an "802\-3\-ethernet" setting with a "mac\-address" property\&. -.sp -Format: string -.RE -.PP -\fBvlan\&.protocol\fR -.RS 4 -Specifies the VLAN protocol to use for encapsulation\&. -.sp -Supported values are: \*(Aq802\&.1Q\*(Aq, \*(Aq802\&.1ad\*(Aq\&. If not specified the default value is \*(Aq802\&.1Q\*(Aq\&. -.sp -Format: string -.sp -Valid values: 802\&.1Q, 802\&.1ad -.RE -.SS "vpn setting" -.PP -VPN Settings\&. -.PP -Properties: -.PP -\fBvpn\&.data\fR -.RS 4 -Dictionary of key/value pairs of VPN plugin specific data\&. Both keys and values must be strings\&. -.sp -Format: list of key/value options -.RE -.PP -\fBvpn\&.persistent\fR -.RS 4 -If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBvpn\&.secrets\fR -.RS 4 -Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys\&. Both keys and values must be strings\&. -.sp -Format: list of key/value options -.RE -.PP -\fBvpn\&.service\-type\fR -.RS 4 -Alias: vpn\-type -.sp -D\-Bus service name of the VPN plugin that this setting uses to connect to its network\&. i\&.e\&. org\&.freedesktop\&.NetworkManager\&.vpnc for the vpnc plugin\&. -.sp -Format: string -.RE -.PP -\fBvpn\&.timeout\fR -.RS 4 -Timeout for the VPN service to establish the connection\&. Some services may take quite a long time to connect\&. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn\&.timeout in configuration file)\&. Values greater than zero mean timeout in seconds\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBvpn\&.user\-name\fR -.RS 4 -Alias: user -.sp -If the VPN connection requires a user name for authentication, that name should be provided here\&. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty\&. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection\&. -.sp -Format: string -.RE -.SS "vrf setting" -.PP -VRF settings\&. -.PP -Properties: -.PP -\fBvrf\&.table\fR -.RS 4 -Alias: table -.sp -The routing table for this VRF\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.SS "vxlan setting" -.PP -VXLAN Settings\&. -.PP -Properties: -.PP -\fBvxlan\&.ageing\fR -.RS 4 -Specifies the lifetime in seconds of FDB entries learnt by the kernel\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBvxlan\&.destination\-port\fR -.RS 4 -Alias: destination\-port -.sp -Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint\&. -.sp -Format: integer -.sp -Valid values: 0 \- 65535 -.RE -.PP -\fBvxlan\&.id\fR -.RS 4 -Alias: id -.sp -Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use\&. -.sp -Format: integer -.sp -Valid values: 0 \- 16777215 -.RE -.PP -\fBvxlan\&.l2\-miss\fR -.RS 4 -Specifies whether netlink LL ADDR miss notifications are generated\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBvxlan\&.l3\-miss\fR -.RS 4 -Specifies whether netlink IP ADDR miss notifications are generated\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBvxlan\&.learning\fR -.RS 4 -Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBvxlan\&.limit\fR -.RS 4 -Specifies the maximum number of FDB entries\&. A value of zero means that the kernel will store unlimited entries\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBvxlan\&.local\fR -.RS 4 -Alias: local -.sp -If given, specifies the source IP address to use in outgoing packets\&. -.sp -Format: string -.RE -.PP -\fBvxlan\&.parent\fR -.RS 4 -Alias: dev -.sp -If given, specifies the parent interface name or parent connection UUID\&. -.sp -Format: string -.RE -.PP -\fBvxlan\&.proxy\fR -.RS 4 -Specifies whether ARP proxy is turned on\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBvxlan\&.remote\fR -.RS 4 -Alias: remote -.sp -Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join\&. -.sp -Format: string -.RE -.PP -\fBvxlan\&.rsc\fR -.RS 4 -Specifies whether route short circuit is turned on\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBvxlan\&.source\-port\-max\fR -.RS 4 -Alias: source\-port\-max -.sp -Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint\&. -.sp -Format: integer -.sp -Valid values: 0 \- 65535 -.RE -.PP -\fBvxlan\&.source\-port\-min\fR -.RS 4 -Alias: source\-port\-min -.sp -Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint\&. -.sp -Format: integer -.sp -Valid values: 0 \- 65535 -.RE -.PP -\fBvxlan\&.tos\fR -.RS 4 -Specifies the TOS value to use in outgoing packets\&. -.sp -Format: integer -.sp -Valid values: 0 \- 255 -.RE -.PP -\fBvxlan\&.ttl\fR -.RS 4 -Specifies the time\-to\-live value to use in outgoing packets\&. -.sp -Format: integer -.sp -Valid values: 0 \- 255 -.RE -.SS "wifi\-p2p setting" -.PP -Wi\-Fi P2P Settings\&. -.PP -Properties: -.PP -\fBwifi\-p2p\&.peer\fR -.RS 4 -Alias: peer -.sp -The P2P device that should be connected to\&. Currently, this is the only way to create or join a group\&. -.sp -Format: MAC address -.RE -.PP -\fBwifi\-p2p\&.wfd\-ies\fR -.RS 4 -The Wi\-Fi Display (WFD) Information Elements (IEs) to set\&. -.sp -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\&. -.sp -Format: bytes -.RE -.PP -\fBwifi\-p2p\&.wps\-method\fR -.RS 4 -Flags indicating which mode of WPS is to be used\&. -.sp -There\*(Aqs little point in changing the default setting as NetworkManager will automatically determine the best method to use\&. -.sp -Format: flags (NMSettingWirelessSecurityWpsMethod) -.sp -Valid values: default (0x0), disabled (0x1), auto (0x2), pbc (0x4), pin (0x8) -.RE -.SS "wimax setting" -.PP -WiMax Settings\&. -.PP -Properties: -.PP -\fBwimax\&.mac\-address\fR -.RS 4 -Alias: mac -.sp -If specified, this connection will only apply to the WiMAX device whose MAC address matches\&. This property does not change the MAC address of the device (known as MAC spoofing)\&. -.sp -This property is deprecated since version 1\&.2\&. WiMAX is no longer supported\&. -.sp -Format: string -.RE -.PP -\fBwimax\&.network\-name\fR -.RS 4 -Alias: nsp -.sp -Network Service Provider (NSP) name of the WiMAX network this connection should use\&. -.sp -This property is deprecated since version 1\&.2\&. WiMAX is no longer supported\&. -.sp -Format: MAC address -.RE -.SS "802\-3\-ethernet setting" -.PP -Alias: ethernet -.PP -Wired Ethernet Settings\&. -.PP -Properties: -.PP -\fB802\-3\-ethernet\&.accept\-all\-mac\-addresses\fR -.RS 4 -When TRUE, setup the interface to accept packets for all MAC addresses\&. This is enabling the kernel interface flag IFF_PROMISC\&. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fB802\-3\-ethernet\&.auto\-negotiate\fR -.RS 4 -When TRUE, enforce auto\-negotiation of speed and duplex mode\&. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto\-negotiation process: this works only for BASE\-T 802\&.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory\&. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fB802\-3\-ethernet\&.cloned\-mac\-address\fR -.RS 4 -Alias: cloned\-mac -.sp -If specified, request that the device use this MAC address instead\&. This is known as MAC cloning or spoofing\&. -.sp -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 if the device has one (otherwise this is treated as "preserve")\&. "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\&. -.sp -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)\&. -.sp -On D\-Bus, this field is expressed as "assigned\-mac\-address" or the deprecated "cloned\-mac\-address"\&. -.sp -Format: MAC address -.sp -Special values: preserve, permanent, random, stable -.RE -.PP -\fB802\-3\-ethernet\&.duplex\fR -.RS 4 -When a value is set, either "half" or "full", configures the device to use the specified duplex mode\&. If "auto\-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE\-T 802\&.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory\&. If the value is unset (the default), the link configuration will be either skipped (if "auto\-negotiate" is "no", the default) or will be auto\-negotiated (if "auto\-negotiate" is "yes") and the local device will advertise all the supported duplex modes\&. Must be set together with the "speed" property if specified\&. Before specifying a duplex mode be sure your device supports it\&. -.sp -Format: string -.sp -Valid values: half, full -.RE -.PP -\fB802\-3\-ethernet\&.generate\-mac\-address\-mask\fR -.RS 4 -With "cloned\-mac\-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally\-administered, unicast MAC address is created\&. This property allows to specify that certain bits are fixed\&. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address\&. -.sp -If the property is NULL, it is eligible to be overwritten by a default connection setting\&. If the value is still NULL or an empty string, the default is to create a locally\-administered, unicast MAC address\&. -.sp -If the value contains one MAC address, this address is used as mask\&. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization\&. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm\&. -.sp -If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized\&. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized\&. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally\-administered, burned\-in MAC address\&. -.sp -If the value contains more than one additional MAC addresses, one of them is chosen randomly\&. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered\&. -.sp -Format: string -.RE -.PP -\fB802\-3\-ethernet\&.mac\-address\fR -.RS 4 -Alias: mac -.sp -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)\&. -.sp -Format: MAC address -.RE -.PP -\fB802\-3\-ethernet\&.mac\-address\-blacklist\fR -.RS 4 -If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list\&. Each MAC address is in the standard hex\-digits\-and\-colons notation (00:11:22:33:44:55)\&. -.sp -Format: list of MAC addresses -.RE -.PP -\fB802\-3\-ethernet\&.mac\-address\-denylist\fR -.RS 4 -If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list\&. Each MAC address is in the standard hex\-digits\-and\-colons notation (00:11:22:33:44:55)\&. -.sp -Format: list of MAC addresses -.RE -.PP -\fB802\-3\-ethernet\&.mtu\fR -.RS 4 -Alias: mtu -.sp -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. -.sp -Format: integer -.sp -Special values: auto -.RE -.PP -\fB802\-3\-ethernet\&.port\fR -.RS 4 -Specific port type to use if the device supports multiple attachment methods\&. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface)\&. If the device supports only one port type, this setting is ignored\&. -.sp -Format: read only -.RE -.PP -\fB802\-3\-ethernet\&.s390\-nettype\fR -.RS 4 -s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems\&. -.sp -Format: string -.sp -Valid values: qeth, lcs, ctc -.RE -.PP -\fB802\-3\-ethernet\&.s390\-options\fR -.RS 4 -Dictionary of key/value pairs of s390\-specific device options\&. Both keys and values must be strings\&. Allowed keys include "portno", "layer2", "portname", "protocol", among others\&. Key names must contain only alphanumeric characters (ie, [a\-zA\-Z0\-9])\&. -.sp -Currently, NetworkManager itself does nothing with this information\&. However, s390utils ships a udev rule which parses this information and applies it to the interface\&. -.sp -Format: list of key/value options -.RE -.PP -\fB802\-3\-ethernet\&.s390\-subchannels\fR -.RS 4 -Identifies specific subchannels that this network device uses for communication with z/VM or s390 host\&. Like the "mac\-address" property for non\-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels\&. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (\&.) character\&. -.sp -Format: list of 802\-3\-ethernet\&.s390\-subchannels objects -.RE -.PP -\fB802\-3\-ethernet\&.speed\fR -.RS 4 -When a value greater than 0 is set, configures the device to use the specified speed\&. If "auto\-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE\-T 802\&.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory\&. If the value is unset (0, the default), the link configuration will be either skipped (if "auto\-negotiate" is "no", the default) or will be auto\-negotiated (if "auto\-negotiate" is "yes") and the local device will advertise all the supported speeds\&. In Mbit/s, ie 100 == 100Mbit/s\&. Must be set together with the "duplex" property when non\-zero\&. Before specifying a speed value be sure your device supports it\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fB802\-3\-ethernet\&.wake\-on\-lan\fR -.RS 4 -The NMSettingWiredWakeOnLan options to enable\&. Not all devices support all options\&. May be any combination of "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)\&. -.sp -Format: flags (NMSettingWiredWakeOnLan) -.sp -Valid values: phy (0x2), unicast (0x4), multicast (0x8), broadcast (0x10), arp (0x20), magic (0x40), default (0x1), ignore (0x8000) -.RE -.PP -\fB802\-3\-ethernet\&.wake\-on\-lan\-password\fR -.RS 4 -If specified, the password used with magic\-packet\-based Wake\-on\-LAN, represented as an Ethernet MAC address\&. If NULL, no password will be required\&. -.sp -Format: MAC address -.RE -.SS "wireguard setting" -.PP -WireGuard Settings\&. -.PP -Properties: -.PP -\fBwireguard\&.fwmark\fR -.RS 4 -The use of fwmark is optional and is by default off\&. Setting it to 0 disables it\&. Otherwise, it is a 32\-bit fwmark for outgoing packets\&. -.sp -Note that "ip4\-auto\-default\-route" or "ip6\-auto\-default\-route" enabled, implies to automatically choose a fwmark\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fBwireguard\&.ip4\-auto\-default\-route\fR -.RS 4 -Whether to enable special handling of the IPv4 default route\&. If enabled, the IPv4 default route from wireguard\&.peer\-routes will be placed to a dedicated routing\-table and two policy routing rules will be added\&. The fwmark number is also used as routing\-table for the default\-route, and if fwmark is zero, an unused fwmark/table is chosen automatically\&. This corresponds to what wg\-quick does with Table=auto and what WireGuard calls "Improved Rule\-based Routing"\&. -.sp -Note that for this automatism to work, you usually don\*(Aqt want to set ipv4\&.gateway, because that will result in a conflicting default route\&. -.sp -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\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fBwireguard\&.ip6\-auto\-default\-route\fR -.RS 4 -Like ip4\-auto\-default\-route, but for the IPv6 default route\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fBwireguard\&.listen\-port\fR -.RS 4 -The listen\-port\&. If listen\-port is not specified, the port will be chosen randomly when the interface comes up\&. -.sp -Format: integer -.sp -Valid values: 0 \- 65535 -.RE -.PP -\fBwireguard\&.mtu\fR -.RS 4 -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments\&. -.sp -If zero a default MTU is used\&. Note that contrary to wg\-quick\*(Aqs MTU setting, this does not take into account the current routes at the time of activation\&. -.sp -Format: integer -.sp -Special values: auto -.RE -.PP -\fBwireguard\&.peer\-routes\fR -.RS 4 -Whether to automatically add routes for the AllowedIPs ranges of the peers\&. If TRUE (the default), NetworkManager will automatically add routes in the routing tables according to ipv4\&.route\-table and ipv6\&.route\-table\&. Usually you want this automatism enabled\&. If FALSE, no such routes are added automatically\&. In this case, the user may want to configure static routes in ipv4\&.routes and ipv6\&.routes, respectively\&. -.sp -Note that if the peer\*(Aqs AllowedIPs is "0\&.0\&.0\&.0/0" or "::/0" and the profile\*(Aqs ipv4\&.never\-default or ipv6\&.never\-default setting is enabled, the peer route for this peer won\*(Aqt be added automatically\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fBwireguard\&.private\-key\fR -.RS 4 -The 256 bit private\-key in base64 encoding\&. -.sp -Format: string -.RE -.PP -\fBwireguard\&.private\-key\-flags\fR -.RS 4 -Flags indicating how to handle the "private\-key" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.SS "802\-11\-wireless setting" -.PP -Alias: wifi -.PP -Wi\-Fi Settings\&. -.PP -Properties: -.PP -\fB802\-11\-wireless\&.ap\-isolation\fR -.RS 4 -Configures AP isolation, which prevents communication between wireless devices connected to this AP\&. This property can be set to a value different from "default" (\-1) only when the interface is configured in AP mode\&. -.sp -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\&. -.sp -If set to "false" (0), devices can talk to each other\&. -.sp -When set to "default" (\-1), the global default is used; in case the global default is unspecified it is assumed to be "false" (0)\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fB802\-11\-wireless\&.band\fR -.RS 4 -802\&.11 frequency band of the network\&. One of "a" for 5GHz 802\&.11a or "bg" for 2\&.4GHz 802\&.11\&. This will lock associations to the Wi\-Fi network to the specific band, i\&.e\&. if "a" is specified, the device will not associate with the same network in the 2\&.4GHz band even if the network\*(Aqs settings are compatible\&. This setting depends on specific driver capability and may not work with all drivers\&. -.sp -Format: string -.sp -Valid values: a, bg -.RE -.PP -\fB802\-11\-wireless\&.bssid\fR -.RS 4 -If specified, directs the device to only associate with the given access point\&. This capability is highly driver dependent and not supported by all devices\&. Note: this property does not control the BSSID used when creating an Ad\-Hoc network and is unlikely to in the future\&. -.sp -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\&. -.sp -Format: MAC address -.RE -.PP -\fB802\-11\-wireless\&.channel\fR -.RS 4 -Wireless channel to use for the Wi\-Fi connection\&. The device will only join (or create for Ad\-Hoc networks) a Wi\-Fi network on the specified channel\&. Because channel numbers overlap between bands, this property also requires the "band" property to be set\&. -.sp -Format: integer -.sp -Valid values: 0 \- 4294967295 -.RE -.PP -\fB802\-11\-wireless\&.channel\-width\fR -.RS 4 -Specifies width of the wireless channel in Access Point (AP) mode\&. -.sp -When set to "auto" (0) (the default), the channel width is automatically determined\&. At the moment, this means that the safest (smallest) width is chosen\&. -.sp -If the value is not "auto" (0), then the \*(Aqchannel\*(Aq property must also be set\&. When using the 2\&.4GHz band, the width can be at most 40MHz\&. -.sp -This property can be set to a value different from "auto" (0) only when the interface is configured in AP mode\&. -.sp -Format: choice (NMSettingWirelessChannelWidth) -.sp -Valid values: auto (0), 20mhz (20), 40mhz (40), 80mhz (80) -.RE -.PP -\fB802\-11\-wireless\&.cloned\-mac\-address\fR -.RS 4 -Alias: cloned\-mac -.sp -If specified, request that the device use this MAC address instead\&. This is known as MAC cloning or spoofing\&. -.sp -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}"\&. -.sp -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)\&. -.sp -On D\-Bus, this field is expressed as "assigned\-mac\-address" or the deprecated "cloned\-mac\-address"\&. -.sp -Format: MAC address -.sp -Special values: preserve, permanent, random, stable, stable\-ssid -.RE -.PP -\fB802\-11\-wireless\&.generate\-mac\-address\-mask\fR -.RS 4 -With "cloned\-mac\-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally\-administered, unicast MAC address is created\&. This property allows to specify that certain bits are fixed\&. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address\&. -.sp -If the property is NULL, it is eligible to be overwritten by a default connection setting\&. If the value is still NULL or an empty string, the default is to create a locally\-administered, unicast MAC address\&. -.sp -If the value contains one MAC address, this address is used as mask\&. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization\&. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm\&. -.sp -If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized\&. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized\&. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally\-administered, burned\-in MAC address\&. -.sp -If the value contains more than one additional MAC addresses, one of them is chosen randomly\&. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered\&. -.sp -Format: string -.RE -.PP -\fB802\-11\-wireless\&.hidden\fR -.RS 4 -If TRUE, indicates that the network is a non\-broadcasting network that hides its SSID\&. This works both in infrastructure and AP mode\&. -.sp -In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe\-scanning the SSID\&. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution\&. -.sp -In AP mode, the created network does not broadcast its SSID\&. -.sp -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\&. -.sp -Format: boolean -.sp -Valid values: true/yes/on, false/no/off -.RE -.PP -\fB802\-11\-wireless\&.mac\-address\fR -.RS 4 -Alias: mac -.sp -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)\&. -.sp -Format: MAC address -.RE -.PP -\fB802\-11\-wireless\&.mac\-address\-blacklist\fR -.RS 4 -A list of permanent MAC addresses of Wi\-Fi devices to which this connection should never apply\&. Each MAC address should be given in the standard hex\-digits\-and\-colons notation (eg "00:11:22:33:44:55")\&. -.sp -Format: list of MAC addresses -.RE -.PP -\fB802\-11\-wireless\&.mac\-address\-denylist\fR -.RS 4 -A list of permanent MAC addresses of Wi\-Fi devices to which this connection should never apply\&. Each MAC address should be given in the standard hex\-digits\-and\-colons notation (eg "00:11:22:33:44:55")\&. -.sp -Format: list of MAC addresses -.RE -.PP -\fB802\-11\-wireless\&.mac\-address\-randomization\fR -.RS 4 -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)\&. -.sp -This property is deprecated since version 1\&.4\&. Use the "cloned\-mac\-address" property instead\&. -.sp -Format: choice (NMSettingMacRandomization) -.sp -Valid values: default (0), never (1), always (2) -.RE -.PP -\fB802\-11\-wireless\&.mode\fR -.RS 4 -Alias: mode -.sp -Wi\-Fi network mode; one of "infrastructure", "mesh", "adhoc" or "ap"\&. If blank, infrastructure is assumed\&. -.sp -Format: string -.sp -Valid values: infrastructure, adhoc, ap, mesh -.RE -.PP -\fB802\-11\-wireless\&.mtu\fR -.RS 4 -Alias: mtu -.sp -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. -.sp -Format: integer -.sp -Special values: auto -.RE -.PP -\fB802\-11\-wireless\&.powersave\fR -.RS 4 -One of "disable" (2) (disable Wi\-Fi power saving), "enable" (3) (enable Wi\-Fi power saving), "ignore" (1) (don\*(Aqt touch currently configure setting) or "default" (0) (use the globally configured value)\&. All other values are reserved\&. -.sp -Format: choice (NMSettingWirelessPowersave) -.sp -Valid values: default (0), ignore (1), disable (2), enable (3) -.RE -.PP -\fB802\-11\-wireless\&.seen\-bssids\fR -.RS 4 -A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi\-Fi network\&. NetworkManager internally tracks previously seen BSSIDs\&. The property is only meant for reading and reflects the BSSID list of NetworkManager\&. The changes you make to this property will not be preserved\&. -.sp -This is not a regular property that the user would configure\&. Instead, NetworkManager automatically sets the seen BSSIDs and tracks them internally in "/var/lib/NetworkManager/seen\-bssids" file\&. -.sp -Format: read only -.RE -.PP -\fB802\-11\-wireless\&.ssid\fR -.RS 4 -Alias: ssid -.sp -SSID of the Wi\-Fi network\&. Must be specified\&. -.sp -Format: string -.RE -.PP -\fB802\-11\-wireless\&.wake\-on\-wlan\fR -.RS 4 -The NMSettingWirelessWakeOnWLan options to enable\&. Not all devices support all options\&. May be any combination of "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)\&. -.sp -Format: flags (NMSettingWirelessWakeOnWLan) -.sp -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) -.RE -.SS "802\-11\-wireless\-security setting" -.PP -Alias: wifi\-sec -.PP -Wi\-Fi Security Settings\&. -.PP -Properties: -.PP -\fB802\-11\-wireless\-security\&.auth\-alg\fR -.RS 4 -When WEP is used (ie, key\-mgmt = "none" or "ieee8021x") indicate the 802\&.11 authentication algorithm required by the AP here\&. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP\&. When using Cisco LEAP (ie, key\-mgmt = "ieee8021x" and auth\-alg = "leap") the "leap\-username" and "leap\-password" properties must be specified\&. -.sp -Format: string -.sp -Valid values: open, shared, leap -.RE -.PP -\fB802\-11\-wireless\-security\&.fils\fR -.RS 4 -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\&. -.sp -Format: choice (NMSettingWirelessSecurityFils) -.sp -Valid values: default (0), disable (1), optional (2), required (3) -.RE -.PP -\fB802\-11\-wireless\-security\&.group\fR -.RS 4 -A list of group/broadcast encryption algorithms which prevents connections to Wi\-Fi networks that do not utilize one of the algorithms in the list\&. For maximum compatibility leave this property empty\&. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp"\&. -.sp -Format: list of strings -.sp -Valid values: wep40, wep104, tkip, ccmp -.RE -.PP -\fB802\-11\-wireless\-security\&.key\-mgmt\fR -.RS 4 -Key management used for the connection\&. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa\-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa\-eap" (WPA2 + WPA3 enterprise) or "wpa\-eap\-suite\-b\-192" (WPA3 enterprise only)\&. -.sp -This property must be set for any Wi\-Fi connection that uses security\&. -.sp -Format: string -.sp -Valid values: none, ieee8021x, wpa\-psk, wpa\-eap, wpa\-eap\-suite\-b\-192, sae, owe -.RE -.PP -\fB802\-11\-wireless\-security\&.leap\-password\fR -.RS 4 -The login password for legacy LEAP connections (ie, key\-mgmt = "ieee8021x" and auth\-alg = "leap")\&. -.sp -Format: string -.RE -.PP -\fB802\-11\-wireless\-security\&.leap\-password\-flags\fR -.RS 4 -Flags indicating how to handle the "leap\-password" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fB802\-11\-wireless\-security\&.leap\-username\fR -.RS 4 -The login username for legacy LEAP connections (ie, key\-mgmt = "ieee8021x" and auth\-alg = "leap")\&. -.sp -Format: string -.RE -.PP -\fB802\-11\-wireless\-security\&.pairwise\fR -.RS 4 -A list of pairwise encryption algorithms which prevents connections to Wi\-Fi networks that do not utilize one of the algorithms in the list\&. For maximum compatibility leave this property empty\&. Each list element may be one of "tkip" or "ccmp"\&. -.sp -Format: list of strings -.sp -Valid values: tkip, ccmp -.RE -.PP -\fB802\-11\-wireless\-security\&.pmf\fR -.RS 4 -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\&. -.sp -Format: choice (NMSettingWirelessSecurityPmf) -.sp -Valid values: default (0), disable (1), optional (2), required (3) -.RE -.PP -\fB802\-11\-wireless\-security\&.proto\fR -.RS 4 -List of strings specifying the allowed WPA protocol versions to use\&. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN)\&. If not specified, both WPA and RSN connections are allowed\&. -.sp -Format: list of strings -.sp -Valid values: wpa, rsn -.RE -.PP -\fB802\-11\-wireless\-security\&.psk\fR -.RS 4 -Pre\-Shared\-Key for WPA networks\&. For WPA\-PSK, it\*(Aqs either an ASCII passphrase of 8 to 63 characters that is (as specified in the 802\&.11i standard) hashed to derive the actual key, or the key in form of 64 hexadecimal character\&. The WPA3\-Personal networks use a passphrase of any length for SAE authentication\&. -.sp -Format: string -.RE -.PP -\fB802\-11\-wireless\-security\&.psk\-flags\fR -.RS 4 -Flags indicating how to handle the "psk" property\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fB802\-11\-wireless\-security\&.wep\-key\-flags\fR -.RS 4 -Flags indicating how to handle the "wep\-key0", "wep\-key1", "wep\-key2", and "wep\-key3" properties\&. -.sp -Format: flags (NMSettingSecretFlags) -.sp -Valid values: none (0x0), agent\-owned (0x1), not\-saved (0x2), not\-required (0x4) -.RE -.PP -\fB802\-11\-wireless\-security\&.wep\-key\-type\fR -.RS 4 -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\&. -.sp -Format: choice (NMWepKeyType) -.sp -Valid values: unknown (0), key (1), passphrase (2) -.RE -.PP -\fB802\-11\-wireless\-security\&.wep\-key0\fR -.RS 4 -Index 0 WEP key\&. This is the WEP key used in most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. -.sp -Format: string -.RE -.PP -\fB802\-11\-wireless\-security\&.wep\-key1\fR -.RS 4 -Index 1 WEP key\&. This WEP index is not used by most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. -.sp -Format: string -.RE -.PP -\fB802\-11\-wireless\-security\&.wep\-key2\fR -.RS 4 -Index 2 WEP key\&. This WEP index is not used by most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. -.sp -Format: string -.RE -.PP -\fB802\-11\-wireless\-security\&.wep\-key3\fR -.RS 4 -Index 3 WEP key\&. This WEP index is not used by most networks\&. See the "wep\-key\-type" property for a description of how this key is interpreted\&. -.sp -Format: string -.RE -.PP -\fB802\-11\-wireless\-security\&.wep\-tx\-keyidx\fR -.RS 4 -When static WEP is used (ie, key\-mgmt = "none") and a non\-default WEP key index is used by the AP, put that WEP key index here\&. Valid values are 0 (default key) through 3\&. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 \- 4\&. -.sp -Format: integer -.sp -Valid values: 0 \- 3 -.RE -.PP -\fB802\-11\-wireless\-security\&.wps\-method\fR -.RS 4 -Flags indicating which mode of WPS is to be used if any\&. -.sp -There\*(Aqs little point in changing the default setting as NetworkManager will automatically determine whether it\*(Aqs feasible to start WPS enrollment from the Access Point capabilities\&. -.sp -WPS can be disabled by setting this property to a value of 1\&. -.sp -Format: flags (NMSettingWirelessSecurityWpsMethod) -.sp -Valid values: default (0x0), disabled (0x1), auto (0x2), pbc (0x4), pin (0x8) -.RE -.SS "wpan setting" -.PP -IEEE 802\&.15\&.4 (WPAN) MAC Settings\&. -.PP -Properties: -.PP -\fBwpan\&.channel\fR -.RS 4 -Alias: channel -.sp -IEEE 802\&.15\&.4 channel\&. A positive integer or \-1, meaning "do not set, use whatever the device is already set to"\&. -.sp -Format: integer -.sp -Valid values: \-32768 \- 32767 -.sp -Special values: default (\-1) -.RE -.PP -\fBwpan\&.mac\-address\fR -.RS 4 -Alias: mac -.sp -If specified, this connection will only apply to the IEEE 802\&.15\&.4 (WPAN) MAC layer device whose permanent MAC address matches\&. -.sp -Format: WPAN MAC address -.RE -.PP -\fBwpan\&.page\fR -.RS 4 -Alias: page -.sp -IEEE 802\&.15\&.4 channel page\&. A positive integer or \-1, meaning "do not set, use whatever the device is already set to"\&. -.sp -Format: integer -.sp -Valid values: \-32768 \- 32767 -.sp -Special values: default (\-1) -.RE -.PP -\fBwpan\&.pan\-id\fR -.RS 4 -Alias: pan\-id -.sp -IEEE 802\&.15\&.4 Personal Area Network (PAN) identifier\&. -.sp -Format: integer -.sp -Valid values: 0 \- 65535 -.sp -Special values: unset (0xffff) -.RE -.PP -\fBwpan\&.short\-address\fR -.RS 4 -Alias: short\-addr -.sp -Short IEEE 802\&.15\&.4 address to be used within a restricted environment\&. -.sp -Format: integer -.sp -Valid values: 0 \- 65535 -.sp -Special values: unset (0xffff) -.RE -.SS "bond\-port setting" -.PP -Bond Port Settings\&. -.PP -Properties: -.PP -\fBbond\-port\&.prio\fR -.RS 4 -Alias: prio -.sp -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\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.RE -.PP -\fBbond\-port\&.queue\-id\fR -.RS 4 -Alias: queue\-id -.sp -The queue ID of this bond port\&. The maximum value of queue ID is the number of TX queues currently active in device\&. -.sp -Format: integer -.sp -Valid values: 0 \- 65535 -.RE -.SS "hostname setting" -.PP -Hostname settings\&. -.PP -Properties: -.PP -\fBhostname\&.from\-dhcp\fR -.RS 4 -Whether the system hostname can be determined from DHCP on this connection\&. -.sp -When set to "default" (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be "true" (1)\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fBhostname\&.from\-dns\-lookup\fR -.RS 4 -Whether the system hostname can be determined from reverse DNS lookup of addresses on this device\&. -.sp -When set to "default" (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be "true" (1)\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fBhostname\&.only\-from\-default\fR -.RS 4 -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)\&. -.sp -If set to "false" (0), the hostname can be set from this device even if it doesn\*(Aqt have the default route\&. -.sp -When set to "default" (\-1), the value from global configuration is used\&. If the property doesn\*(Aqt have a value in the global configuration, NetworkManager assumes the value to be "false" (0)\&. -.sp -Format: ternary -.sp -Valid values: true/yes/on, false/no/off, default/unknown -.RE -.PP -\fBhostname\&.priority\fR -.RS 4 -The relative priority of this connection to determine the system hostname\&. A lower numerical value is better (higher priority)\&. A connection with higher priority is considered before connections with lower priority\&. -.sp -If the value is zero, it can be overridden by a global value from NetworkManager configuration\&. If the property doesn\*(Aqt have a value in the global configuration, the value is assumed to be 100\&. -.sp -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\&. -.sp -Format: integer -.sp -Valid values: \-2147483648 \- 2147483647 -.RE -.SS "link setting" -.PP -Link settings\&. -.PP -Properties: -.PP -\fBlink\&.gro\-max\-size\fR -.RS 4 -The maximum size of a packet built by the Generic Receive Offload stack for this device\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 4294967295 -.sp -Special values: default (\-1) -.RE -.PP -\fBlink\&.gso\-max\-segments\fR -.RS 4 -The maximum segments of a Generic Segment Offload packet the device should accept\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 4294967295 -.sp -Special values: default (\-1) -.RE -.PP -\fBlink\&.gso\-max\-size\fR -.RS 4 -The maximum size of a Generic Segment Offload packet the device should accept\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 4294967295 -.sp -Special values: default (\-1) -.RE -.PP -\fBlink\&.tx\-queue\-length\fR -.RS 4 -The size of the transmit queue for the device, in number of packets\&. The value must be between 0 and 4294967295\&. When set to \-1, the existing value is preserved\&. -.sp -Format: integer -.sp -Valid values: \-1 \- 4294967295 -.sp -Special values: default (\-1) -.RE -.SS "loopback setting" -.PP -Loopback Link Settings\&. -.PP -Properties: -.PP -\fBloopback\&.mtu\fR -.RS 4 -Alias: mtu -.sp -If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames\&. -.sp -Format: integer -.sp -Special values: auto -.RE -.SS "veth setting" -.PP -Veth Settings\&. -.PP -Properties: -.PP -\fBveth\&.peer\fR -.RS 4 -Alias: peer -.sp -This property specifies the peer interface name of the veth\&. This property is mandatory\&. -.sp -Format: string -.RE -.SS "Secret flag types:" -.PP -Each password or secret property in a setting has an associated -\fIflags\fR -property that describes how to handle that secret\&. The -\fIflags\fR -property is a bitfield that contains zero or more of the following values logically OR\-ed together\&. -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -0x0 (none) \- the system is responsible for providing and storing this secret\&. This may be required so that secrets are already available before the user logs in\&. It also commonly means that the secret will be stored in plain text on disk, accessible to root only\&. For example via the keyfile settings plugin as described in the "PLUGINS" section in -\fBNetworkManager.conf\fR(5)\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -0x1 (agent\-owned) \- a user\-session secret agent is responsible for providing and storing this secret; when it is required, agents will be asked to provide it\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -0x2 (not\-saved) \- this secret should not be saved but should be requested from the user each time it is required\&. This flag should be used for One\-Time\-Pad secrets, PIN codes from hardware tokens, or if the user simply does not want to save the secret\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -0x4 (not\-required) \- in some situations it cannot be automatically determined that a secret is required or not\&. This flag hints that the secret is not required and should not be requested from the user\&. -.RE -.SH "FILES" -.PP -/etc/NetworkManager/system\-connections -or distro plugin\-specific location -.SH "SEE ALSO" -.PP -\fBnmcli\fR(1), -\fBnmcli-examples\fR(7), -\fBNetworkManager\fR(8), -\fBnm-settings-dbus\fR(5), -\fBnm-settings-keyfile\fR(5), -\fBNetworkManager.conf\fR(5) diff --git a/man/nmcli-examples.7 b/man/nmcli-examples.7 deleted file mode 100644 index bbeacfed..00000000 --- a/man/nmcli-examples.7 +++ /dev/null @@ -1,835 +0,0 @@ -'\" t -.\" Title: nmcli-examples -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: Examples -.\" Source: NetworkManager 1.50.0 -.\" Language: English -.\" -.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.50\&.0" "Examples" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nmcli-examples \- usage examples of nmcli -.SH "SYNOPSIS" -.HP \w'\fBnmcli\fR\ 'u -\fBnmcli\fR [OPTIONS...] -.SH "DESCRIPTION" -.PP -\fInmcli\fR -is a command\-line client for NetworkManager\&. It allows controlling NetworkManager and reporting its status\&. For more information please refer to -\fBnmcli\fR(1) -manual page\&. -.PP -The purpose of this manual page is to provide you with various examples and usage scenarios of -\fInmcli\fR\&. -.SH "EXAMPLES" -.PP -\fBExample\ \&1.\ \&Listing available Wi\-Fi APs\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli device wifi list\fR -* SSID MODE CHAN RATE SIGNAL BARS SECURITY - netdatacomm_local Infra 6 54 Mbit/s 37 â–‚â–„__ WEP -* F1 Infra 11 54 Mbit/s 98 ▂▄▆█ WPA1 - LoremCorp Infra 1 54 Mbit/s 62 â–‚â–„â–†_ WPA2 802\&.1X - Internet Infra 6 54 Mbit/s 29 â–‚___ WPA1 - HPB110a\&.F2672A Ad\-Hoc 6 54 Mbit/s 22 â–‚___ \-\- - Jozinet Infra 1 54 Mbit/s 19 â–‚___ WEP - VOIP Infra 1 54 Mbit/s 20 â–‚___ WEP - MARTINA Infra 4 54 Mbit/s 32 â–‚â–„__ WPA2 - N24PU1 Infra 7 11 Mbit/s 22 â–‚___ \-\- - alfa Infra 1 54 Mbit/s 67 â–‚â–„â–†_ WPA2 - bertnet Infra 5 54 Mbit/s 20 â–‚___ WPA1 WPA2 -.fi -.if n \{\ -.RE -.\} -.PP -This command shows how to list available Wi\-Fi networks (APs)\&. You can also use -\fI\-\-fields\fR -option for displaying different columns\&. -\fBnmcli \-f all dev wifi list\fR -will show all of them\&. -.PP -\fBExample\ \&2.\ \&Connect to a password\-protected wifi network\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli device wifi connect "$SSID" password "$PASSWORD"\fR -.fi -.if n \{\ -.RE -.\} -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-\-ask device wifi connect "$SSID"\fR -.fi -.if n \{\ -.RE -.\} -.PP -\fBExample\ \&3.\ \&Showing general information and properties for a Wi\-Fi interface\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-p \-f general,wifi\-properties device show wlan0\fR -=========================================================================== - Device details (wlan0) -=========================================================================== -GENERAL\&.DEVICE: wlan0 -GENERAL\&.TYPE: wifi -GENERAL\&.VENDOR: Intel Corporation -GENERAL\&.PRODUCT: PRO/Wireless 5100 AGN [Shiloh] Network Connection -GENERAL\&.DRIVER: iwlwifi -GENERAL\&.DRIVER\-VERSION: 3\&.8\&.13\-100\&.fc17\&.x86_64 -GENERAL\&.FIRMWARE\-VERSION: 8\&.83\&.5\&.1 build 33692 -GENERAL\&.HWADDR: 00:1E:65:37:A1:D3 -GENERAL\&.MTU: 1500 -GENERAL\&.STATE: 100 (connected) -GENERAL\&.REASON: 0 (No reason given) -GENERAL\&.UDI: /sys/devices/pci0000:00/0000:00:1c\&.1/net/wlan0 -GENERAL\&.IP\-IFACE: wlan0 -GENERAL\&.IS\-SOFTWARE: no -GENERAL\&.NM\-MANAGED: yes -GENERAL\&.AUTOCONNECT: yes -GENERAL\&.FIRMWARE\-MISSING: no -GENERAL\&.CONNECTION: My Alfa WiFi -GENERAL\&.CON\-UUID: 85194f4c\-d496\-4eec\-bae0\-d880b4cbcf26 -GENERAL\&.CON\-PATH: /org/freedesktop/NetworkManager/ActiveConnection/ -10 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -WIFI\-PROPERTIES\&.WEP: yes -WIFI\-PROPERTIES\&.WPA: yes -WIFI\-PROPERTIES\&.WPA2: yes -WIFI\-PROPERTIES\&.TKIP: yes -WIFI\-PROPERTIES\&.CCMP: yes -WIFI\-PROPERTIES\&.AP: no -WIFI\-PROPERTIES\&.ADHOC: yes -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -.fi -.if n \{\ -.RE -.\} -.PP -This command shows information about a Wi\-Fi device\&. -.PP -\fBExample\ \&4.\ \&Listing NetworkManager polkit permissions\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli general permissions\fR -PERMISSION VALUE -org\&.freedesktop\&.NetworkManager\&.enable\-disable\-network yes -org\&.freedesktop\&.NetworkManager\&.enable\-disable\-wifi yes -org\&.freedesktop\&.NetworkManager\&.enable\-disable\-wwan yes -org\&.freedesktop\&.NetworkManager\&.enable\-disable\-wimax yes -org\&.freedesktop\&.NetworkManager\&.sleep\-wake no -org\&.freedesktop\&.NetworkManager\&.network\-control yes -org\&.freedesktop\&.NetworkManager\&.wifi\&.share\&.protected yes -org\&.freedesktop\&.NetworkManager\&.wifi\&.share\&.open yes -org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.system yes -org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.own yes -org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.hostname auth -org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.global\-dns auth -org\&.freedesktop\&.NetworkManager\&.reload auth -.fi -.if n \{\ -.RE -.\} -.PP -This command shows configured polkit permissions for various NetworkManager operations\&. These permissions or actions (using polkit language) are configured by a system administrator and are not meant to be changed by users\&. The usual place for the polkit configuration is /usr/share/polkit\-1/actions/org\&.freedesktop\&.NetworkManager\&.policy\&. -\fIpkaction\fR -command can display description for polkit actions\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -\fB - pkaction \-\-action\-id org\&.freedesktop\&.NetworkManager\&.network\-control \-\-verbose - \fR -.fi -.if n \{\ -.RE -.\} -.sp -More information about polkit can be found at http://www\&.freedesktop\&.org/wiki/Software/polkit\&. -.PP -\fBExample\ \&5.\ \&Listing NetworkManager log level and domains\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli general logging\fR -LEVEL DOMAINS -INFO PLATFORM,RFKILL,ETHER,WIFI,BT,MB,DHCP4,DHCP6,PPP,WIFI_SCAN,IP4,IP6,A -UTOIP4,DNS,VPN,SHARING,SUPPLICANT,AGENTS,SETTINGS,SUSPEND,CORE,DEVICE,OLPC, -WIMAX,INFINIBAND,FIREWALL,ADSL,BOND,VLAN,BRIDGE,DBUS_PROPS,TEAM,CONCHECK,DC -B,DISPATCH -.fi -.if n \{\ -.RE -.\} -.PP -This command shows current NetworkManager logging status\&. -.PP -\fBExample\ \&6.\ \&Changing NetworkManager logging\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli g log level DEBUG domains CORE,ETHER,IP\fR -$ \fBnmcli g log level INFO domains DEFAULT\fR -.fi -.if n \{\ -.RE -.\} -.PP -The first command makes NetworkManager log in DEBUG level, and only for CORE, ETHER and IP domains\&. The second command restores the default logging state\&. Please refer to the -\fBNetworkManager.conf\fR(5) -manual page for available logging levels and domains\&. -.PP -\fBExample\ \&7.\ \&Activating a VPN connection profile requiring interactive password input\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-\-ask con up my\-vpn\-con\fR -.fi -.if n \{\ -.RE -.\} -.PP -This command activates a VPN connection profile enabling nmcli to interact with the user (\*(Aq\-\-ask\*(Aq): this will allow nmcli to prompt for the VPN password on the command line when the -\fIpassword\-flags\fR -are set to \*(Aq0x02\*(Aq (\*(Aqalways ask\*(Aq, see -\fBnm-settings-nmcli\fR(5) -)\&. This is particularly useful for OTP based VPNs, as the user needs to be prompted for the password each time the connection is activated\&. -.PP -\fBExample\ \&8.\ \&Adding a bonding controller and two port connection profiles\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli con add type bond ifname mybond0 mode active\-backup\fR -$ \fBnmcli con add type ethernet ifname eth1 controller mybond0\fR -$ \fBnmcli con add type ethernet ifname eth2 controller mybond0\fR -.fi -.if n \{\ -.RE -.\} -.PP -This example demonstrates adding a bond controller connection and two ports\&. The first command adds a controller bond connection, naming the bonding interface -\fImybond0\fR -and using -\fIactive\-backup\fR -mode\&. The next two commands add port connections, both attached as port to -\fImybond0\fR\&. The first port will be bound to -\fIeth1\fR -interface, the second to -\fIeth2\fR\&. -.PP -\fBExample\ \&9.\ \&Adding a team controller and two port connection profiles\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli con add type team con\-name Team1 ifname Team1 config team1\-controller\-json\&.conf\fR -$ \fBnmcli con add type ethernet con\-name Team1\-port1 ifname em1 controller Team1\fR -$ \fBnmcli con add type ethernet con\-name Team1\-port2 ifname em2 controller Team1\fR -.fi -.if n \{\ -.RE -.\} -.PP -This example demonstrates adding a team controller connection profile and two ports\&. It is very similar to the bonding example\&. The first command adds a controller team profile, naming the team interface and the profile -\fITeam1\fR\&. The team configuration for the controller is read from -\fIteam1\-controller\-json\&.conf\fR -file\&. Later, you can change the configuration with -\fImodify\fR -command (\fBnmcli con modify Team1 team\&.config team1\-controller\-another\-json\&.conf\fR)\&. The last two commands add port profiles, both attached as port to -\fITeam1\fR\&. The first port will be bound to the -\fIem1\fR -interface, the second to -\fIem2\fR\&. The ports don\*(Aqt specify -\fIconfig\fR -and thus -\fIteamd\fR -will use its default configuration\&. You will activate the whole setup by activating both ports: -.sp -.if n \{\ -.RS 4 -.\} -.nf - $ \fBnmcli con up Team1\-port1\fR - $ \fBnmcli con up Team1\-port2\fR -.fi -.if n \{\ -.RE -.\} -.sp -By default, the created profiles are marked for auto\-activation\&. But if another connection has been activated on the device, the new profile won\*(Aqt activate automatically and you need to activate it manually\&. -.PP -\fBExample\ \&10.\ \&Adding a bridge and two port profiles\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli con add type bridge con\-name TowerBridge ifname TowerBridge\fR -$ \fBnmcli con add type ethernet con\-name br\-port\-1 ifname ens3 controller TowerBridge\fR -$ \fBnmcli con add type ethernet con\-name br\-port\-2 ifname ens4 controller TowerBridge\fR -$ \fBnmcli con modify TowerBridge bridge\&.stp no\fR -.fi -.if n \{\ -.RE -.\} -.PP -This example demonstrates adding a bridge controller connection and two ports\&. The first command adds a controller bridge connection, naming the bridge interface and the profile as -\fITowerBridge\fR\&. The next two commands add ports profiles, both will be attached as port to -\fITowerBridge\fR\&. The first port will be tied to -\fIens3\fR -interface, the second to -\fIens4\fR\&. The last command will disable 802\&.1D STP for the TowerBridge profile\&. -.PP -\fBExample\ \&11.\ \&Adding an ethernet connection profile with manual IP configuration\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli con add con\-name my\-con\-em1 ifname em1 type ethernet \e - ip4 192\&.168\&.100\&.100/24 gw4 192\&.168\&.100\&.1 ip4 1\&.2\&.3\&.4 ip6 abbe::cafe\fR -$ \fBnmcli con mod my\-con\-em1 ipv4\&.dns "8\&.8\&.8\&.8 8\&.8\&.4\&.4"\fR -$ \fBnmcli con mod my\-con\-em1 +ipv4\&.dns 1\&.2\&.3\&.4\fR -$ \fBnmcli con mod my\-con\-em1 ipv6\&.dns "2001:4860:4860::8888 2001:4860:4860::8844"\fR -$ \fBnmcli \-p con show my\-con\-em1\fR -.fi -.if n \{\ -.RE -.\} -.PP -The first command adds an Ethernet connection profile named -\fImy\-con\-em1\fR -that is bound to interface name -\fIem1\fR\&. The profile is configured with static IP addresses\&. Three addresses are added, two IPv4 addresses and one IPv6\&. The first IP 192\&.168\&.100\&.100 has a prefix of 24 (netmask equivalent of 255\&.255\&.255\&.0)\&. Gateway entry will become the default route if this profile is activated on em1 interface (and there is no connection with higher priority)\&. The next two addresses do not specify a prefix, so a default prefix will be used, i\&.e\&. 32 for IPv4 and 128 for IPv6\&. The second, third and fourth commands modify DNS parameters of the new connection profile\&. The last -\fIcon show\fR -command displays the profile so that all parameters can be reviewed\&. -.PP -\fBExample\ \&12.\ \&Convenient field values retrieval for scripting\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-g ip4\&.address connection show my\-con\-eth0\fR -192\&.168\&.1\&.12/24 -.fi -.if n \{\ -.RE -.\} -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-g ip4\&.address,ip4\&.dns connection show my\-con\-eth0\fR -192\&.168\&.1\&.12/24 -192\&.168\&.1\&.1 -.fi -.if n \{\ -.RE -.\} -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-g ip4 connection show my\-con\-eth0\fR -IP4:192\&.168\&.1\&.12/24:192\&.168\&.1\&.1::192\&.168\&.1\&.1:: -.fi -.if n \{\ -.RE -.\} -.PP -This example shows retrieval of ip4 connection field values via the \-\-get\-values option\&. Multiple comma separated fields can be provided: they will be printed one per line\&. If a whole section is provided instead of a single field, the name of the section will be printed followed by all the related field values on the same line\&. See also \-\-terse, \-\-mode, \-\-fields and \-\-escape options in -\fBnmcli\fR(1) -manual page for more customized output\&. -.PP -\fBExample\ \&13.\ \&Adding an Ethernet connection and configuring SR\-IOV VFs\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli con add type ethernet con\-name EthernetPF ifname em1\fR -$ \fBnmcli con modify EthernetPF sriov\&.total\-vfs 3 sriov\&.autoprobe\-drivers false\fR -$ \fBnmcli con modify EthernetPF sriov\&.vfs \*(Aq0 mac=00:11:22:33:44:55 vlans=10, 1 trust=true spoof\-check=false\*(Aq\fR -$ \fBnmcli con modify EthernetPF +sriov\&.vfs \*(Aq2 max\-tx\-rate=20\*(Aq\fR -.fi -.if n \{\ -.RE -.\} -.PP -This example demonstrates adding an Ethernet connection for physical function (PF) -\fIens4\fR -and configuring 3 SR\-IOV virtual functions (VFs) on it\&. The first VF is configured with MAC address 00:11:22:33:44:55 and VLAN 10, the second one has the -\fItrust\fR -and -\fIspoof\-check\fR -features respectively enabled and disabled\&. VF number 2 has a maximum transmission rate of 20Mbps\&. The kernel is instructed to not automatically instantiate a network interface for the VFs\&. -.PP -\fBExample\ \&14.\ \&Escaping colon characters in tabular mode\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-t \-f general \-e yes \-m tab dev show eth0\fR -GENERAL:eth0:ethernet:Intel Corporation:82567LM Gigabit Network Connection: -e1000e:2\&.1\&.4\-k:1\&.8\-3:00\e:22\e:68\e:15\e:29\e:21:1500:100 (connected):0 (No reas -on given):/sys/devices/pci0000\e:00/0000\e:00\e:19\&.0/net/eth0:eth0:yes:yes:no: -ethernet\-13:89cbcbc6\-dc85\-456c\-9c8b\-bd828fee3917:/org/freedesktop/NetworkMa -nager/ActiveConnection/9 -.fi -.if n \{\ -.RE -.\} -.PP -This example shows escaping colon characters in tabular mode\&. It may be useful for script processing, because \*(Aq:\*(Aq is used as a field separator\&. -.PP -\fBExample\ \&15.\ \&nmcli usage in a NetworkManager dispatcher script to make Ethernet and Wi\-Fi mutually exclusive\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -#!/bin/bash -export LC_ALL=C - -enable_disable_wifi () -{ - result=$(nmcli dev | grep "ethernet" | grep \-w "connected") - if [ \-n "$result" ]; then - nmcli radio wifi off - else - nmcli radio wifi on - fi -} - -if [ "$2" = "up" ]; then - enable_disable_wifi -fi - -if [ "$2" = "down" ]; then - enable_disable_wifi -fi - -.fi -.if n \{\ -.RE -.\} -.PP -This dispatcher script makes Wi\-Fi mutually exclusive with wired networking\&. When a wired interface is connected, Wi\-Fi will be set to airplane mode (rfkilled)\&. When the wired interface is disconnected, Wi\-Fi will be turned back on\&. Name this script e\&.g\&. 70\-wifi\-wired\-exclusive\&.sh and put it into /etc/NetworkManager/dispatcher\&.d/ directory\&. See -\fBNetworkManager\fR(8) -manual page for more information about NetworkManager dispatcher scripts\&. -.PP -\fBExample sessions of interactive connection editor\fR -.PP -\fBExample\ \&16.\ \&Adding an ethernet connection profile in interactive editor (a)\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli connection edit type ethernet\fR - -===| nmcli interactive connection editor |=== - -Adding a new \*(Aq802\-3\-ethernet\*(Aq connection - -Type \*(Aqhelp\*(Aq or \*(Aq?\*(Aq for available commands\&. -Type \*(Aqdescribe [<setting>\&.<prop>]\*(Aq for detailed property description\&. - -You may edit the following settings: connection, 802\-3\-ethernet (ethernet), -802\-1x, ipv4, ipv6, dcb -nmcli> \fBprint\fR -=========================================================================== - Connection details -=========================================================================== -connection\&.id: ethernet\-4 -connection\&.uuid: de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4 -connection\&.interface\-name: \-\- -connection\&.type: 802\-3\-ethernet -connection\&.autoconnect: yes -connection\&.autoconnect\-priority: 0 -connection\&.timestamp: 0 -connection\&.read\-only: no -connection\&.permissions: -connection\&.zone: \-\- -connection\&.controller: \-\- -connection\&.port\-type: \-\- -connection\&.secondaries: -connection\&.gateway\-ping\-timeout: 0 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -802\-3\-ethernet\&.port: \-\- -802\-3\-ethernet\&.speed: 0 -802\-3\-ethernet\&.duplex: \-\- -802\-3\-ethernet\&.auto\-negotiate: yes -802\-3\-ethernet\&.mac\-address: \-\- -802\-3\-ethernet\&.cloned\-mac\-address: \-\- -802\-3\-ethernet\&.mac\-address\-blacklist: -802\-3\-ethernet\&.mtu: auto -802\-3\-ethernet\&.s390\-subchannels: -802\-3\-ethernet\&.s390\-nettype: \-\- -802\-3\-ethernet\&.s390\-options: -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv4\&.method: auto -ipv4\&.dns: -ipv4\&.dns\-search: -ipv4\&.addresses: -ipv4\&.gateway: \-\- -ipv4\&.routes: -ipv4\&.route\-metric: \-1 -ipv4\&.ignore\-auto\-routes: no -ipv4\&.ignore\-auto\-dns: no -ipv4\&.dhcp\-client\-id: \-\- -ipv4\&.dhcp\-send\-hostname: yes -ipv4\&.dhcp\-hostname: \-\- -ipv4\&.never\-default: no -ipv4\&.may\-fail: yes -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv6\&.method: auto -ipv6\&.dns: -ipv6\&.dns\-search: -ipv6\&.addresses: -ipv6\&.gateway: \-\- -ipv6\&.routes: -ipv6\&.route\-metric: \-1 -ipv6\&.ignore\-auto\-routes: no -ipv6\&.ignore\-auto\-dns: no -ipv6\&.never\-default: no -ipv6\&.may\-fail: yes -ipv6\&.ip6\-privacy: \-1 (unknown) -ipv6\&.dhcp\-hostname: \-\- -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -nmcli> \fBgoto ethernet\fR -You may edit the following properties: port, speed, duplex, auto\-negotiate, - mac\-address, cloned\-mac\-address, mac\-address\-blacklist, mtu, s390\-subchann -els, s390\-nettype, s390\-options -nmcli 802\-3\-ethernet> set mtu 1492 -nmcli 802\-3\-ethernet> b -nmcli> \fBgoto ipv4\&.addresses\fR -nmcli ipv4\&.addresses> desc - -=== [addresses] === -[NM property description] -Array of IP addresses\&. - -[nmcli specific description] -Enter a list of IPv4 addresses formatted as: - ip[/prefix], ip[/prefix],\&.\&.\&. -Missing prefix is regarded as prefix of 32\&. - -Example: 192\&.168\&.1\&.5/24, 10\&.0\&.0\&.11/24 - -nmcli ipv4\&.addresses> set 192\&.168\&.1\&.100/24 -Do you also want to set \*(Aqipv4\&.method\*(Aq to \*(Aqmanual\*(Aq? [yes]: yes -nmcli ipv4\&.addresses> -nmcli ipv4\&.addresses> print -addresses: 192\&.168\&.1\&.100/24 -nmcli ipv4\&.addresses> back -nmcli ipv4> b -nmcli> \fBset ipv4\&.gateway 192\&.168\&.1\&.1\fR -nmcli> \fBverify\fR -Verify connection: OK -nmcli> \fBprint\fR -=========================================================================== - Connection details -=========================================================================== -connection\&.id: ethernet\-4 -connection\&.uuid: de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4 -connection\&.interface\-name: \-\- -connection\&.type: 802\-3\-ethernet -connection\&.autoconnect: yes -connection\&.autoconnect\-priority: 0 -connection\&.timestamp: 0 -connection\&.read\-only: no -connection\&.permissions: -connection\&.zone: \-\- -connection\&.controller: \-\- -connection\&.port\-type: \-\- -connection\&.secondaries: -connection\&.gateway\-ping\-timeout: 0 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -802\-3\-ethernet\&.port: \-\- -802\-3\-ethernet\&.speed: 0 -802\-3\-ethernet\&.duplex: \-\- -802\-3\-ethernet\&.auto\-negotiate: yes -802\-3\-ethernet\&.mac\-address: \-\- -802\-3\-ethernet\&.cloned\-mac\-address: \-\- -802\-3\-ethernet\&.mac\-address\-blacklist: -802\-3\-ethernet\&.mtu: 1492 -802\-3\-ethernet\&.s390\-subchannels: -802\-3\-ethernet\&.s390\-nettype: \-\- -802\-3\-ethernet\&.s390\-options: -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv4\&.method: manual -ipv4\&.dns: -ipv4\&.dns\-search: -ipv4\&.addresses: 192\&.168\&.1\&.100/24 -ipv4\&.gateway: 192\&.168\&.1\&.1 -ipv4\&.routes: -ipv4\&.route\-metric: \-1 -ipv4\&.ignore\-auto\-routes: no -ipv4\&.ignore\-auto\-dns: no -ipv4\&.dhcp\-client\-id: \-\- -ipv4\&.dhcp\-send\-hostname: yes -ipv4\&.dhcp\-hostname: \-\- -ipv4\&.never\-default: no -ipv4\&.may\-fail: yes -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv6\&.method: auto -ipv6\&.dns: -ipv6\&.dns\-search: -ipv6\&.addresses: -ipv6\&.routes: -ipv6\&.route\-metric: \-1 -ipv6\&.ignore\-auto\-routes: no -ipv6\&.ignore\-auto\-dns: no -ipv6\&.never\-default: no -ipv6\&.may\-fail: yes -ipv6\&.ip6\-privacy: \-1 (unknown) -ipv6\&.dhcp\-hostname: \-\- -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -nmcli> \fBset ipv4\&.dns 8\&.8\&.8\&.8 8\&.8\&.4\&.4\fR -nmcli> \fBprint\fR -=========================================================================== - Connection details -=========================================================================== -connection\&.id: ethernet\-4 -connection\&.uuid: de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4 -connection\&.interface\-name: \-\- -connection\&.type: 802\-3\-ethernet -connection\&.autoconnect: yes -connection\&.autoconnect\-priority: 0 -connection\&.timestamp: 0 -connection\&.read\-only: no -connection\&.permissions: -connection\&.zone: \-\- -connection\&.controller: \-\- -connection\&.port\-type: \-\- -connection\&.secondaries: -connection\&.gateway\-ping\-timeout: 0 -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -802\-3\-ethernet\&.port: \-\- -802\-3\-ethernet\&.speed: 0 -802\-3\-ethernet\&.duplex: \-\- -802\-3\-ethernet\&.auto\-negotiate: yes -802\-3\-ethernet\&.mac\-address: \-\- -802\-3\-ethernet\&.cloned\-mac\-address: \-\- -802\-3\-ethernet\&.mac\-address\-blacklist: -802\-3\-ethernet\&.mtu: 1492 -802\-3\-ethernet\&.s390\-subchannels: -802\-3\-ethernet\&.s390\-nettype: \-\- -802\-3\-ethernet\&.s390\-options: -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv4\&.method: manual -ipv4\&.dns: 8\&.8\&.8\&.8,8\&.8\&.4\&.4 -ipv4\&.dns\-search: -ipv4\&.addresses: 192\&.168\&.1\&.100/24 -ipv4\&.gateway: 192\&.168\&.1\&.1 -ipv4\&.routes: -ipv4\&.route\-metric: \-1 -ipv4\&.ignore\-auto\-routes: no -ipv4\&.ignore\-auto\-dns: no -ipv4\&.dhcp\-client\-id: \-\- -ipv4\&.dhcp\-send\-hostname: yes -ipv4\&.dhcp\-hostname: \-\- -ipv4\&.never\-default: no -ipv4\&.may\-fail: yes -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -ipv6\&.method: auto -ipv6\&.dns: -ipv6\&.dns\-search: -ipv6\&.addresses: -ipv6\&.gateway: \-\- -ipv6\&.routes: -ipv6\&.route\-metric: \-1 -ipv6\&.ignore\-auto\-routes: no -ipv6\&.ignore\-auto\-dns: no -ipv6\&.never\-default: no -ipv6\&.may\-fail: yes -ipv6\&.ip6\-privacy: \-1 (unknown) -ipv6\&.dhcp\-hostname: \-\- -\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- -nmcli> \fBverify\fR -Verify connection: OK -nmcli> \fBsave\fR -Connection \*(Aqethernet\-4\*(Aq (de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4) successfully - saved\&. -nmcli> \fBquit\fR -.fi -.if n \{\ -.RE -.\} -.PP -Example session in the nmcli interactive connection editor\&. The scenario creates an Ethernet connection profile with static addressing (IPs and DNS)\&. -.PP -\fBExample\ \&17.\ \&Bluetooth connection profiles\fR -.PP -NetworkManger supports both connecting to NAP and DUN devices as a client\&. It also supports sharing the network via a NAP server\&. -.PP -For NAP client connections, NetworkManager automatically creates a suitable in\-memory profile for paired devices if none is available\&. You may use that generated profile directly, but you may also modify and persist it, which will prevent to automatically re\-create it\&. You may also create a profile from scratch\&. For example, the following uses DHCP and IPv6 autoconf for address configuration: -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli connection add type bluetooth con\-name "Profile for My Bluetooth Device (NAP)" autoconnect no bluetooth\&.type panu bluetooth\&.bdaddr "$BDADDR"\fR -.fi -.if n \{\ -.RE -.\} -.PP -For DUN connections, the user needs to configure modem settings and hence no profile gets created automatically\&. The modem settings depend on your device and you either need a "gsm" or a "csma" section\&. For example, -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli connection add type bluetooth con\-name "Profile for My Bluetooth Device (DUN)" autoconnect no bluetooth\&.type dun bluetooth\&.bdaddr "$BDADDR" gsm\&.apn apn\&.com\fR -.fi -.if n \{\ -.RE -.\} -.PP -Finally, you can create a bluetooth hotspot\&. BlueZ implements those as a bridge device, so such profiles also have a bridge section\&. Also, you probably want to set IP methods as "shared", so that clients get automatic IP addressing\&. Note that the "shared" IPv4 method requires dnsmasq to be available\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli connection add type bluetooth con\-name "My Bluetooth Hotspot" autoconnect no ifname btnap0 bluetooth\&.type nap ipv4\&.method shared ipv6\&.method shared\fR -.fi -.if n \{\ -.RE -.\} -.PP -\fBExample\ \&18.\ \&Offline use\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-\-offline con add type ethernet \*(Aq - conn\&.id eth0 \e - conn\&.interface\-name eth0 \e - >/sysroot/etc/NetworkManager/system\-connections/eth0\&.nmconnection\fR -.fi -.if n \{\ -.RE -.\} -.PP -Creates a connection file in keyfile format without using the NetworkManager service\&. This allows for use of familiar -\fBnmcli\fR -syntax in situations where the service is not running, such as during system installation of image provisioning and ensures the resulting file is correctly formatted\&. -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli \-\-offline con modify type ethernet \*(Aq - conn\&.id eth0\-ipv6 \e - ipv4\&.method disabled \e - </sysroot/etc/NetworkManager/system\-connections/eth0\&.nmconnection \e - >/sysroot/etc/NetworkManager/system\-connections/eth0\-ipv6\&.nmconnection\fR -.fi -.if n \{\ -.RE -.\} -.PP -Read and write a connection file without using the NetworkManager service, modifying some properties along the way\&. -.PP -This allows templating of the connection profiles using familiar -\fBnmcli\fR -syntax in situations where the service is not running\&. -.PP -\fBExample\ \&19.\ \&Device Checkpoint and Restore\fR -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli dev checkpoint eth0 \-\- nmcli dev dis eth0\fR -Device \*(Aqeth0\*(Aq successfully disconnected\&. -Type "Yes" to commit the changes: No -Checkpoint was removed\&. -.fi -.if n \{\ -.RE -.\} -.PP -In this example the device eth0 was disconnected with the eth0 checkpoint taken\&. The user didn\*(Aqt confirm that the change is good, so the eth0 was brought back to the state it was when the checkpoint was taken\&. -.PP -If the command being run unintentionaly brings down the remote connection (such as a -\fBssh\fR(1) -session) to the very machine it\*(Aqs being run on, the user wouldn\*(Aqt be able to confirm the success and the connectivity would end up being restored after a timeout\&. -.PP -If, on the other hand, the command results in a success, the user could just confirm, causing the checkpoint to be abandoned without a rollback: -.sp -.if n \{\ -.RS 4 -.\} -.nf -$ \fBnmcli dev checkpoint \-\- ip link del br0\fR -Type "Yes" to commit the changes: \fBYes\fR -.fi -.if n \{\ -.RE -.\} -.SH "SEE ALSO" -.PP -\fBnmcli\fR(1), -\fBNetworkManager\fR(8), -\fBNetworkManager.conf\fR(5), -\fBnm-settings-nmcli\fR(5), -\fBnm-online\fR(1), -\fBnm-applet\fR(1), -\fBnm-connection-editor\fR(1) diff --git a/man/nmcli.1 b/man/nmcli.1 deleted file mode 100644 index 50188e71..00000000 --- a/man/nmcli.1 +++ /dev/null @@ -1,2159 +0,0 @@ -'\" t -.\" Title: nmcli -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: General Commands Manual -.\" Source: NetworkManager 1.50.0 -.\" Language: English -.\" -.TH "NMCLI" "1" "" "NetworkManager 1\&.50\&.0" "General Commands Manual" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nmcli \- command\-line tool for controlling NetworkManager -.SH "SYNOPSIS" -.HP \w'\fBnmcli\fR\ 'u -\fBnmcli\fR [\fIOPTIONS\fR...] {\fBhelp\fR | \fBgeneral\fR | \fBnetworking\fR | \fBradio\fR | \fBconnection\fR | \fBdevice\fR | \fBagent\fR | \fBmonitor\fR} [\fICOMMAND\fR] [\fIARGUMENTS\fR...] -.SH "DESCRIPTION" -.PP -\fBnmcli\fR -is a command\-line tool for controlling NetworkManager and reporting network status\&. It can be utilized as a replacement for -\fBnm\-applet\fR -or other graphical clients\&. -\fBnmcli\fR -is used to create, display, edit, delete, activate, and deactivate network connections, as well as control and display network device status\&. See -\fBnmcli-examples\fR(7) -for ready to run nmcli examples\&. -.PP -Typical uses include: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Scripts: Utilize NetworkManager via -\fBnmcli\fR -instead of managing network connections manually\&. -\fBnmcli\fR -supports a terse output format which is better suited for script processing\&. Note that NetworkManager can also execute scripts, called "dispatcher scripts", in response to network events\&. See -\fBNetworkManager\fR(8) -for details about these dispatcher scripts\&. -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -Servers, headless machines, and terminals: -\fBnmcli\fR -can be used to control NetworkManager without a GUI, including creating, editing, starting and stopping network connections and viewing network status\&. -.RE -.SH "OPTIONS" -.PP -\fB\-a\fR | \fB\-\-ask\fR -.RS 4 -When using this option -\fBnmcli\fR -will stop and ask for any missing required arguments, so do not use this option for non\-interactive purposes like scripts\&. This option controls, for example, whether you will be prompted for a password if it is required for connecting to a network\&. -.RE -.PP -\fB\-c\fR | \fB\-\-colors\fR {yes | no | auto} -.RS 4 -This option controls color output (using terminal escape sequences)\&. -yes -enables colors, -no -disables them, -auto -only produces colors when standard output is directed to a terminal\&. The default value is -auto\&. -.sp -The actual colors used are configured as described in -\fBterminal-colors.d\fR(5)\&. Please refer to the -COLORS -section for a list of color names supported by -\fBnmcli\fR\&. -.sp -If the environment variable -NO_COLOR -is set (to any non\-empty value), then coloring is disabled with mode "auto"\&. If the environment variable -CLICOLOR_FORCE -is set (to any non\-empty value), then coloring is enabled with mode "auto"\&. Explicitly enabling coloring overrides the environment variable\&. -.RE -.PP -\fB\-\-complete\-args\fR -.RS 4 -Instead of conducting the desired action, -\fBnmcli\fR -will list possible completions for the last argument\&. This is useful to implement argument completion in shell\&. -.sp -The -exit status -will indicate success or return a code 65 to indicate the last argument is a file name\&. -.sp -NetworkManager ships with command completion support for GNU Bash\&. -.RE -.PP -\fB\-e\fR | \fB\-\-escape\fR {yes | no} -.RS 4 -Whether to escape -: -and -\e -characters in terse tabular mode\&. The escape character is -\e\&. -.sp -If omitted, default is -yes\&. -.RE -.PP -\fB\-f\fR | \fB\-\-fields\fR {\fIfield1\fR,\fIfield2\fR... | all | common} -.RS 4 -This option is used to specify what fields (column names) should be printed\&. Valid field names differ for specific commands\&. List available fields by providing an invalid value to the -\fB\-\-fields\fR -option\&. -all -is used to print all valid field values of the command\&. -common -is used to print common field values of the command\&. -.sp -If omitted, default is -common\&. -.RE -.PP -\fB\-g\fR | \fB\-\-get\-values\fR {\fIfield1\fR,\fIfield2\fR... | all | common} -.RS 4 -This option is used to print values from specific fields\&. It is basically a shortcut for -\-\-mode tabular \-\-terse \-\-fields -and is a convenient way to retrieve values for particular fields\&. The values are printed one per line without headers\&. -.sp -If a section is specified instead of a field, the section name will be printed followed by colon separated values of the fields belonging to that section, all on the same line\&. -.RE -.PP -\fB\-h\fR | \fB\-\-help\fR -.RS 4 -Print help information\&. -.RE -.PP -\fB\-m\fR | \fB\-\-mode\fR {tabular | multiline} -.RS 4 -Switch between tabular and multiline output: -.PP -tabular -.RS 4 -Output is a table where each line describes a single entry\&. Columns define particular properties of the entry\&. -.RE -.PP -multiline -.RS 4 -Each entry comprises multiple lines, each property on its own line\&. The values are prefixed with the property name\&. -.RE -.sp -If omitted, default is -tabular -for most commands\&. For the commands producing more structured information, that cannot be displayed on a single line, default is -multiline\&. Currently, they are: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -nmcli connection show \fIID\fR -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -nmcli device show -.RE -.RE -.PP -\fB\-p\fR | \fB\-\-pretty\fR -.RS 4 -Output is pretty\&. This causes -\fBnmcli\fR -to produce easily readable outputs for humans, i\&.e\&. values are aligned, headers are printed, etc\&. -.RE -.PP -\fB\-s\fR | \fB\-\-show\-secrets\fR -.RS 4 -When using this option -\fBnmcli\fR -will display passwords and secrets that might be present in an output of an operation\&. This option also influences echoing passwords typed by user as an input\&. -.RE -.PP -\fB\-t\fR | \fB\-\-terse\fR -.RS 4 -Output is terse\&. This mode is designed and suitable for computer (script) processing\&. -.RE -.PP -\fB\-\-offline\fR -.RS 4 -Work without a daemon\&. Makes -\fBconnection add\fR -and -\fBconnection modify\fR -commands accept and produce connection data via standard input/output\&. Ordinarily, nmcli would communicate with the NetworkManager service\&. -.sp -The connection data format (keyfile) is described in -\fBnm-settings-keyfile\fR(5) -manual\&. -.RE -.PP -\fB\-v\fR | \fB\-\-version\fR -.RS 4 -Show -\fBnmcli\fR -version\&. -.RE -.PP -\fB\-w\fR | \fB\-\-wait\fR \fIseconds\fR -.RS 4 -This option sets a timeout period for which -\fBnmcli\fR -will wait for NetworkManager to finish operations\&. It is especially useful for commands that may take a longer time to complete, e\&.g\&. connection activation\&. -.sp -Specifying a value of -0 -instructs -\fBnmcli\fR -not to wait but to exit immediately with a status of success\&. The default value depends on the executed command\&. -.RE -.SH "GENERAL COMMANDS" -.HP \w'\fBnmcli\ general\fR\ 'u -\fBnmcli general\fR {\fBstatus\fR | \fBhostname\fR | \fBpermissions\fR | \fBlogging\fR | \fBreload\fR} [\fIARGUMENTS\fR...] -.PP -Use this command to show NetworkManager status and permissions\&. You can also get and change system hostname, as well as NetworkManager logging level and domains\&. -.PP -\fBstatus\fR -.RS 4 -Show overall status of NetworkManager\&. This is the default action, when no additional command is provided for -\fBnmcli general\fR\&. -.RE -.PP -\fBhostname\fR [\fIhostname\fR] -.RS 4 -Get and change system hostname\&. With no arguments, this prints currently configured hostname\&. When you pass a hostname, it will be handed over to NetworkManager to be set as a new system hostname\&. -.sp -Note that the term "system" hostname may also be referred to as "persistent" or "static" by other programs or tools\&. The hostname is stored in -/etc/hostname -file in most distributions\&. For example, systemd\-hostnamed service uses the term "static" hostname and it only reads the -/etc/hostname -file when it starts\&. -.RE -.PP -\fBpermissions\fR -.RS 4 -Show the permissions a caller has for various authenticated operations that NetworkManager provides, like enable and disable networking, changing Wi\-Fi and WWAN state, modifying connections, etc\&. -.RE -.PP -\fBlogging\fR [\fBlevel\fR\ \fIlevel\fR] [\fBdomains\fR\ \fIdomains\fR...] -.RS 4 -Get and change NetworkManager logging level and domains\&. Without any argument current logging level and domains are shown\&. In order to change logging state, provide -\fBlevel\fR -and, or, -\fBdomain\fR -parameters\&. See -\fBNetworkManager.conf\fR(5) -for available level and domain values\&. -.RE -.PP -\fBreload\fR [\fIflags\fR...] -.RS 4 -Reload NetworkManager\*(Aqs configuration and perform certain updates, like flushing caches or rewriting external state to disk\&. This is similar to sending SIGHUP to NetworkManager but it allows for more fine\-grained control over what to reload through the flags argument\&. It also allows non\-root access via PolicyKit and contrary to signals it is synchronous\&. Available flags are: -.PP -\fBconf\fR -.RS 4 -Reload the NetworkManager\&.conf configuration from disk\&. Note that this does not include connections, which can be reloaded through -\fBnmcli connection reload\fR -instead\&. -.RE -.PP -\fBdns\-rc\fR -.RS 4 -Update DNS configuration, which usually involves writing /etc/resolv\&.conf anew\&. This is equivalent to sending the SIGUSR1 signal to the NetworkManager process\&. -.RE -.PP -\fBdns\-full\fR -.RS 4 -Restart the DNS plugin\&. This is for example useful when using dnsmasq plugin, which uses additional configuration in -/etc/NetworkManager/dnsmasq\&.d\&. If you edit those files, you can restart the DNS plugin\&. This action shortly interrupts name resolution\&. -.RE -.sp -With no flags, everything that is supported is reloaded, which is identical to sending a SIGHUP\&. See -\fBNetworkManager\fR(8) -for more details about signals\&. -.RE -.SH "NETWORKING CONTROL COMMANDS" -.HP \w'\fBnmcli\ networking\fR\ 'u -\fBnmcli networking\fR {\fBon\fR | \fBoff\fR | \fBconnectivity\fR} [\fIARGUMENTS\fR...] -.PP -Query NetworkManager networking status, enable and disable networking\&. -.PP -\fBon\fR, \fBoff\fR -.RS 4 -Enable or disable networking control by NetworkManager\&. All interfaces managed by NetworkManager are deactivated when networking is disabled\&. -.RE -.PP -\fBconnectivity\fR [check] -.RS 4 -Get network connectivity state\&. The optional -\fBcheck\fR -argument tells NetworkManager to re\-check the connectivity, else the most recent known connectivity state is displayed without re\-checking\&. -.sp -Possible states are: -.PP -none -.RS 4 -the host is not connected to any network\&. -.RE -.PP -portal -.RS 4 -the host is behind a captive portal and cannot reach the full Internet\&. -.RE -.PP -limited -.RS 4 -the host is connected to a network, but it has no access to the Internet\&. -.RE -.PP -full -.RS 4 -the host is connected to a network and has full access to the Internet\&. -.RE -.PP -unknown -.RS 4 -the connectivity status cannot be found out\&. -.RE -.RE -.SH "RADIO TRANSMISSION CONTROL COMMANDS" -.HP \w'\fBnmcli\ radio\fR\ 'u -\fBnmcli radio\fR {\fBall\fR | \fBwifi\fR | \fBwwan\fR} [\fIARGUMENTS\fR...] -.PP -Show radio switches status, or enable and disable the switches\&. -.PP -\fBwifi\fR [on | off] -.RS 4 -Show or set status of Wi\-Fi in NetworkManager\&. If no arguments are supplied, Wi\-Fi status is printed; -\fBon\fR -enables Wi\-Fi; -\fBoff\fR -disables Wi\-Fi\&. -.RE -.PP -\fBwwan\fR [on | off] -.RS 4 -Show or set status of WWAN (mobile broadband) in NetworkManager\&. If no arguments are supplied, mobile broadband status is printed; -\fBon\fR -enables mobile broadband, -\fBoff\fR -disables it\&. -.RE -.PP -\fBall\fR [on | off] -.RS 4 -Show or set all previously mentioned radio switches at the same time\&. -.RE -.SH "ACTIVITY MONITOR" -.HP \w'\fBnmcli\ monitor\fR\ 'u -\fBnmcli monitor\fR -.PP -Observe NetworkManager activity\&. Watches for changes in connectivity state, devices or connection profiles\&. -.PP -See also -\fBnmcli connection monitor\fR -and -\fBnmcli device monitor\fR -to watch for changes in certain devices or connections\&. -.SH "CONNECTION MANAGEMENT COMMANDS" -.HP \w'\fBnmcli\ connection\fR\ 'u -\fBnmcli connection\fR {\fBshow\fR | \fBup\fR | \fBdown\fR | \fBmodify\fR | \fBadd\fR | \fBedit\fR | \fBclone\fR | \fBdelete\fR | \fBmonitor\fR | \fBreload\fR | \fBload\fR | \fBimport\fR | \fBexport\fR | \fBmigrate\fR} [\fIARGUMENTS\fR...] -.PP -NetworkManager stores all network configuration as "connections", which are collections of data (Layer2 details, IP addressing, etc\&.) that describe how to create or connect to a network\&. A connection is "active" when a device uses that connection\*(Aqs configuration to create or connect to a network\&. There may be multiple connections that apply to a device, but only one of them can be active on that device at any given time\&. The additional connections can be used to allow quick switching between different networks and configurations\&. -.PP -Consider a machine which is usually connected to a DHCP\-enabled network, but sometimes connected to a testing network which uses static IP addressing\&. Instead of manually reconfiguring eth0 each time the network is changed, the settings can be saved as two connections which both apply to eth0, one for DHCP (called -default) and one with the static addressing details (called -testing)\&. When connected to the DHCP\-enabled network the user would run -\fBnmcli con up default\fR -, and when connected to the static network the user would run -\fBnmcli con up testing\fR\&. -.PP -\fBshow\fR [\fB\-\-active\fR] [\fB\-\-order\fR\ [+\-]\fIcategory\fR:...] -.RS 4 -List in\-memory and on\-disk connection profiles, some of which may also be active if a device is using that connection profile\&. Without a parameter, all profiles are listed\&. When -\fB\-\-active\fR -option is specified, only the active profiles are shown\&. -.sp -The -\fB\-\-order\fR -option can be used to get custom ordering of connections\&. The connections can be ordered by active status (active), name (name), type (type) or D\-Bus path (path)\&. If connections are equal according to a sort order category, an additional category can be specified\&. The default sorting order is equivalent to -\-\-order active:name:path\&. -+ -or no prefix means sorting in ascending order (alphabetically or in numbers), -\- -means reverse (descending) order\&. The category names can be abbreviated (e\&.g\&. -\-\-order \-a:na)\&. -.RE -.PP -\fBshow\fR [\fB\-\-active\fR] [\fBid\fR | \fBuuid\fR | \fBpath\fR | \fBapath\fR] \fIID\fR... -.RS 4 -Show details for specified connections\&. By default, both static configuration and active connection data are displayed\&. When -\fB\-\-active\fR -option is specified, only the active profiles are taken into account\&. Use global -\fB\-\-show\-secrets\fR -option to display secrets associated with the profile\&. -.sp -\fBid\fR, -\fBuuid\fR, -\fBpath\fR -and -\fBapath\fR -keywords can be used if -\fIID\fR -is ambiguous\&. Optional -\fIID\fR\-specifying keywords are: -.PP -\fBid\fR -.RS 4 -the -\fIID\fR -denotes a connection name\&. -.RE -.PP -\fBuuid\fR -.RS 4 -the -\fIID\fR -denotes a connection UUID\&. -.RE -.PP -\fBpath\fR -.RS 4 -the -\fIID\fR -denotes a D\-Bus static connection path in the format of /org/freedesktop/NetworkManager/Settings/\fInum\fR -or just -\fInum\fR\&. -.RE -.PP -\fBapath\fR -.RS 4 -the -\fIID\fR -denotes a D\-Bus active connection path in the format of /org/freedesktop/NetworkManager/ActiveConnection/\fInum\fR -or just -\fInum\fR\&. -.RE -.sp -It is possible to filter the output using the global -\fB\-\-fields\fR -option\&. Use the following values: -.PP -\fBprofile\fR -.RS 4 -only shows static profile configuration\&. -.RE -.PP -\fBactive\fR -.RS 4 -only shows active connection data (when the profile is active)\&. -.RE -.sp -You can also specify particular fields\&. For static configuration, use setting and property names as described in -\fBnm-settings-nmcli\fR(5) -manual page\&. For active data use GENERAL, IP4, DHCP4, IP6, DHCP6, VPN\&. -.sp -When no command is given to the -\fBnmcli connection\fR, the default action is -\fBnmcli connection show\fR\&. -.RE -.PP -\fBup\fR [\fBid\fR | \fBuuid\fR | \fBpath\fR] \fIID\fR [\fBifname\fR\ \fIifname\fR] [\fBap\fR\ \fIBSSID\fR] [\fBpasswd\-file\fR\ \fIfile\fR] -.RS 4 -Activate a connection\&. The connection is identified by its name, UUID or D\-Bus path\&. If -\fIID\fR -is ambiguous, a keyword -\fBid\fR, -\fBuuid\fR -or -\fBpath\fR -can be used\&. When requiring a particular device to activate the connection on, the -\fBifname\fR -option with interface name should be given\&. If the -\fIID\fR -is not given an -\fBifname\fR -is required, and NetworkManager will activate the best available connection for the given -\fBifname\fR\&. In case of a VPN connection, the -\fBifname\fR -option specifies the device of the base connection\&. The -\fBap\fR -option specify what particular AP should be used in case of a Wi\-Fi connection\&. -.sp -If -\fB\-\-wait\fR -option is not specified, the default timeout will be 90 seconds\&. -.sp -See -\fBconnection show\fR -above for the description of the -\fIID\fR\-specifying keywords\&. -.sp -Available options are: -.PP -\fBifname\fR -.RS 4 -interface that will be used for activation\&. -.RE -.PP -\fBap\fR -.RS 4 -BSSID of the AP which the command should connect to (for Wi\-Fi connections)\&. -.RE -.PP -\fBpasswd\-file\fR -.RS 4 -some networks may require credentials during activation\&. You can give these credentials using this option\&. Each line of the file should contain one password in the form: -.sp -.if n \{\ -.RS 4 -.\} -.nf -setting_name\&.property_name:the password -.fi -.if n \{\ -.RE -.\} -.sp -For example, for WPA Wi\-Fi with PSK, the line would be -.sp -.if n \{\ -.RS 4 -.\} -.nf -802\-11\-wireless\-security\&.psk:secret12345 -.fi -.if n \{\ -.RE -.\} -.sp -For 802\&.1X password, the line would be -.sp -.if n \{\ -.RS 4 -.\} -.nf -802\-1x\&.password:my 1X password -.fi -.if n \{\ -.RE -.\} -.sp - -\fBnmcli\fR -also accepts -wifi\-sec -and -wifi -strings instead of -802\-11\-wireless\-security\&. When NetworkManager requires a password and it is not given, -\fBnmcli\fR -will ask for it when run with -\fB\-\-ask\fR\&. If -\fB\-\-ask\fR -was not passed, NetworkManager can ask another secret agent that may be running (typically a GUI secret agent, such as nm\-applet or gnome\-shell)\&. -.RE -.RE -.PP -\fBdown\fR [\fBid\fR | \fBuuid\fR | \fBpath\fR | \fBapath\fR] \fIID\fR... -.RS 4 -Deactivate a connection from a device without preventing the device from further auto\-activation\&. Multiple connections can be passed to the command\&. -.sp -Be aware that this command deactivates the specified active connection, but the device on which the connection was active, is still ready to connect and will perform auto\-activation by looking for a suitable connection that has the \*(Aqautoconnect\*(Aq flag set\&. Note that the deactivating connection profile is internally blocked from autoconnecting again\&. Hence it will not autoconnect until reboot or until the user performs an action that unblocks autoconnect, like modifying the profile or explicitly activating it\&. -.sp -In most cases you may want to use -\fBdevice down\fR -command instead\&. -.sp -The connection is identified by its name, UUID or D\-Bus path\&. If -\fIID\fR -is ambiguous, a keyword -\fBid\fR, -\fBuuid\fR, -\fBpath\fR -or -\fBapath\fR -can be used\&. -.sp -See -\fBconnection show\fR -above for the description of the -\fIID\fR\-specifying keywords\&. -.sp -If -\fB\-\-wait\fR -option is not specified, the default timeout will be 10 seconds\&. -.RE -.PP -\fBmodify\fR [\fB\-\-temporary\fR] [\fBid\fR | \fBuuid\fR | \fBpath\fR] [\fIID\fR] {\fIoption\fR\ \fIvalue\fR\ |\ [+|\-]\fIsetting\fR\&.\fIproperty\fR\ \fIvalue\fR}... -.RS 4 -Add, modify or remove properties in the connection profile\&. -.sp -To set the property just specify the property name followed by the value\&. An empty value ("") resets the property value to the default\&. -.sp -See -\fBnm-settings-nmcli\fR(5) -for complete reference of setting and property names, their descriptions and default values\&. The -\fIsetting\fR -and -\fIproperty\fR -can be abbreviated provided they are unique\&. -.sp -If you want to append an item or a flag to the existing value, use -+ -prefix for the property name or alias\&. If you want to remove items from a container\-type or flag property, use -\- -prefix\&. For certain properties you can also remove elements by specifying the zero\-based index(es)\&. The -+ -and -\- -modifiers only have a real effect for properties that support them\&. These are for example multi\-value (container) properties or flags like -ipv4\&.dns, -ip4, -ipv4\&.addresses, -bond\&.options, -802\-1x\&.phase1\-auth\-flags -etc\&. -.sp -The connection is identified by its name, UUID or D\-Bus path\&. If -\fIID\fR -is ambiguous, a keyword -\fBid\fR, -\fBuuid\fR -or -\fBpath\fR -can be used\&. The -\fIID\fR -is not used with the global -\fB\-\-offline\fR -option\&. -.sp -When the global -\fB\-\-offline\fR -is used, the command reads the connection from the standard input and prints the modified connection to standard output instead of making the the NetworkManager daemon act upon specified connection\&. -.RE -.PP -\fBmodify\fR [\fB\-\-temporary\fR] [\fBid\fR | \fBuuid\fR | \fBpath\fR] \fIID\fR \fBremove\fR\ \fIsetting\fR -.RS 4 -Removes a setting from the connection profile\&. -.RE -.PP -\fBadd\fR [\fBsave\fR\ {yes\ |\ no}] {\fIoption\fR\ \fIvalue\fR\ |\ [+|\-]\fIsetting\fR\&.\fIproperty\fR\ \fIvalue\fR}... -.RS 4 -Create a new connection using specified properties\&. -.sp -You need to describe the newly created connections with the property and value pairs\&. See -\fBnm-settings-nmcli\fR(5) -for the complete reference\&. The syntax is the same as of the -\fBnmcli connection modify\fR -command\&. -.sp -To construct a meaningful connection you at the very least need to set the -\fBconnection\&.type\fR -property (or use the -\fBtype\fR -alias) to one of known NetworkManager connection types: -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -6lowpan -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -802\-11\-olpc\-mesh -(alias -olpc\-mesh) -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -802\-11\-wireless -(alias -wifi) -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -802\-3\-ethernet -(alias -ethernet) -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -adsl -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -bluetooth -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -bond -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -bond\-slave -(deprecated for ethernet with controller) -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -bridge -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -bridge\-slave -(deprecated for ethernet with controller) -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -cdma -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -dummy -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -generic -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -gsm -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -infiniband -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -ip\-tunnel -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -macsec -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -macvlan -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -olpc\-mesh -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -ovs\-bridge -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -ovs\-dpdk -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -ovs\-interface -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -ovs\-patch -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -ovs\-port -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -pppoe -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -team -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -team\-slave -(deprecated for ethernet with controller) -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -tun -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -veth -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -vlan -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -vpn -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -vrf -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -vxlan -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -wifi\-p2p -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -wimax -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -wireguard -.RE -.sp -.RS 4 -.ie n \{\ -\h'-04'\(bu\h'+03'\c -.\} -.el \{\ -.sp -1 -.IP \(bu 2.3 -.\} -wpan -.RE -.sp -The most typical uses are described in the -EXAMPLES -section\&. -.sp -Aside from the properties and values two special options are accepted: -.PP -\fBsave\fR -.RS 4 -Controls whether the connection should be persistent, i\&.e\&. NetworkManager should store it on disk (default: -yes)\&. -.RE -.PP -\fB\-\-\fR -.RS 4 -If a single -\fB\-\-\fR -argument is encountered it is ignored\&. This is for compatibility with older versions on -\fBnmcli\fR\&. -.RE -.sp -When the global -\fB\-\-offline\fR -is used, the command prints the resulting connection to standard output instead of actually adding the connection via the NetworkManager daemon\&. -.RE -.PP -\fBedit\fR {[\fBid\fR\ |\ \fBuuid\fR\ |\ \fBpath\fR]\ \fIID\fR | [\fBtype\fR\ \fItype\fR]\ [\fBcon\-name\fR\ \fIname\fR] } -.RS 4 -Edit an existing connection or add a new one, using an interactive editor\&. -.sp -The existing connection is identified by its name, UUID or D\-Bus path\&. If -\fIID\fR -is ambiguous, a keyword -\fBid\fR, -\fBuuid\fR, or -\fBpath\fR -can be used\&. See -\fBconnection show\fR -above for the description of the -\fIID\fR\-specifying keywords\&. Not providing an -\fIID\fR -means that a new connection will be added\&. -.sp -The interactive editor will guide you through the connection editing and allow you to change connection parameters according to your needs by means of a simple menu\-driven interface\&. The editor indicates what settings and properties can be modified and provides in\-line help\&. -.sp -Available options: -.PP -\fBtype\fR -.RS 4 -type of the new connection; valid types are the same as for -\fBconnection add\fR -command\&. -.RE -.PP -\fBcon\-name\fR -.RS 4 -name for the new connection\&. It can be changed later in the editor\&. -.RE -.sp -See also -\fBnm-settings-nmcli\fR(5) -for all NetworkManager settings and property names, and their descriptions; and -\fBnmcli-examples\fR(7) -for sample editor sessions\&. -.RE -.PP -\fBclone\fR [\fB\-\-temporary\fR] [\fBid\fR | \fBuuid\fR | \fBpath\fR] \fIID\fR \fInew_name\fR -.RS 4 -Clone a connection\&. The connection to be cloned is identified by its name, UUID or D\-Bus path\&. If -\fIID\fR -is ambiguous, a keyword -\fBid\fR, -\fBuuid\fR -or -\fBpath\fR -can be used\&. See -\fBconnection show\fR -above for the description of the -\fIID\fR\-specifying keywords\&. -\fInew_name\fR -is the name of the new cloned connection\&. The new connection will be the exact copy except the connection\&.id (\fInew_name\fR) and connection\&.uuid (generated) properties\&. -.sp -The new connection profile will be saved as persistent unless -\fB\-\-temporary\fR -option is specified, in which case the new profile won\*(Aqt exist after NetworkManager restart\&. -.RE -.PP -\fBdelete\fR [\fBid\fR | \fBuuid\fR | \fBpath\fR] \fIID\fR... -.RS 4 -Delete a configured connection\&. The connection to be deleted is identified by its name, UUID or D\-Bus path\&. If -\fIID\fR -is ambiguous, a keyword -\fBid\fR, -\fBuuid\fR -or -\fBpath\fR -can be used\&. See -\fBconnection show\fR -above for the description of the -\fIID\fR\-specifying keywords\&. -.sp -If -\fB\-\-wait\fR -option is not specified, the default timeout will be 10 seconds\&. -.RE -.PP -\fBmonitor\fR [\fBid\fR | \fBuuid\fR | \fBpath\fR] \fIID\fR... -.RS 4 -Monitor connection profile activity\&. This command prints a line whenever the specified connection changes\&. The connection to be monitored is identified by its name, UUID or D\-Bus path\&. If -\fIID\fR -is ambiguous, a keyword -\fBid\fR, -\fBuuid\fR -or -\fBpath\fR -can be used\&. See -\fBconnection show\fR -above for the description of the -\fIID\fR\-specifying keywords\&. -.sp -Monitors all connection profiles in case none is specified\&. The command terminates when all monitored connections disappear\&. If you want to monitor connection creation consider using the global monitor with -\fBnmcli monitor\fR -command\&. -.RE -.PP -\fBreload\fR -.RS 4 -Reload all connection files from disk\&. NetworkManager does not monitor changes to connection\&. So you need to use this command in order to tell NetworkManager to re\-read the connection profiles from disk when a change was made to them\&. -.RE -.PP -\fBload\fR \fIfilename\fR... -.RS 4 -Load/reload one or more connection files from disk\&. Use this after manually editing a connection file to ensure that NetworkManager is aware of its latest state\&. -.RE -.PP -\fBimport\fR [\fB\-\-temporary\fR] \fBtype\fR\ \fItype\fR \fBfile\fR\ \fIfile\fR -.RS 4 -Import an external/foreign configuration as a NetworkManager connection profile\&. The type of the input file is specified by -\fBtype\fR -option\&. -.sp -Only VPN configurations are supported at the moment\&. The configuration is imported by NetworkManager VPN plugins\&. -\fBtype\fR -values are the same as for -\fBvpn\-type\fR -option in -\fBnmcli connection add\fR\&. VPN configurations are imported by VPN plugins\&. Therefore the proper VPN plugin has to be installed so that -\fBnmcli\fR -could import the data\&. -.sp -The imported connection profile will be saved as persistent unless -\fB\-\-temporary\fR -option is specified, in which case the new profile won\*(Aqt exist after NetworkManager restart\&. -.RE -.PP -\fBexport\fR [\fBid\fR | \fBuuid\fR | \fBpath\fR] \fIID\fR [\fIfile\fR] -.RS 4 -Export a connection\&. -.sp -Only VPN connections are supported at the moment\&. A proper VPN plugin has to be installed so that -\fBnmcli\fR -could export a connection\&. If no -\fIfile\fR -is provided, the VPN configuration data will be printed to standard output\&. -.RE -.PP -\fBmigrate\fR [\fB\-\-plugin\fR\ \fIplugin\fR...] [\fBid\fR | \fBuuid\fR | \fBpath\fR] [\fIID\fR...] -.RS 4 -Migrate connection profiles to a different settings plugin, such as -keyfile -(default) or -ifcfg\-rh\&. -.sp -The connection to be migrated is identified by its name, UUID or D\-Bus path\&. If -\fIID\fR -is ambiguous, a keyword -\fBid\fR, -\fBuuid\fR -or -\fBpath\fR -can be used\&. See -\fBconnection show\fR -above for the description of the -\fIID\fR\-specifying keywords\&. -.sp -If no connections are specified, the command acts on all available connections\&. Therefore, with no arguments, the command migrates all connection profiles to the -keyfile -plugin\&. -.sp -If -\fB\-\-wait\fR -option is not specified, the default timeout will be 10 seconds\&. -.RE -.SH "DEVICE MANAGEMENT COMMANDS" -.HP \w'\fBnmcli\ device\fR\ 'u -\fBnmcli device\fR {\fBstatus\fR | \fBshow\fR | \fBset\fR | \fBup\fR | \fBconnect\fR | \fBreapply\fR | \fBmodify\fR | \fBdown\fR | \fBdisconnect\fR | \fBdelete\fR | \fBmonitor\fR | \fBwifi\fR | \fBlldp\fR | \fBcheckpoint\fR} [\fIARGUMENTS\fR...] -.PP -Show and manage network interfaces\&. -.PP -\fBstatus\fR -.RS 4 -Print status of devices\&. -.sp -This is the default action if no command is specified to -\fBnmcli device\fR\&. -.RE -.PP -\fBshow\fR [\fIifname\fR] -.RS 4 -Show detailed information about devices\&. Without an argument, all devices are examined\&. To get information for a specific device, the interface name has to be provided\&. -.RE -.PP -\fBset\fR [ifname] \fIifname\fR [\fBautoconnect\fR\ {yes\ |\ no}] [\fBmanaged\fR\ {yes\ |\ no}] -.RS 4 -Set device properties\&. -.RE -.PP -\fBup\fR \fIifname\fR -.RS 4 -Connect the device\&. NetworkManager will try to find a suitable connection that will be activated\&. It will also consider connections that are not set to auto connect\&. -.sp -If no compatible connection exists, a new profile with default settings will be created and activated\&. This differentiates -\fBnmcli connection up ifname "$DEVICE"\fR -from -\fBnmcli device up "$DEVICE"\fR -.sp -If -\fB\-\-wait\fR -option is not specified, the default timeout will be 90 seconds\&. -.RE -.PP -\fBconnect\fR \fIifname\fR -.RS 4 -Alias for command -\fBup\fR\&. Before version 1\&.34\&.0 -\fBup\fR -was not supported\&. -.RE -.PP -\fBreapply\fR \fIifname\fR -.RS 4 -Attempt to update device with changes to the currently active connection made since it was last applied\&. -.RE -.PP -\fBmodify\fR \fIifname\fR {\fIoption\fR\ \fIvalue\fR\ |\ [+|\-]\fIsetting\fR\&.\fIproperty\fR\ \fIvalue\fR}... -.RS 4 -Modify the settings currently active on the device\&. -.sp -This command lets you do temporary changes to a configuration active on a particular device\&. The changes are not preserved in the connection profile\&. -.sp -See -\fBnm-settings-nmcli\fR(5) -for the list of available properties\&. Please note that some properties can\*(Aqt be changed on an already connected device\&. -.RE -.PP -\fBdown\fR \fIifname\fR... -.RS 4 -Disconnect a device and prevent the device from automatically activating further connections without user/manual intervention\&. Note that disconnecting software devices may mean that the devices will disappear\&. -.sp -If -\fB\-\-wait\fR -option is not specified, the default timeout will be 10 seconds\&. -.RE -.PP -\fBdisconnect\fR \fIifname\fR... -.RS 4 -Alias for command -\fBdown\fR\&. Before version 1\&.34\&.0 -\fBdown\fR -was not supported\&. -.RE -.PP -\fBdelete\fR \fIifname\fR... -.RS 4 -Delete a device\&. The command removes the interface from the system\&. Note that this only works for software devices like bonds, bridges, teams, etc\&. Hardware devices (like Ethernet) cannot be deleted by the command\&. -.sp -If -\fB\-\-wait\fR -option is not specified, the default timeout will be 10 seconds\&. -.RE -.PP -\fBmonitor\fR [\fIifname\fR...] -.RS 4 -Monitor device activity\&. This command prints a line whenever the specified devices change state\&. -.sp -Monitors all devices in case no interface is specified\&. The monitor terminates when all specified devices disappear\&. If you want to monitor device addition consider using the global monitor with -\fBnmcli monitor\fR -command\&. -.RE -.PP -\fBwifi\fR [\fBlist\fR\ [\fB\-\-rescan\fR\ |\ \fBauto\fR\ |\ \fBno\fR\ |\ \fByes\fR]\ [\fBifname\fR\ \fIifname\fR]\ [\fBbssid\fR\ \fIBSSID\fR]] -.RS 4 -List available Wi\-Fi access points\&. The -\fBifname\fR -and -\fBbssid\fR -options can be used to list APs for a particular interface or with a specific BSSID, respectively\&. -.sp -By default, -\fBnmcli\fR -ensures that the access point list is no older than 30 seconds and triggers a network scan if necessary\&. The -\fB\-\-rescan\fR -can be used to either force or disable the scan regardless of how fresh the access point list is\&. -.RE -.PP -\fBwifi\fR \fBconnect\fR \fI(B)SSID\fR [\fBpassword\fR\ \fIpassword\fR] [\fBwep\-key\-type\fR\ {key\ |\ phrase}] [\fBifname\fR\ \fIifname\fR] [\fBbssid\fR\ \fIBSSID\fR] [\fBname\fR\ \fIname\fR] [\fBprivate\fR\ {yes\ |\ no}] [\fBhidden\fR\ {yes\ |\ no}] -.RS 4 -Connect to a Wi\-Fi network specified by SSID or BSSID\&. The command finds a matching connection or creates one and then activates it on a device\&. This is a command\-line counterpart of clicking an SSID in a GUI client\&. If a connection for the network already exists, it is possible to bring up (activate) the existing profile as follows: -\fBnmcli con up id \fR\fB\fIname\fR\fR\&. Note that only open, WEP and WPA\-PSK networks are supported if no previous connection exists\&. It is also assumed that IP configuration is obtained via DHCP\&. -.sp -If -\fB\-\-wait\fR -option is not specified, the default timeout will be 90 seconds\&. -.sp -Available options are: -.PP -\fBpassword\fR -.RS 4 -password for secured networks (WEP or WPA)\&. -.RE -.PP -\fBwep\-key\-type\fR -.RS 4 -type of WEP secret, either -\fBkey\fR -for ASCII/HEX key or -\fBphrase\fR -for passphrase\&. -.RE -.PP -\fBifname\fR -.RS 4 -interface that will be used for activation\&. -.RE -.PP -\fBbssid\fR -.RS 4 -if specified, the created connection will be restricted just for the BSSID\&. -.RE -.PP -\fBname\fR -.RS 4 -if specified, the connection will use the name (else NM creates a name itself)\&. -.RE -.PP -\fBprivate\fR -.RS 4 -if set to -yes, the connection will only be visible to the user who created it\&. Otherwise, the connection is system\-wide, which is the default\&. -.RE -.PP -\fBhidden\fR -.RS 4 -set to -yes -when connecting for the first time to an AP not broadcasting its SSID\&. Otherwise, the SSID would not be found and the connection attempt would fail\&. -.RE -.RE -.PP -\fBwifi\fR \fBhotspot\fR [\fBifname\fR\ \fIifname\fR] [\fBcon\-name\fR\ \fIname\fR] [\fBssid\fR\ \fISSID\fR] [\fBband\fR\ {a\ |\ bg}] [\fBchannel\fR\ \fIchannel\fR] [\fBpassword\fR\ \fIpassword\fR] -.RS 4 -Create a Wi\-Fi hotspot\&. The command creates a hotspot connection profile according to Wi\-Fi device capabilities and activates it on the device\&. The hotspot is secured with WPA if device/driver supports that, otherwise WEP is used\&. Use -\fBconnection down\fR -or -\fBdevice down\fR -to stop the hotspot\&. -.sp -Parameters of the hotspot can be influenced by the optional parameters: -.PP -\fBifname\fR -.RS 4 -what Wi\-Fi device is used\&. -.RE -.PP -\fBcon\-name\fR -.RS 4 -name of the created hotspot connection profile\&. -.RE -.PP -\fBssid\fR -.RS 4 -SSID of the hotspot\&. -.RE -.PP -\fBband\fR -.RS 4 -Wi\-Fi band to use\&. -.RE -.PP -\fBchannel\fR -.RS 4 -Wi\-Fi channel to use\&. -.RE -.PP -\fBpassword\fR -.RS 4 -password to use for the created hotspot\&. If not provided, -\fBnmcli\fR -will generate a password\&. The password is either WPA pre\-shared key or WEP key\&. -.sp -Note that -\fB\-\-show\-secrets\fR -global option can be used to print the hotspot password\&. It is useful especially when the password was generated\&. -.RE -.RE -.PP -\fBwifi\fR \fBrescan\fR [\fBifname\fR\ \fIifname\fR] [\fBssid\fR\ \fISSID\fR...] -.RS 4 -Request that NetworkManager immediately re\-scan for available access points\&. NetworkManager scans Wi\-Fi networks periodically, but in some cases it can be useful to start scanning manually (e\&.g\&. after resuming the computer)\&. By using -\fBssid\fR, it is possible to scan for a specific SSID, which is useful for APs with hidden SSIDs\&. You can provide multiple -\fBssid\fR -parameters in order to scan more SSIDs\&. -.sp -This command does not show the APs, use -\fBnmcli device wifi list\fR -for that\&. -.RE -.PP -\fBwifi\fR \fBshow\-password\fR [\fBifname\fR\ \fIifname\fR] -.RS 4 -Show the details of the active Wi\-Fi networks, including the secrets\&. -.RE -.PP -\fBlldp\fR [\fBlist\fR\ [\fBifname\fR\ \fIifname\fR]] -.RS 4 -Display information about neighboring devices learned through the Link Layer Discovery Protocol (LLDP)\&. The -\fBifname\fR -option can be used to list neighbors only for a given interface\&. The protocol must be enabled in the connection settings\&. -.RE -.PP -\fBcheckpoint\fR [\fB\-\-timeout\fR\ \fIseconds\fR] [\fIifname\fR...] \fB\-\-\fR \fICOMMAND\fR... -.RS 4 -Runs the command with a configuration checkpoint taken and asks for a confirmation when finished\&. When the confirmation is not given, the checkpoint is automatically restored after timeout\&. -.sp -This allows doing disruptive configuration changes over remote connections with an option of restoring the network configuration to a known good state in case of an error\&. -.sp -If the a list of interface names is specified, the checkpoint is taken, the checkpoint is takes only on the specified devices\&. Otherwise a checkpoint is taken for all devices\&. -.sp -Currently the timeout defaults to 15 seconds\&. This may change in a future version\&. -.RE -.SH "SECRET AGENT" -.HP \w'\fBnmcli\ agent\fR\ 'u -\fBnmcli agent\fR {\fBsecret\fR | \fBpolkit\fR | \fBall\fR} -.PP -Run -\fBnmcli\fR -as a NetworkManager secret agent, or polkit agent\&. -.PP -\fBsecret\fR -.RS 4 -Register -\fBnmcli\fR -as a NetworkManager secret agent and listen for secret requests\&. You usually do not need this command, because -\fBnmcli\fR -can handle secrets when connecting to networks\&. However, you may find the command useful when you use another tool for activating connections and you do not have a secret agent available (like nm\-applet)\&. -.RE -.PP -\fBpolkit\fR -.RS 4 -Register -\fBnmcli\fR -as a polkit agent for the user session and listen for authorization requests\&. You do not usually need this command, because -\fBnmcli\fR -can handle polkit actions related to NetworkManager operations (when run with -\fB\-\-ask\fR)\&. However, you may find the command useful when you want to run a simple text based polkit agent and you do not have an agent of a desktop environment\&. Note that running this command makes -\fBnmcli\fR -handle all polkit requests, not only NetworkManager related ones, because only one polkit agent can run for the session\&. -.RE -.PP -\fBall\fR -.RS 4 -Runs -\fBnmcli\fR -as both NetworkManager secret and a polkit agent\&. -.RE -.SH "COLORS" -.PP -Implicit coloring can be disabled by an empty file -/etc/terminal\-colors\&.d/nmcli\&.disable\&. -.PP -See -\fBterminal-colors.d\fR(5) -for more details about colorization configuration\&. The logical color names supported by -\fBnmcli\fR -are: -.PP -\fBconnection\-activated\fR -.RS 4 -A connection that is active\&. -.RE -.PP -\fBconnection\-activating\fR -.RS 4 -Connection that is being activated\&. -.RE -.PP -\fBconnection\-disconnecting\fR -.RS 4 -Connection that is being disconnected\&. -.RE -.PP -\fBconnection\-external\fR -.RS 4 -Connection representing configuration created externally to NetworkManager\&. -.RE -.PP -\fBconnection\-invisible\fR -.RS 4 -Connection whose details is the user not permitted to see\&. -.RE -.PP -\fBconnection\-deprecated\fR -.RS 4 -Connection that uses deprecated settings\&. It might not be possible to activate it\&. -.RE -.PP -\fBconnectivity\-full\fR -.RS 4 -Connectivity state when Internet is reachable\&. -.RE -.PP -\fBconnectivity\-limited\fR -.RS 4 -Connectivity state when only a local network reachable\&. -.RE -.PP -\fBconnectivity\-none\fR -.RS 4 -Connectivity state when the network is disconnected\&. -.RE -.PP -\fBconnectivity\-portal\fR -.RS 4 -Connectivity state when a captive portal hijacked the connection\&. -.RE -.PP -\fBconnectivity\-unknown\fR -.RS 4 -Connectivity state when a connectivity check didn\*(Aqt run\&. -.RE -.PP -\fBdevice\-activated\fR -.RS 4 -Device that is connected\&. -.RE -.PP -\fBdevice\-activating\fR -.RS 4 -Device that is being configured\&. -.RE -.PP -\fBdevice\-disconnected\fR -.RS 4 -Device that is not connected\&. -.RE -.PP -\fBdevice\-external\fR -.RS 4 -Device configured externally to NetworkManager\&. -.RE -.PP -\fBdevice\-firmware\-missing\fR -.RS 4 -Warning of a missing device firmware\&. -.RE -.PP -\fBdevice\-plugin\-missing\fR -.RS 4 -Warning of a missing device plugin\&. -.RE -.PP -\fBdevice\-unavailable\fR -.RS 4 -Device that is not available for activation\&. -.RE -.PP -\fBdevice\-disabled\fR -.RS 4 -Device is disabled by software or hardware kill switch\&. -.RE -.PP -\fBmanager\-running\fR -.RS 4 -Notice that the NetworkManager daemon is available\&. -.RE -.PP -\fBmanager\-starting\fR -.RS 4 -Notice that the NetworkManager daemon is being initially connected\&. -.RE -.PP -\fBmanager\-stopped\fR -.RS 4 -Notice that the NetworkManager daemon is not available\&. -.RE -.PP -\fBpermission\-auth\fR -.RS 4 -An action that requires user authentication to get permission\&. -.RE -.PP -\fBpermission\-no\fR -.RS 4 -An action that is not permitted\&. -.RE -.PP -\fBpermission\-yes\fR -.RS 4 -An action that is permitted\&. -.RE -.PP -\fBprompt\fR -.RS 4 -Prompt in interactive mode\&. -.RE -.PP -\fBstate\-asleep\fR -.RS 4 -Indication that NetworkManager in suspended state\&. -.RE -.PP -\fBstate\-connected\-global\fR -.RS 4 -Indication that NetworkManager in connected to Internet\&. -.RE -.PP -\fBstate\-connected\-local\fR -.RS 4 -Indication that NetworkManager in local network\&. -.RE -.PP -\fBstate\-connected\-site\fR -.RS 4 -Indication that NetworkManager in connected to networks other than Internet\&. -.RE -.PP -\fBstate\-connecting\fR -.RS 4 -Indication that NetworkManager is establishing a network connection\&. -.RE -.PP -\fBstate\-disconnected\fR -.RS 4 -Indication that NetworkManager is disconnected from a network\&. -.RE -.PP -\fBstate\-disconnecting\fR -.RS 4 -Indication that NetworkManager is being disconnected from a network\&. -.RE -.PP -\fBwifi\-signal\-excellent\fR -.RS 4 -Wi\-Fi network with an excellent signal level\&. -.RE -.PP -\fBwifi\-signal\-fair\fR -.RS 4 -Wi\-Fi network with a fair signal level\&. -.RE -.PP -\fBwifi\-signal\-good\fR -.RS 4 -Wi\-Fi network with a good signal level\&. -.RE -.PP -\fBwifi\-signal\-poor\fR -.RS 4 -Wi\-Fi network with a poor signal level\&. -.RE -.PP -\fBwifi\-signal\-unknown\fR -.RS 4 -Wi\-Fi network that hasn\*(Aqt been actually seen (a hidden AP)\&. -.RE -.PP -\fBwifi\-deprecated\fR -.RS 4 -Wi\-Fi network that might be impossible to connect to due to use of deprecated functionality\&. -.RE -.PP -\fBdisabled\fR -.RS 4 -A property that is turned off\&. -.RE -.PP -\fBenabled\fR -.RS 4 -A property that is turned on\&. -.RE -.SH "ENVIRONMENT VARIABLES" -.PP -\fBnmcli\fR\*(Aqs behavior is affected by the following environment variables\&. -.PP -\fBLC_ALL\fR -.RS 4 -If set to a non\-empty string value, it overrides the values of all the other internationalization variables\&. -.RE -.PP -\fBLC_MESSAGES\fR -.RS 4 -Determines the locale to be used for internationalized messages\&. -.RE -.PP -\fBLANG\fR -.RS 4 -Provides a default value for the internationalization variables that are unset or null\&. -.RE -.PP -\fBNO_COLOR\fR -.RS 4 -Default to not producing colored and paged output\&. The -\fB\-\-colors\fR -option, if used, takes precedence\&. -.RE -.PP -\fBPAGER\fR -.RS 4 -Filter to pipe the output through if it doesn\*(Aqt fit on a screen\&. Can be a file name of an executable or a shell command\&. Empty string to disable the functionality\&. -.sp -Note that the pager command is expected to handle wide characters and ANSI escape sequences for changing colors (unless they\*(Aqre disabled)\&. -\fBnmcli\fR -sets up the environment variables -\fBLESS\fR -and -\fBLESSCHARSET\fR -appropriately for the -\fBless\fR(1) -pager, other pagers may or may not need extra configuration\&. -.sp -If unspecified, -\fBpager\fR(1), -\fBless\fR(1) -and -\fBmore\fR(1) -will be tried (in that order)\&. -.RE -.PP -\fBTERM\fR -.RS 4 -Terminal type\&. If -dumb, -\fBnmcli\fR -will not use a pager or produce ANSI escape sequences for coloring\&. -.sp -Terminal types other than -dumb -are assumed to support ASCII escape sequences for setting the output color\&. -.RE -.SH "INTERNATIONALIZATION NOTES" -.PP -Be aware that -\fBnmcli\fR -is localized and that is why the output depends on your environment\&. This is important to realize especially when you parse the output\&. -.PP -Call -\fBnmcli\fR -as -\fBLC_ALL=C nmcli\fR -to be sure the locale is set to -C -while executing in a script\&. -.PP -\fBLC_ALL\fR, -\fBLC_MESSAGES\fR, -\fBLANG\fR -variables specify the -\fBLC_MESSAGES\fR -locale category (in that order), which determines the language that -\fBnmcli\fR -uses for messages\&. The -C -locale is used if none of these variables are set, and this locale uses English messages\&. -.SH "EXIT STATUS" -.PP -\fBnmcli\fR -exits with status 0 if it succeeds, a value greater than 0 is returned if an error occurs\&. -.PP -\fB0\fR -.RS 4 -Success \(en indicates the operation succeeded\&. -.RE -.PP -\fB1\fR -.RS 4 -Unknown or unspecified error\&. -.RE -.PP -\fB2\fR -.RS 4 -Invalid user input, wrong -\fBnmcli\fR -invocation\&. -.RE -.PP -\fB3\fR -.RS 4 -Timeout expired (see -\fB\-\-wait\fR -option)\&. -.RE -.PP -\fB4\fR -.RS 4 -Connection activation failed\&. -.RE -.PP -\fB5\fR -.RS 4 -Connection deactivation failed\&. -.RE -.PP -\fB6\fR -.RS 4 -Disconnecting device failed\&. -.RE -.PP -\fB7\fR -.RS 4 -Connection deletion failed\&. -.RE -.PP -\fB8\fR -.RS 4 -NetworkManager is not running\&. -.RE -.PP -\fB10\fR -.RS 4 -Connection, device, or access point does not exist\&. -.RE -.PP -\fB65\fR -.RS 4 -When used with -\fB\-\-complete\-args\fR -option, a file name is expected to follow\&. -.RE -.SH "EXAMPLES" -.PP -This section presents various examples of -\fBnmcli\fR -usage\&. If you want even more, please refer to -\fBnmcli-examples\fR(7) -manual page\&. -.PP -\fBnmcli \-t \-f RUNNING general\fR -.RS 4 -tells you whether NetworkManager is running or not\&. -.RE -.PP -\fBnmcli \-t \-f STATE general\fR -.RS 4 -shows the overall status of NetworkManager\&. -.RE -.PP -\fBnmcli radio wifi off\fR -.RS 4 -switches Wi\-Fi off\&. -.RE -.PP -\fBnmcli connection show\fR -.RS 4 -lists all connections NetworkManager has\&. -.RE -.PP -\fBnmcli \-p \-m multiline \-f all con show\fR -.RS 4 -shows all configured connections in multi\-line mode\&. -.RE -.PP -\fBnmcli connection show \-\-active\fR -.RS 4 -lists all currently active connections\&. -.RE -.PP -\fBnmcli \-f name,autoconnect c s\fR -.RS 4 -shows all connection profile names and their auto\-connect property\&. -.RE -.PP -\fBnmcli \-p connection show "My default em1"\fR -.RS 4 -shows details for "My default em1" connection profile\&. -.RE -.PP -\fBnmcli \-\-show\-secrets connection show "My Home Wi\-Fi"\fR -.RS 4 -shows details for "My Home Wi\-Fi" connection profile with all passwords\&. Without -\fB\-\-show\-secrets\fR -option, secrets would not be displayed\&. -.RE -.PP -\fBnmcli \-f active connection show "My default em1"\fR -.RS 4 -shows details for "My default em1" active connection, like IP, DHCP information, etc\&. -.RE -.PP -\fBnmcli \-f profile con s "My wired connection"\fR -.RS 4 -shows static configuration details of the connection profile with "My wired connection" name\&. -.RE -.PP -\fBnmcli \-p con up "My wired connection" ifname eth0\fR -.RS 4 -activates the connection profile with name "My wired connection" on interface eth0\&. The \-p option makes -\fBnmcli\fR -show progress of the activation\&. -.RE -.PP -\fBnmcli con up 6b028a27\-6dc9\-4411\-9886\-e9ad1dd43761 ap 00:3A:98:7C:42:D3\fR -.RS 4 -connects the Wi\-Fi connection with UUID 6b028a27\-6dc9\-4411\-9886\-e9ad1dd43761 to the AP with BSSID 00:3A:98:7C:42:D3\&. -.RE -.PP -\fBnmcli device status\fR -.RS 4 -shows the status for all devices\&. -.RE -.PP -\fBnmcli dev down em2\fR -.RS 4 -disconnects a connection on interface em2 and marks the device as unavailable for auto\-connecting\&. As a result, no connection will automatically be activated on the device until the device\*(Aqs \*(Aqautoconnect\*(Aq is set to TRUE or the user manually activates a connection\&. -.RE -.PP -\fBnmcli \-f GENERAL,WIFI\-PROPERTIES dev show wlan0\fR -.RS 4 -shows details for wlan0 interface; only GENERAL and WIFI\-PROPERTIES sections will be shown\&. -.RE -.PP -\fBnmcli \-f CONNECTIONS device show wlp3s0\fR -.RS 4 -shows all available connection profiles for your Wi\-Fi interface wlp3s0\&. -.RE -.PP -\fBnmcli dev wifi\fR -.RS 4 -lists available Wi\-Fi access points known to NetworkManager\&. -.RE -.PP -\fBnmcli dev wifi con "Cafe Hotspot 1" password caffeine name "My cafe"\fR -.RS 4 -creates a new connection named "My cafe" and then connects it to "Cafe Hotspot 1" SSID using password "caffeine"\&. This is mainly useful when connecting to "Cafe Hotspot 1" for the first time\&. Next time, it is better to use -\fBnmcli con up id "My cafe"\fR -so that the existing connection profile can be used and no additional is created\&. -.RE -.PP -\fBnmcli \-s dev wifi hotspot con\-name QuickHotspot\fR -.RS 4 -creates a hotspot profile and connects it\&. Prints the hotspot password the user should use to connect to the hotspot from other devices\&. -.RE -.PP -\fBnmcli dev modify em1 ipv4\&.method shared\fR -.RS 4 -starts IPv4 connection sharing using em1 device\&. The sharing will be active until the device is disconnected\&. -.RE -.PP -\fBnmcli dev modify em1 ipv6\&.address 2001:db8::a:bad:c0de\fR -.RS 4 -temporarily adds an IP address to a device\&. The address will be removed when the same connection is activated again\&. -.RE -.PP -\fBnmcli connection add type ethernet autoconnect no ifname eth0\fR -.RS 4 -non\-interactively adds an Ethernet connection tied to eth0 interface with automatic IP configuration (DHCP), and disables the connection\*(Aqs -autoconnect -flag\&. -.RE -.PP -\fBnmcli c a ifname Maxipes\-fik type vlan dev eth0 id 55\fR -.RS 4 -non\-interactively adds a VLAN connection with ID 55\&. The connection will use eth0 and the VLAN interface will be named Maxipes\-fik\&. -.RE -.PP -\fBnmcli c a ifname eth0 type ethernet ipv4\&.method disabled ipv6\&.method link\-local\fR -.RS 4 -non\-interactively adds a connection that will use eth0 Ethernet interface and only have an IPv6 link\-local address configured\&. -.RE -.PP -\fBnmcli connection edit ethernet\-em1\-2\fR -.RS 4 -edits existing "ethernet\-em1\-2" connection in the interactive editor\&. -.RE -.PP -\fBnmcli connection edit type ethernet con\-name "yet another Ethernet connection"\fR -.RS 4 -adds a new Ethernet connection in the interactive editor\&. -.RE -.PP -\fBnmcli con mod ethernet\-2 connection\&.autoconnect no\fR -.RS 4 -modifies \*(Aqautoconnect\*(Aq property in the \*(Aqconnection\*(Aq setting of \*(Aqethernet\-2\*(Aq connection\&. -.RE -.PP -\fBnmcli con mod "Home Wi\-Fi" wifi\&.mtu 1350\fR -.RS 4 -modifies \*(Aqmtu\*(Aq property in the \*(Aqwifi\*(Aq setting of \*(AqHome Wi\-Fi\*(Aq connection\&. -.RE -.PP -\fBnmcli con mod em1\-1 ipv4\&.method manual ipv4\&.addr "192\&.168\&.1\&.23/24 192\&.168\&.1\&.1, 10\&.10\&.1\&.5/8, 10\&.0\&.0\&.11"\fR -.RS 4 -sets manual addressing and the addresses in em1\-1 profile\&. -.RE -.PP -\fBnmcli con modify ABC +ipv4\&.dns 8\&.8\&.8\&.8\fR -.RS 4 -appends a Google public DNS server to DNS servers in ABC profile\&. -.RE -.PP -\fBnmcli con modify ABC \-ipv4\&.addresses "192\&.168\&.100\&.25/24 192\&.168\&.1\&.1"\fR -.RS 4 -removes the specified IP address from (static) profile ABC\&. -.RE -.PP -\fBnmcli con import type openvpn file ~/Downloads/frootvpn\&.ovpn\fR -.RS 4 -imports an OpenVPN configuration to NetworkManager\&. -.RE -.PP -\fBnmcli con export corp\-vpnc /home/joe/corpvpn\&.conf\fR -.RS 4 -exports NetworkManager VPN profile corp\-vpnc as standard Cisco (vpnc) configuration\&. -.RE -.SH "NOTES" -.PP -\fBnmcli\fR -accepts abbreviations, as long as they are a unique prefix in the set of possible options\&. As new options get added, these abbreviations are not guaranteed to stay unique\&. For scripting and long term compatibility it is therefore strongly advised to spell out the full option names\&. -.SH "BUGS" -.PP -There are probably some bugs\&. If you find a bug, please report it to your distribution or upstream at -https://gitlab\&.freedesktop\&.org/NetworkManager/NetworkManager\&. -.SH "SEE ALSO" -.PP -\fBnmcli-examples\fR(7), -\fBnm-settings-nmcli\fR(5), -\fBnm-online\fR(1), -\fBNetworkManager\fR(8), -\fBNetworkManager.conf\fR(5), -\fBnm-applet\fR(1), -\fBnm-connection-editor\fR(1), -\fBterminal-colors.d\fR(5)\&. diff --git a/man/nmtui.1 b/man/nmtui.1 deleted file mode 100644 index f99bef43..00000000 --- a/man/nmtui.1 +++ /dev/null @@ -1,76 +0,0 @@ -'\" t -.\" Title: nmtui -.\" Author: -.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 10/02/2024 -.\" Manual: General Commands Manual -.\" Source: NetworkManager 1.50.0 -.\" Language: English -.\" -.TH "NMTUI" "1" "" "NetworkManager 1\&.50\&.0" "General Commands Manual" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nmtui \- Text User Interface for controlling NetworkManager -.SH "SYNOPSIS" -.HP \w'\fBnmtui\-edit\ |\ nmtui\ edit\ \fR\ 'u -\fBnmtui\-edit | nmtui\ edit \fR {\fIname\fR\ |\ \fIid\fR} -.HP \w'\fBnmtui\-connect\ |\ nmtui\ connect\ \fR\ 'u -\fBnmtui\-connect | nmtui\ connect \fR {\fIname\fR\ |\ \fIuuid\fR\ |\ \fIdevice\fR\ |\ \fISSID\fR} -.HP \w'\fBnmtui\-hostname\ |\ nmtui\ hostname\ \fR\ 'u -\fBnmtui\-hostname | nmtui\ hostname \fR -.SH "DESCRIPTION" -.PP -\fBnmtui\fR -is a curses\(hybased TUI application for interacting with NetworkManager\&. When starting -\fBnmtui\fR, the user is prompted to choose the activity to perform unless it was specified as the first argument\&. -.PP -The supported activities are: -.PP -\fBedit\fR -.RS 4 -Show a connection editor that supports adding, modifying, viewing and deleting connections\&. It provides similar functionality as -\fBnm\-connection\-editor\fR\&. -.RE -.PP -\fBconnect\fR -.RS 4 -Show a list of available connections, with the option to activate or deactivate them\&. It provides similar functionality as -\fBnm\-applet\fR\&. -.RE -.PP -\fBhostname\fR -.RS 4 -Set the system hostname\&. -.RE -.PP -Corresponding to above activities, -\fBnmtui\fR -also comes with binaries named -\fBnmtui\-edit\fR, -\fBnmtui\-connect\fR, and -\fBnmtui\-hostname\fR -to skip the selection of the activities\&. -.SH "SEE ALSO" -.PP -\fBnmcli\fR(1), -\fBnm-applet\fR(1), -\fBnm-connection-editor\fR(1), -\fBNetworkManager\fR(8)\&. |