diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/Makefile.am | 1 | ||||
| -rw-r--r-- | man/Makefile.in | 1 | ||||
| -rw-r--r-- | man/NetworkManager.8 | 308 | ||||
| -rw-r--r-- | man/NetworkManager.conf.5 | 905 | ||||
| -rw-r--r-- | man/NetworkManager.conf.xml | 22 | ||||
| -rw-r--r-- | man/NetworkManager.conf.xml.in | 20 | ||||
| -rw-r--r-- | man/NetworkManager.xml | 2 | ||||
| -rw-r--r-- | man/nm-online.1.in | 2 | ||||
| -rw-r--r-- | man/nm-settings-ifcfg-rh.5 | 26 | ||||
| -rw-r--r-- | man/nm-settings-ifcfg-rh.xml | 6 | ||||
| -rw-r--r-- | man/nm-settings-keyfile.5 | 6 | ||||
| -rw-r--r-- | man/nm-settings-keyfile.xml | 2 | ||||
| -rw-r--r-- | man/nm-settings.5 | 34 | ||||
| -rw-r--r-- | man/nm-settings.xml | 12 | ||||
| -rw-r--r-- | man/nmcli-examples.5 | 693 | ||||
| -rw-r--r-- | man/nmcli-examples.xml | 36 | ||||
| -rw-r--r-- | man/nmcli.1.in | 41 | ||||
| -rw-r--r-- | man/nmtui.1.in | 2 |
18 files changed, 2031 insertions, 88 deletions
diff --git a/man/Makefile.am b/man/Makefile.am index be33eeb2..65d8d007 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -94,6 +94,7 @@ EXTRA_DIST += \ nm-settings-ifcfg-rh.xml \ nm-settings-ifcfg-rh.xsl \ $(addsuffix .xml,$(basename $(docbook_generated_man_pages))) \ + $(docbook_generated_man_pages) \ $(docbook_autogenerated_man_pages) man_MANS += $(configure_generated_man_pages) diff --git a/man/Makefile.in b/man/Makefile.in index edf86ef5..07c8d369 100644 --- a/man/Makefile.in +++ b/man/Makefile.in @@ -455,6 +455,7 @@ EXTRA_DIST = NetworkManager.conf.xml.in $(am__append_3) \ nm-settings-keyfile.xsl nm-settings-ifcfg-rh.xml \ nm-settings-ifcfg-rh.xsl $(addsuffix .xml,$(basename \ $(docbook_generated_man_pages))) \ + $(docbook_generated_man_pages) \ $(docbook_autogenerated_man_pages) XSLTPROC = xsltproc XSLTPROC_FLAGS = --xinclude --nonet diff --git a/man/NetworkManager.8 b/man/NetworkManager.8 new file mode 100644 index 00000000..42768d74 --- /dev/null +++ b/man/NetworkManager.8 @@ -0,0 +1,308 @@ +'\" t +.\" Title: NetworkManager +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 03/29/2016 +.\" Manual: Network management daemons +.\" Source: NetworkManager 1.2 +.\" Language: English +.\" +.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.2" "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, WiFi, 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 will execute scripts in the /etc/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 it is always "none"\&. +.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 +The environment contains more information about the interface and the connection\&. The following variables are available for the use in the dispatcher scripts: +.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 +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 +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 "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\-\-plugins\fR +.RS 4 +List plugins used to manage system\-wide connection settings\&. This list has preference over plugins specified in the configuration file\&. Currently supported plugins are: keyfile, +\fBifcfg\-rh\fR, +\fBifcfg\-suse\fR, +\fBifupdown\fR\&. +.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\&. +.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 +No default connection will be created and automatic activation will not be attempted when this property of a device is set to a true value ("1" or "true")\&. You will still be able to attach a connection to the device manually or observe externally added configuration such as addresses or routes\&. +.sp +Create an udev rule that sets this property to prevent NetworkManager from interfering with virtual Ethernet device interfaces that are managed by virtualization tools\&. +.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\&. The signal also forces a rewrite of DNS configuration\&. +.RE +.PP +\fISIGUSR1\fR +.RS 4 +The signal forces a rewrite of DNS configuration\&. +.RE +.PP +\fISIGUSR2\fR +.RS 4 +The signal has no effect at the moment\&. +.RE +.SH "DEBUGGING" +.PP +The following environment variables are supported to help debugging\&. When used in conjunction with the +\fB\-\-no\-daemon\fR +option (thus echoing PPP and DHCP helper output to stdout) these can quickly help pinpoint the source of connection issues\&. Also see the +\fB\-\-log\-level\fR +and +\fB\-\-log\-domains\fR +to enable debug logging inside NetworkManager itself\&. +.PP +\fBNM_PPP_DEBUG\fR: When set to anything, causes NetworkManager to turn on PPP debugging in pppd, which logs all PPP and PPTP frames and client/server exchanges\&. +.SH "SEE ALSO" +.PP +\fBNetworkManager.conf\fR(5), +\fBnmcli\fR(1), +\fBnmcli-examples\fR(5), +\fBnm-online\fR(1), +\fBnm-settings\fR(5), +\fBnm-applet\fR(1), +\fBnm-connection-editor\fR(1)\fBudev\fR(7) diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5 new file mode 100644 index 00000000..d0f9acbb --- /dev/null +++ b/man/NetworkManager.conf.5 @@ -0,0 +1,905 @@ +'\" t +.\" Title: NetworkManager.conf +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 03/29/2016 +.\" Manual: Configuration +.\" Source: NetworkManager 1.2 +.\" Language: English +.\" +.TH "NETWORKMANAGER\&.CON" "5" "" "NetworkManager 1\&.2" "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, +/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\&. The loading of a file +/usr/lib/NetworkManager/conf\&.d/\fIname\fR\&.conf +can be prevented by adding a file +/etc/NetworkManager/conf\&.d/\fIname\fR\&.conf\&. In this case, the file from the etc configuration shadows the file from the system configuration directory\&. +.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\&. +.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 +Minimal system settings 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 connections\&. 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 +If NetworkManager defines a distro\-specific network\-configuration plugin for your system, then that will normally be listed here\&. (See below for the available plugins\&.) Note that the +keyfile +plugin is always appended to the end of this list (if it doesn\*(Aqt already appear earlier in the list), so if there is no distro\-specific plugin for your system then you can leave this key unset and NetworkManager will fall back to using +keyfile\&. +.RE +.PP +\fImonitor\-connection\-files\fR +.RS 4 +Whether the configured settings plugin(s) should set up file monitors and immediately pick up changes made to connection files while NetworkManager is running\&. This is disabled by default; NetworkManager will only read the connection files at startup, and when explicitly requested via the ReloadConnections D\-Bus call\&. If this key is set to \*(Aqtrue\*(Aq, then NetworkManager will reload connection files any time they changed\&. +.RE +.PP +\fIauth\-polkit\fR +.RS 4 +Whether the system uses PolicyKit for authorization\&. If +false, all requests will be allowed\&. If +true, non\-root requests are authorized using PolicyKit\&. The default value is +true\&. +.RE +.PP +\fIdhcp\fR +.RS 4 +This key sets up what DHCP client NetworkManager will use\&. Allowed values are +dhclient, +dhcpcd, and +internal\&. The +dhclient +and +dhcpcd +options require the indicated clients to be installed\&. The +internal +option uses a built\-in DHCP client which is not currently as featureful as the external clients\&. +.sp +If this key is missing, available DHCP clients are looked for in this order: +dhclient, +dhcpcd, +internal\&. +.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/run/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 +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 +Listing a device here 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 +See +the section called \(lqDevice List Format\(rq +for the syntax how to specify a device\&. +.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 +When set to \*(Aqtrue\*(Aq, NetworkManager quits after performing initial network configuration but spawns small helpers to preserve DHCP leases and IPv6 addresses\&. This is useful in environments where network setup is more or less static or it is desirable to save process time but still handle some dynamic configurations\&. When this option is +true, network configuration for WiFi, WWAN, Bluetooth, ADSL, and PPPoE interfaces cannot be preserved due to their use of external services, and these devices will be deconfigured when NetworkManager quits even though other interface\*(Aqs configuration may be preserved\&. Also, to preserve DHCP addresses the \*(Aqdhcp\*(Aq option must be set to \*(Aqinternal\*(Aq\&. The default value of the \*(Aqconfigure\-and\-quit\*(Aq option is \*(Aqfalse\*(Aq, meaning that NetworkManager will continue running after initial network configuration and continue responding to system and hardware events, D\-Bus requests, and user commands\&. +.RE +.PP +\fIdns\fR +.RS 4 +Set the DNS (resolv\&.conf) processing mode\&. +.sp +default: The default if the key is not specified\&. NetworkManager will update +resolv\&.conf +to reflect the nameservers provided by currently active connections\&. +.sp +dnsmasq: NetworkManager will run dnsmasq as a local caching nameserver, using a "split DNS" configuration if you are connected to a VPN, and then update +resolv\&.conf +to point to the local nameserver\&. +.sp +unbound: NetworkManager will talk to unbound and dnssec\-triggerd, providing a "split DNS" configuration with DNSSEC support\&. The /etc/resolv\&.conf will be managed by dnssec\-trigger daemon\&. +.sp +none: NetworkManager will not modify resolv\&.conf\&. +.RE +.PP +\fIrc\-manager\fR +.RS 4 +Set the +resolv\&.conf +management mode\&. The default value depends on how NetworkManager was built\&. Regardless of this setting, NetworkManager will always write resolv\&.conf to its runtime state directory\&. +.sp +none: NetworkManager will symlink +/etc/resolv\&.conf +to its private resolv\&.conf file in the runtime state directory\&. +.sp +file: NetworkManager will write +/etc/resolv\&.conf +as file\&. +.sp +resolvconf: NetworkManager will run resolvconf to update the DNS configuration\&. +.sp +netconfig: NetworkManager will run netconfig to update the DNS configuration\&. +.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 +.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 "/usr/local/etc/NetworkManager/conf\&.d"\&. +.RE +.PP +\fIunmanaged\-devices\fR +.RS 4 +Set devices that should be ignored by NetworkManager\&. +.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 +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\&. Any settings here are overridden by the +\fB\-\-log\-level\fR +and +\fB\-\-log\-domains\fR +command\-line options\&. +.PP +.PP +\fIlevel\fR +.RS 4 +The default logging verbosity level\&. One of +OFF, +ERR, +WARN, +INFO, +DEBUG, +TRACE\&. The ERR level logs only critical errors\&. WARN logs warnings that may reflect operation\&. INFO logs various informational messages that are useful for tracking state and operations\&. DEBUG enables verbose logging for debugging purposes\&. TRACE enables even more verbose logging then DEBUG level\&. Subsequent levels also log all messages from earlier levels; thus setting the log level to INFO also logs error and warning messages\&. +.RE +.PP +\fIdomains\fR +.RS 4 +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\&. +.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"\&. +.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 +.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 + +.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 +.RE +.PP +\fIbackend\fR +.RS 4 +The logging backend\&. Supported values are "debug", "syslog", "journal"\&. "debug" uses syslog and logs to standard error\&. If NetworkManager is started in debug mode (\-\-debug) this option is ignored and "debug" is always used\&. Otherwise, the default is "journal"\&. +.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 +true\&. +.RE +.SH "CONNECTION SECTION" +.PP +Specify default values for connections\&. +.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\fR(5) +for details)\&. A default value is only consulted if the corresponding per\-connection value explicitly allows for that\&. +.PP +\fIconnection\&.autoconnect\-slaves\fR +.RS 4 +.RE +.PP +\fIconnection\&.lldp\fR +.RS 4 +.RE +.PP +\fIethernet\&.wake\-on\-lan\fR +.RS 4 +.RE +.PP +\fIipv4\&.dad\-timeout\fR +.RS 4 +.RE +.PP +\fIipv4\&.dhcp\-timeout\fR +.RS 4 +If left unspecified, the default value for the interface type is used\&. +.RE +.PP +\fIipv4\&.route\-metric\fR +.RS 4 +.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\&.route\-metric\fR +.RS 4 +.RE +.PP +\fIvpn\&.timeout\fR +.RS 4 +If left unspecified, default value of 60 seconds is used\&. +.RE +.PP +\fIwifi\&.mac\-address\-randomization\fR +.RS 4 +If left unspecified, MAC address randomization is disabled\&. +.RE +.PP +\fIwifi\&.powersave\fR +.RS 4 +If left unspecified, the default value "ignore" will be used\&. +.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\-slaves=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, its +ipv6\&.ip6\-privacy +value would be unspecified\&. +.RE +.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 +.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, it\*(Aqs 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 +\fIresponse\fR +.RS 4 +If set controls what body content NetworkManager checks for when requesting the URI for connectivity checking\&. If missing, defaults to "NetworkManager is online" +.RE +.SH "GLOBAL\-DNS SECTION" +.PP +This section specifies global DNS settings that override connection\-specific configuration\&. +.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 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\&. More specific domains have the precedence over less specific ones and the default domain is represented by the wildcard "*"\&. A default domain section is mandatory\&. +.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 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 +# always skip loading 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\&. +.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 +\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\&. +.sp +The stored connection file may contain passwords and private keys, 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\&. +.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 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\&. +.RE +.PP +\fIifcfg\-suse\fR +.RS 4 +This plugin is deprecated and its selection has no effect\&. The +keyfile +plugin should be used instead\&. +.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 +This plugin allows to read iBFT configuration (iSCSI Boot Firmware Table)\&. The configuration is read using /sbin/iscsiadm\&. Users are expected to configure iBFT connections via the firmware interfaces\&. If ibft support is available, it is automatically enabled after +ifcfg\-rh\&. This can be disabled by +no\-ibft\&. You can also explicitly specify +ibft +to load the plugin without +ifcfg\-rh +or to change the plugin order\&. +.RE +.SH "APPENDIX" +.SS "Device List Format" +.PP +The configuration options +main\&.no\-auto\-default, +main\&.ignore\-carrier, and +keyfile\&.unmanaged\-devices +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 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 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 +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\&. +.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 +.SH "SEE ALSO" +.PP +\fBNetworkManager\fR(8), +\fBnmcli\fR(1), +\fBnmcli-examples\fR(5), +\fBnm-online\fR(1), +\fBnm-settings\fR(5), +\fBnm-applet\fR(1), +\fBnm-connection-editor\fR(1) diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml index 3e8b1e80..597f373f 100644 --- a/man/NetworkManager.conf.xml +++ b/man/NetworkManager.conf.xml @@ -17,7 +17,7 @@ Copyright 2010 - 2014 Red Hat, Inc. <manvolnum>5</manvolnum> <refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="manual">Configuration</refmiscinfo> - <refmiscinfo class="version">1.0</refmiscinfo> + <refmiscinfo class="version">1.2</refmiscinfo> </refmeta> <refnamediv> @@ -157,8 +157,7 @@ plugins-=remove-me and <literal>dhcpcd</literal> options require the indicated clients to be installed. The <literal>internal</literal> option uses a built-in DHCP client which is not currently as - featureful as the external clients (and in particular, does - not yet support DHCPv6).</para> + featureful as the external clients.</para> <para>If this key is missing, available DHCP clients are looked for in this order: <literal>dhclient</literal>, <literal>dhcpcd</literal>, @@ -289,9 +288,13 @@ no-auto-default=* <term><varname>rc-manager</varname></term> <listitem><para>Set the <filename>resolv.conf</filename> management mode. The default value depends on how NetworkManager - was built.</para> - <para><literal>none</literal>: NetworkManager will directly - write changes to <filename>resolv.conf</filename>.</para> + was built. Regardless of this setting, NetworkManager will + always write resolv.conf to its runtime state directory.</para> + <para><literal>none</literal>: NetworkManager will symlink + <filename>/etc/resolv.conf</filename> to its private + resolv.conf file in the runtime state directory.</para> + <para><literal>file</literal>: NetworkManager will write + <filename>/etc/resolv.conf</filename> as file.</para> <para><literal>resolvconf</literal>: NetworkManager will run resolvconf to update the DNS configuration.</para> <para><literal>netconfig</literal>: NetworkManager will run @@ -483,14 +486,11 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth <term><varname>backend</varname></term> <listitem><para>The logging backend. Supported values are "<literal>debug</literal>", "<literal>syslog</literal>", - "<literal>journal</literal>" and "<literal>journal-syslog-style</literal>. + "<literal>journal</literal>". "<literal>debug</literal>" uses syslog and logs to standard error. - "<literal>journal-syslog-style</literal>" prints the same message to journal - as it would print for "<literal>syslog</literal>", containing redundant - fields in the text. If NetworkManager is started in debug mode (<literal>--debug</literal>) this option is ignored and "<literal>debug</literal>" is always used. - Otherwise, the default is "<literal>journal-syslog-style</literal>". + Otherwise, the default is "<literal>journal</literal>". </para></listitem> </varlistentry> <varlistentry> diff --git a/man/NetworkManager.conf.xml.in b/man/NetworkManager.conf.xml.in index 75e1d938..2a847f8f 100644 --- a/man/NetworkManager.conf.xml.in +++ b/man/NetworkManager.conf.xml.in @@ -17,7 +17,7 @@ Copyright 2010 - 2014 Red Hat, Inc. <manvolnum>5</manvolnum> <refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="manual">Configuration</refmiscinfo> - <refmiscinfo class="version">1.0</refmiscinfo> + <refmiscinfo class="version">1.2</refmiscinfo> </refmeta> <refnamediv> @@ -157,8 +157,7 @@ plugins-=remove-me and <literal>dhcpcd</literal> options require the indicated clients to be installed. The <literal>internal</literal> option uses a built-in DHCP client which is not currently as - featureful as the external clients (and in particular, does - not yet support DHCPv6).</para> + featureful as the external clients.</para> <para>If this key is missing, available DHCP clients are looked for in this order: <literal>dhclient</literal>, <literal>dhcpcd</literal>, @@ -289,9 +288,13 @@ no-auto-default=* <term><varname>rc-manager</varname></term> <listitem><para>Set the <filename>resolv.conf</filename> management mode. The default value depends on how NetworkManager - was built.</para> - <para><literal>none</literal>: NetworkManager will directly - write changes to <filename>resolv.conf</filename>.</para> + was built. Regardless of this setting, NetworkManager will + always write resolv.conf to its runtime state directory.</para> + <para><literal>none</literal>: NetworkManager will symlink + <filename>/etc/resolv.conf</filename> to its private + resolv.conf file in the runtime state directory.</para> + <para><literal>file</literal>: NetworkManager will write + <filename>/etc/resolv.conf</filename> as file.</para> <para><literal>resolvconf</literal>: NetworkManager will run resolvconf to update the DNS configuration.</para> <para><literal>netconfig</literal>: NetworkManager will run @@ -483,11 +486,8 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth <term><varname>backend</varname></term> <listitem><para>The logging backend. Supported values are "<literal>debug</literal>", "<literal>syslog</literal>", - "<literal>journal</literal>" and "<literal>journal-syslog-style</literal>. + "<literal>journal</literal>". "<literal>debug</literal>" uses syslog and logs to standard error. - "<literal>journal-syslog-style</literal>" prints the same message to journal - as it would print for "<literal>syslog</literal>", containing redundant - fields in the text. If NetworkManager is started in debug mode (<literal>--debug</literal>) this option is ignored and "<literal>debug</literal>" is always used. Otherwise, the default is "<literal>@NM_CONFIG_LOGGING_BACKEND_DEFAULT_TEXT@</literal>". diff --git a/man/NetworkManager.xml b/man/NetworkManager.xml index e674943e..39dfe484 100644 --- a/man/NetworkManager.xml +++ b/man/NetworkManager.xml @@ -19,7 +19,7 @@ <manvolnum>8</manvolnum> <refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="manual">Network management daemons</refmiscinfo> - <refmiscinfo class="version">1.0</refmiscinfo> + <refmiscinfo class="version">1.2</refmiscinfo> </refmeta> <refnamediv> diff --git a/man/nm-online.1.in b/man/nm-online.1.in index f56f5daf..fbec3716 100644 --- a/man/nm-online.1.in +++ b/man/nm-online.1.in @@ -21,7 +21,7 @@ .\" .\" Copyright (C) 2010 - 2014 Red Hat, Inc. .\" -.TH NM-ONLINE "1" "25 March 2014" +.TH NM-ONLINE "1" "2014-03-25" "NetworkManager 1.2" .SH NAME nm-online \- ask NetworkManager whether the network is connected diff --git a/man/nm-settings-ifcfg-rh.5 b/man/nm-settings-ifcfg-rh.5 index 58daaba0..7b848128 100644 --- a/man/nm-settings-ifcfg-rh.5 +++ b/man/nm-settings-ifcfg-rh.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-ifcfg-rh .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> -.\" Date: 01 March 2016 +.\" Date: 29 March 2016 .\" Manual: Configuration -.\" Source: NetworkManager 1.1.91 +.\" Source: NetworkManager 1.1.92 .\" Language: English .\" -.TH "NM\-SETTINGS\-IFCFG\" "5" "" "NetworkManager 1\&.1\&.91" "Configuration" +.TH "NM\-SETTINGS\-IFCFG\" "5" "" "NetworkManager 1\&.1\&.92" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -367,6 +367,8 @@ l l l l 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 @@ -455,6 +457,15 @@ 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{ client\-cert T}:T{ IEEE_8021X_CLIENT_CERT\fI(+)\fR @@ -547,6 +558,15 @@ 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\-client\-cert T}:T{ IEEE_8021X_INNER_CLIENT_CERT\fI(+)\fR diff --git a/man/nm-settings-ifcfg-rh.xml b/man/nm-settings-ifcfg-rh.xml index b161f5aa..ef8e1df9 100644 --- a/man/nm-settings-ifcfg-rh.xml +++ b/man/nm-settings-ifcfg-rh.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-ifcfg-rh"><refentryinfo><date>01 March 2016</date></refentryinfo><refmeta><refentrytitle>nm-settings-ifcfg-rh</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.1.91</refmiscinfo></refmeta><refnamediv><refname>nm-settings-ifcfg-rh</refname><refpurpose>Description of <emphasis>ifcfg-rh</emphasis> settings plugin</refpurpose></refnamediv><refsect1><title>DESCRIPTION</title><para> +<refentry id="nm-settings-ifcfg-rh"><refentryinfo><date>29 March 2016</date></refentryinfo><refmeta><refentrytitle>nm-settings-ifcfg-rh</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.1.92</refmiscinfo></refmeta><refnamediv><refname>nm-settings-ifcfg-rh</refname><refpurpose>Description of <emphasis>ifcfg-rh</emphasis> settings plugin</refpurpose></refnamediv><refsect1><title>DESCRIPTION</title><para> NetworkManager is based on the concept of connection profiles that contain network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing @@ -181,7 +181,7 @@ Example: </emphasis>IEEE_8021X_CA_CERT=/home/joe/cacert.crt</entry></row><row><e Example: </emphasis>IEEE_8021X_SUBJECT_MATCH="Red Hat"</entry></row><row><entry align="left">altsubject-matches</entry><entry align="left">IEEE_8021X_ALTSUBJECT_MATCHES<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">List of strings to be matched against the altSubjectName.<emphasis role="bold"> -Example: </emphasis>IEEE_8021X_ALTSUBJECT_MATCHES="s1.domain.cc"</entry></row><row><entry align="left">client-cert</entry><entry align="left">IEEE_8021X_CLIENT_CERT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Client certificate for EAP.<emphasis role="bold"> +Example: </emphasis>IEEE_8021X_ALTSUBJECT_MATCHES="s1.domain.cc"</entry></row><row><entry align="left">domain-suffix-match</entry><entry align="left">IEEE_8021X_DOMAIN_SUFFIX_MATCH<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Suffix to match domain of server certificate against.</entry></row><row><entry align="left">client-cert</entry><entry align="left">IEEE_8021X_CLIENT_CERT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Client certificate for EAP.<emphasis role="bold"> Example: </emphasis>IEEE_8021X_CLIENT_CERT=/home/joe/mycert.crt</entry></row><row><entry align="left">phase1-peapver</entry><entry align="left">IEEE_8021X_PEAP_VERSION<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Use to force a specific PEAP version.<emphasis role="bold"> @@ -201,7 +201,7 @@ Example: </emphasis>IEEE_8021X_INNER_AUTH_METHODS="MSCHAPV2 EAP-TLS"<emphasis ro Allowed values: </emphasis>"EAP-MD5", "EAP-MSCHAPV2", "EAP-GTC", "EAP-OTP" and "EAP-TLS"</entry></row><row><entry align="left">phase2-subject-match</entry><entry align="left">IEEE_8021X_PHASE2_SUBJECT_MATCH<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Substring to match subject of server certificate against.<emphasis role="bold"> -Example: </emphasis>IEEE_8021X_PHASE2_SUBJECT_MATCH="Red Hat"</entry></row><row><entry align="left">phase2-altsubject-matches</entry><entry align="left">IEEE_8021X_PHASE2_ALTSUBJECT_MATCHES<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left"/></row><row><entry align="left">phase2-client-cert</entry><entry align="left">IEEE_8021X_INNER_CLIENT_CERT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Client certificate for inner EAP method.<emphasis role="bold"> +Example: </emphasis>IEEE_8021X_PHASE2_SUBJECT_MATCH="Red Hat"</entry></row><row><entry align="left">phase2-altsubject-matches</entry><entry align="left">IEEE_8021X_PHASE2_ALTSUBJECT_MATCHES<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left"/></row><row><entry align="left">phase2-domain-suffix-match</entry><entry align="left">IEEE_8021X_PHASE2_DOMAIN_SUFFIX_MATCH<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Suffix to match domain of server certificate for phase 2 against.</entry></row><row><entry align="left">phase2-client-cert</entry><entry align="left">IEEE_8021X_INNER_CLIENT_CERT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Client certificate for inner EAP method.<emphasis role="bold"> Example: </emphasis>IEEE_8021X_INNER_CLIENT_CERT=/home/joe/mycert.crt</entry></row><row><entry align="left">password</entry><entry align="left">IEEE_8021X_PASSWORD<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">UTF-8 encoded password used for EAP. It can also go to "key-" lookaside file, or it can be owned by a secret agent.</entry></row><row><entry align="left">password-flags</entry><entry align="left">IEEE_8021X_PASSWORD_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for IEEE_8021X_PASSWORD password. (see <xref linkend="secrets-flags"/> for _FLAGS values)</entry></row><row><entry align="left">password-raw</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">password-raw-flags</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">private-key</entry><entry align="left">IEEE_8021X_PRIVATE_KEY<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Private key for EAP-TLS.<emphasis role="bold"> diff --git a/man/nm-settings-keyfile.5 b/man/nm-settings-keyfile.5 index eddeec0d..ef5069ff 100644 --- a/man/nm-settings-keyfile.5 +++ b/man/nm-settings-keyfile.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-keyfile .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> -.\" Date: 01 March 2016 +.\" Date: 29 March 2016 .\" Manual: Configuration -.\" Source: NetworkManager 1.1.91 +.\" Source: NetworkManager 1.1.92 .\" Language: English .\" -.TH "NM\-SETTINGS\-KEYFIL" "5" "" "NetworkManager 1\&.1\&.91" "Configuration" +.TH "NM\-SETTINGS\-KEYFIL" "5" "" "NetworkManager 1\&.1\&.92" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-settings-keyfile.xml b/man/nm-settings-keyfile.xml index 7e210548..d8cdfe21 100644 --- a/man/nm-settings-keyfile.xml +++ b/man/nm-settings-keyfile.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-keyfile"><refentryinfo><date>01 March 2016</date></refentryinfo><refmeta><refentrytitle>nm-settings-keyfile</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.1.91</refmiscinfo></refmeta><refnamediv><refname>nm-settings-keyfile</refname><refpurpose>Description of <emphasis>keyfile</emphasis> settings plugin</refpurpose></refnamediv><refsect1><title>DESCRIPTION</title><para> +<refentry id="nm-settings-keyfile"><refentryinfo><date>29 March 2016</date></refentryinfo><refmeta><refentrytitle>nm-settings-keyfile</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.1.92</refmiscinfo></refmeta><refnamediv><refname>nm-settings-keyfile</refname><refpurpose>Description of <emphasis>keyfile</emphasis> settings plugin</refpurpose></refnamediv><refsect1><title>DESCRIPTION</title><para> NetworkManager is based on the concept of connection profiles that contain network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing diff --git a/man/nm-settings.5 b/man/nm-settings.5 index d1e15a07..d24d2fbe 100644 --- a/man/nm-settings.5 +++ b/man/nm-settings.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings .\" Author: [see the "AUTHOR" section] .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> -.\" Date: 01 March 2016 +.\" Date: 29 March 2016 .\" Manual: Configuration -.\" Source: NetworkManager 1.1.91 +.\" Source: NetworkManager 1.1.92 .\" Language: English .\" -.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.1\&.91" "Configuration" +.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.1\&.92" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -109,6 +109,8 @@ l l l l 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 @@ -156,6 +158,15 @@ 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{ +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\&. +T} +T{ eap T}:T{ array of string @@ -309,6 +320,15 @@ 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\-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\&. +T} +T{ phase2\-private\-key T}:T{ byte array @@ -342,7 +362,7 @@ 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\&. +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 its use is deprecated in favor of NMSetting8021x:phase2\-domain\-suffix\-match\&. T} T{ pin @@ -396,7 +416,7 @@ 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\&. +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 its use is deprecated in favor of NMSetting8021x:domain\-suffix\-match\&. T} T{ system\-ca\-certs @@ -1692,7 +1712,7 @@ string T}:T{ \ \& T}:T{ -IP configuration method\&. NMSettingIP4Config and NMSettingIP6Config both support "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\&. +IP configuration method\&. NMSettingIP4Config and NMSettingIP6Config both support "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\&. T} T{ name @@ -1923,7 +1943,7 @@ string T}:T{ \ \& T}:T{ -IP configuration method\&. NMSettingIP4Config and NMSettingIP6Config both support "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\&. +IP configuration method\&. NMSettingIP4Config and NMSettingIP6Config both support "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\&. T} T{ name diff --git a/man/nm-settings.xml b/man/nm-settings.xml index d38b24a6..9b709621 100644 --- a/man/nm-settings.xml +++ b/man/nm-settings.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings"><refentryinfo><date>01 March 2016</date></refentryinfo><refmeta><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.1.91</refmiscinfo></refmeta><refnamediv><refname>nm-settings</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles</refpurpose></refnamediv><refsect1><title>DESCRIPTION</title><para> +<refentry id="nm-settings"><refentryinfo><date>29 March 2016</date></refentryinfo><refmeta><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.1.92</refmiscinfo></refmeta><refnamediv><refname>nm-settings</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles</refpurpose></refnamediv><refsect1><title>DESCRIPTION</title><para> NetworkManager is based on a concept of connection profiles, sometimes referred to as connections only. These connection profiles contain a network configuration. When NetworkManager activates a connection profile on a network device the configuration will @@ -39,6 +39,7 @@ <row><entry align="left">ca-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry>Contains the CA 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's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</entry></row> <row><entry align="left">ca-path</entry><entry align="left">string</entry><entry align="left"/><entry>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.</entry></row> <row><entry align="left">client-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry>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's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.</entry></row> + <row><entry align="left">domain-suffix-match</entry><entry align="left">string</entry><entry align="left"/><entry>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.</entry></row> <row><entry align="left">eap</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>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.</entry></row> <row><entry align="left">identity</entry><entry align="left">string</entry><entry align="left"/><entry>Identity string for EAP authentication methods. Often the user's user or login name.</entry></row> <row><entry align="left">name</entry><entry align="left">string</entry><entry align="left">802-1x</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> @@ -56,16 +57,17 @@ <row><entry align="left">phase2-ca-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry>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"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</entry></row> <row><entry align="left">phase2-ca-path</entry><entry align="left">string</entry><entry align="left"/><entry>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.</entry></row> <row><entry align="left">phase2-client-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry>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's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</entry></row> + <row><entry align="left">phase2-domain-suffix-match</entry><entry align="left">string</entry><entry align="left"/><entry>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.</entry></row> <row><entry align="left">phase2-private-key</entry><entry align="left">byte array</entry><entry align="left"/><entry>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's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and 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.</entry></row> <row><entry align="left">phase2-private-key-password</entry><entry align="left">string</entry><entry align="left"/><entry>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.</entry></row> <row><entry align="left">phase2-private-key-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "phase2-private-key-password" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> - <row><entry align="left">phase2-subject-match</entry><entry align="left">string</entry><entry align="left"/><entry>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's subject is performed.</entry></row> + <row><entry align="left">phase2-subject-match</entry><entry align="left">string</entry><entry align="left"/><entry>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's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match.</entry></row> <row><entry align="left">pin</entry><entry align="left">string</entry><entry align="left"/><entry>PIN used for EAP authentication methods.</entry></row> <row><entry align="left">pin-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "pin" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> <row><entry align="left">private-key</entry><entry align="left">byte array</entry><entry align="left"/><entry>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's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and 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.</entry></row> <row><entry align="left">private-key-password</entry><entry align="left">string</entry><entry align="left"/><entry>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.</entry></row> <row><entry align="left">private-key-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "private-key-password" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> - <row><entry align="left">subject-match</entry><entry align="left">string</entry><entry align="left"/><entry>Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed.</entry></row> + <row><entry align="left">subject-match</entry><entry align="left">string</entry><entry align="left"/><entry>Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match.</entry></row> <row><entry align="left">system-ca-certs</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>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).</entry></row> </tbody></tgroup></table> <table><title>adsl setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> @@ -193,7 +195,7 @@ <row><entry align="left">ignore-auto-dns</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</entry></row> <row><entry align="left">ignore-auto-routes</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>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.</entry></row> <row><entry align="left">may-fail</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>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.</entry></row> - <row><entry align="left">method</entry><entry align="left">string</entry><entry align="left"/><entry>IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "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.</entry></row> + <row><entry align="left">method</entry><entry align="left">string</entry><entry align="left"/><entry>IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "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.</entry></row> <row><entry align="left">name</entry><entry align="left">string</entry><entry align="left">ipv4</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left">never-default</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>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.</entry></row> <row><entry align="left">route-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv4 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'gateway' entry, containing the gateway IP address as a string. If the route has a 'metric' 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.</entry></row> @@ -216,7 +218,7 @@ <row><entry align="left">ignore-auto-routes</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>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.</entry></row> <row><entry align="left">ip6-privacy</entry><entry align="left">NMSettingIP6ConfigPrivacy (int32)</entry><entry align="left"/><entry>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" (unknown) means fallback to global configuration "ipv6.ip6-privacy". If also global configuration is 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's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.</entry></row> <row><entry align="left">may-fail</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>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.</entry></row> - <row><entry align="left">method</entry><entry align="left">string</entry><entry align="left"/><entry>IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "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.</entry></row> + <row><entry align="left">method</entry><entry align="left">string</entry><entry align="left"/><entry>IP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "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.</entry></row> <row><entry align="left">name</entry><entry align="left">string</entry><entry align="left">ipv6</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left">never-default</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>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.</entry></row> <row><entry align="left">route-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv6 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' 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.</entry></row> diff --git a/man/nmcli-examples.5 b/man/nmcli-examples.5 new file mode 100644 index 00000000..e25f8717 --- /dev/null +++ b/man/nmcli-examples.5 @@ -0,0 +1,693 @@ +'\" t +.\" Title: nmcli-examples +.\" Author: +.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> +.\" Date: 19 November 2014 +.\" Manual: Examples +.\" Source: NetworkManager 1.2 +.\" Language: English +.\" +.TH "NMCLI\-EXAMPLES" "5" "" "NetworkManager 1\&.2" "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\fB[OPTIONS...]\fR\ 'u +\fBnmcli \fR\fB[OPTIONS...]\fR +.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\&. +.PP +Note: this page has "work\-in\-progress" status\&. +.SH "EXAMPLES" +.PP +\fBExample\ \&1.\ \&Listing available Wi-Fi APs\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB +$ nmcli device wifi list + \fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +* 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.\ \&Showing general information and properties for a Wi-Fi interface\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB +$ nmcli \-p \-f general,wifi\-properties device show wlan0 + \fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +=============================================================================== + 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/0000:03:00\&.0/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\ \&3.\ \&Listing NetworkManager polkit permissions\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB +$ nmcli general permissions + \fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +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 + +.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\ \&4.\ \&Listing NetworkManager log level and domains\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB +$ nmcli general logging + \fR +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +LEVEL DOMAINS +INFO 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 + +.fi +.if n \{\ +.RE +.\} +.PP +This command shows current NetworkManager logging status\&. +.PP +\fBExample\ \&5.\ \&Changing NetworkManager logging\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB +$ nmcli g log level DEBUG domains CORE,ETHER,IP +$ nmcli 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\ \&6.\ \&Adding a bonding master and two slave connection profiles\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB +$ nmcli con add type bond ifname mybond0 mode active\-backup +$ nmcli con add type ethernet ifname eth1 master mybond0 +$ nmcli con add type ethernet ifname eth2 master mybond0 + \fR +.fi +.if n \{\ +.RE +.\} +.PP +This example demonstrates adding a bond master connection and two slaves\&. The first command adds a master bond connection, naming the bonding interface +\fImybond0\fR +and using +\fIactive\-backup\fR +mode\&. The next two commands add slaves connections, both enslaved to +\fImybond0\fR\&. The first slave will be bound to +\fIeth1\fR +interface, the second to +\fIeth2\fR\&. +.PP +\fBExample\ \&7.\ \&Adding a team master and two slave connection profiles\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB +$ nmcli con add type team con\-name Team1 ifname Team1 config team1\-master\-json\&.conf +$ nmcli con add type ethernet con\-name Team1\-slave1 ifname em1 master Team1 +$ nmcli con add type ethernet con\-name Team1\-slave2 ifname em2 master Team1 + \fR +.fi +.if n \{\ +.RE +.\} +.PP +This example demonstrates adding a team master connection profile and two slaves\&. It is very similar to the bonding example\&. The first command adds a master team profile, naming the team interface and the profile +\fITeam1\fR\&. The team configuration for the master is read from +\fIteam1\-master\-json\&.conf\fR +file\&. Later, you can change the configuration with +\fImodify\fR +command (\fBnmcli con modify Team1 team\&.config team1\-master\-another\-json\&.conf\fR)\&. The last two commands add slaves profiles, both enslaved to +\fITeam1\fR\&. The first slave will be bound to +\fIem1\fR +interface, the second to +\fIem2\fR\&. The slaves don\*(Aqt specify +\fIconfig\fR +and thus +\fIteamd\fR +will use its default configuration\&. You will activate the whole setup by activating both slaves: +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB +$ nmcli con up Team1\-slave1 +$ nmcli con up Team1\-slave2 + \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\ \&8.\ \&Adding a bridge and two slave profiles\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +\fB +$ nmcli con add type bridge con\-name TowerBridge ifname TowerBridge +$ nmcli con add type ethernet con\-name br\-slave\-1 ifname ens3 master TowerBridge +$ nmcli con add type ethernet con\-name br\-slave\-2 ifname ens4 master TowerBridge +$ nmcli con modify TowerBridge bridge\&.stp no + \fR +.fi +.if n \{\ +.RE +.\} +.PP +This example demonstrates adding a bridge master connection and two slaves\&. The first command adds a master bridge connection, naming the bridge interface and the profile as +\fITowerBridge\fR\&. The next two commands add slaves profiles, both will be enslaved to +\fITowerBridge\fR\&. The first slave 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\ \&9.\ \&Adding an ethernet connection profile with manual IP configuration\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fB +$ nmcli con add con\-name my\-con\-em1 ifname em1 type ethernet ip4 192\&.168\&.100\&.100/24 gw4 192\&.168\&.100\&.1 ip4 1\&.2\&.3\&.4 ip6 abbe::cafe +$ nmcli con mod my\-con\-em1 ipv4\&.dns "8\&.8\&.8\&.8 8\&.8\&.4\&.4" +$ nmcli con mod my\-con\-em1 +ipv4\&.dns 1\&.2\&.3\&.4 +$ nmcli con mod my\-con\-em1 ipv6\&.dns "2001:4860:4860::8888 2001:4860:4860::8844" +$ nmcli \-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\ \&10.\ \&Escaping colon characters in tabular mode\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fB +$ nmcli \-t \-f general \-e yes \-m tab dev show eth0 + \fR + +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +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 reason 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/NetworkManager/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\ \&11.\ \&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\ \&12.\ \&Adding an ethernet connection profile in interactive editor (a)\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf + \fB +$ nmcli connection edit type ethernet + \fR + +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf + +===| 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> print +=============================================================================== + 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\&.master: \-\- +connection\&.slave\-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> goto ethernet +You may edit the following properties: port, speed, duplex, auto\-negotiate, mac\-address, cloned\-mac\-address, mac\-address\-blacklist, mtu, s390\-subchannels, s390\-nettype, s390\-options +nmcli 802\-3\-ethernet> set mtu 1492 +nmcli 802\-3\-ethernet> b +nmcli> goto ipv4\&.addresses +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> set ipv4\&.gateway 192\&.168\&.1\&.1 +nmcli> verify +Verify connection: OK +nmcli> print +=============================================================================== + 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\&.master: \-\- +connection\&.slave\-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> set ipv4\&.dns 8\&.8\&.8\&.8 8\&.8\&.4\&.4 +nmcli> print +=============================================================================== + 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\&.master: \-\- +connection\&.slave\-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> verify +Verify connection: OK +nmcli> save +Connection \*(Aqethernet\-4\*(Aq (de89cdeb\-a3e1\-4d53\-8fa0\-c22546c775f4) successfully saved\&. +nmcli> quit + +.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)\&. +.SH "SEE ALSO" +.PP +\fBnmcli\fR(1), +\fBNetworkManager\fR(8), +\fBNetworkManager.conf\fR(5), +\fBnm-settings\fR(5), +\fBnm-online\fR(1), +\fBnm-applet\fR(1), +\fBnm-connection-editor\fR(1) diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml index d4ba7172..0ce7dc72 100644 --- a/man/nmcli-examples.xml +++ b/man/nmcli-examples.xml @@ -18,7 +18,7 @@ Copyright 2013 - 2014 Red Hat, Inc. <manvolnum>5</manvolnum> <refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="manual">Examples</refmiscinfo> - <refmiscinfo class="version">1.0</refmiscinfo> + <refmiscinfo class="version">1.2</refmiscinfo> </refmeta> <refnamediv> @@ -143,9 +143,9 @@ org.freedesktop.NetworkManager.settings.modify.hostname auth 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. <emphasis>pkaction</emphasis> command can display description for polkit actions. - <programlisting><command> - pkaction --action-id org.freedesktop.NetworkManager.network-control --verbose - </command></programlisting> + <synopsis><command> +pkaction --action-id org.freedesktop.NetworkManager.network-control --verbose + </command></synopsis> More information about polkit can be found at http://www.freedesktop.org/wiki/Software/polkit. </para> @@ -176,11 +176,11 @@ $ nmcli g log level INFO domains DEFAULT </para> <example><title>Adding a bonding master and two slave connection profiles</title> - <programlisting><emphasis role="bold"> + <synopsis><emphasis role="bold"> $ nmcli con add type bond ifname mybond0 mode active-backup $ nmcli con add type ethernet ifname eth1 master mybond0 $ nmcli con add type ethernet ifname eth2 master mybond0 - </emphasis></programlisting> + </emphasis></synopsis> </example> <para> This example demonstrates adding a bond master connection and two slaves. The @@ -192,11 +192,11 @@ $ nmcli con add type ethernet ifname eth2 master mybond0 </para> <example><title>Adding a team master and two slave connection profiles</title> - <programlisting><emphasis role="bold"> + <synopsis><emphasis role="bold"> $ nmcli con add type team con-name Team1 ifname Team1 config team1-master-json.conf $ nmcli con add type ethernet con-name Team1-slave1 ifname em1 master Team1 $ nmcli con add type ethernet con-name Team1-slave2 ifname em2 master Team1 - </emphasis></programlisting> + </emphasis></synopsis> </example> <para> This example demonstrates adding a team master connection profile and two slaves. It is @@ -210,22 +210,22 @@ $ nmcli con add type ethernet con-name Team1-slave2 ifname em2 master Team1 <emphasis>em2</emphasis>. The slaves don't specify <emphasis>config</emphasis> and thus <emphasis>teamd</emphasis> will use its default configuration. You will activate the whole setup by activating both slaves: - <programlisting><emphasis role="bold"> + <synopsis><emphasis role="bold"> $ nmcli con up Team1-slave1 $ nmcli con up Team1-slave2 - </emphasis></programlisting> + </emphasis></synopsis> By default, the created profiles are marked for auto-activation. But if another connection has been activated on the device, the new profile won't activate automatically and you need to activate it manually. </para> <example><title>Adding a bridge and two slave profiles</title> - <programlisting><emphasis role="bold"> + <synopsis><emphasis role="bold"> $ nmcli con add type bridge con-name TowerBridge ifname TowerBridge $ nmcli con add type ethernet con-name br-slave-1 ifname ens3 master TowerBridge $ nmcli con add type ethernet con-name br-slave-2 ifname ens4 master TowerBridge $ nmcli con modify TowerBridge bridge.stp no - </emphasis></programlisting> + </emphasis></synopsis> </example> <para> This example demonstrates adding a bridge master connection and two slaves. The @@ -239,7 +239,7 @@ $ nmcli con modify TowerBridge bridge.stp no </para> <example><title>Adding an ethernet connection profile with manual IP configuration</title> - <programlisting> + <synopsis> <emphasis role="bold"> $ nmcli con add con-name my-con-em1 ifname em1 type ethernet ip4 192.168.100.100/24 gw4 192.168.100.1 ip4 1.2.3.4 ip6 abbe::cafe $ nmcli con mod my-con-em1 ipv4.dns "8.8.8.8 8.8.4.4" @@ -247,7 +247,7 @@ $ nmcli con mod my-con-em1 +ipv4.dns 1.2.3.4 $ nmcli con mod my-con-em1 ipv6.dns "2001:4860:4860::8888 2001:4860:4860::8844" $ nmcli -p con show my-con-em1 </emphasis> - </programlisting> + </synopsis> </example> <para> The first command adds an Ethernet connection profile named <emphasis>my-con-em1</emphasis> @@ -263,11 +263,11 @@ $ nmcli -p con show my-con-em1 </para> <example><title>Escaping colon characters in tabular mode</title> - <programlisting> + <synopsis> <emphasis role="bold"> $ nmcli -t -f general -e yes -m tab dev show eth0 </emphasis> - </programlisting> + </synopsis> <screen> GENERAL:eth0:ethernet:Intel Corporation:82567LM Gigabit Network Connection:e1000e:2.1.4-k:1.8-3:00\:22\:68\:15\:29\:21:1500:100 (connected):0 (No reason given):/sys/devices/pci0000\:00/0000\:00\:19.0/net/eth0:eth0:yes:yes:no:ethernet-13:89cbcbc6-dc85-456c-9c8b-bd828fee3917:/org/freedesktop/NetworkManager/ActiveConnection/9 </screen> @@ -316,11 +316,11 @@ fi <para><emphasis role="bold">Example sessions of interactive connection editor</emphasis></para> <example><title>Adding an ethernet connection profile in interactive editor (a)</title> - <programlisting> + <synopsis> <emphasis role="bold"> $ nmcli connection edit type ethernet </emphasis> - </programlisting> + </synopsis> <screen> ===| nmcli interactive connection editor |=== diff --git a/man/nmcli.1.in b/man/nmcli.1.in index fbd53c49..3c76348f 100644 --- a/man/nmcli.1.in +++ b/man/nmcli.1.in @@ -21,7 +21,7 @@ .\" .\" Copyright 2010 - 2015 Red Hat, Inc. .\" -.TH NMCLI "1" "12 August 2015" +.TH NMCLI "1" "2016-03-09" "NetworkManager 1.2" .SH NAME nmcli \- command\(hyline tool for controlling NetworkManager @@ -435,7 +435,7 @@ See \fBconnection show\fP above for the description of the <ID>-specifying keywo .br If '--wait' option is not specified, the default timeout will be 10 seconds. .TP -.B add COMMON_OPTIONS TYPE_SPECIFIC_OPTIONS SLAVE_OPTIONS IP_OPTIONS [-- [+|-]<setting>.<property> <value> ...] +.B add COMMON_OPTIONS TYPE_SPECIFIC_OPTIONS IP_OPTIONS [-- [+|-]<setting>.<property> <value> ...] .br Add a connection for NetworkManager. Arguments differ according to connection types, see below. .RS @@ -460,7 +460,6 @@ Note: use quotes around \fB*\fP to suppress shell expansion. .IP "\fI[master <master (ifname, or connection UUID or name)>]\fP" 42 \(en master interface name, or connection UUID or ID of master connection profile. The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disambiguate it. -See below \fBSLAVE_OPTIONS\fP for additional options for slave connection to masters of various types. .IP "\fI[slave-type <master connection type>]\fP" 42 \(en type of master connection. Only required when it can not be inferred (i.e. the master connection does not exist yet). @@ -610,6 +609,11 @@ The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disamb .RE .RS .TP +.IP "\fI[config <file>|<raw JSON data>]\fP" 42 +\(en JSON configuration for team +.RE +.RS +.TP .B bridge: .IP "\fI[stp yes|no]\fP" 42 \(en controls whether Spanning Tree Protocol (STP) is enabled for this bridge (default: yes) @@ -638,6 +642,16 @@ The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disamb .RE .RS .TP +.IP "\fI[priority <0-63>]\fP" 42 +\(en STP priority of this slave (default: 32) +.IP "\fI[path-cost <1-65535>]\fP" 42 +\(en STP port cost for destinations via this slave (default: 100) +.IP "\fI[hairpin yes|no]\fP" 42 +\(en 'hairpin mode' for the slave, which allows frames +to be sent back out through the slave the frame was received on (default: yes) +.RE +.RS +.TP .B vpn: .IP "\fIvpn-type vpnc|openvpn|pptp|openconnect|openswan|libreswan|strongswan|ssh|l2tp|iodine|fortisslvpn|...\fP" 42 \(en VPN type @@ -724,27 +738,6 @@ The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disamb .RE .RS .TP -.B SLAVE_OPTIONS: -.RE -.RS -.TP -.B bridge: -.IP "\fI[priority <0-63>]\fP" 42 -\(en STP priority of this slave (default: 32) -.IP "\fI[path-cost <1-65535>]\fP" 42 -\(en STP port cost for destinations via this slave (default: 100) -.IP "\fI[hairpin yes|no]\fP" 42 -\(en 'hairpin mode' for the slave, which allows frames -to be sent back out through the slave the frame was received on (default: yes) -.RE -.RS -.TP -.B team: -.IP "\fI[config <file>|<raw JSON data>]\fP" 42 -\(en JSON configuration for team -.RE -.RS -.TP .B IP_OPTIONS: .IP "\fI[ip4 <IPv4 address>] [gw4 <IPv4 gateway>]\fP" 42 \(en IPv4 addresses diff --git a/man/nmtui.1.in b/man/nmtui.1.in index 32b76954..977339db 100644 --- a/man/nmtui.1.in +++ b/man/nmtui.1.in @@ -21,7 +21,7 @@ .\" .\" Copyright 2014 Red Hat, Inc. .\" -.TH NMTUI "1" "6 November 2014" +.TH NMTUI "1" "2014-11-06" "NetworkManager 1.2" .SH NAME nmtui \- Text User Interface for controlling NetworkManager |