diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/Makefile.am | 27 | ||||
| -rw-r--r-- | man/Makefile.in | 44 | ||||
| -rw-r--r-- | man/NetworkManager.8 | 277 | ||||
| -rw-r--r-- | man/NetworkManager.conf.5 | 670 | ||||
| -rw-r--r-- | man/NetworkManager.conf.xml | 988 | ||||
| -rw-r--r-- | man/NetworkManager.conf.xml.in | 295 | ||||
| -rw-r--r-- | man/NetworkManager.xml | 461 | ||||
| -rw-r--r-- | man/nm-settings-ifcfg-rh.5 | 212 | ||||
| -rw-r--r-- | man/nm-settings-ifcfg-rh.xml | 46 | ||||
| -rw-r--r-- | man/nm-settings-ifcfg-rh.xsl | 6 | ||||
| -rw-r--r-- | man/nm-settings-keyfile.5 | 8 | ||||
| -rw-r--r-- | man/nm-settings-keyfile.xml | 8 | ||||
| -rw-r--r-- | man/nm-settings-keyfile.xsl | 2 | ||||
| -rw-r--r-- | man/nm-settings.5 | 682 | ||||
| -rw-r--r-- | man/nm-settings.xml | 83 | ||||
| -rw-r--r-- | man/nm-settings.xsl | 2 | ||||
| -rw-r--r-- | man/nmcli-examples.5 | 693 | ||||
| -rw-r--r-- | man/nmcli-examples.xml | 568 | ||||
| -rw-r--r-- | man/nmcli.1.in | 316 |
19 files changed, 3578 insertions, 1810 deletions
diff --git a/man/Makefile.am b/man/Makefile.am index 4577cb41..85b6f3a9 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -25,6 +25,16 @@ if ENABLE_GTK_DOC endif +CLEANFILES += NetworkManager.conf.xml +EXTRA_DIST += NetworkManager.conf.xml.in +NetworkManager.conf.xml: $(srcdir)/NetworkManager.conf.xml.in + $(AM_V_GEN) sed \ + -e 's|[@]NM_CONFIG_DEFAULT_AUTH_POLKIT_TEXT[@]|$(NM_CONFIG_DEFAULT_AUTH_POLKIT_TEXT)|g' \ + -e 's|[@]NM_CONFIG_KEYFILE_PATH_DEFAULT[@]|$(nmconfdir)/conf.d|g' \ + -e 's|[@]NM_CONFIG_LOGGING_BACKEND_DEFAULT_TEXT[@]|$(NM_CONFIG_LOGGING_BACKEND_DEFAULT_TEXT)|g' \ + -e 's|[@]NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT[@]|$(NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT)|g' \ + $< >$@ + if BUILD_SETTING_DOCS nm-settings.xml: nm-settings.xsl $(top_builddir)/libnm/nm-setting-docs.xml @@ -71,14 +81,14 @@ docbook_autogenerated_man_pages = \ nm-settings-keyfile.5 \ nm-settings-ifcfg-rh.5 -EXTRA_DIST += \ - nm-settings.xml \ - nm-settings.xsl \ - nm-settings-keyfile.xml \ - nm-settings-keyfile.xsl \ - nm-settings-ifcfg-rh.xml \ - nm-settings-ifcfg-rh.xsl \ - $(docbook_generated_man_pages:.%=.xml) \ +EXTRA_DIST += \ + nm-settings.xml \ + nm-settings.xsl \ + nm-settings-keyfile.xml \ + nm-settings-keyfile.xsl \ + nm-settings-ifcfg-rh.xml \ + nm-settings-ifcfg-rh.xsl \ + $(addsuffix .xml,$(basename $(docbook_generated_man_pages))) \ $(docbook_autogenerated_man_pages) man_MANS += $(configure_generated_man_pages) @@ -109,4 +119,3 @@ man_MANS += \ $(docbook_autogenerated_man_pages) endif endif - diff --git a/man/Makefile.in b/man/Makefile.in index 7f421ea9..9e52f66f 100644 --- a/man/Makefile.in +++ b/man/Makefile.in @@ -120,8 +120,8 @@ am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ DIST_COMMON = $(srcdir)/Makefile.am $(am__DIST_COMMON) mkinstalldirs = $(install_sh) -d CONFIG_HEADER = $(top_builddir)/config.h -CONFIG_CLEAN_FILES = NetworkManager.conf.xml nm-system-settings.conf.5 \ - nm-online.1 nmcli.1 nmtui.1 +CONFIG_CLEAN_FILES = nm-system-settings.conf.5 nm-online.1 nmcli.1 \ + nmtui.1 CONFIG_CLEAN_VPATH_FILES = AM_V_P = $(am__v_P_@AM_V@) am__v_P_ = $(am__v_P_@AM_DEFAULT_V@) @@ -177,8 +177,7 @@ man8dir = $(mandir)/man8 NROFF = nroff MANS = $(man_MANS) am__tagged_files = $(HEADERS) $(SOURCES) $(TAGS_FILES) $(LISP) -am__DIST_COMMON = $(srcdir)/Makefile.in \ - $(srcdir)/NetworkManager.conf.xml.in $(srcdir)/nm-online.1.in \ +am__DIST_COMMON = $(srcdir)/Makefile.in $(srcdir)/nm-online.1.in \ $(srcdir)/nm-system-settings.conf.5.in $(srcdir)/nmcli.1.in \ $(srcdir)/nmtui.1.in DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) @@ -197,7 +196,6 @@ BLUEZ5_LIBS = @BLUEZ5_LIBS@ CC = @CC@ CCDEPMODE = @CCDEPMODE@ CFLAGS = @CFLAGS@ -CKDB_PATH = @CKDB_PATH@ CODE_COVERAGE_CFLAGS = @CODE_COVERAGE_CFLAGS@ CODE_COVERAGE_ENABLED = @CODE_COVERAGE_ENABLED@ CODE_COVERAGE_LDFLAGS = @CODE_COVERAGE_LDFLAGS@ @@ -209,8 +207,6 @@ CXXDEPMODE = @CXXDEPMODE@ CXXFLAGS = @CXXFLAGS@ CYGPATH_W = @CYGPATH_W@ DBUS_CFLAGS = @DBUS_CFLAGS@ -DBUS_GLIB_100_CFLAGS = @DBUS_GLIB_100_CFLAGS@ -DBUS_GLIB_100_LIBS = @DBUS_GLIB_100_LIBS@ DBUS_LIBS = @DBUS_LIBS@ DBUS_SYS_DIR = @DBUS_SYS_DIR@ DEFS = @DEFS@ @@ -220,6 +216,7 @@ DHCPCD_PATH = @DHCPCD_PATH@ DISTRO_NETWORK_SERVICE = @DISTRO_NETWORK_SERVICE@ DLLTOOL = @DLLTOOL@ DNSMASQ_PATH = @DNSMASQ_PATH@ +DNSSEC_TRIGGER_SCRIPT = @DNSSEC_TRIGGER_SCRIPT@ DSYMUTIL = @DSYMUTIL@ DUMPBIN = @DUMPBIN@ ECHO_C = @ECHO_C@ @@ -274,16 +271,13 @@ INTROSPECTION_MAKEFILE = @INTROSPECTION_MAKEFILE@ INTROSPECTION_SCANNER = @INTROSPECTION_SCANNER@ INTROSPECTION_TYPELIBDIR = @INTROSPECTION_TYPELIBDIR@ IPTABLES_PATH = @IPTABLES_PATH@ -IWMX_SDK_CFLAGS = @IWMX_SDK_CFLAGS@ -IWMX_SDK_LIBS = @IWMX_SDK_LIBS@ KERNEL_FIRMWARE_DIR = @KERNEL_FIRMWARE_DIR@ LCOV = @LCOV@ LD = @LD@ LDFLAGS = @LDFLAGS@ +LIBAUDIT_CFLAGS = @LIBAUDIT_CFLAGS@ +LIBAUDIT_LIBS = @LIBAUDIT_LIBS@ LIBDL = @LIBDL@ -LIBGCRYPT_CFLAGS = @LIBGCRYPT_CFLAGS@ -LIBGCRYPT_CONFIG = @LIBGCRYPT_CONFIG@ -LIBGCRYPT_LIBS = @LIBGCRYPT_LIBS@ LIBICONV = @LIBICONV@ LIBINTL = @LIBINTL@ LIBM = @LIBM@ @@ -320,6 +314,8 @@ NEWT_LIBS = @NEWT_LIBS@ NM = @NM@ NMEDIT = @NMEDIT@ NM_CONFIG_DEFAULT_AUTH_POLKIT_TEXT = @NM_CONFIG_DEFAULT_AUTH_POLKIT_TEXT@ +NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT = @NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT@ +NM_CONFIG_LOGGING_BACKEND_DEFAULT_TEXT = @NM_CONFIG_LOGGING_BACKEND_DEFAULT_TEXT@ NM_MAJOR_VERSION = @NM_MAJOR_VERSION@ NM_MICRO_VERSION = @NM_MICRO_VERSION@ NM_MINOR_VERSION = @NM_MINOR_VERSION@ @@ -348,7 +344,6 @@ POLKIT_LIBS = @POLKIT_LIBS@ POSUB = @POSUB@ PPPD_PATH = @PPPD_PATH@ PPPD_PLUGIN_DIR = @PPPD_PLUGIN_DIR@ -PPPOE_PATH = @PPPOE_PATH@ QT_CFLAGS = @QT_CFLAGS@ QT_LIBS = @QT_LIBS@ RANLIB = @RANLIB@ @@ -363,6 +358,8 @@ SYSTEMD_200_CFLAGS = @SYSTEMD_200_CFLAGS@ SYSTEMD_200_LIBS = @SYSTEMD_200_LIBS@ SYSTEMD_INHIBIT_CFLAGS = @SYSTEMD_INHIBIT_CFLAGS@ SYSTEMD_INHIBIT_LIBS = @SYSTEMD_INHIBIT_LIBS@ +SYSTEMD_JOURNAL_CFLAGS = @SYSTEMD_JOURNAL_CFLAGS@ +SYSTEMD_JOURNAL_LIBS = @SYSTEMD_JOURNAL_LIBS@ SYSTEMD_LOGIN_CFLAGS = @SYSTEMD_LOGIN_CFLAGS@ SYSTEMD_LOGIN_LIBS = @SYSTEMD_LOGIN_LIBS@ SYSTEM_CA_PATH = @SYSTEM_CA_PATH@ @@ -423,6 +420,7 @@ mkdir_p = @mkdir_p@ nmbinary = @nmbinary@ nmconfdir = @nmconfdir@ nmdatadir = @nmdatadir@ +nmlibdir = @nmlibdir@ nmrundir = @nmrundir@ nmstatedir = @nmstatedir@ oldincludedir = @oldincludedir@ @@ -430,6 +428,7 @@ pdfdir = @pdfdir@ prefix = @prefix@ program_transform_name = @program_transform_name@ psdir = @psdir@ +runstatedir = @runstatedir@ sbindir = @sbindir@ sharedstatedir = @sharedstatedir@ srcdir = @srcdir@ @@ -447,11 +446,13 @@ with_resolvconf = @with_resolvconf@ with_valgrind = @with_valgrind@ man_MANS = $(configure_generated_man_pages) $(am__append_2) \ $(am__append_4) $(am__append_6) -CLEANFILES = $(am__append_1) $(am__append_3) $(am__append_5) -EXTRA_DIST = nm-settings.xml nm-settings.xsl nm-settings-keyfile.xml \ +CLEANFILES = NetworkManager.conf.xml $(am__append_1) $(am__append_3) \ + $(am__append_5) +EXTRA_DIST = NetworkManager.conf.xml.in nm-settings.xml \ + nm-settings.xsl nm-settings-keyfile.xml \ nm-settings-keyfile.xsl nm-settings-ifcfg-rh.xml \ - nm-settings-ifcfg-rh.xsl \ - $(docbook_generated_man_pages:.%=.xml) \ + nm-settings-ifcfg-rh.xsl $(addsuffix .xml,$(basename \ + $(docbook_generated_man_pages))) \ $(docbook_autogenerated_man_pages) XSLTPROC = xsltproc XSLTPROC_FLAGS = --xinclude --nonet @@ -513,8 +514,6 @@ $(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) $(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh $(am__aclocal_m4_deps): -NetworkManager.conf.xml: $(top_builddir)/config.status $(srcdir)/NetworkManager.conf.xml.in - cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ nm-system-settings.conf.5: $(top_builddir)/config.status $(srcdir)/nm-system-settings.conf.5.in cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ nm-online.1: $(top_builddir)/config.status $(srcdir)/nm-online.1.in @@ -827,6 +826,13 @@ uninstall-man: uninstall-man1 uninstall-man5 uninstall-man8 @ENABLE_GTK_DOC_TRUE@%.5: %.xml @ENABLE_GTK_DOC_TRUE@ $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< +NetworkManager.conf.xml: $(srcdir)/NetworkManager.conf.xml.in + $(AM_V_GEN) sed \ + -e 's|[@]NM_CONFIG_DEFAULT_AUTH_POLKIT_TEXT[@]|$(NM_CONFIG_DEFAULT_AUTH_POLKIT_TEXT)|g' \ + -e 's|[@]NM_CONFIG_KEYFILE_PATH_DEFAULT[@]|$(nmconfdir)/conf.d|g' \ + -e 's|[@]NM_CONFIG_LOGGING_BACKEND_DEFAULT_TEXT[@]|$(NM_CONFIG_LOGGING_BACKEND_DEFAULT_TEXT)|g' \ + -e 's|[@]NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT[@]|$(NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT)|g' \ + $< >$@ @BUILD_SETTING_DOCS_TRUE@nm-settings.xml: nm-settings.xsl $(top_builddir)/libnm/nm-setting-docs.xml @BUILD_SETTING_DOCS_TRUE@ $(AM_V_GEN) xsltproc \ diff --git a/man/NetworkManager.8 b/man/NetworkManager.8 deleted file mode 100644 index 58fc9bd8..00000000 --- a/man/NetworkManager.8 +++ /dev/null @@ -1,277 +0,0 @@ -'\" t -.\" Title: NetworkManager -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> -.\" Date: 12/23/2015 -.\" Manual: Network management daemons -.\" Source: NetworkManager 1.0 -.\" Language: English -.\" -.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.0" "Network management daemons" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -NetworkManager \- network management daemon -.SH "SYNOPSIS" -.HP \w'\fBNetworkManager\ \fR\fB[OPTIONS...]\fR\ 'u -\fBNetworkManager \fR\fB[OPTIONS...]\fR -.SH "DESCRIPTION" -.PP -The NetworkManager daemon attempts to make networking configuration and operation as painless and automatic as possible by managing the primary network connection and other network interfaces, like Ethernet, 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\&. -.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_FILENAME\fR -.RS 4 -The backing file name of the connection profile (if any)\&. -.RE -.PP -\fIDEVICE_IFACE\fR -.RS 4 -The interface name of the device\&. -.RE -.PP -\fIDEVICE_IP_IFACE\fR -.RS 4 -The IP interface name of the device\&. -.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\&. 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 proccess 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 NetworkMangager 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 "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 deleted file mode 100644 index e85af1b4..00000000 --- a/man/NetworkManager.conf.5 +++ /dev/null @@ -1,670 +0,0 @@ -'\" t -.\" Title: NetworkManager.conf -.\" Author: -.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> -.\" Date: 12/23/2015 -.\" Manual: Configuration -.\" Source: NetworkManager 1.0 -.\" Language: English -.\" -.TH "NETWORKMANAGER\&.CON" "5" "" "NetworkManager 1\&.0" "Configuration" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -NetworkManager.conf \- NetworkManager configuration file -.SH "SYNOPSIS" -.PP -/etc/NetworkManager/NetworkManager\&.conf, -/etc/NetworkManager/conf\&.d/\fIname\fR\&.conf -.SH "DESCRIPTION" -.PP -This is a configuration file for NetworkManager\&. It is used to set up various aspects of NetworkManager\*(Aqs behavior\&. The location of the file may be changed through use of the -\fB\-\-config\fR -argument for NetworkManager\&. -.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 -conf\&.d -directory\&. These will be read in order, with later files overriding earlier ones\&. -.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 (and in particular, does not yet support DHCPv6)\&. -.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 -\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 -Set a persistent hostname\&. -.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 -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\&. -.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"\&. -.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 (avahi) 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 - -.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 -.SH "CONNECTION SECTION" -.PP -This section allows to specify default values for connections\&. Not all properties can be overwritten, only a selected list below\&. You can have multiple -connection -sections, by having different sections with a name that all start with "connection"\&. -.PP -Example: -.sp -.if n \{\ -.RS 4 -.\} -.nf -[connection] -ipv6\&.ip6\-privacy=0 -connection\&.autoconnect\-slaves=1 - -[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 section 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 -.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 -.PP -The following properties are supported to have their default values configured: -.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 -\fIconnection\&.autoconnect\-slaves\fR -.RS 4 -.RE -.PP -\fIethernet\&.wake\-on\-lan\fR -.RS 4 -.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 "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 writeable 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\&. -.RE -.PP -\fIifcfg\-suse\fR -.RS 4 -This plugin is only provided for simple backward compatibility with SUSE and OpenSUSE configuration\&. Most setups should be using the -keyfile -plugin instead\&. The -ifcfg\-suse -plugin supports reading Ethernet and Wi\-Fi connections, but does not support saving any connection types\&. -.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 -.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\&. -.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 comman or semicolon\&. The order does not matter as matches are either positive (inclusive) or negative, 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 taken literally so usually the specs will be concatenated without spaces\&. -.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 new file mode 100644 index 00000000..b4fe396d --- /dev/null +++ b/man/NetworkManager.conf.xml @@ -0,0 +1,988 @@ +<?xml version='1.0'?> <!--*-nxml-*--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + +<!-- +Copyright 2010 - 2014 Red Hat, Inc. +--> + +<refentry id="NetworkManager.conf"> + <refentryinfo> + <title>NetworkManager.conf</title> + <author>NetworkManager developers</author> + </refentryinfo> + + <refmeta> + <refentrytitle>NetworkManager.conf</refentrytitle> + <manvolnum>5</manvolnum> + <refmiscinfo class="source">NetworkManager</refmiscinfo> + <refmiscinfo class="manual">Configuration</refmiscinfo> + <refmiscinfo class="version">1.0</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>NetworkManager.conf</refname> + <refpurpose>NetworkManager configuration file</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <para><filename>/etc/NetworkManager/NetworkManager.conf</filename>, + <filename>/etc/NetworkManager/conf.d/<replaceable>name</replaceable>.conf</filename>, + <filename>/usr/lib/NetworkManager/conf.d/<replaceable>name</replaceable>.conf</filename>, + <filename>/var/lib/NetworkManager/NetworkManager-intern.conf</filename> + </para> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + <para><literal>NetworkManager.conf</literal> is the configuration file for NetworkManager. It is used + to set up various aspects of NetworkManager's behavior. The + location of the main file and configuration directories may be changed + through use of the <option>--config</option>, <option>--config-dir</option>, + <option>--system-config-dir</option>, and <option>--intern-config</option> + argument for NetworkManager, respectively. + </para> + <para>If a default <literal>NetworkManager.conf</literal> is + provided by your distribution's packages, you should not modify + it, since your changes may get overwritten by package + updates. Instead, you can add additional <literal>.conf</literal> + files to the <literal>/etc/NetworkManager/conf.d</literal> directory. + These will be read in order, with later files overriding earlier ones. + Packages might install further configuration snippets to <literal>/usr/lib/NetworkManager/conf.d</literal>. + This directory is parsed first, even before <literal>NetworkManager.conf</literal>. + The loading of a file <literal>/usr/lib/NetworkManager/conf.d/<replaceable>name</replaceable>.conf</literal> + can be prevented by adding a file <literal>/etc/NetworkManager/conf.d/<replaceable>name</replaceable>.conf</literal>. + In this case, the file from the etc configuration shadows the file from the + system configuration directory. + </para> + <para> + NetworkManager can overwrite certain user configuration options via D-Bus or other internal + operations. In this case it writes those changes to <literal>/var/lib/NetworkManager/NetworkManager-intern.conf</literal>. + This file is not intended to be modified by the user, but it is read last and can shadow + user configuration from <literal>NetworkManager.conf</literal>. + </para> + + </refsect1> + + <refsect1> + <title>File Format</title> + <para> + 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 '#' and blank lines are + considered comments. Sections are started by a header line + containing the section enclosed in '[' and ']', 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. + </para> + <para> + 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 <xref linkend="device-spec"/> + below. + </para> + <para> + Minimal system settings configuration file looks like this: + <programlisting> + [main] + plugins=keyfile + </programlisting> + </para> + <para> + As an extension to the normal keyfile format, you can also + append a value to a previously-set list-valued key by doing: + <programlisting> + plugins+=another-plugin + plugins-=remove-me + </programlisting> + </para> + </refsect1> + + <refsect1> + <title><literal>main</literal> section</title> + <variablelist> + <varlistentry> + <term><varname>plugins</varname></term> + <listitem> + <para> + Lists system settings plugin names separated by ','. 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't 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. + </para> + <para> + 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 <literal>keyfile</literal> plugin + is always appended to the end of this list (if it doesn't + 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 + <literal>keyfile</literal>. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>monitor-connection-files</varname></term> + <listitem><para>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 + '<literal>true</literal>', then NetworkManager will reload + connection files any time they changed.</para></listitem> + </varlistentry> + <varlistentry> + <term><varname>auth-polkit</varname></term> + <listitem><para>Whether the system uses PolicyKit for authorization. + If <literal>false</literal>, all requests will be allowed. If + <literal>true</literal>, non-root requests are authorized using PolicyKit. + The default value is <literal>true</literal>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>dhcp</varname></term> + <listitem><para>This key sets up what DHCP client + NetworkManager will use. Allowed values are + <literal>dhclient</literal>, <literal>dhcpcd</literal>, and + <literal>internal</literal>. The <literal>dhclient</literal> + 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> + <para>If this key is missing, available DHCP clients are + looked for in this order: <literal>dhclient</literal>, + <literal>dhcpcd</literal>, + <literal>internal</literal>.</para></listitem> + </varlistentry> + <varlistentry> + <term><varname>no-auto-default</varname></term> + <listitem><para>Specify devices for which + NetworkManager shouldn't create default wired connection + (Auto eth0). By default, NetworkManager creates a temporary + wired connection for any Ethernet device that is managed and + doesn't have a connection configured. List a device in this + option to inhibit creating the default connection for the + device. May have the special value <literal>*</literal> to + apply to all devices.</para> + <para>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 + <filename>/var/run/NetworkManager/no-auto-default.state</filename> + to prevent creating the default connection for that device + again.</para> + <para>See <xref linkend="device-spec"/> for the syntax how to + specify a device. + </para> + <para> + Example: + <programlisting> +no-auto-default=00:22:68:5c:5d:c4,00:1e:65:ff:aa:ee +no-auto-default=eth0,eth1 +no-auto-default=* + </programlisting> + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ignore-carrier</varname></term> + <listitem> + <para> + 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. + </para> + <para> + 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. + </para> + <para> + Note that the "carrier" property of NMDevices and device D-Bus + interfaces will still reflect the actual device state; it's just + that NetworkManager will not make use of that information. + </para> + <para>See <xref linkend="device-spec"/> for the syntax how to + specify a device. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>assume-ipv6ll-only</varname></term> + <listitem> + <para> + 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. + </para> + <para>See <xref linkend="device-spec"/> for the syntax how to + specify a device. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>configure-and-quit</varname></term> + <listitem> + <para> + When set to '<literal>true</literal>', 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 <literal>true</literal>, + 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's configuration may be preserved. + Also, to preserve DHCP addresses the '<literal>dhcp</literal>' option + must be set to '<literal>internal</literal>'. The default value of + the '<literal>configure-and-quit</literal>' option is + '<literal>false</literal>', meaning that NetworkManager will continue + running after initial network configuration and continue responding + to system and hardware events, D-Bus requests, and user commands. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>dns</varname></term> + <listitem><para>Set the DNS (<filename>resolv.conf</filename>) processing mode.</para> + <para><literal>default</literal>: The default if the key is + not specified. NetworkManager will update + <filename>resolv.conf</filename> to reflect the nameservers + provided by currently active connections.</para> + <para><literal>dnsmasq</literal>: NetworkManager will run + dnsmasq as a local caching nameserver, using a "split DNS" + configuration if you are connected to a VPN, and then update + <filename>resolv.conf</filename> to point to the local + nameserver.</para> + <para><literal>unbound</literal>: 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.</para> + <para><literal>none</literal>: NetworkManager will not + modify resolv.conf.</para> + </listitem> + </varlistentry> + + <varlistentry> + <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> + <para><literal>resolvconf</literal>: NetworkManager will run + resolvconf to update the DNS configuration.</para> + <para><literal>netconfig</literal>: NetworkManager will run + netconfig to update the DNS configuration.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>debug</varname></term> + <listitem><para>Comma separated list of options to aid + debugging. This value will be combined with the environment + variable <literal>NM_DEBUG</literal>. Currently the following + values are supported:</para> + <para> + <literal>RLIMIT_CORE</literal>: set ulimit -c unlimited + to write out core dumps. Beware, that a core dump can contain + sensitive information such as passwords or configuration settings. + </para> + <para> + <literal>fatal-warnings</literal>: 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. + </para> + </listitem> + </varlistentry> + + </variablelist> + </refsect1> + + <refsect1> + <title><literal>keyfile</literal> section</title> + <para>This section contains keyfile-plugin-specific options, and + is normally only used when you are not using any other + distro-specific plugin.</para> + + <para> + <variablelist> + <varlistentry> + <term><varname>hostname</varname></term> + <listitem><para>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. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>path</varname></term> + <listitem> + <para>The location where keyfiles are read and stored. + This defaults to "<literal>/usr/local/etc/NetworkManager/conf.d</literal>". + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>unmanaged-devices</varname></term> + <listitem><para>Set devices that should be ignored by + NetworkManager. + </para> + <para>See <xref linkend="device-spec"/> for the syntax how to + specify a device. + </para> + <para> + Example: + <programlisting> +unmanaged-devices=interface-name:em4 +unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth2 + </programlisting> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1> + <title><literal>ifupdown</literal> section</title> + <para>This section contains ifupdown-specific options and thus only + has effect when using the <literal>ifupdown</literal> plugin.</para> + + <para> + <variablelist> + <varlistentry> + <term><varname>managed</varname></term> + <listitem><para>If set to <literal>true</literal>, then + interfaces listed in + <filename>/etc/network/interfaces</filename> are managed by + NetworkManager. If set to <literal>false</literal>, then + any interface listed in + <filename>/etc/network/interfaces</filename> 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.</para> + <para> + The default value is <literal>false</literal>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1> + <title><literal>logging</literal> section</title> + <para>This section controls NetworkManager's logging. Any + settings here are overridden by the <option>--log-level</option> + and <option>--log-domains</option> command-line options.</para> + + <para> + <variablelist> + <varlistentry> + <term><varname>level</varname></term> + <listitem><para>The default logging verbosity level. + One of <literal>OFF</literal>, <literal>ERR</literal>, + <literal>WARN</literal>, <literal>INFO</literal>, + <literal>DEBUG</literal>, <literal>TRACE</literal>. 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.</para></listitem> + </varlistentry> + <varlistentry> + <term><varname>domains</varname></term> + <listitem><para>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.</para> + <para>In addition, these special domains can be used: NONE, + ALL, DEFAULT, DHCP, IP.</para> + <para>You can specify per-domain log level overrides by + adding a colon and a log level to any domain. E.g., + "<literal>WIFI:DEBUG,WIFI_SCAN:OFF</literal>".</para></listitem> + </varlistentry> + <varlistentry> + <para>Domain descriptions: + <simplelist type="horiz" columns="1"> + <member>PLATFORM : OS (platform) operations</member> + <member>RFKILL : RFKill subsystem operations</member> + <member>ETHER : Ethernet device operations</member> + <member>WIFI : Wi-Fi device operations</member> + <member>BT : Bluetooth operations</member> + <member>MB : Mobile broadband operations</member> + <member>DHCP4 : DHCP for IPv4</member> + <member>DHCP6 : DHCP for IPv6</member> + <member>PPP : Point-to-point protocol operations</member> + <member>WIFI_SCAN : Wi-Fi scanning operations</member> + <member>IP4 : IPv4-related operations</member> + <member>IP6 : IPv6-related operations</member> + <member>AUTOIP4 : AutoIP operations</member> + <member>DNS : Domain Name System related operations</member> + <member>VPN : Virtual Private Network connections and operations</member> + <member>SHARING : Connection sharing</member> + <member>SUPPLICANT : WPA supplicant related operations</member> + <member>AGENTS : Secret agents operations and communication</member> + <member>SETTINGS : Settings/config service operations</member> + <member>SUSPEND : Suspend/resume</member> + <member>CORE : Core daemon and policy operations</member> + <member>DEVICE : Activation and general interface operations</member> + <member>OLPC : OLPC Mesh device operations</member> + <member>WIMAX : WiMAX device operations</member> + <member>INFINIBAND : InfiniBand device operations</member> + <member>FIREWALL : FirewallD related operations</member> + <member>ADSL : ADSL device operations</member> + <member>BOND : Bonding operations</member> + <member>VLAN : VLAN operations</member> + <member>BRIDGE : Bridging operations</member> + <member>DBUS_PROPS : D-Bus property changes</member> + <member>TEAM : Teaming operations</member> + <member>CONCHECK : Connectivity check</member> + <member>DCB : Data Center Bridging (DCB) operations</member> + <member>DISPATCH : Dispatcher scripts</member> + <member>AUDIT : Audit records</member> + <member> </member> + <member>NONE : when given by itself logging is disabled</member> + <member>ALL : all log domains</member> + <member>DEFAULT : default log domains</member> + <member>DHCP : shortcut for "DHCP4,DHCP6"</member> + <member>IP : shortcut for "IP4,IP6"</member> + <member> </member> + <member>HW : deprecated alias for "PLATFORM"</member> + </simplelist> + </para> + </varlistentry> + <varlistentry> + <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>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>". + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>audit</varname></term> + <listitem><para>Whether the audit records are delivered to + auditd, the audit daemon. If <literal>false</literal>, audit + records will be sent only to the NetworkManager logging + system. If set to <literal>true</literal>, they will be also + sent to auditd. The default value is <literal>true</literal>. + </para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1> + <title><literal>connection</literal> section</title> + <para>This section allows to specify default values for + connections. Not all properties can be overwritten, only a selected + list below. You can have multiple <literal>connection</literal> + sections, by having different sections with a name that all start + with "connection".</para> + <para> + Example: +<programlisting> +[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 +</programlisting> + </para> + + <para> + The sections within one file are considered in order of appearance, with the + exception that the <literal>[connection]</literal> section is always + considered last. In the example above, this order is <literal>[connection-wifi-wlan0]</literal>, + <literal>[connection-wlan-other]</literal>, and <literal>[connection]</literal>. + When checking for a default configuration value, the section 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. + </para> + <para> + 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. + </para> + + <para> + <variablelist> + <varlistentry> + <term><varname>match-device</varname></term> + <listitem><para>An optional device spec that restricts + when the section applies. See <xref linkend="device-spec"/> + for the possible values. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>stop-match</varname></term> + <listitem><para>An optional boolean value which defaults to + <literal>no</literal>. If the section matches (based on + <literal>match-device</literal>), further sections will not be + considered even if the property in question is not present. In + the example above, if <literal>[connection-wifi-wlan0]</literal> would + have <literal>stop-match</literal> set to <literal>yes</literal>, + its <literal>ipv6.ip6-privacy</literal> value would be + unspecified. + </para></listitem> + </varlistentry> + </variablelist> + </para> + + <para> + The following properties are supported to have their default values configured: + <variablelist> + <varlistentry> + <term><varname>connection.autoconnect-slaves</varname></term> + </varlistentry> + <varlistentry> + <term><varname>connection.lldp</varname></term> + </varlistentry> + <varlistentry> + <term><varname>ethernet.wake-on-lan</varname></term> + </varlistentry> + <varlistentry> + <term><varname>ipv4.route-metric</varname></term> + </varlistentry> + <varlistentry> + <term><varname>ipv4.dhcp-timeout</varname></term> + <listitem><para>If left unspecified, the default value for + the interface type is used.</para></listitem> + </varlistentry> + <varlistentry> + <term><varname>ipv6.ip6-privacy</varname></term> + <listitem><para>If <literal>ipv6.ip6-privacy</literal> is unset, use the content of + "/proc/sys/net/ipv6/conf/default/use_tempaddr" as last fallback. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>ipv6.route-metric</varname></term> + </varlistentry> + </variablelist> + <varlistentry> + <term><varname>vpn.timeout</varname></term> + <listitem><para>If left unspecified, default value of 60 seconds is used.</para></listitem> + </varlistentry> + <varlistentry> + <term><varname>wifi.mac-address-randomization</varname></term> + <listitem><para>If left unspecified, MAC address randomization is disabled.</para></listitem> + </varlistentry> + </para> + </refsect1> + + <refsect1> + <title><literal>connectivity</literal> section</title> + <para>This section controls NetworkManager's 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.</para> + + <para> + <variablelist> + <varlistentry> + <term><varname>uri</varname></term> + <listitem><para>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's body content should + be set to "NetworkManager is online". The body content + check can be controlled by the <literal>response</literal> + option. If this option is blank or missing, connectivity + checking is disabled. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>interval</varname></term> + <listitem><para>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.</para></listitem> + </varlistentry> + <varlistentry> + <term><varname>response</varname></term> + <listitem><para>If set controls what body content + NetworkManager checks for when requesting the URI for + connectivity checking. If missing, defaults to + "NetworkManager is online" </para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1> + <title><literal>global-dns</literal> section</title> + <para>This section specifies global DNS settings that override + connection-specific configuration.</para> + <para> + <variablelist> + <varlistentry> + <term><varname>searches</varname></term> + <listitem> + <para> + A list of search domains to be used during hostname lookup. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>options</varname></term> + <listitem> + <para> + A list of of options to be passed to the hostname resolver. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1> + <title><literal>global-dns-domain</literal> sections</title> + <para>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. + </para> + <para> + <variablelist> + <varlistentry> + <term><varname>servers</varname></term> + <listitem> + <para> + A list of addresses of DNS servers to be used for the given domain. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>options</varname></term> + <listitem> + <para> + A list of domain-specific DNS options. Not used at the moment. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1> + <title><literal>.config</literal> sections</title> + <para>This is a special section that contains options which apply + to the configuration file that contains the option. + </para> + <para> + <variablelist> + <varlistentry> + <term><varname>enable</varname></term> + <listitem> + <para> + Defaults to "<literal>true</literal>". If "<literal>false</literal>", + the configuration file will be skipped during loading. + Note that the main configuration file <literal>NetworkManager.conf</literal> + cannot be disabled. +<programlisting> +# always skip loading the config file +[.config] +enable=false +</programlisting> + </para> + <para> + You can also match against the version of NetworkManager. For example + the following are valid configurations: +<programlisting> +# 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 +</programlisting> + </para> + <para> + You can also match against the value of the environment variable + <literal>NM_CONFIG_ENABLE_TAG</literal>, like: +<programlisting> +# always skip loading the file when running NetworkManager with +# environment variable "NM_CONFIG_ENABLE_TAG=TAG1" +[.config] +enable=env:TAG1 +</programlisting> + </para> + <para> + 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. +<programlisting> +# 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 +</programlisting> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1> + <title>Plugins</title> + + <variablelist> + <varlistentry> + <term><varname>keyfile</varname></term> + <listitem> + <para> + The <literal>keyfile</literal> 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. + </para> + <para> + 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. + </para> + <para> + This plugin is always active, and will automatically be + used to store any connections that aren't supported by any + other active plugin. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>ifcfg-rh</varname></term> + <listitem> + <para> + This plugin is used on the Fedora and Red Hat Enterprise + Linux distributions to read and write configuration from + the standard + <filename>/etc/sysconfig/network-scripts/ifcfg-*</filename> + files. It currently supports reading Ethernet, Wi-Fi, + InfiniBand, VLAN, Bond, Bridge, and Team connections. + Enabling <literal>ifcfg-rh</literal> implicitly enables + <literal>ibft</literal> plugin, if it is available. + This can be disabled by adding <literal>no-ibft</literal>. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ifcfg-suse</varname></term> + <listitem> + <para> + This plugin is deprecated and its selection has no effect. + The <literal>keyfile</literal> plugin should be used + instead. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ifupdown</varname></term> + <listitem> + <para> + This plugin is used on the Debian and Ubuntu + distributions, and reads Ethernet and Wi-Fi connections + from <filename>/etc/network/interfaces</filename>. + </para> + <para> + 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 <literal>keyfile</literal> + plugin instead. + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>ibft</varname>, <varname>no-ibft</varname></term> + <listitem> + <para> + 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 + <literal>ifcfg-rh</literal>. This can be disabled by <literal>no-ibft</literal>. + You can also explicitly specify <literal>ibft</literal> to load the + plugin without <literal>ifcfg-rh</literal> or to change the plugin order. + </para> + </listitem> + </varlistentry> + + </variablelist> + </refsect1> + + <refsect1> + <title>Appendix</title> + <refsect2 id="device-spec"> + <title>Device List Format</title> + <para> + The configuration options <literal>main.no-auto-default</literal>, <literal>main.ignore-carrier</literal>, + and <literal>keyfile.unmanaged-devices</literal> select devices based on a list of matchings. + Devices can be specified using the following format: + </para> + <para> + <variablelist> + <varlistentry> + <term>*</term> + <listitem><para>Matches every device.</para></listitem> + </varlistentry> + <varlistentry> + <term>IFNAME</term> + <listitem><para>Case sensitive match of interface name of the device. Globbing is not supported.</para></listitem> + </varlistentry> + <varlistentry> + <term>HWADDR</term> + <listitem><para>Match the MAC address of the device. Globbing is not supported</para></listitem> + </varlistentry> + <varlistentry> + <term>interface-name:IFNAME</term> + <term>interface-name:~IFNAME</term> + <listitem><para>Case sensitive match of interface name of the device. Simple globbing is supported with + <literal>*</literal> and <literal>?</literal>. Ranges and escaping is not supported.</para></listitem> + </varlistentry> + <varlistentry> + <term>interface-name:=IFNAME</term> + <listitem><para>Case sensitive match of interface name of the device. Globbing is disabled and <literal>IFNAME</literal> + is taken literally.</para></listitem> + </varlistentry> + <varlistentry> + <term>mac:HWADDR</term> + <listitem><para>Match the MAC address of the device. Globbing is not supported</para></listitem> + </varlistentry> + <varlistentry> + <term>s390-subchannels:HWADDR</term> + <listitem><para>Match the device based on the subchannel address. Globbing is not supported</para></listitem> + </varlistentry> + <varlistentry> + <term>type:TYPE</term> + <listitem><para>Match the device type. Valid type names are as reported by "<literal>nmcli -f GENERAL.TYPE device show</literal>". + Globbing is not supported.</para></listitem> + </varlistentry> + <varlistentry> + <term>except:SPEC</term> + <listitem><para>Negative match of a device. <literal>SPEC</literal> must be explicitly qualified with + a prefix such as <literal>interface-name:</literal>. A negative match has higher priority then the positive + matches above.</para></listitem> + </varlistentry> + <varlistentry> + <term>SPEC[,;]SPEC</term> + <listitem><para>Multiple specs can be concatenated with commas or semicolons. The order does not matter as + matches are either inclusive or negative (<literal>except:</literal>), with negative matches having higher + priority. + </para> + <para>Backslash is supported to escape the separators ';' and ',', and to express special + characters such as newline ('\n'), tabulator ('\t'), whitespace ('\s') and backslash ('\\'). The globbing of + interface names cannot be escaped. Whitespace is not a separator but will be trimmed between + two specs (unless escaped as '\s'). + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + <para> + Example: + <programlisting> +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 + </programlisting> + </para> + </refsect2> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-online</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-applet</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-connection-editor</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> +</refentry> diff --git a/man/NetworkManager.conf.xml.in b/man/NetworkManager.conf.xml.in index 029db24e..31c1cf8c 100644 --- a/man/NetworkManager.conf.xml.in +++ b/man/NetworkManager.conf.xml.in @@ -27,23 +27,39 @@ Copyright 2010 - 2014 Red Hat, Inc. <refsynopsisdiv> <para><filename>/etc/NetworkManager/NetworkManager.conf</filename>, - <filename>/etc/NetworkManager/conf.d/<replaceable>name</replaceable>.conf</filename> + <filename>/etc/NetworkManager/conf.d/<replaceable>name</replaceable>.conf</filename>, + <filename>/usr/lib/NetworkManager/conf.d/<replaceable>name</replaceable>.conf</filename>, + <filename>/var/lib/NetworkManager/NetworkManager-intern.conf</filename> </para> </refsynopsisdiv> <refsect1> <title>Description</title> - <para>This is a configuration file for NetworkManager. It is used + <para><literal>NetworkManager.conf</literal> is the configuration file for NetworkManager. It is used to set up various aspects of NetworkManager's behavior. The - location of the file may be changed through use of the - <option>--config</option> argument for NetworkManager. + location of the main file and configuration directories may be changed + through use of the <option>--config</option>, <option>--config-dir</option>, + <option>--system-config-dir</option>, and <option>--intern-config</option> + argument for NetworkManager, respectively. </para> <para>If a default <literal>NetworkManager.conf</literal> is provided by your distribution's packages, you should not modify it, since your changes may get overwritten by package updates. Instead, you can add additional <literal>.conf</literal> - files to the <literal>conf.d</literal> directory. These will be read in order, - with later files overriding earlier ones. + files to the <literal>/etc/NetworkManager/conf.d</literal> directory. + These will be read in order, with later files overriding earlier ones. + Packages might install further configuration snippets to <literal>/usr/lib/NetworkManager/conf.d</literal>. + This directory is parsed first, even before <literal>NetworkManager.conf</literal>. + The loading of a file <literal>/usr/lib/NetworkManager/conf.d/<replaceable>name</replaceable>.conf</literal> + can be prevented by adding a file <literal>/etc/NetworkManager/conf.d/<replaceable>name</replaceable>.conf</literal>. + In this case, the file from the etc configuration shadows the file from the + system configuration directory. + </para> + <para> + NetworkManager can overwrite certain user configuration options via D-Bus or other internal + operations. In this case it writes those changes to <literal>/var/lib/NetworkManager/NetworkManager-intern.conf</literal>. + This file is not intended to be modified by the user, but it is read last and can shadow + user configuration from <literal>NetworkManager.conf</literal>. </para> </refsect1> @@ -270,6 +286,20 @@ no-auto-default=* </varlistentry> <varlistentry> + <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> + <para><literal>resolvconf</literal>: NetworkManager will run + resolvconf to update the DNS configuration.</para> + <para><literal>netconfig</literal>: NetworkManager will run + netconfig to update the DNS configuration.</para> + </listitem> + </varlistentry> + + <varlistentry> <term><varname>debug</varname></term> <listitem><para>Comma separated list of options to aid debugging. This value will be combined with the environment @@ -301,8 +331,19 @@ no-auto-default=* <variablelist> <varlistentry> <term><varname>hostname</varname></term> - <listitem><para>Set a persistent hostname.</para></listitem> + <listitem><para>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. + </para></listitem> </varlistentry> + <varlistentry> + <term><varname>path</varname></term> + <listitem> + <para>The location where keyfiles are read and stored. + This defaults to "<literal>@NM_CONFIG_KEYFILE_PATH_DEFAULT@</literal>". + </para> + </listitem> + </varlistentry> <varlistentry> <term><varname>unmanaged-devices</varname></term> <listitem><para>Set devices that should be ignored by @@ -363,7 +404,7 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth <varlistentry> <term><varname>level</varname></term> <listitem><para>The default logging verbosity level. - One of <literal>ERR</literal>, + One of <literal>OFF</literal>, <literal>ERR</literal>, <literal>WARN</literal>, <literal>INFO</literal>, <literal>DEBUG</literal>, <literal>TRACE</literal>. The ERR level logs only critical errors. WARN logs warnings that may @@ -381,12 +422,12 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth 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.</para> + TEAM, CONCHECK, DCB, DISPATCH, AUDIT.</para> <para>In addition, these special domains can be used: NONE, ALL, DEFAULT, DHCP, IP.</para> <para>You can specify per-domain log level overrides by adding a colon and a log level to any domain. E.g., - "<literal>WIFI:DEBUG</literal>".</para></listitem> + "<literal>WIFI:DEBUG,WIFI_SCAN:OFF</literal>".</para></listitem> </varlistentry> <varlistentry> <para>Domain descriptions: @@ -403,7 +444,7 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth <member>WIFI_SCAN : Wi-Fi scanning operations</member> <member>IP4 : IPv4-related operations</member> <member>IP6 : IPv6-related operations</member> - <member>AUTOIP4 : AutoIP (avahi) operations</member> + <member>AUTOIP4 : AutoIP operations</member> <member>DNS : Domain Name System related operations</member> <member>VPN : Virtual Private Network connections and operations</member> <member>SHARING : Connection sharing</member> @@ -426,6 +467,7 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth <member>CONCHECK : Connectivity check</member> <member>DCB : Data Center Bridging (DCB) operations</member> <member>DISPATCH : Dispatcher scripts</member> + <member>AUDIT : Audit records</member> <member> </member> <member>NONE : when given by itself logging is disabled</member> <member>ALL : all log domains</member> @@ -437,6 +479,29 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth </simplelist> </para> </varlistentry> + <varlistentry> + <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>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>". + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>audit</varname></term> + <listitem><para>Whether the audit records are delivered to + auditd, the audit daemon. If <literal>false</literal>, audit + records will be sent only to the NetworkManager logging + system. If set to <literal>true</literal>, they will be also + sent to auditd. The default value is <literal>@NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT@</literal>. + </para></listitem> + </varlistentry> </variablelist> </para> </refsect1> @@ -454,6 +519,7 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth [connection] ipv6.ip6-privacy=0 connection.autoconnect-slaves=1 +vpn.timeout=120 [connection-wifi-wlan0] match-device=interface-name:wlan0 @@ -514,9 +580,23 @@ ipv6.ip6-privacy=1 The following properties are supported to have their default values configured: <variablelist> <varlistentry> + <term><varname>connection.autoconnect-slaves</varname></term> + </varlistentry> + <varlistentry> + <term><varname>connection.lldp</varname></term> + </varlistentry> + <varlistentry> + <term><varname>ethernet.wake-on-lan</varname></term> + </varlistentry> + <varlistentry> <term><varname>ipv4.route-metric</varname></term> </varlistentry> <varlistentry> + <term><varname>ipv4.dhcp-timeout</varname></term> + <listitem><para>If left unspecified, the default value for + the interface type is used.</para></listitem> + </varlistentry> + <varlistentry> <term><varname>ipv6.ip6-privacy</varname></term> <listitem><para>If <literal>ipv6.ip6-privacy</literal> is unset, use the content of "/proc/sys/net/ipv6/conf/default/use_tempaddr" as last fallback. @@ -525,13 +605,15 @@ ipv6.ip6-privacy=1 <varlistentry> <term><varname>ipv6.route-metric</varname></term> </varlistentry> - <varlistentry> - <term><varname>connection.autoconnect-slaves</varname></term> - </varlistentry> - <varlistentry> - <term><varname>ethernet.wake-on-lan</varname></term> - </varlistentry> </variablelist> + <varlistentry> + <term><varname>vpn.timeout</varname></term> + <listitem><para>If left unspecified, default value of 60 seconds is used.</para></listitem> + </varlistentry> + <varlistentry> + <term><varname>wifi.mac-address-randomization</varname></term> + <listitem><para>If left unspecified, MAC address randomization is disabled.</para></listitem> + </varlistentry> </para> </refsect1> @@ -575,6 +657,153 @@ ipv6.ip6-privacy=1 </refsect1> <refsect1> + <title><literal>global-dns</literal> section</title> + <para>This section specifies global DNS settings that override + connection-specific configuration.</para> + <para> + <variablelist> + <varlistentry> + <term><varname>searches</varname></term> + <listitem> + <para> + A list of search domains to be used during hostname lookup. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>options</varname></term> + <listitem> + <para> + A list of of options to be passed to the hostname resolver. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1> + <title><literal>global-dns-domain</literal> sections</title> + <para>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. + </para> + <para> + <variablelist> + <varlistentry> + <term><varname>servers</varname></term> + <listitem> + <para> + A list of addresses of DNS servers to be used for the given domain. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><varname>options</varname></term> + <listitem> + <para> + A list of domain-specific DNS options. Not used at the moment. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1> + <title><literal>.config</literal> sections</title> + <para>This is a special section that contains options which apply + to the configuration file that contains the option. + </para> + <para> + <variablelist> + <varlistentry> + <term><varname>enable</varname></term> + <listitem> + <para> + Defaults to "<literal>true</literal>". If "<literal>false</literal>", + the configuration file will be skipped during loading. + Note that the main configuration file <literal>NetworkManager.conf</literal> + cannot be disabled. +<programlisting> +# always skip loading the config file +[.config] +enable=false +</programlisting> + </para> + <para> + You can also match against the version of NetworkManager. For example + the following are valid configurations: +<programlisting> +# 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 +</programlisting> + </para> + <para> + You can also match against the value of the environment variable + <literal>NM_CONFIG_ENABLE_TAG</literal>, like: +<programlisting> +# always skip loading the file when running NetworkManager with +# environment variable "NM_CONFIG_ENABLE_TAG=TAG1" +[.config] +enable=env:TAG1 +</programlisting> + </para> + <para> + 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. +<programlisting> +# 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 +</programlisting> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1> <title>Plugins</title> <variablelist> @@ -592,7 +821,7 @@ ipv6.ip6-privacy=1 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 - writeable by any user or group other than root. + writable by any user or group other than root. </para> <para> This plugin is always active, and will automatically be @@ -611,6 +840,9 @@ ipv6.ip6-privacy=1 <filename>/etc/sysconfig/network-scripts/ifcfg-*</filename> files. It currently supports reading Ethernet, Wi-Fi, InfiniBand, VLAN, Bond, Bridge, and Team connections. + Enabling <literal>ifcfg-rh</literal> implicitly enables + <literal>ibft</literal> plugin, if it is available. + This can be disabled by adding <literal>no-ibft</literal>. </para> </listitem> </varlistentry> @@ -619,12 +851,9 @@ ipv6.ip6-privacy=1 <term><varname>ifcfg-suse</varname></term> <listitem> <para> - This plugin is only provided for simple backward - compatibility with SUSE and OpenSUSE configuration. Most - setups should be using the <literal>keyfile</literal> - plugin instead. The <literal>ifcfg-suse</literal> plugin - supports reading Ethernet and Wi-Fi connections, but does - not support saving any connection types. + This plugin is deprecated and its selection has no effect. + The <literal>keyfile</literal> plugin should be used + instead. </para> </listitem> </varlistentry> @@ -647,12 +876,16 @@ ipv6.ip6-privacy=1 </varlistentry> <varlistentry> - <term><varname>ibft</varname></term> + <term><varname>ibft</varname>, <varname>no-ibft</varname></term> <listitem> <para> 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 + <literal>ifcfg-rh</literal>. This can be disabled by <literal>no-ibft</literal>. + You can also explicitly specify <literal>ibft</literal> to load the + plugin without <literal>ifcfg-rh</literal> or to change the plugin order. </para> </listitem> </varlistentry> @@ -715,12 +948,16 @@ ipv6.ip6-privacy=1 </varlistentry> <varlistentry> <term>SPEC[,;]SPEC</term> - <listitem><para>Multiple specs can be concatenated with comman or semicolon. The order does not matter as - matches are either positive (inclusive) or negative, with negative matches having higher priority.</para> + <listitem><para>Multiple specs can be concatenated with commas or semicolons. The order does not matter as + matches are either inclusive or negative (<literal>except:</literal>), with negative matches having higher + priority. + </para> <para>Backslash is supported to escape the separators ';' and ',', and to express special characters such as newline ('\n'), tabulator ('\t'), whitespace ('\s') and backslash ('\\'). The globbing of - interface names cannot be escaped. Whitespace is taken literally so usually the specs will be concatenated - without spaces.</para></listitem> + interface names cannot be escaped. Whitespace is not a separator but will be trimmed between + two specs (unless escaped as '\s'). + </para> + </listitem> </varlistentry> </variablelist> </para> diff --git a/man/NetworkManager.xml b/man/NetworkManager.xml new file mode 100644 index 00000000..2df37d9a --- /dev/null +++ b/man/NetworkManager.xml @@ -0,0 +1,461 @@ +<?xml version='1.0'?> <!--*-nxml-*--> +<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" + "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> + +<!-- + Copyright 2005 - 2014 Red Hat, Inc. + Copyright 2005 - 2009 Novell, Inc. + Copyright 2005 Robert Love +--> + +<refentry id="NetworkManager"> + <refentryinfo> + <title>NetworkManager</title> + <author>NetworkManager developers</author> + </refentryinfo> + <refmeta> + <refentrytitle>NetworkManager</refentrytitle> + <manvolnum>8</manvolnum> + <refmiscinfo class="source">NetworkManager</refmiscinfo> + <refmiscinfo class="manual">Network management daemons</refmiscinfo> + <refmiscinfo class="version">1.0</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>NetworkManager</refname> + <refpurpose>network management daemon</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>NetworkManager <arg choice="opt" rep="repeat">OPTIONS</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + <para> + 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. + </para> + </refsect1> + + <refsect1> + <title>Dispatcher scripts</title> + <para> + 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. + </para> + <para> + 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 <varname>hostname</varname> action it is always "none". + </para> + <para>The actions are:</para> + <variablelist class="dispatcher-options"> + <varlistentry> + <term><varname>pre-up</varname></term> + <listitem><para>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. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>up</varname></term> + <listitem><para>The interface has been activated.</para></listitem> + </varlistentry> + <varlistentry> + <term><varname>pre-down</varname></term> + <listitem><para>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. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>down</varname></term> + <listitem><para> + The interface has been deactivated. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>vpn-pre-up</varname></term> + <listitem><para>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. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>vpn-up</varname></term> + <listitem><para> + A VPN connection has been activated. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>vpn-pre-down</varname></term> + <listitem><para>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. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>vpn-down</varname></term> + <listitem><para> + A VPN connection has been deactivated. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>hostname</varname></term> + <listitem><para> + 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. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>dhcp4-change</varname></term> + <listitem><para> + The DHCPv4 lease has changed (renewed, rebound, etc). + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>dhcp6-change</varname></term> + <listitem><para> + The DHCPv6 lease has changed (renewed, rebound, etc). + </para></listitem> + </varlistentry> + </variablelist> + <para> + The environment contains more information about the interface and the connection. + The following variables are available for the use in the dispatcher scripts: + <variablelist class="dispatcher-environment"> + <varlistentry> + <term><varname>CONNECTION_UUID</varname></term> + <listitem><para> + The UUID of the connection profile. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>CONNECTION_ID</varname></term> + <listitem><para> + The name (ID) of the connection profile. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>CONNECTION_DBUS_PATH</varname></term> + <listitem><para> + The NetworkManager D-Bus path of the connection. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>CONNECTION_FILENAME</varname></term> + <listitem><para> + The backing file name of the connection profile (if any). + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>CONNECTION_EXTERNAL</varname></term> + <listitem><para> + If "1", this indicates that the connection describes a + network configuration created outside of NetworkManager. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>DEVICE_IFACE</varname></term> + <listitem><para> + The interface name of the device. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>DEVICE_IP_IFACE</varname></term> + <listitem><para> + The IP interface name of the device. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>IP4_ADDRESS_N</varname></term> + <listitem><para> + 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. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>IP4_NUM_ADDRESSES</varname></term> + <listitem><para> + The variable contains the number of IPv4 addresses the script may expect. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>IP4_GATEWAY</varname></term> + <listitem><para> + The gateway IPv4 address in traditional numbers-and-dots notation. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>IP4_ROUTE_N</varname></term> + <listitem><para> + The IPv4 route in the format "address/prefix next-hop metric", where N is a number + from 0 to (# IPv4 routes - 1). + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>IP4_NUM_ROUTES</varname></term> + <listitem><para> + The variable contains the number of IPv4 routes the script may expect. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>IP4_NAMESERVERS</varname></term> + <listitem><para> + The variable contains a space-separated list of the DNS servers. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>IP4_DOMAINS</varname></term> + <listitem><para> + The variable contains a space-separated list of the search domains. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>DHCP4_<dhcp-option-name></varname></term> + <listitem><para> + 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". + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>IP6_<name> and DHCP6_<name></varname></term> + <listitem><para> + The same variables as for IPv4 are available for IPv6, but the prefixes are IP6_ + and DHCP6_ instead. + </para></listitem> + </varlistentry> + </variablelist> + </para> + <para> + 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. + </para> + <para> + 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.) + </para> + </refsect1> + + <refsect1> + <title>Options</title> + + <para>The following options are understood:</para> + + <variablelist> + <varlistentry> + <term><option>--version</option> | <option>-V</option></term> + <listitem><para>Print the NetworkManager software version and exit. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--help</option> | <option>-h</option></term> + <listitem><para>Print NetworkManager's available options and exit. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--no-daemon</option> | <option>-n</option></term> + <listitem><para>Do not daemonize. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--debug</option> | <option>-d</option></term> + <listitem><para>Do not daemonize, and direct log output to the + controlling terminal in addition to syslog. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--pid-file</option> | <option>-p</option></term> + <listitem><para>Specify location of a PID file. The PID file + is used for storing PID of the running process and prevents + running multiple instances. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--state-file</option></term> + <listitem><para>Specify file for storing state of the + NetworkManager persistently. If not specified, the default + value of /var/lib/NetworkManager/NetworkManager.state is used. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--config</option></term> + <listitem><para> 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 'nm-system-settings.conf' if located + in the same directory. See + <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for more information on configuration file. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--plugins</option></term> + <listitem><para>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, <option>ifcfg-rh</option>, + <option>ifcfg-suse</option>, <option>ifupdown</option>. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--log-level</option></term> + <listitem><para> + Sets how much information NetworkManager sends to the log destination (usually + syslog's "daemon" facility). By default, only informational, warning, and error + messages are logged. See the section on <literal>logging</literal> in + <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for more information. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--log-domains</option></term> + <listitem><para> + 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 <literal>logging</literal> in + <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for more information. + </para></listitem> + </varlistentry> + <varlistentry> + <term><option>--print-config</option></term> + <listitem><para> + Print the NetworkManager configuration to stdout and exit. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>UDEV PROPERTIES</title> + + <para> + <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry> + device manager is used for the network device discovery. The following + property influences how NetworkManager manages the devices: + </para> + + <variablelist> + <varlistentry> + <term><varname>NM_UNMANAGED</varname></term> + <listitem><para> + 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. + </para><para> + Create an udev rule that sets this property to prevent NetworkManager + from interfering with virtual Ethernet device interfaces that are + managed by virtualization tools. + </para></listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1> + <title>SIGNALS</title> + <para> + NetworkManager process handles the following signals: + <variablelist> + <varlistentry> + <term><varname>SIGHUP</varname></term> + <listitem><para> + The signal causes a reload of NetworkManager's 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. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>SIGUSR1</varname></term> + <listitem><para> + The signal forces a rewrite of DNS configuration. + </para></listitem> + </varlistentry> + <varlistentry> + <term><varname>SIGUSR2</varname></term> + <listitem><para> + The signal has no effect at the moment. + </para></listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1> + <title>DEBUGGING</title> + <para> + The following environment variables are supported to help + debugging. When used in conjunction with the + <option>--no-daemon</option> option (thus echoing PPP and DHCP + helper output to stdout) these can quickly help pinpoint the + source of connection issues. Also see the + <option>--log-level</option> and <option>--log-domains</option> + to enable debug logging inside NetworkManager itself. + </para> + <para> + <option>NM_PPP_DEBUG</option>: When set to anything, causes + NetworkManager to turn on PPP debugging in pppd, which logs + all PPP and PPTP frames and client/server exchanges. + </para> + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-online</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-applet</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-connection-editor</refentrytitle><manvolnum>1</manvolnum></citerefentry> + <citerefentry><refentrytitle>udev</refentrytitle><manvolnum>7</manvolnum></citerefentry> + </para> + </refsect1> +</refentry> diff --git a/man/nm-settings-ifcfg-rh.5 b/man/nm-settings-ifcfg-rh.5 index ddc9062f..5b0435f8 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: 23 December 2015 +.\" Date: 19 January 2016 .\" Manual: Configuration -.\" Source: NetworkManager 1.0.9 +.\" Source: NetworkManager 1.1.90 .\" Language: English .\" -.TH "NM\-SETTINGS\-IFCFG\" "5" "" "NetworkManager 1\&.0\&.9" "Configuration" +.TH "NM\-SETTINGS\-IFCFG\" "5" "" "NetworkManager 1\&.1\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -257,7 +257,7 @@ files for a single device, NM_CONTROLLED=no in one of the files will cause the d .PP \fBNew variables\fR .RS 4 -NetworkManager has introduced some new variable, not present in initscripts, to be able to store data for its new features\&. The variables are marked as extensions in the tables bellows\&. +NetworkManager has introduced some new variable, not present in initscripts, to be able to store data for its new features\&. The variables are marked as extensions in the tables below\&. .RE .PP \fBSemantic change of variables\fR @@ -791,6 +791,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ mac\-address @@ -865,6 +866,17 @@ Ethernet MAC ageing time\&.\fB Allowed values: \fR0 \- 1000000 T} +T{ +multicast\-snooping +T}:T{ +BRIDGING_OPTS: multicast_snooping= +T}:T{ +1 +T}:T{ +IGMP snooping support\&.\fB + +Allowed values: \fR0 or 1 +T} .TE .sp 1 .sp @@ -899,6 +911,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ id @@ -1044,6 +1057,19 @@ Example: \fRCONNECTION_METERED=yes\fB Allowed values: \fRyes,no,unknown T} +T{ +lldp +T}:T{ +LLDP +T}:T{ +missing variable means global default +T}:T{ +whether LLDP is enabled for the connection\fB + +Example: \fRLLDP=no\fB + +Allowed values: \fRboolean value or \*(Aqrx\*(Aq +T} .TE .sp 1 .sp @@ -1240,7 +1266,7 @@ T} .TE .sp 1 .PP -All DCB related configuration is a NetworkManager extention\&. DCB=yes must be used explicitly to enable DCB so that the rest of the DCB_* variables can apply\&. +All DCB related configuration is a NetworkManager extension\&. DCB=yes must be used explicitly to enable DCB so that the rest of the DCB_* variables can apply\&. .sp .it 1 an-trap .nr an-no-space-flag 1 @@ -1323,7 +1349,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&8.\ \&ipv4 setting +.B Table\ \&8.\ \&ip-tunnel setting .TS allbox tab(:); lB lB lB lB. @@ -1337,6 +1363,30 @@ T}:T{ Description T} .T& +. +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&9.\ \&ipv4 setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Ifcfg\-rh Variable +T}:T{ +Default +T}:T{ +Description +T} +.T& +l l l l +l l l l l l l l l l l l l l l l @@ -1447,7 +1497,7 @@ DHCP_HOSTNAME T}:T{ \ \& T}:T{ -Hostname to send to the DHCP server\&. +Hostname to send to the DHCP server\&. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used\&. T} T{ never\-default @@ -1487,6 +1537,28 @@ A string sent to the DHCP server to identify the local machine\&.\fB Example: \fRDHCP_CLIENT_ID=ax\-srv\-1 T} +T{ +dhcp\-timeout +T}:T{ +DHCP_TIMEOUT\fI(+)\fR +T}:T{ +\ \& +T}:T{ +A timeout after which the DHCP transaction fails in case of no response\&.\fB + +Example: \fRDHCP_TIMEOUT=10 +T} +T{ +dhcp\-fqdn +T}:T{ +DHCP_FQDN +T}:T{ +\ \& +T}:T{ +FQDN to send to the DHCP server\&. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used\&.\fB + +Example: \fRDHCP_FQDN=foo\&.bar\&.com +T} .TE .sp 1 .sp @@ -1494,7 +1566,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&9.\ \&ipv6 setting +.B Table\ \&10.\ \&ipv6 setting .TS allbox tab(:); lB lB lB lB. @@ -1520,6 +1592,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ method @@ -1646,6 +1719,41 @@ Example: \fRIPV6_PRIVACY=rfc3041 IPV6_PRIVACY_PREFER_PUBLIC_IP=yes\fB Allowed values: \fRIPV6_PRIVACY: no, yes (rfc3041 or rfc4941); IPV6_PRIVACY_PREFER_PUBLIC_IP: yes, no T} +T{ +addr\-gen\-mode +T}:T{ +IPV6_ADDR_GEN_MODE +T}:T{ +eui64 +T}:T{ +Configure IPv6 Stable Privacy addressing for SLAAC (RFC7217)\&.\fB + +Example: \fRIPV6_ADDR_GEN_MODE=stable\-privacy\fB + +Allowed values: \fRIPV6_ADDR_GEN_MODE: eui64, stable\-privacy +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&11.\ \&macvlan setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Ifcfg\-rh Variable +T}:T{ +Default +T}:T{ +Description +T} +.T& +. .TE .sp 1 .sp @@ -1653,7 +1761,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&10.\ \&team-port setting +.B Table\ \&12.\ \&team-port setting .TS allbox tab(:); lB lB lB lB. @@ -1684,7 +1792,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&11.\ \&team setting +.B Table\ \&13.\ \&team setting .TS allbox tab(:); lB lB lB lB. @@ -1715,7 +1823,29 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&12.\ \&vlan setting +.B Table\ \&14.\ \&tun setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Ifcfg\-rh Variable +T}:T{ +Default +T}:T{ +Description +T} +.T& +. +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&15.\ \&vlan setting .TS allbox tab(:); lB lB lB lB. @@ -1756,13 +1886,13 @@ T} T{ flags T}:T{ -VLAN_FLAGS, REORDER_HDR +REORDER_HDR, GVRP, MVRP, VLAN_FLAGS T}:T{ \ \& T}:T{ VLAN flags\&.\fB -Allowed values: \fR"GVRP", "LOOSE_BINDING" for VLAN_FLAGS; 0 or 1 for REORDER_HDR +Allowed values: \fR"yes or "no" for REORDER_HDR, GVRP and MVRP; "LOOSE_BINDING" for VLAN_FLAGS T} T{ ingress\-priority\-map @@ -1804,7 +1934,29 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&13.\ \&802-3-ethernet setting +.B Table\ \&16.\ \&vxlan setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Ifcfg\-rh Variable +T}:T{ +Default +T}:T{ +Description +T} +.T& +. +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&17.\ \&802-3-ethernet setting .TS allbox tab(:); lB lB lB lB. @@ -1943,7 +2095,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&14.\ \&802-11-wireless-security setting +.B Table\ \&18.\ \&802-11-wireless-security setting .TS allbox tab(:); lB lB lB lB. @@ -2150,7 +2302,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&15.\ \&802-11-wireless setting +.B Table\ \&19.\ \&802-11-wireless setting .TS allbox tab(:); lB lB lB lB. @@ -2177,6 +2329,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{ ssid @@ -2308,6 +2462,30 @@ T}:T{ Whether the network hides the SSID\&. T} T{ +powersave +T}:T{ +POWERSAVE\fI(+)\fR +T}:T{ +no +T}:T{ +Enables or disables Wi\-Fi power saving\&.\fB + +Example: \fRPOWERSAVE=yes +T} +T{ +mac\-address\-randomization +T}:T{ +MAC_ADDRESS_RANDOMIZATION\fI(+)\fR +T}:T{ +1 +T}:T{ +Enables or disables Wi\-Fi MAC address randomization\&.\fB + +Example: \fRMAC_ADDRESS_RANDOMIZATION=2\fB + +Allowed values: \fR0 (default), (1) never, (2) always +T} +T{ security T}:T{ (none) @@ -2332,7 +2510,7 @@ property that describes how to handle that secret\&. In the \fIfcfg\-rh\fR plugin variables for secret flags have a \fI_FLAGS\fR -suffix\&. The variables contain one or more of the folowing values (space separated)\&. Missing (or empty) *_FLAGS variable means that the password is owned by NetworkManager\&. +suffix\&. The variables contain one or more of the following values (space separated)\&. Missing (or empty) *_FLAGS variable means that the password is owned by NetworkManager\&. .sp .RS 4 .ie n \{\ diff --git a/man/nm-settings-ifcfg-rh.xml b/man/nm-settings-ifcfg-rh.xml index c5360f54..7d577106 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>23 December 2015</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.0.9</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>19 January 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.90</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 @@ -145,7 +145,7 @@ DEVICETYPE=TeamPort </para></listitem></varlistentry><varlistentry><term><emphasis role="bold">New variables</emphasis></term><listitem><para> NetworkManager has introduced some new variable, not present in initscripts, to be able to store data for its new features. The variables are marked - as extensions in the tables bellows. + as extensions in the tables below. </para></listitem></varlistentry><varlistentry><term><emphasis role="bold">Semantic change of variables</emphasis></term><listitem><para> NetworkManager had to slightly change the semantic for a few variables. <itemizedlist><listitem><para><literal>PEERDNS</literal> - @@ -221,7 +221,9 @@ Allowed values: </emphasis>1 - 10</entry></row><row><entry align="left">max-age< Allowed values: </emphasis>6 - 40</entry></row><row><entry align="left">ageing-time</entry><entry align="left">BRIDGING_OPTS: ageing_time=</entry><entry align="left">300</entry><entry align="left">Ethernet MAC ageing time.<emphasis role="bold"> -Allowed values: </emphasis>0 - 1000000</entry></row></tbody></tgroup></table><table><title>connection setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">id</entry><entry align="left">NAME<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">User friendly name for the connection profile.</entry></row><row><entry align="left">uuid</entry><entry align="left">UUID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">UUID for the connection profile. When missing, NetworkManager creates the UUID itself (by hashing the file).</entry></row><row><entry align="left">interface-name</entry><entry align="left">DEVICE</entry><entry align="left"/><entry align="left">Interface name of the device this profile is bound to. The variable can be left out when the profile should apply for more devices. Note that DEVICE can be required for some connection types.</entry></row><row><entry align="left">type</entry><entry align="left">TYPE (DEVICETYPE, DEVICE)</entry><entry align="left"/><entry align="left">Base type of the connection. DEVICETYPE is used for teaming connections.<emphasis role="bold"> +Allowed values: </emphasis>0 - 1000000</entry></row><row><entry align="left">multicast-snooping</entry><entry align="left">BRIDGING_OPTS: multicast_snooping=</entry><entry align="left">1</entry><entry align="left">IGMP snooping support.<emphasis role="bold"> + +Allowed values: </emphasis>0 or 1</entry></row></tbody></tgroup></table><table><title>connection setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">id</entry><entry align="left">NAME<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">User friendly name for the connection profile.</entry></row><row><entry align="left">uuid</entry><entry align="left">UUID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">UUID for the connection profile. When missing, NetworkManager creates the UUID itself (by hashing the file).</entry></row><row><entry align="left">interface-name</entry><entry align="left">DEVICE</entry><entry align="left"/><entry align="left">Interface name of the device this profile is bound to. The variable can be left out when the profile should apply for more devices. Note that DEVICE can be required for some connection types.</entry></row><row><entry align="left">type</entry><entry align="left">TYPE (DEVICETYPE, DEVICE)</entry><entry align="left"/><entry align="left">Base type of the connection. DEVICETYPE is used for teaming connections.<emphasis role="bold"> Example: </emphasis>TYPE=Ethernet; TYPE=Bond; TYPE=Bridge; DEVICETYPE=TeamPort<emphasis role="bold"> @@ -239,7 +241,11 @@ Example: </emphasis>GATEWAY_PING_TIMEOUT=5</entry></row><row><entry align="left" Example: </emphasis>CONNECTION_METERED=yes<emphasis role="bold"> -Allowed values: </emphasis>yes,no,unknown</entry></row></tbody></tgroup></table><table><title>dcb setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">app-fcoe-flags</entry><entry align="left">DCB_APP_FCOE_ENABLE, DCB_APP_FCOE_ADVERTISE, DCB_APP_FCOE_WILLING</entry><entry align="left">no</entry><entry align="left">FCOE flags.<emphasis role="bold"> +Allowed values: </emphasis>yes,no,unknown</entry></row><row><entry align="left">lldp</entry><entry align="left">LLDP</entry><entry align="left">missing variable means global default</entry><entry align="left">whether LLDP is enabled for the connection<emphasis role="bold"> + +Example: </emphasis>LLDP=no<emphasis role="bold"> + +Allowed values: </emphasis>boolean value or 'rx'</entry></row></tbody></tgroup></table><table><title>dcb setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">app-fcoe-flags</entry><entry align="left">DCB_APP_FCOE_ENABLE, DCB_APP_FCOE_ADVERTISE, DCB_APP_FCOE_WILLING</entry><entry align="left">no</entry><entry align="left">FCOE flags.<emphasis role="bold"> Example: </emphasis>DCB_APP_FCOE_ENABLE=yes DCB_APP_FCOE_ADVERTISE=yes</entry></row><row><entry align="left">app-fcoe-priority</entry><entry align="left">DCB_APP_FCOE_PRIORITY</entry><entry align="left"/><entry align="left">Priority of FCoE frames.<emphasis role="bold"> @@ -262,7 +268,7 @@ Example: </emphasis>DCB_PG_UPPCT=7,13,10,10,15,15,10,20</entry></row><row><entry Example: </emphasis>DCB_PG_STRICT=01101110</entry></row><row><entry align="left">priority-traffic-class</entry><entry align="left">DCB_PG_UP2TC</entry><entry align="left"/><entry align="left">Priority values. String of eight trafic class values (0 - 7).<emphasis role="bold"> Example: </emphasis>DCB_PG_UP2TC=01623701</entry></row></tbody></tgroup></table><para> - All DCB related configuration is a NetworkManager extention. DCB=yes must be + All DCB related configuration is a NetworkManager extension. DCB=yes must be used explicitly to enable DCB so that the rest of the DCB_* variables can apply. </para><table><title>infiniband setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">IBoIP 20-byte hardware address of the device (in traditional hex-digits-and-colons notation).<emphasis role="bold"> @@ -270,7 +276,7 @@ Example: </emphasis>HWADDR=01:02:03:04:05:06:07:08:09:0A:01:02:03:04:05:06:07:08 Example: </emphasis>PKEY=yes PKEY_ID=2 PHYSDEV=mlx4_ib0 DEVICE=mlx4_ib0.8002</entry></row><row><entry align="left">parent</entry><entry align="left">PHYSDEV (PKEY=yes)</entry><entry align="left">PKEY=no</entry><entry align="left">InfiniBand parent device.<emphasis role="bold"> -Example: </emphasis>PHYSDEV=ib0</entry></row></tbody></tgroup></table><table><title>ipv4 setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">method</entry><entry align="left">BOOTPROTO</entry><entry align="left">none</entry><entry align="left">Method used for IPv4 protocol configuration.<emphasis role="bold"> +Example: </emphasis>PHYSDEV=ib0</entry></row></tbody></tgroup></table><table><title>ip-tunnel setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>ipv4 setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">method</entry><entry align="left">BOOTPROTO</entry><entry align="left">none</entry><entry align="left">Method used for IPv4 protocol configuration.<emphasis role="bold"> Allowed values: </emphasis>none, dhcp (bootp), static, ibft, autoip, shared</entry></row><row><entry align="left">dns</entry><entry align="left">DNS1, DNS2, ...</entry><entry align="left"/><entry align="left">List of DNS servers. Even if NetworkManager supports many DNS servers, initscripts and resolver only care about the first three, usually.<emphasis role="bold"> @@ -278,9 +284,13 @@ Example: </emphasis>DNS1=1.2.3.4 DNS2=10.0.0.254 DNS3=8.8.8.8</entry></row><row> Example: </emphasis>IPADDR=10.5.5.23 PREFIX=24 IPADDR1=1.1.1.2 PREFIX1=16</entry></row><row><entry align="left">gateway</entry><entry align="left">GATEWAY</entry><entry align="left"/><entry align="left">Gateway IP address.<emphasis role="bold"> -Example: </emphasis>GATEWAY=10.5.5.1</entry></row><row><entry align="left">routes</entry><entry align="left">ADDRESS1, NETMASK1, GATEWAY1, METRIC1, ...</entry><entry align="left"/><entry align="left">List of static routes. They are not stored in ifcfg-* file, but in route-* file instead.</entry></row><row><entry align="left">ignore-auto-routes</entry><entry align="left">PEERROUTES<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">PEERROUTES has the opposite meaning as 'ignore-auto-routes' property.</entry></row><row><entry align="left">ignore-auto-dns</entry><entry align="left">PEERDNS</entry><entry align="left">yes</entry><entry align="left">PEERDNS has the opposite meaning as 'ignore-auto-dns' property.</entry></row><row><entry align="left">dhcp-send-hostname</entry><entry align="left">DHCP_SEND_HOSTNAME<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">Whether DHCP_HOSTNAME should be sent to the DHCP server.</entry></row><row><entry align="left">dhcp-hostname</entry><entry align="left">DHCP_HOSTNAME</entry><entry align="left"/><entry align="left">Hostname to send to the DHCP server.</entry></row><row><entry align="left">never-default</entry><entry align="left">DEFROUTE (GATEWAYDEV in /etc/sysconfig/network)</entry><entry align="left">yes</entry><entry align="left">DEFROUTE=no tells NetworkManager that this connection should not be assigned the default route. DEFROUTE has the opposite meaning as 'never-default' property.</entry></row><row><entry align="left">may-fail</entry><entry align="left">IPV4_FAILURE_FATAL<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">IPV4_FAILURE_FATAL has the opposite meaning as 'may-fail' property.</entry></row><row><entry align="left">route-metric</entry><entry align="left">IPV4_ROUTE_METRIC<emphasis>(+)</emphasis></entry><entry align="left">-1</entry><entry align="left">IPV4_ROUTE_METRIC is the default IPv4 metric for routes on this connection. If set to -1, a default metric based on the device type is used.</entry></row><row><entry align="left">dhcp-client-id</entry><entry align="left">DHCP_CLIENT_ID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A string sent to the DHCP server to identify the local machine.<emphasis role="bold"> +Example: </emphasis>GATEWAY=10.5.5.1</entry></row><row><entry align="left">routes</entry><entry align="left">ADDRESS1, NETMASK1, GATEWAY1, METRIC1, ...</entry><entry align="left"/><entry align="left">List of static routes. They are not stored in ifcfg-* file, but in route-* file instead.</entry></row><row><entry align="left">ignore-auto-routes</entry><entry align="left">PEERROUTES<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">PEERROUTES has the opposite meaning as 'ignore-auto-routes' property.</entry></row><row><entry align="left">ignore-auto-dns</entry><entry align="left">PEERDNS</entry><entry align="left">yes</entry><entry align="left">PEERDNS has the opposite meaning as 'ignore-auto-dns' property.</entry></row><row><entry align="left">dhcp-send-hostname</entry><entry align="left">DHCP_SEND_HOSTNAME<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">Whether DHCP_HOSTNAME should be sent to the DHCP server.</entry></row><row><entry align="left">dhcp-hostname</entry><entry align="left">DHCP_HOSTNAME</entry><entry align="left"/><entry align="left">Hostname to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used.</entry></row><row><entry align="left">never-default</entry><entry align="left">DEFROUTE (GATEWAYDEV in /etc/sysconfig/network)</entry><entry align="left">yes</entry><entry align="left">DEFROUTE=no tells NetworkManager that this connection should not be assigned the default route. DEFROUTE has the opposite meaning as 'never-default' property.</entry></row><row><entry align="left">may-fail</entry><entry align="left">IPV4_FAILURE_FATAL<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">IPV4_FAILURE_FATAL has the opposite meaning as 'may-fail' property.</entry></row><row><entry align="left">route-metric</entry><entry align="left">IPV4_ROUTE_METRIC<emphasis>(+)</emphasis></entry><entry align="left">-1</entry><entry align="left">IPV4_ROUTE_METRIC is the default IPv4 metric for routes on this connection. If set to -1, a default metric based on the device type is used.</entry></row><row><entry align="left">dhcp-client-id</entry><entry align="left">DHCP_CLIENT_ID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A string sent to the DHCP server to identify the local machine.<emphasis role="bold"> + +Example: </emphasis>DHCP_CLIENT_ID=ax-srv-1</entry></row><row><entry align="left">dhcp-timeout</entry><entry align="left">DHCP_TIMEOUT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A timeout after which the DHCP transaction fails in case of no response.<emphasis role="bold"> + +Example: </emphasis>DHCP_TIMEOUT=10</entry></row><row><entry align="left">dhcp-fqdn</entry><entry align="left">DHCP_FQDN</entry><entry align="left"/><entry align="left">FQDN to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used.<emphasis role="bold"> -Example: </emphasis>DHCP_CLIENT_ID=ax-srv-1</entry></row></tbody></tgroup></table><table><title>ipv6 setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">method</entry><entry align="left">IPV6INIT, IPV6FORWARDING, IPV6_AUTOCONF, DHCPV6C</entry><entry align="left">IPV6INIT=yes; IPV6FORWARDING=no; IPV6_AUTOCONF=!IPV6FORWARDING, DHCPV6=no</entry><entry align="left">Method used for IPv6 protocol configuration. ignore ~ IPV6INIT=no; auto ~ IPV6_AUTOCONF=yes; dhcp ~ IPV6_AUTOCONF=no and DHCPV6C=yes</entry></row><row><entry align="left">dns</entry><entry align="left">DNS1, DNS2, ...</entry><entry align="left"/><entry align="left">List of DNS servers. NetworkManager uses the variables both for IPv4 and IPv6.</entry></row><row><entry align="left">dns-search</entry><entry align="left">DOMAIN</entry><entry align="left"/><entry align="left">List of DNS search domains.</entry></row><row><entry align="left">addresses</entry><entry align="left">IPV6ADDR, IPV6ADDR_SECONDARIES</entry><entry align="left"/><entry align="left">List of static IP addresses.<emphasis role="bold"> +Example: </emphasis>DHCP_FQDN=foo.bar.com</entry></row></tbody></tgroup></table><table><title>ipv6 setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">method</entry><entry align="left">IPV6INIT, IPV6FORWARDING, IPV6_AUTOCONF, DHCPV6C</entry><entry align="left">IPV6INIT=yes; IPV6FORWARDING=no; IPV6_AUTOCONF=!IPV6FORWARDING, DHCPV6=no</entry><entry align="left">Method used for IPv6 protocol configuration. ignore ~ IPV6INIT=no; auto ~ IPV6_AUTOCONF=yes; dhcp ~ IPV6_AUTOCONF=no and DHCPV6C=yes</entry></row><row><entry align="left">dns</entry><entry align="left">DNS1, DNS2, ...</entry><entry align="left"/><entry align="left">List of DNS servers. NetworkManager uses the variables both for IPv4 and IPv6.</entry></row><row><entry align="left">dns-search</entry><entry align="left">DOMAIN</entry><entry align="left"/><entry align="left">List of DNS search domains.</entry></row><row><entry align="left">addresses</entry><entry align="left">IPV6ADDR, IPV6ADDR_SECONDARIES</entry><entry align="left"/><entry align="left">List of static IP addresses.<emphasis role="bold"> Example: </emphasis>IPV6ADDR=ab12:9876::1 IPV6ADDR_SECONDARIES="ab12:9876::2 ab12:9876::3"</entry></row><row><entry align="left">gateway</entry><entry align="left">IPV6_DEFAULTGW</entry><entry align="left"/><entry align="left">Gateway IP address.<emphasis role="bold"> @@ -288,15 +298,19 @@ Example: </emphasis>IPV6_DEFAULTGW=abbe::1</entry></row><row><entry align="left" Example: </emphasis>IPV6_PRIVACY=rfc3041 IPV6_PRIVACY_PREFER_PUBLIC_IP=yes<emphasis role="bold"> -Allowed values: </emphasis>IPV6_PRIVACY: no, yes (rfc3041 or rfc4941); IPV6_PRIVACY_PREFER_PUBLIC_IP: yes, no</entry></row></tbody></tgroup></table><table><title>team-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">config</entry><entry align="left">TEAM_PORT_CONFIG</entry><entry align="left"/><entry align="left">Team port configuration in JSON. See man teamd.conf for details.</entry></row></tbody></tgroup></table><table><title>team setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">config</entry><entry align="left">TEAM_CONFIG</entry><entry align="left"/><entry align="left">Team configuration in JSON. See man teamd.conf for details.</entry></row></tbody></tgroup></table><table><title>vlan setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">parent</entry><entry align="left">DEVICE or PHYSDEV</entry><entry align="left"/><entry align="left">Parent interface of the VLAN.</entry></row><row><entry align="left">id</entry><entry align="left">VLAN_ID or DEVICE</entry><entry align="left"/><entry align="left">VLAN identifier.</entry></row><row><entry align="left">flags</entry><entry align="left">VLAN_FLAGS, REORDER_HDR</entry><entry align="left"/><entry align="left">VLAN flags.<emphasis role="bold"> +Allowed values: </emphasis>IPV6_PRIVACY: no, yes (rfc3041 or rfc4941); IPV6_PRIVACY_PREFER_PUBLIC_IP: yes, no</entry></row><row><entry align="left">addr-gen-mode</entry><entry align="left">IPV6_ADDR_GEN_MODE</entry><entry align="left">eui64</entry><entry align="left">Configure IPv6 Stable Privacy addressing for SLAAC (RFC7217).<emphasis role="bold"> -Allowed values: </emphasis>"GVRP", "LOOSE_BINDING" for VLAN_FLAGS; 0 or 1 for REORDER_HDR</entry></row><row><entry align="left">ingress-priority-map</entry><entry align="left">VLAN_INGRESS_PRIORITY_MAP</entry><entry align="left"/><entry align="left">Ingress priority mapping.<emphasis role="bold"> +Example: </emphasis>IPV6_ADDR_GEN_MODE=stable-privacy<emphasis role="bold"> + +Allowed values: </emphasis>IPV6_ADDR_GEN_MODE: eui64, stable-privacy</entry></row></tbody></tgroup></table><table><title>macvlan setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>team-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">config</entry><entry align="left">TEAM_PORT_CONFIG</entry><entry align="left"/><entry align="left">Team port configuration in JSON. See man teamd.conf for details.</entry></row></tbody></tgroup></table><table><title>team setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">config</entry><entry align="left">TEAM_CONFIG</entry><entry align="left"/><entry align="left">Team configuration in JSON. See man teamd.conf for details.</entry></row></tbody></tgroup></table><table><title>tun setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>vlan setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">parent</entry><entry align="left">DEVICE or PHYSDEV</entry><entry align="left"/><entry align="left">Parent interface of the VLAN.</entry></row><row><entry align="left">id</entry><entry align="left">VLAN_ID or DEVICE</entry><entry align="left"/><entry align="left">VLAN identifier.</entry></row><row><entry align="left">flags</entry><entry align="left">REORDER_HDR, GVRP, MVRP, VLAN_FLAGS</entry><entry align="left"/><entry align="left">VLAN flags.<emphasis role="bold"> + +Allowed values: </emphasis>"yes or "no" for REORDER_HDR, GVRP and MVRP; "LOOSE_BINDING" for VLAN_FLAGS</entry></row><row><entry align="left">ingress-priority-map</entry><entry align="left">VLAN_INGRESS_PRIORITY_MAP</entry><entry align="left"/><entry align="left">Ingress priority mapping.<emphasis role="bold"> Example: </emphasis>VLAN_INGRESS_PRIORITY_MAP=4:2,3:5</entry></row><row><entry align="left">egress-priority-map</entry><entry align="left">VLAN_EGRESS_PRIORITY_MAP</entry><entry align="left"/><entry align="left">Egress priority mapping.<emphasis role="bold"> Example: </emphasis>VLAN_EGRESS_PRIORITY_MAP=5:4,4:1,3:7</entry></row><row><entry align="left">interface-name</entry><entry align="left">PHYSDEV and VLAN_ID, or DEVICE</entry><entry align="left"/><entry align="left">VLAN interface name. If all variables are set, parent device from PHYSDEV takes precedence over DEVICE, but VLAN id from DEVICE takes precedence over VLAN_ID.<emphasis role="bold"> -Example: </emphasis>PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12</entry></row></tbody></tgroup></table><table><title>802-3-ethernet setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">port</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not saved by the plugin.</entry></row><row><entry align="left">speed</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not saved by the plugin.</entry></row><row><entry align="left">duplex</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not saved by the plugin.</entry></row><row><entry align="left">auto-negotiate</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not saved by the plugin.</entry></row><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05).</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left">MACADDR</entry><entry align="left"/><entry align="left">Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left">HWADDR_BLACKLIST<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">It denies usage of the connection for any device whose address is listed.<emphasis role="bold"> +Example: </emphasis>PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12</entry></row></tbody></tgroup></table><table><title>vxlan setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>802-3-ethernet setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">port</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not saved by the plugin.</entry></row><row><entry align="left">speed</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not saved by the plugin.</entry></row><row><entry align="left">duplex</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not saved by the plugin.</entry></row><row><entry align="left">auto-negotiate</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not saved by the plugin.</entry></row><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05).</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left">MACADDR</entry><entry align="left"/><entry align="left">Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left">HWADDR_BLACKLIST<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">It denies usage of the connection for any device whose address is listed.<emphasis role="bold"> Example: </emphasis>HWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55"</entry></row><row><entry align="left">mtu</entry><entry align="left">MTU</entry><entry align="left"/><entry align="left">MTU of the interface.</entry></row><row><entry align="left">s390-subchannels</entry><entry align="left">SUBCHANNELS</entry><entry align="left"/><entry align="left">Subchannels for IBM S390 hosts.<emphasis role="bold"> @@ -332,12 +346,18 @@ Allowed values: </emphasis>a, bg</entry></row><row><entry align="left">channel</ Example: </emphasis>CHANNEL=6</entry></row><row><entry align="left">bssid</entry><entry align="left">BSSID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Restricts association only to a single AP.<emphasis role="bold"> -Example: </emphasis>BSSID=00:1E:BD:64:83:21</entry></row><row><entry align="left">rate</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">tx-power</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05).</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left">MACADDR</entry><entry align="left"/><entry align="left">Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left">HWADDR_BLACKLIST<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">It denies usage of the connection for any device whose address is listed.</entry></row><row><entry align="left">seen-bssids</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">mtu</entry><entry align="left">MTU</entry><entry align="left"/><entry align="left">MTU of the wireless interface.</entry></row><row><entry align="left">hidden</entry><entry align="left">SSID_HIDDEN<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Whether the network hides the SSID.</entry></row><row><entry align="left">security</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is deprecated and not handled by ifcfg-rh-plugin.</entry></row></tbody></tgroup></table><para>The following settings are not supported by <emphasis>ifcfg-rh</emphasis> plugin:</para><para>adsl, bluetooth, ppp, pppoe, serial, generic, gsm, cdma, 802-11-olpc-mesh, wimax, vpn</para><refsect2 id="secrets-flags"><title>Secret flags</title><para> +Example: </emphasis>BSSID=00:1E:BD:64:83:21</entry></row><row><entry align="left">rate</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">tx-power</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05).</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left">MACADDR</entry><entry align="left"/><entry align="left">Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left">HWADDR_BLACKLIST<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">It denies usage of the connection for any device whose address is listed.</entry></row><row><entry align="left">seen-bssids</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">mtu</entry><entry align="left">MTU</entry><entry align="left"/><entry align="left">MTU of the wireless interface.</entry></row><row><entry align="left">hidden</entry><entry align="left">SSID_HIDDEN<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Whether the network hides the SSID.</entry></row><row><entry align="left">powersave</entry><entry align="left">POWERSAVE<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Enables or disables Wi-Fi power saving.<emphasis role="bold"> + +Example: </emphasis>POWERSAVE=yes</entry></row><row><entry align="left">mac-address-randomization</entry><entry align="left">MAC_ADDRESS_RANDOMIZATION<emphasis>(+)</emphasis></entry><entry align="left">1</entry><entry align="left">Enables or disables Wi-Fi MAC address randomization.<emphasis role="bold"> + +Example: </emphasis>MAC_ADDRESS_RANDOMIZATION=2<emphasis role="bold"> + +Allowed values: </emphasis>0 (default), (1) never, (2) always</entry></row><row><entry align="left">security</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">This property is deprecated and not handled by ifcfg-rh-plugin.</entry></row></tbody></tgroup></table><para>The following settings are not supported by <emphasis>ifcfg-rh</emphasis> plugin:</para><para>adsl, bluetooth, ppp, pppoe, serial, generic, gsm, cdma, 802-11-olpc-mesh, wimax, vpn</para><refsect2 id="secrets-flags"><title>Secret flags</title><para> Each secret property in a NetworkManager setting has an associated <emphasis>flags</emphasis> property that describes how to handle that secret. In the <emphasis>fcfg-rh</emphasis> plugin variables for secret flags have a <emphasis>_FLAGS</emphasis> suffix. The variables contain one or more of the - folowing values (space separated). Missing (or empty) *_FLAGS variable means + following values (space separated). Missing (or empty) *_FLAGS variable means that the password is owned by NetworkManager. </para><itemizedlist><listitem><para><literal>user</literal> - a user-session secret agent is responsible for providing and storing this secret; when it is required, agents will be asked to provide it.</para></listitem><listitem><para><literal>ask</literal> - the associated password is not saved but it will be diff --git a/man/nm-settings-ifcfg-rh.xsl b/man/nm-settings-ifcfg-rh.xsl index 4338b90d..c648e65f 100644 --- a/man/nm-settings-ifcfg-rh.xsl +++ b/man/nm-settings-ifcfg-rh.xsl @@ -228,7 +228,7 @@ DEVICETYPE=TeamPort <listitem><para> NetworkManager has introduced some new variable, not present in initscripts, to be able to store data for its new features. The variables are marked - as extensions in the tables bellows. + as extensions in the tables below. </para></listitem> </varlistentry> <varlistentry> @@ -284,7 +284,7 @@ DEVICETYPE=TeamPort <emphasis>flags</emphasis> property that describes how to handle that secret. In the <emphasis>fcfg-rh</emphasis> plugin variables for secret flags have a <emphasis>_FLAGS</emphasis> suffix. The variables contain one or more of the - folowing values (space separated). Missing (or empty) *_FLAGS variable means + following values (space separated). Missing (or empty) *_FLAGS variable means that the password is owned by NetworkManager. </para> <itemizedlist> @@ -353,7 +353,7 @@ DEVICETYPE=TeamPort <xsl:if test="@name = 'dcb'"> <para> - All DCB related configuration is a NetworkManager extention. DCB=yes must be + All DCB related configuration is a NetworkManager extension. DCB=yes must be used explicitly to enable DCB so that the rest of the DCB_* variables can apply. </para> </xsl:if> diff --git a/man/nm-settings-keyfile.5 b/man/nm-settings-keyfile.5 index 91f0a93a..af246bb7 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: 23 December 2015 +.\" Date: 19 January 2016 .\" Manual: Configuration -.\" Source: NetworkManager 1.0.9 +.\" Source: NetworkManager 1.1.90 .\" Language: English .\" -.TH "NM\-SETTINGS\-KEYFIL" "5" "" "NetworkManager 1\&.0\&.9" "Configuration" +.TH "NM\-SETTINGS\-KEYFIL" "5" "" "NetworkManager 1\&.1\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -39,7 +39,7 @@ for details)\&. The profiles can be stored in various formats\&. NetworkManager The \fIkeyfile\fR plugin is the generic plugin that supports all the connection types and capabilities that NetworkManager has\&. It writes files out in a \&.ini\-style format in -/etc/NetworkManager/system\-connections/\&. This plugin is always enabled and will automatically be used to store any connections that are not supported by any other active plugin\&. For security, it will ignore files that are readable or writeable by any user or group other than \*(Aqroot\*(Aq since private keys and passphrases may be stored in plaintext inside the file\&. +/etc/NetworkManager/system\-connections/\&. This plugin is always enabled and will automatically be used to store any connections that are not supported by any other active plugin\&. For security, it will ignore files that are readable or writable by any user or group other than \*(Aqroot\*(Aq since private keys and passphrases may be stored in plaintext inside the file\&. .SH "FILE FORMAT" .PP The diff --git a/man/nm-settings-keyfile.xml b/man/nm-settings-keyfile.xml index 6e0e36a3..bf666b7c 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>23 December 2015</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.0.9</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>19 January 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.90</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 @@ -11,7 +11,7 @@ out in a .ini-style format in <filename>/etc/NetworkManager/system-connections/</filename>. This plugin is always enabled and will automatically be used to store any connections that are not supported by any other active plugin. - For security, it will ignore files that are readable or writeable by any user + For security, it will ignore files that are readable or writable by any user or group other than 'root' since private keys and passphrases may be stored in plaintext inside the file. </para></refsect1><refsect1><title>File Format</title><para> @@ -155,6 +155,7 @@ Example: </emphasis>mac-address=00:22:68:12:79:A2 mac-address=0;34;104;18;121;16 Example: </emphasis>mac-address= 80:00:00:6d:fe:80:00:00:00:00:00:00:00:02:55:00:70:33:cf:01</entry></row> </tbody></tgroup></table> + <table><title>ipv4 setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> <row><entry align="left">dns</entry><entry align="left">dns</entry><entry align="left">list of DNS IP addresses</entry><entry align="left">List of DNS servers.<emphasis role="bold"> @@ -186,6 +187,7 @@ Example: </emphasis>route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403 + <table><title>serial setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> <row><entry align="left">parity</entry><entry align="left">parity</entry><entry align="left">'e', 'o', or 'n'</entry><entry align="left">The connection parity; even, odd, or none. Note that older versions of NetworkManager stored this as an integer: 69 ('E') for even, 111 ('o') for odd, or 110 ('n') for none.<emphasis role="bold"> @@ -194,6 +196,7 @@ Example: </emphasis>parity=n</entry></row> + <table><title>vpn setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> <row><entry align="left">data</entry><entry align="left">separate variables named after keys of the dictionary</entry><entry align="left"/><entry align="left">The keys of the data dictionary are used as variable names directly under [vpn] section.<emphasis role="bold"> @@ -203,6 +206,7 @@ Example: </emphasis>remote=ovpn.corp.com cipher=AES-256-CBC username=joe</entry> Example: </emphasis>password=Popocatepetl</entry></row> </tbody></tgroup></table> + <table><title>802-3-ethernet setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> <row><entry align="left">mac-address</entry><entry align="left">mac-address</entry><entry align="left">ususal hex-digits-and-colons notation</entry><entry align="left">MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:A2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;162)</entry></row> <row><entry align="left">cloned-mac-address</entry><entry align="left">cloned-mac-address</entry><entry align="left">ususal hex-digits-and-colons notation</entry><entry align="left">Cloned MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:12:79:B2), or semicolon separated list of 6 bytes (obsolete) (e.g. 0;34;104;18;121;178).</entry></row> diff --git a/man/nm-settings-keyfile.xsl b/man/nm-settings-keyfile.xsl index b6e01a23..980a573c 100644 --- a/man/nm-settings-keyfile.xsl +++ b/man/nm-settings-keyfile.xsl @@ -43,7 +43,7 @@ out in a .ini-style format in <filename>/etc/NetworkManager/system-connections/</filename>. This plugin is always enabled and will automatically be used to store any connections that are not supported by any other active plugin. - For security, it will ignore files that are readable or writeable by any user + For security, it will ignore files that are readable or writable by any user or group other than 'root' since private keys and passphrases may be stored in plaintext inside the file. </para> diff --git a/man/nm-settings.5 b/man/nm-settings.5 index 858cd6ef..bee66154 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: 23 December 2015 +.\" Date: 19 January 2016 .\" Manual: Configuration -.\" Source: NetworkManager 1.0.9 +.\" Source: NetworkManager 1.1.90 .\" Language: English .\" -.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.0\&.9" "Configuration" +.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.1\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -46,7 +46,7 @@ objects\&. Setting .RS 4 A group of related key/value pairs describing a specific piece of a -\fIConnection (profile)\fR\&. Settings keys and allowed values are described in the tables below\&. Keys are also reffered to as properties\&. Developers can find the setting objects and their properties in the libnm\-util sources\&. Look for the +\fIConnection (profile)\fR\&. Settings keys and allowed values are described in the tables below\&. Keys are also referred to as properties\&. Developers can find the setting objects and their properties in the libnm\-util sources\&. Look for the \fBclass_init\fR functions near the bottom of each setting source file\&. .RE @@ -639,6 +639,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ ageing\-time @@ -695,6 +696,15 @@ T}:T{ The Spanning Tree Protocol (STP) maximum message age, in seconds\&. T} T{ +multicast\-snooping +T}:T{ +boolean +T}:T{ +TRUE +T}:T{ +Controls whether IGMP snooping is enabled for this bridge\&. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved\&. +T} +T{ name T}:T{ string @@ -890,6 +900,7 @@ 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{ autoconnect @@ -946,6 +957,15 @@ T}:T{ The name of the network interface this connection is bound to\&. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings)\&. For software devices this specifies the name of the created device\&. For connection types where interface names cannot easily be made persistent (e\&.g\&. mobile broadband or USB Ethernet), this property should not be used\&. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface\&. T} T{ +lldp +T}:T{ +int32 +T}:T{ +\-1 +T}:T{ +Whether LLDP is enabled for the connection\&. +T} +T{ master T}:T{ string @@ -961,7 +981,7 @@ NMMetered (int32) T}:T{ \ \& T}:T{ -Whether the connection is metered\&. +Whether the connection is metered\&. When updating this property on a currently activated connection, the change takes effect immediately\&. T} T{ name @@ -1042,7 +1062,7 @@ string T}:T{ \ \& T}:T{ -The trust level of a the connection\&. Free form case\-insensitive string (for example "Home", "Work", "Public")\&. NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall\&. +The trust level of a the connection\&. Free form case\-insensitive string (for example "Home", "Work", "Public")\&. NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall\&. When updating this property on a currently activated connection, the change takes effect immediately\&. T} .TE .sp 1 @@ -1286,6 +1306,9 @@ l l l l l l l l l l l l l l l l +l l l l +l l l l +l l l l l l l l. T{ apn @@ -1297,6 +1320,15 @@ T}:T{ The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM\-based network\&. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider\-specific walled\-garden, so it is important to use the correct APN for the user\*(Aqs mobile broadband plan\&. The APN may only be composed of the characters a\-z, 0\-9, \&., and \- per GSM 03\&.60 Section 14\&.9\&. T} T{ +device\-id +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The device unique identifier (as given by the WWAN management service) which this connection applies to\&. If given, the connection will only apply to the specified device\&. +T} +T{ home\-only T}:T{ boolean @@ -1369,6 +1401,24 @@ T}:T{ Flags indicating how to handle the "pin" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ +sim\-id +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The SIM card unique identifier (as given by the WWAN management service) which this connection applies to\&. If given, the connection will apply to any device also allowed by "device\-id" which contains a SIM card matching the given identifier\&. +T} +T{ +sim\-operator\-id +T}:T{ +string +T}:T{ +\ \& +T}:T{ +A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to\&. If given, the connection will apply to any device also allowed by "device\-id" and "sim\-id" which contains a SIM card provisioined by the given operator\&. +T} +T{ username T}:T{ string @@ -1495,6 +1545,9 @@ l l l l l l l l l l l l l l l l +l l l l +l l l l +l l l l l l l l. T{ address\-data @@ -1524,13 +1577,22 @@ T}:T{ A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options\&. T} T{ +dhcp\-fqdn +T}:T{ +string +T}:T{ +\ \& +T}:T{ +If the "dhcp\-send\-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease\&. This property and "dhcp\-hostname" are mutually exclusive and cannot be set at the same time\&. +T} +T{ dhcp\-hostname T}:T{ string T}:T{ \ \& T}:T{ -If the "dhcp\-send\-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease\&. +If the "dhcp\-send\-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease\&. This property and "dhcp\-fqdn" are mutually exclusive and cannot be set at the same time\&. T} T{ dhcp\-send\-hostname @@ -1542,6 +1604,15 @@ T}:T{ If TRUE, a hostname is sent to the DHCP server when acquiring a lease\&. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer\&. If the "dhcp\-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent\&. T} T{ +dhcp\-timeout +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +A timeout for a DHCP transaction in seconds\&. +T} +T{ dns T}:T{ array of uint32 @@ -1551,6 +1622,15 @@ T}:T{ Array of IP addresses of DNS servers (as network\-byte\-order integers) T} T{ +dns\-options +T}:T{ +array of string +T}:T{ +[] +T}:T{ +Array of DNS options\&. NULL means that the options are unset and left at the default\&. In this case NetworkManager will use default options\&. This is distinct from an empty list of properties\&. +T} +T{ dns\-search T}:T{ array of string @@ -1686,8 +1766,19 @@ l l l l l l l l l l l l l l l l +l l l l +l l l l l l l l. T{ +addr\-gen\-mode +T}:T{ +int32 +T}:T{ +1 +T}:T{ +Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration\&. The permitted values are: "eui64", "stable\-privacy" or unset\&. If the property is set to "eui64", the addresses will be generated using the interface tokens derived from hardware address\&. This makes the host part of the address to stay constant, making it possible to track host\*(Aqs presence when it changes networks\&. The address changes when the interface hardware is replaced\&. The value of "stable\-privacy" enables use of cryptographically secure hash of a secret host\-specific key along with the connection identification and the network address as specified by RFC7217\&. This makes it impossible to use the address track host\*(Aqs presence, and makes the address stable when the network interface hardware is replaced\&. Leaving this unset causes a default that could be subject to change in future versions to be used\&. Note that this setting is distinct from the Privacy Extensions as configured by "ip6\-privacy" property and it does not affect the temporary addresses configured with this option\&. +T} +T{ address\-data T}:T{ array of vardict @@ -1712,7 +1803,7 @@ string T}:T{ \ \& T}:T{ -If the "dhcp\-send\-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease\&. +If the "dhcp\-send\-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease\&. This property and "dhcp\-fqdn" are mutually exclusive and cannot be set at the same time\&. T} T{ dhcp\-send\-hostname @@ -1733,6 +1824,15 @@ T}:T{ Array of IP addresses of DNS servers (in network byte order) T} T{ +dns\-options +T}:T{ +array of string +T}:T{ +[] +T}:T{ +Array of DNS options\&. NULL means that the options are unset and left at the default\&. In this case NetworkManager will use default options\&. This is distinct from an empty list of properties\&. +T} +T{ dns\-search T}:T{ array of string @@ -1775,7 +1875,7 @@ NMSettingIP6ConfigPrivacy (int32) T}:T{ \ \& T}:T{ -Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941\&. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI\-64\&. This enhances privacy, but could cause problems in some applications, on the other hand\&. The permitted values are: \-1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses)\&. Having a per\-connection setting set to "\-1" (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"\&. +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\*(Aqs "stable\-privacy" setting as another way of avoiding host tracking with IPv6 addresses\&. T} T{ may\-fail @@ -1847,7 +1947,229 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&15.\ \&802-11-olpc-mesh setting +.B Table\ \&15.\ \&ip-tunnel setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l. +T{ +encapsulation\-limit +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +How many additional levels of encapsulation are permitted to be prepended to packets\&. This property applies only to IPv6 tunnels\&. +T} +T{ +flow\-label +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +The flow label to assign to tunnel packets\&. This property applies only to IPv6 tunnels\&. +T} +T{ +input\-key +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE)\&. If empty, no key is used\&. +T} +T{ +local +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address\&. +T} +T{ +mode +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2)\&. +T} +T{ +mtu +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +None +T} +T{ +name +T}:T{ +string +T}:T{ +ip\-tunnel +T}:T{ +The setting\*(Aqs 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"\&. +T} +T{ +output\-key +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE)\&. If empty, no key is used\&. +T} +T{ +parent +T}:T{ +string +T}:T{ +\ \& +T}:T{ +If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface\&. +T} +T{ +path\-mtu\-discovery +T}:T{ +boolean +T}:T{ +TRUE +T}:T{ +Whether to enable Path MTU Discovery on this tunnel\&. +T} +T{ +remote +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address\&. +T} +T{ +tos +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets\&. +T} +T{ +ttl +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +The TTL to assign to tunneled packets\&. 0 is a special value meaning that packets inherit the TTL value\&. +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&16.\ \&macvlan setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l +l l l l +l l l l +l l l l +l l l l. +T{ +mode +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device\&. +T} +T{ +name +T}:T{ +string +T}:T{ +macvlan +T}:T{ +The setting\*(Aqs 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"\&. +T} +T{ +parent +T}:T{ +string +T}:T{ +\ \& +T}:T{ +If given, specifies the parent interface name or parent connection UUID from which this MAC\-VLAN interface should be created\&. If this property is not specified, the connection must contain an "802\-3\-ethernet" setting with a "mac\-address" property\&. +T} +T{ +promiscuous +T}:T{ +boolean +T}:T{ +TRUE +T}:T{ +Whether the interface should be put in promiscuous mode\&. +T} +T{ +tap +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +Whether the interface should be a MACVTAP\&. +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&17.\ \&802-11-olpc-mesh setting .TS allbox tab(:); lB lB lB lB. @@ -1908,7 +2230,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&16.\ \&ppp setting +.B Table\ \&18.\ \&ppp setting .TS allbox tab(:); lB lB lB lB. @@ -2119,7 +2441,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&17.\ \&pppoe setting +.B Table\ \&19.\ \&pppoe setting .TS allbox tab(:); lB lB lB lB. @@ -2190,7 +2512,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&18.\ \&serial setting +.B Table\ \&20.\ \&serial setting .TS allbox tab(:); lB lB lB lB. @@ -2271,7 +2593,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&19.\ \&team setting +.B Table\ \&21.\ \&team setting .TS allbox tab(:); lB lB lB lB. @@ -2322,7 +2644,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&20.\ \&team-port setting +.B Table\ \&22.\ \&team-port setting .TS allbox tab(:); lB lB lB lB. @@ -2363,7 +2685,98 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&21.\ \&vlan setting +.B Table\ \&23.\ \&tun setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l. +T{ +group +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The group ID which will own the device\&. If set to NULL everyone will be able to use the device\&. +T} +T{ +mode +T}:T{ +uint32 +T}:T{ +1 +T}:T{ +The operating mode of the virtual device\&. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet\-like layer 2 one\&. +T} +T{ +multi\-queue +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving\&. Otherwise, the interface will only support a single queue\&. +T} +T{ +name +T}:T{ +string +T}:T{ +tun +T}:T{ +The setting\*(Aqs 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"\&. +T} +T{ +owner +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The user ID which will own the device\&. If set to NULL everyone will be able to use the device\&. +T} +T{ +pi +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets\&. +T} +T{ +vnet\-hdr +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header\&. +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&24.\ \&vlan setting .TS allbox tab(:); lB lB lB lB. @@ -2400,7 +2813,7 @@ NMVlanFlags (uint32) T}:T{ \ \& T}:T{ -One or more flags which control the behavior and features of the VLAN interface\&. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device\*(Aqs operating state)\&. +One or more flags which control the behavior and features of the VLAN interface\&. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device\*(Aqs operating state)\&. NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol)\&. The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0\&. To preserve backward compatibility, the default\-value in the D\-Bus API continues to be 0 and a missing property on D\-Bus is still considered as 0\&. T} T{ id @@ -2454,7 +2867,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&22.\ \&vpn setting +.B Table\ \&25.\ \&vpn setting .TS allbox tab(:); lB lB lB lB. @@ -2473,6 +2886,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ data @@ -2520,6 +2934,15 @@ T}:T{ D\-Bus service name of the VPN plugin that this setting uses to connect to its network\&. i\&.e\&. org\&.freedesktop\&.NetworkManager\&.vpnc for the vpnc plugin\&. T} T{ +timeout +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Timeout for the VPN service to establish the connection\&. Some services may take quite a long time to connect\&. Value of 0 means a default timeout, which is 60 seconds (unless overriden by vpn\&.timeout in configuration file)\&. Values greater than zero mean timeout in seconds\&. +T} +T{ user\-name T}:T{ string @@ -2535,7 +2958,198 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&23.\ \&wimax setting +.B Table\ \&26.\ \&vxlan setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l. +T{ +ageing +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Specifies the lifetime in seconds of FDB entries learnt by the kernel\&. +T} +T{ +destination\-port +T}:T{ +uint32 +T}:T{ +8472 +T}:T{ +Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint\&. +T} +T{ +id +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Specifies the VXLAN Network Identifer (or VXLAN Segment Identifier) to use\&. +T} +T{ +l2\-miss +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +Specifies whether netlink LL ADDR miss notifications are generated\&. +T} +T{ +l3\-miss +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +Specifies whether netlink IP ADDR miss notifications are generated\&. +T} +T{ +learning +T}:T{ +boolean +T}:T{ +TRUE +T}:T{ +Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database\&. +T} +T{ +limit +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Specifies the maximum number of FDB entries\&. A value of zero means that the kernel will store unlimited entries\&. +T} +T{ +local +T}:T{ +string +T}:T{ +\ \& +T}:T{ +If given, specifies the source IP address to use in outgoing packets\&. +T} +T{ +name +T}:T{ +string +T}:T{ +vxlan +T}:T{ +The setting\*(Aqs 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"\&. +T} +T{ +parent +T}:T{ +string +T}:T{ +\ \& +T}:T{ +If given, specifies the parent interface name or parent connection UUID\&. +T} +T{ +proxy +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +Specifies whether ARP proxy is turned on\&. +T} +T{ +remote +T}:T{ +string +T}:T{ +\ \& +T}:T{ +Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join\&. +T} +T{ +rsc +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +Specifies whether route short circuit is turned on\&. +T} +T{ +source\-port\-max +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint\&. +T} +T{ +source\-port\-min +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint\&. +T} +T{ +tos +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Specifies the TOS value to use in outgoing packets\&. +T} +T{ +ttl +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Specifies the time\-to\-live value to use in outgoing packets\&. +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&27.\ \&wimax setting .TS allbox tab(:); lB lB lB lB. @@ -2559,7 +3173,7 @@ byte array T}:T{ \ \& T}:T{ -If specified, this connection will only apply to the WiMAX device whose MAC address matches\&. This property does not change the MAC address of the device (known as MAC spoofing)\&. +If specified, this connection will only apply to the WiMAX device whose MAC address matches\&. This property does not change the MAC address of the device (known as MAC spoofing)\&. Deprecated: 1 T} T{ name @@ -2577,7 +3191,7 @@ string T}:T{ \ \& T}:T{ -Network Service Provider (NSP) name of the WiMAX network this connection should use\&. +Network Service Provider (NSP) name of the WiMAX network this connection should use\&. Deprecated: 1 T} .TE .sp 1 @@ -2586,7 +3200,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&24.\ \&802-3-ethernet setting +.B Table\ \&28.\ \&802-3-ethernet setting .TS allbox tab(:); lB lB lB lB. @@ -2747,7 +3361,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&25.\ \&802-11-wireless setting +.B Table\ \&29.\ \&802-11-wireless setting .TS allbox tab(:); lB lB lB lB. @@ -2775,6 +3389,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{ band @@ -2840,6 +3456,15 @@ T}:T{ A list of permanent MAC addresses of Wi\-Fi devices to which this connection should never apply\&. Each MAC address should be given in the standard hex\-digits\-and\-colons notation (eg "00:11:22:33:44:55")\&. T} T{ +mac\-address\-randomization +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address)\&. +T} +T{ mode T}:T{ string @@ -2867,6 +3492,15 @@ T}:T{ The setting\*(Aqs 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"\&. T} T{ +powersave +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +If set to FALSE, Wi\-Fi power saving behavior is disabled\&. If set to TRUE, Wi\-Fi power saving behavior is enabled\&. All other values are reserved\&. Note that even though only boolean values are allowed, the property type is an unsigned integer to allow for future expansion\&. +T} +T{ rate T}:T{ uint32 @@ -2918,7 +3552,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&26.\ \&802-11-wireless-security setting +.B Table\ \&30.\ \&802-11-wireless-security setting .TS allbox tab(:); lB lB lB lB. diff --git a/man/nm-settings.xml b/man/nm-settings.xml index f809e1ea..2a8ee9f9 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>23 December 2015</date></refentryinfo><refmeta><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.0.9</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>19 January 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.90</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 @@ -20,7 +20,7 @@ </para></listitem></varlistentry></variablelist><variablelist><varlistentry><term>Setting</term><listitem><para> A group of related key/value pairs describing a specific piece of a <emphasis>Connection (profile)</emphasis>. Settings keys and allowed values are - described in the tables below. Keys are also reffered to as properties. + described in the tables below. Keys are also referred to as properties. Developers can find the setting objects and their properties in the libnm-util sources. Look for the <function>class_init</function> functions near the bottom of each setting source file. @@ -95,6 +95,7 @@ <row><entry align="left">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name.</entry></row> <row><entry align="left">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. When matching an existing (outside NetworkManager created) bridge, this MAC address must match.</entry></row> <row><entry align="left">max-age</entry><entry align="left">uint32</entry><entry align="left">20</entry><entry>The Spanning Tree Protocol (STP) maximum message age, in seconds.</entry></row> + <row><entry align="left">multicast-snooping</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.</entry></row> <row><entry align="left">name</entry><entry align="left">string</entry><entry align="left">bridge</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">priority</entry><entry align="left">uint32</entry><entry align="left">32768</entry><entry>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</entry></row> <row><entry align="left">stp</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</entry></row> @@ -119,8 +120,9 @@ <row><entry align="left">gateway-ping-timeout</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</entry></row> <row><entry align="left">id</entry><entry align="left">string</entry><entry align="left"/><entry>A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</entry></row> <row><entry align="left">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). For software devices this specifies the name of the created device. For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.</entry></row> + <row><entry align="left">lldp</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Whether LLDP is enabled for the connection.</entry></row> <row><entry align="left">master</entry><entry align="left">string</entry><entry align="left"/><entry>Interface name of the master device or UUID of the master connection.</entry></row> - <row><entry align="left">metered</entry><entry align="left">NMMetered (int32)</entry><entry align="left"/><entry>Whether the connection is metered.</entry></row> + <row><entry align="left">metered</entry><entry align="left">NMMetered (int32)</entry><entry align="left"/><entry>Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.</entry></row> <row><entry align="left">name</entry><entry align="left">string</entry><entry align="left">connection</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">permissions</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection. Otherwise a user is allowed to access this connection if and only if they are in this list. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</entry></row> <row><entry align="left">read-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>FALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.</entry></row> @@ -129,7 +131,7 @@ <row><entry align="left">timestamp</entry><entry align="left">uint64</entry><entry align="left">0</entry><entry>The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).</entry></row> <row><entry align="left">type</entry><entry align="left">string</entry><entry align="left"/><entry>Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).</entry></row> <row><entry align="left">uuid</entry><entry align="left">string</entry><entry align="left"/><entry>A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").</entry></row> - <row><entry align="left">zone</entry><entry align="left">string</entry><entry align="left"/><entry>The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.</entry></row> + <row><entry align="left">zone</entry><entry align="left">string</entry><entry align="left"/><entry>The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. When updating this property on a currently activated connection, the change takes effect immediately.</entry></row> </tbody></tgroup></table> <table><title>dcb 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> <row><entry align="left">app-fcoe-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row> @@ -154,6 +156,7 @@ </tbody></tgroup></table> <table><title>gsm 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> <row><entry align="left">apn</entry><entry align="left">string</entry><entry align="left"/><entry>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</entry></row> + <row><entry align="left">device-id</entry><entry align="left">string</entry><entry align="left"/><entry>The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</entry></row> <row><entry align="left">home-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</entry></row> <row><entry align="left">name</entry><entry align="left">string</entry><entry align="left">gsm</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">network-id</entry><entry align="left">string</entry><entry align="left"/><entry>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</entry></row> @@ -162,6 +165,8 @@ <row><entry align="left">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> <row><entry align="left">pin</entry><entry align="left">string</entry><entry align="left"/><entry>If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</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">sim-id</entry><entry align="left">string</entry><entry align="left"/><entry>The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.</entry></row> + <row><entry align="left">sim-operator-id</entry><entry align="left">string</entry><entry align="left"/><entry>A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioined by the given operator.</entry></row> <row><entry align="left">username</entry><entry align="left">string</entry><entry align="left"/><entry>The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.</entry></row> </tbody></tgroup></table> <table><title>infiniband 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> @@ -176,9 +181,12 @@ <row><entry align="left">address-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv4 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.</entry></row> <row><entry align="left">addresses</entry><entry align="left">array of array of uint32</entry><entry align="left">[]</entry><entry>Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet.</entry></row> <row><entry align="left">dhcp-client-id</entry><entry align="left">string</entry><entry align="left"/><entry>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options.</entry></row> - <row><entry align="left">dhcp-hostname</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.</entry></row> + <row><entry align="left">dhcp-fqdn</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</entry></row> + <row><entry align="left">dhcp-hostname</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row> <row><entry align="left">dhcp-send-hostname</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</entry></row> + <row><entry align="left">dhcp-timeout</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>A timeout for a DHCP transaction in seconds.</entry></row> <row><entry align="left">dns</entry><entry align="left">array of uint32</entry><entry align="left">[]</entry><entry>Array of IP addresses of DNS servers (as network-byte-order integers)</entry></row> + <row><entry align="left">dns-options</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>Array of DNS options. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.</entry></row> <row><entry align="left">dns-search</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>Array of DNS search domains.</entry></row> <row><entry align="left">gateway</entry><entry align="left">string</entry><entry align="left"/><entry>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</entry></row> <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> @@ -192,16 +200,18 @@ <row><entry align="left">routes</entry><entry align="left">array of array of uint32</entry><entry align="left">[]</entry><entry>Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. If the metric is 0, NM will choose an appropriate default metric for the device. (There is no way to explicitly specify an actual metric of 0 with this property.)</entry></row> </tbody></tgroup></table> <table><title>ipv6 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> + <row><entry align="left">addr-gen-mode</entry><entry align="left">int32</entry><entry align="left">1</entry><entry>Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: "eui64", "stable-privacy" or unset. If the property is set to "eui64", the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. The value of "stable-privacy" enables use of cryptographically secure hash of a secret host-specific key along with the connection identification and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. Leaving this unset causes a default that could be subject to change in future versions to be used. Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</entry></row> <row><entry align="left">address-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv6 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.</entry></row> <row><entry align="left">addresses</entry><entry align="left">array of legacy IPv6 address struct (a(ayuay))</entry><entry align="left">[]</entry><entry>Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv6 address structures. Each IPv6 address structure is composed of an IPv6 address, a prefix length (1 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.</entry></row> - <row><entry align="left">dhcp-hostname</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.</entry></row> + <row><entry align="left">dhcp-hostname</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row> <row><entry align="left">dhcp-send-hostname</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</entry></row> <row><entry align="left">dns</entry><entry align="left">array of byte array</entry><entry align="left">[]</entry><entry>Array of IP addresses of DNS servers (in network byte order)</entry></row> + <row><entry align="left">dns-options</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>Array of DNS options. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.</entry></row> <row><entry align="left">dns-search</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>Array of DNS search domains.</entry></row> <row><entry align="left">gateway</entry><entry align="left">string</entry><entry align="left"/><entry>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</entry></row> <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">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".</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">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> @@ -210,6 +220,28 @@ <row><entry align="left">route-metric</entry><entry align="left">int64</entry><entry align="left">-1</entry><entry>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is choosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</entry></row> <row><entry align="left">routes</entry><entry align="left">array of legacy IPv6 route struct (a(ayuayu))</entry><entry align="left">[]</entry><entry>Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv6 route structures. Each IPv6 route structure is composed of an IPv6 address, a prefix length (1 - 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric. If the metric is 0, NM will choose an appropriate default metric for the device.</entry></row> </tbody></tgroup></table> + <table><title>ip-tunnel 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> + <row><entry align="left">encapsulation-limit</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</entry></row> + <row><entry align="left">flow-label</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</entry></row> + <row><entry align="left">input-key</entry><entry align="left">string</entry><entry align="left"/><entry>The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</entry></row> + <row><entry align="left">local</entry><entry align="left">string</entry><entry align="left"/><entry>The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</entry></row> + <row><entry align="left">mode</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).</entry></row> + <row><entry align="left">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>None</entry></row> + <row><entry align="left">name</entry><entry align="left">string</entry><entry align="left">ip-tunnel</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">output-key</entry><entry align="left">string</entry><entry align="left"/><entry>The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</entry></row> + <row><entry align="left">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.</entry></row> + <row><entry align="left">path-mtu-discovery</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether to enable Path MTU Discovery on this tunnel.</entry></row> + <row><entry align="left">remote</entry><entry align="left">string</entry><entry align="left"/><entry>The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</entry></row> + <row><entry align="left">tos</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</entry></row> + <row><entry align="left">ttl</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</entry></row> + </tbody></tgroup></table> + <table><title>macvlan 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> + <row><entry align="left">mode</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</entry></row> + <row><entry align="left">name</entry><entry align="left">string</entry><entry align="left">macvlan</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">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row> + <row><entry align="left">promiscuous</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether the interface should be put in promiscuous mode.</entry></row> + <row><entry align="left">tap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Whether the interface should be a MACVTAP.</entry></row> + </tbody></tgroup></table> <table><title>802-11-olpc-mesh 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> <row><entry align="left">channel</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Channel on which the mesh network to join is located.</entry></row> <row><entry align="left">dhcp-anycast-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.</entry></row> @@ -261,9 +293,18 @@ <row><entry align="left">config</entry><entry align="left">string</entry><entry align="left"/><entry>The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</entry></row> <row><entry align="left">name</entry><entry align="left">string</entry><entry align="left">team-port</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> </tbody></tgroup></table> + <table><title>tun 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> + <row><entry align="left">group</entry><entry align="left">string</entry><entry align="left"/><entry>The group ID which will own the device. If set to NULL everyone will be able to use the device.</entry></row> + <row><entry align="left">mode</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.</entry></row> + <row><entry align="left">multi-queue</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</entry></row> + <row><entry align="left">name</entry><entry align="left">string</entry><entry align="left">tun</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">owner</entry><entry align="left">string</entry><entry align="left"/><entry>The user ID which will own the device. If set to NULL everyone will be able to use the device.</entry></row> + <row><entry align="left">pi</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</entry></row> + <row><entry align="left">vnet-hdr</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</entry></row> + </tbody></tgroup></table> <table><title>vlan 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> <row><entry align="left">egress-priority-map</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</entry></row> - <row><entry align="left">flags</entry><entry align="left">NMVlanFlags (uint32)</entry><entry align="left"/><entry>One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state).</entry></row> + <row><entry align="left">flags</entry><entry align="left">NMVlanFlags (uint32)</entry><entry align="left"/><entry>One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.</entry></row> <row><entry align="left">id</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The VLAN identifier that the interface created by this connection should be assigned.</entry></row> <row><entry align="left">ingress-priority-map</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</entry></row> <row><entry align="left">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.</entry></row> @@ -276,12 +317,32 @@ <row><entry align="left">persistent</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.</entry></row> <row><entry align="left">secrets</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</entry></row> <row><entry align="left">service-type</entry><entry align="left">string</entry><entry align="left"/><entry>D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</entry></row> + <row><entry align="left">timeout</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overriden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.</entry></row> <row><entry align="left">user-name</entry><entry align="left">string</entry><entry align="left"/><entry>If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.</entry></row> </tbody></tgroup></table> + <table><title>vxlan 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> + <row><entry align="left">ageing</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the lifetime in seconds of FDB entries learnt by the kernel.</entry></row> + <row><entry align="left">destination-port</entry><entry align="left">uint32</entry><entry align="left">8472</entry><entry>Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</entry></row> + <row><entry align="left">id</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the VXLAN Network Identifer (or VXLAN Segment Identifier) to use.</entry></row> + <row><entry align="left">l2-miss</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Specifies whether netlink LL ADDR miss notifications are generated.</entry></row> + <row><entry align="left">l3-miss</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Specifies whether netlink IP ADDR miss notifications are generated.</entry></row> + <row><entry align="left">learning</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.</entry></row> + <row><entry align="left">limit</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.</entry></row> + <row><entry align="left">local</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the source IP address to use in outgoing packets.</entry></row> + <row><entry align="left">name</entry><entry align="left">string</entry><entry align="left">vxlan</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">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID.</entry></row> + <row><entry align="left">proxy</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Specifies whether ARP proxy is turned on.</entry></row> + <row><entry align="left">remote</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.</entry></row> + <row><entry align="left">rsc</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Specifies whether route short circuit is turned on.</entry></row> + <row><entry align="left">source-port-max</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</entry></row> + <row><entry align="left">source-port-min</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</entry></row> + <row><entry align="left">tos</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the TOS value to use in outgoing packets.</entry></row> + <row><entry align="left">ttl</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the time-to-live value to use in outgoing packets.</entry></row> + </tbody></tgroup></table> <table><title>wimax 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> - <row><entry align="left">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing).</entry></row> + <row><entry align="left">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). Deprecated: 1</entry></row> <row><entry align="left">name</entry><entry align="left">string</entry><entry align="left">wimax</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">network-name</entry><entry align="left">string</entry><entry align="left"/><entry>Network Service Provider (NSP) name of the WiMAX network this connection should use.</entry></row> + <row><entry align="left">network-name</entry><entry align="left">string</entry><entry align="left"/><entry>Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1</entry></row> </tbody></tgroup></table> <table><title>802-3-ethernet 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> <row><entry align="left">auto-negotiate</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>If TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, do not allow auto-negotiation, in which case the "speed" and "duplex" properties should be set.</entry></row> @@ -307,9 +368,11 @@ <row><entry align="left">hidden</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, indicates this network is a non-broadcasting network that hides its SSID. In this case various workarounds may take place, such as probe-scanning the SSID for more reliable network discovery. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.</entry></row> <row><entry align="left">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row> <row><entry align="left">mac-address-blacklist</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</entry></row> + <row><entry align="left">mac-address-randomization</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address).</entry></row> <row><entry align="left">mode</entry><entry align="left">string</entry><entry align="left"/><entry>Wi-Fi network mode; one of "infrastructure", "adhoc" or "ap". If blank, infrastructure is assumed.</entry></row> <row><entry align="left">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row> <row><entry align="left">name</entry><entry align="left">string</entry><entry align="left">802-11-wireless</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">powersave</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If set to FALSE, Wi-Fi power saving behavior is disabled. If set to TRUE, Wi-Fi power saving behavior is enabled. All other values are reserved. Note that even though only boolean values are allowed, the property type is an unsigned integer to allow for future expansion.</entry></row> <row><entry align="left">rate</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</entry></row> <row><entry align="left">security</entry><entry align="left">None</entry><entry align="left"/><entry>This property is deprecated, but can be set to the value '802-11-wireless-security' when a wireless security setting is also present in the connection dictionary, for compatibility with very old NetworkManager daemons.</entry></row> <row><entry align="left">seen-bssids</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</entry></row> diff --git a/man/nm-settings.xsl b/man/nm-settings.xsl index 24e41535..b6f564c7 100644 --- a/man/nm-settings.xsl +++ b/man/nm-settings.xsl @@ -61,7 +61,7 @@ <para> A group of related key/value pairs describing a specific piece of a <emphasis>Connection (profile)</emphasis>. Settings keys and allowed values are - described in the tables below. Keys are also reffered to as properties. + described in the tables below. Keys are also referred to as properties. Developers can find the setting objects and their properties in the libnm-util sources. Look for the <function>class_init</function> functions near the bottom of each setting source file. diff --git a/man/nmcli-examples.5 b/man/nmcli-examples.5 deleted file mode 100644 index 23045ecd..00000000 --- a/man/nmcli-examples.5 +++ /dev/null @@ -1,693 +0,0 @@ -'\" 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.0 -.\" Language: English -.\" -.TH "NMCLI\-EXAMPLES" "5" "" "NetworkManager 1\&.0" "Examples" -.\" ----------------------------------------------------------------- -.\" * Define some portability stuff -.\" ----------------------------------------------------------------- -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" http://bugs.debian.org/507673 -.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html -.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.ie \n(.g .ds Aq \(aq -.el .ds Aq ' -.\" ----------------------------------------------------------------- -.\" * set default formatting -.\" ----------------------------------------------------------------- -.\" disable hyphenation -.nh -.\" disable justification (adjust text to left margin only) -.ad l -.\" ----------------------------------------------------------------- -.\" * MAIN CONTENT STARTS HERE * -.\" ----------------------------------------------------------------- -.SH "NAME" -nmcli-examples \- usage examples of nmcli -.SH "SYNOPSIS" -.HP \w'\fBnmcli\ \fR\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 bond\-slave ifname eth1 master mybond0 -$ nmcli con add type bond\-slave 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 team\-slave con\-name Team1\-slave1 ifname em1 master Team1 -$ nmcli con add type team\-slave 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 bridge\-slave con\-name br\-slave\-1 ifname ens3 master TowerBridge -$ nmcli con add type bridge\-slave 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 new file mode 100644 index 00000000..a0da09cc --- /dev/null +++ b/man/nmcli-examples.xml @@ -0,0 +1,568 @@ +<?xml version='1.0'?> <!--*-nxml-*--> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> + +<!-- +Copyright 2013 - 2014 Red Hat, Inc. +--> + +<refentry id="nmcli-examples"> + <refentryinfo> + <title>nmcli-examples</title> + <date>19 November 2014</date> + <author>NetworkManager developers</author> + </refentryinfo> + + <refmeta> + <refentrytitle>nmcli-examples</refentrytitle> + <manvolnum>5</manvolnum> + <refmiscinfo class="source">NetworkManager</refmiscinfo> + <refmiscinfo class="manual">Examples</refmiscinfo> + <refmiscinfo class="version">1.0</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>nmcli-examples</refname> + <refpurpose>usage examples of nmcli</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>nmcli <arg choice="opt" rep="repeat">OPTIONS</arg></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1> + <title>Description</title> + <para> + <emphasis>nmcli</emphasis> is a command-line client for NetworkManager. It + allows controlling NetworkManager and reporting its status. For more information + please refer to <citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry> + manual page. + </para> + <para> + The purpose of this manual page is to provide you with various examples and + usage scenarios of <emphasis>nmcli</emphasis>. + </para> + <para>Note: this page has "work-in-progress" status.</para> + </refsect1> + + <refsect1> + <title>Examples</title> + + <example><title>Listing available Wi-Fi APs</title> + <synopsis><emphasis role="bold"> +$ nmcli device wifi list + </emphasis></synopsis> + <screen> +* 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 + </screen> + </example> + <para> + This command shows how to list available Wi-Fi networks (APs). You can also use + <emphasis>--fields</emphasis> option for displaying different columns. + <emphasis role="bold">nmcli -f all dev wifi list</emphasis> will show all of them. + </para> + + <example><title>Showing general information and properties for a Wi-Fi interface</title> + <synopsis><emphasis role="bold"> +$ nmcli -p -f general,wifi-properties device show wlan0 + </emphasis></synopsis> + <screen> +=============================================================================== + 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 +------------------------------------------------------------------------------- + </screen> + </example> + <para> + This command shows information about a Wi-Fi device. + </para> + + <example><title>Listing NetworkManager polkit permissions</title> + <synopsis><emphasis role="bold"> +$ nmcli general permissions + </emphasis></synopsis> + <screen> +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 + </screen> + </example> + <para> + 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. + <emphasis>pkaction</emphasis> command can display description for polkit actions. + <programlisting><command> + pkaction --action-id org.freedesktop.NetworkManager.network-control --verbose + </command></programlisting> + More information about polkit can be found at http://www.freedesktop.org/wiki/Software/polkit. + </para> + + <example><title>Listing NetworkManager log level and domains</title> + <synopsis><emphasis role="bold"> +$ nmcli general logging + </emphasis></synopsis> + <screen> +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 + </screen> + </example> + <para> + This command shows current NetworkManager logging status. + </para> + + <example><title>Changing NetworkManager logging</title> + <synopsis><emphasis role="bold"> +$ nmcli g log level DEBUG domains CORE,ETHER,IP +$ nmcli g log level INFO domains DEFAULT + </emphasis></synopsis> + </example> + <para> + 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 + <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> manual page + for available logging levels and domains. + </para> + + <example><title>Adding a bonding master and two slave connection profiles</title> + <programlisting><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> + </example> + <para> + This example demonstrates adding a bond master connection and two slaves. The + first command adds a master bond connection, naming the bonding interface + <emphasis>mybond0</emphasis> and using <emphasis>active-backup</emphasis> mode. + The next two commands add slaves connections, both enslaved to <emphasis>mybond0</emphasis>. + The first slave will be bound to <emphasis>eth1</emphasis> interface, the second to + <emphasis>eth2</emphasis>. + </para> + + <example><title>Adding a team master and two slave connection profiles</title> + <programlisting><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> + </example> + <para> + 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 <emphasis>Team1</emphasis>. The team configuration + for the master is read from <emphasis>team1-master-json.conf</emphasis> file. Later, you can + change the configuration with <emphasis>modify</emphasis> command + (<emphasis role="bold">nmcli con modify Team1 team.config team1-master-another-json.conf</emphasis>). + The last two commands add slaves profiles, both enslaved to <emphasis>Team1</emphasis>. + The first slave will be bound to <emphasis>em1</emphasis> interface, the second to + <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"> +$ nmcli con up Team1-slave1 +$ nmcli con up Team1-slave2 + </emphasis></programlisting> + 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"> +$ 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> + </example> + <para> + 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 <emphasis>TowerBridge</emphasis>. + The next two commands add slaves profiles, both will be enslaved to + <emphasis>TowerBridge</emphasis>. + The first slave will be tied to <emphasis>ens3</emphasis> interface, the second to + <emphasis>ens4</emphasis>. + The last command will disable 802.1D STP for the TowerBridge profile. + </para> + + <example><title>Adding an ethernet connection profile with manual IP configuration</title> + <programlisting> + <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" +$ 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> + </example> + <para> + The first command adds an Ethernet connection profile named <emphasis>my-con-em1</emphasis> + that is bound to interface name <emphasis>em1</emphasis>. 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 <emphasis>con show</emphasis> command displays the profile so that all + parameters can be reviewed. + </para> + + <example><title>Escaping colon characters in tabular mode</title> + <programlisting> + <emphasis role="bold"> +$ nmcli -t -f general -e yes -m tab dev show eth0 + </emphasis> + </programlisting> + <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> + </example> + <para> + This example shows escaping colon characters in tabular mode. It may be + useful for script processing, because ':' is used as a field separator. + </para> + + <example><title>nmcli usage in a NetworkManager dispatcher script to make Ethernet and Wi-Fi mutually exclusive</title> + <programlisting> +#!/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 + </programlisting> + </example> + <para> + 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 <citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry> + manual page for more information about NetworkManager dispatcher scripts. + </para> + + + <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> + <emphasis role="bold"> +$ nmcli connection edit type ethernet + </emphasis> + </programlisting> + <screen> + +===| nmcli interactive connection editor |=== + +Adding a new '802-3-ethernet' connection + +Type 'help' or '?' for available commands. +Type 'describe [<setting>.<prop>]' 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 'ipv4.method' to 'manual'? [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 'ethernet-4' (de89cdeb-a3e1-4d53-8fa0-c22546c775f4) successfully saved. +nmcli> quit + </screen> + </example> + <para> + Example session in the nmcli interactive connection editor. + The scenario creates an Ethernet connection profile with static addressing (IPs and DNS). + </para> + + </refsect1> + + <refsect1> + <title>See Also</title> + <para> + <citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-online</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-applet</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-connection-editor</refentrytitle><manvolnum>1</manvolnum></citerefentry> + </para> + </refsect1> +</refentry> diff --git a/man/nmcli.1.in b/man/nmcli.1.in index 8cd2afac..fbd53c49 100644 --- a/man/nmcli.1.in +++ b/man/nmcli.1.in @@ -19,7 +19,7 @@ .\" with this manual; if not, write to the Free Software Foundation, Inc., .\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. .\" -.\" Copyright 2010 - 2014 Red Hat, Inc. +.\" Copyright 2010 - 2015 Red Hat, Inc. .\" .TH NMCLI "1" "12 August 2015" @@ -33,7 +33,7 @@ nmcli \- command\(hyline tool for controlling NetworkManager .sp .IR OBJECT " := { " -.BR general " | " networking " | " radio " | " connection " | " device " | " agent +.BR general " | " networking " | " radio " | " connection " | " device " | " agent " | " monitor .RI " }" .sp @@ -45,6 +45,8 @@ nmcli \- command\(hyline tool for controlling NetworkManager .br \fB\-m\fR[\fImode\fR] tabular | multiline .br +\fB\-c\fR[\fIcolors\fR] auto | yes | no +.br \fB\-f\fR[\fIields\fR] <field1,field2,...> | all | common .br \fB\-e\fR[\fIscape\fR] yes | no @@ -53,6 +55,8 @@ nmcli \- command\(hyline tool for controlling NetworkManager .br \fB\-a\fR[\fIsk\fR] .br +\fB\-s\fR[\fIhow-secrets\fR] +.br \fB\-w\fR[\fIait\fR] <seconds> .br \fB\-v\fR[\fIersion\fR] @@ -106,6 +110,11 @@ Columns define particular properties of the entry. \fImultiline\fP \(en Each entry comprises multiple lines, each property on its own line. The values are prefixed with the property name. .TP +.B \-c, \-\-colors auto|yes|no +This option controls color output (using terminal escape sequences). \fIyes\fP +enables colors, \fIno\fP disables them, \fIauto\fP only produces colors when +standard output is directed to a terminal. The default value is \fIauto\fP. +.TP .B \-f, \-\-fields <field1,field2,...> | all | common This option is used to specify what fields (column names) should be printed. Valid field names differ for specific commands. List available fields by @@ -134,6 +143,11 @@ arguments, so do not use this option for non-interactive purposes like scripts. This option controls, for example, whether you will be prompted for a password if it is required for connecting to a network. .TP +.B \-s, \-\-show-secrets +When using this option \fInmcli\fP will display passwords and secrets that might +be present in an output of an operation. This option also influences echoing +passwords typed by user as an input. +.TP .B \-w, \-\-wait <seconds> This option sets a timeout period for which \fInmcli\fP will wait for \fINetworkManager\fP to finish operations. It is especially useful for commands that may take a longer time to @@ -176,8 +190,8 @@ file in most distributions. For example, systemd-hostnamed service uses the term .B permissions .br Show the permissions a caller has for various authenticated operations that -NetworkManager provides, like enable and disable networking, changing Wi\(hyFi, -WWAN, and WiMAX state, modifying connections, etc. +NetworkManager provides, like enable and disable networking, changing Wi\(hyFi +and WWAN state, modifying connections, etc. .TP .B logging [level <log level>] [domains <log domains>] .br @@ -232,7 +246,7 @@ Possible states are: Use this object to show radio switches status, or enable and disable the switches. .TP -.SS \fICOMMAND\fP := { all | wifi | wwan | wimax } +.SS \fICOMMAND\fP := { all | wifi | wwan } .sp .RS .TP @@ -247,19 +261,22 @@ Show or set status of WWAN (mobile broadband) in NetworkManager. If no arguments are supplied, mobile broadband status is printed; \fIon\fP enables mobile broadband, \fIoff\fP disables it. .TP -.B wimax [ on | off ] -.br -Show or set status of WiMAX in NetworkManager. If no arguments are supplied, -WiMAX status is printed; \fIon\fP enables WiMAX; \fIoff\fP disables WiMAX. Note: -WiMAX support is a compile\(hytime decision, so it may be unavailable on some -installations. -.TP .B all [ on | off ] .br Show or set all previously mentioned radio switches at the same time. .RE .TP +.B monitor \- monitor NetworkManager +.br +Use this object to observe NetworkManager activity. Watches for changes +in connectivity state, devices or connection profiles. +.br +See also \fImonitor\fP command of \fIconnection\fP or \fIdevice\fP object +to watch for changes in certain objects or object classes. +.RE + +.TP .B connection \- start, stop, and manage network connections .sp NetworkManager stores all network configuration as \fIconnections\fP, which are @@ -278,7 +295,7 @@ be saved as two connections which both apply to eth0, one for DHCP (called connected to the DHCP-enabled network the user would run "nmcli con up default" , and when connected to the static network the user would run "nmcli con up testing". .TP -.SS \fICOMMAND\fP := { show | up | down | add | edit | modify | delete | reload | load } +.SS \fICOMMAND\fP := { show | up | down | add | edit | modify | delete | monitor | reload | load } .sp .RS .TP @@ -289,12 +306,31 @@ active if a device is using that connection profile. Without a parameter, all profiles are listed. When --active option is specified, only the active profiles are shown. .TP -.B show [--active] [--show-secrets] [ id | uuid | path | apath ] <ID> ... +.B show [--active] [--order <order spec>] [ id | uuid | path | apath ] <ID> ... .br Show details for specified connections. By default, both static configuration and active connection data are displayed. When --active option is specified, -only the active profiles are taken into account. When --show-secrets option is -specified, secrets associated with the profile will be revealed too. +only the active profiles are taken into account. Use global --show-secrets option +to display secrets associated with the profile. +.sp +Ordering: +.br +The --order option can be used to get custom ordering of connections. The +connections can be ordered by active status, name, type or D-Bus path. If +connections are equal according to a sort order category, an additional +category can be specified. +The default sorting order is equivalent to "--order active:name:path". +.sp +<order spec> := category:category:... +.br +category := [+-]active | [+-]name | [+-]type | [+-]path +.br +\fI+\fP or no prefix means sorting in ascending order (alphabetically or in numbers). +.br +\fI-\fP means reverse (descending) order. +.br +The category names can be abbreviated (e.g. --order -a:na) +.sp \fIid\fP, \fIuuid\fP, \fIpath\fP and \fIapath\fP keywords can be used if \fI<ID>\fP is ambiguous. .RS @@ -329,10 +365,10 @@ When no command is given to the \fIconnection\fP object, the default action is 'nmcli connection show'. .RE .TP -.B up [ id | uuid | path ] <ID> [ifname <ifname>] [ap <BSSID>] [nsp <name>] [passwd-file <file with passwords>] +.B up [ id | uuid | path ] <ID> [ifname <ifname>] [ap <BSSID>] [passwd-file <file with passwords>] .RE .RS -.B up ifname <ifname> [ap <BSSID>] [nsp <name>] [passwd-file <file with passwords>] +.B up ifname <ifname> [ap <BSSID>] [passwd-file <file with passwords>] .RS .br Activate a connection. The connection is identified by its name, UUID or D-Bus @@ -355,8 +391,6 @@ Available options are: \(en interface that will be used for activation .IP \fIap\fP 13 \(en BSSID of the AP which the command should connect to (for Wi\(hyFi connections) -.IP \fInsp\fP 13 -\(en NSP (Network Service Provider) which the command should connect to (for WiMAX connections) .IP \fIpasswd-file\fP 13 \(en some networks may require credentials during activation. You can give these credentials using this option. @@ -401,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 IP_OPTIONS +.B add COMMON_OPTIONS TYPE_SPECIFIC_OPTIONS SLAVE_OPTIONS IP_OPTIONS [-- [+|-]<setting>.<property> <value> ...] .br Add a connection for NetworkManager. Arguments differ according to connection types, see below. .RS @@ -409,6 +443,9 @@ Add a connection for NetworkManager. Arguments differ according to connection ty .B COMMON_OPTIONS: .IP "\fItype <type>\fP" 42 \(en connection type; see below \fBTYPE_SPECIFIC_OPTIONS\fP for allowed values; (mandatory) +Note that types \fIbond-slave\fP, \fIteam-slave\fP and \fIbridge-slave\fP create \fIethernet\fP +connection profiles. Their use is discouraged in favor of using a specific type with \fImaster\fP +option. .IP "\fIifname <ifname> | \(dq\&*\(dq\&\fP" 42 \(en interface to bind the connection to. The connection will only be applicable to this interface name. A special value of "\fB*\fP" can be used for interface-independent connections. @@ -420,6 +457,13 @@ Note: use quotes around \fB*\fP to suppress shell expansion. \(en whether the connection profile can be automatically activated (default: yes) .IP "\fI[save yes|no]\fP" 42 \(en whether the connection should be persistent, i.e. NetworkManager should store it on disk (default: yes) +.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). .RE .RS .TP @@ -563,8 +607,6 @@ The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disamb .IP "\fImaster <master (ifname, or connection UUID or name)>\fP" 42 \(en master team interface name, or connection UUID or ID of team master connection profile. The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disambiguate it. -.IP "\fI[config <file>|<raw JSON data>]\fP" 42 -\(en JSON configuration for team .RE .RS .TP @@ -581,6 +623,8 @@ The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disamb \(en STP maximum message age, in seconds (default: 20) .IP "\fI[ageing-time <0-1000000>]\fP" 42 \(en the Ethernet MAC address aging time, in seconds (default: 300) +.IP "\fI[multicast-snooping yes|no]\fP" 42 +\(en controls whether IGMP snooping is enabled (default: yes) .IP "\fI[mac <MAC address>]\fP" 42 \(en MAC address of the bridge (note: this requires a recent kernel feature, originally introduced in 3.15 upstream kernel) @@ -591,18 +635,11 @@ originally introduced in 3.15 upstream kernel) .IP "\fImaster <master (ifname, or connection UUID or name)>\fP" 42 \(en master bridge interface name, or connection UUID or ID of bridge master connection profile. The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disambiguate it. -.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|ssh|l2tp|iodine|...\fP" 42 +.IP "\fIvpn-type vpnc|openvpn|pptp|openconnect|openswan|libreswan|strongswan|ssh|l2tp|iodine|fortisslvpn|...\fP" 42 \(en VPN type .IP "\fI[user <username>]\fP" 42 \(en VPN username @@ -631,12 +668,94 @@ to be sent back out through the slave the frame was received on (default: yes) .RE .RS .TP +.B tun: +.IP "\fImode tun|tap\fP" 42 +\(en Mode for the device +.IP "\fI[owner <UID>]\fP" 42 +\(en UID of the owner +.IP "\fI[group <GID>]\fP" 42 +\(en GID of the group +.IP "\fI[pi yes|no>]\fP" 42 +\(en include packet information (~IFF_NO_PI flag) +.IP "\fI[vnet-hdr yes|no>]\fP" 42 +\(en send and receive large (i.e. GSO) packets and packets with partial checksums (IFF_VNET_HDR flag) +.IP "\fI[multi-queue yes|no>]\fP" 42 +\(en multi-queue support for tun/tap device (IFF_MULTI_QUEUE flag) +.RE +.RS +.TP +.B ip-tunnel: +.IP "\fImode ipip|gre|sit|isatap|vti|ip6ip6|ipip6|ip6gre|vti6\fP" 42 +\(en tunnel mode +.IP "\fIremote <remote endpoint IP>\fP" 42 +\(en IPv4 or IPv6 address of the remote tunnel endpoint +.IP "\fI[local <local endpoint IP>]\fP" 42 +\(en IPv4 or IPv6 address of the local tunnel endpoint +.IP "\fI[dev <parent device (ifname or connection UUID)>]\fP" 42 +\(en device to use for tunnel endpoint communication +.RE +.RS +.TP +.B macvlan: +.IP "\fIdev <parent device (connection UUID, ifname, or MAC)>\fP" 42 +\(en parent device this MACVLAN is on +.IP "\fImode vepa|bridge|private|passthru|source\fP" 42 +\(en MACVLAN mode, which specifies the communication mechanism between multiple MACVLANs on the same lower device +.IP "\fI[tap yes|no]\fP" 42 +\(en controls the device type. If set to 'yes' a MACVTAP will be created (default: no) +.RE +.RS +.TP +.B vxlan: +.IP "\fIid <VXLAN ID>\fP" 42 +\(en VXLAN Network Identifer to use +.IP "\fIremote <IP>\fP" 42 +\(en unicast destination IP address or multicast IP address to join +.IP "\fI[dev <parent device (ifname or connection UUID)>]\fP" 42 +\(en device to use for tunnel endpoint communication +.IP "\fI[local <IP>]\fP" 42 +\(en source IP address +.IP "\fI[source-port-min <0-65535>]\fP" 42 +\(en minimum UDP source port to communicate to the remote VXLAN tunnel endpoint +.IP "\fI[source-port-max <0-65535>]\fP" 42 +\(en maximum UDP source port to communicate to the remote VXLAN tunnel endpoint +.IP "\fI[destination-port <0-65535>]\fP" 42 +\(en UDP destination port to communicate to the remote VXLAN tunnel endpoint +.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 .IP "\fI[ip6 <IPv6 address>] [gw6 <IPv6 gateway>]\fP" 42 \(en IPv6 addresses .RE +.RS +If a \fI--\fP argument is encountered, the rest of command line is interpreted +as property list in the same format as \fIconnection modify\fP command accepts. +This makes it possible to adjust the connection properties before it's added. +.RE .TP .B edit [id | uuid | path ] <ID> - edit an existing connection .RE @@ -693,6 +812,20 @@ The changes to the connection profile will be saved persistently by NetworkManager, unless \fI--temporary\fP option is provided, in which case the changes won't persist over NetworkManager restart. .TP +.B clone [--temporary] [ id | uuid | path ] <ID> <new name> +.br +Clone a connection. The connection to be cloned is identified by its +name, UUID or D-Bus path. If <ID> is ambiguous, a keyword \fIid\fP, +\fIuuid\fP or \fIpath\fP can be used. See \fBconnection show\fP above for +the description of the <ID>-specifying keywords. \fI<new name>\fP is the name +of the new cloned connection. The new connection will be the exact copy except +the connection.id (\fI<new name>\fP) and connection.uuid (generated) +properties. +.br +The new connection profile will be saved as persistent unless \fI--temporary\fP +option is specified, in which case the new profile won't exist after NetworkManager +restart. +.TP .B delete [ id | uuid | path ] <ID> ... .br Delete a configured connection. The connection to be deleted is identified by @@ -703,6 +836,19 @@ 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 monitor [ id | uuid | path ] <ID> ... +.br +Monitor connection profile activity. This command prints a line whenever the +specified connection changes. The connection to be monitored is identified by +its name, UUID or D-Bus path. If <ID> is ambiguous, a keyword \fIid\fP, +\fIuuid\fP or \fIpath\fP can be used. +.br +See \fBconnection show\fP above for the description of the <ID>-specifying keywords. +.br +Monitors all connection profiles in case none is specified. The command terminates +when all monitored connections disappear. If you want to monitor connection creation +consider using the global monitor with \fInmcli monitor\fP command. +.TP .B reload .br Reload all connection files from disk. \fINetworkManager\fP does not monitor @@ -717,13 +863,36 @@ then \fINetworkManager\fP will reload connection files any time they change Load/reload one or more connection files from disk. Use this after manually editing a connection file to ensure that \fBNetworkManager\fP is aware of its latest state. +.TP +.B import [--temporary] type <type> file <file to import> +.br +Import an external/foreign configuration as a NetworkManager connection profile. +The type of the input file is specified by \fItype\fP option. +.br +Only VPN configurations are supported at the moment. The configuration +is imported by NetworkManager VPN plugins. \fItype\fP values are the same as for +\fIvpn-type\fP option in \fBnmcli connection add\fP. VPN configurations are +imported by VPN plugins. Therefore the proper VPN plugin has to be installed +so that nmcli could import the data. +.br +The imported connection profile will be saved as persistent unless \fI--temporary\fP +option is specified, in which case the new profile won't exist after NetworkManager +restart. +.TP +.B export [ id | uuid | path ] <ID> [<output file>] +.br +Export a connection. +.br +Only VPN connections are supported at the moment. A proper VPN plugin has to be +installed so that nmcli could export a connection. If no \fI<output file>\fP is +provided, the VPN configuration data will be printed to standard output. .RE .TP .B device - show and manage network interfaces .br .TP -.SS \fICOMMAND\fP := { status | show | connect | disconnect | delete | wifi | wimax } +.SS \fICOMMAND\fP := { status | show | set | connect | reapply | disconnect | delete | monitor | wifi | lldp } .sp .RS .TP @@ -739,6 +908,11 @@ Show detailed information about devices. Without an argument, all devices are examined. To get information for a specific device, the interface name has to be provided. .TP +.TP +.B set [ifname] <ifname> [autoconnect yes|no] [managed yes|no] +.br +Set device properties. +.TP .B connect <ifname> .br Connect the device. NetworkManager will try to find a suitable connection that @@ -746,6 +920,11 @@ will be activated. It will also consider connections that are not set to auto co .br If '--wait' option is not specified, the default timeout will be 90 seconds. .TP +.B reapply <ifname> +.br +Attempt to update device with changes to the currently active connection +made since it was last applied. +.TP .B disconnect <ifname> ... .br Disconnect a device and prevent the device from automatically activating further @@ -762,6 +941,15 @@ Hardware devices (like Ethernet) cannot be deleted by the command. .br If '--wait' option is not specified, the default timeout will be 10 seconds. .TP +.B monitor [<ifname>] ... +.br +Monitor device activity. This command prints a line whenever the specified devices +change state. +.br +Monitors all devices in case no interface is specified. The monitor terminates when +all specified devices disappear. If you want to monitor device addition consider +using the global monitor with \fInmcli monitor\fP command. +.TP .B wifi [list [ifname <ifname>] [bssid <BSSID>]] .br List available Wi\(hyFi access points. The \fIifname\fP and \fIbssid\fP options @@ -802,6 +990,35 @@ Otherwise the connection is system\(hywide, which is the default. Otherwise the SSID would not be found and the connection attempt would fail. .RE .TP +.B wifi hotspot [ifname <ifname>] [con-name <name>] [ssid <SSID>] [band a|bg] [channel <channel>] [password <password>] +.br +Create a Wi-Fi hotspot. The command creates a hotspot connection profile according to +Wi-Fi device capabilities and activates it on the device. The hotspot is secured with WPA +if device/driver supports that, otherwise WEP is used. +Use \fIconnection down\fP or \fIdevice disconnect\fP to stop the hotspot. +.br +.RS +.PP +Parameters of the hotspot can be influenced by the optional parameters: +.IP \fIifname\fP 17 +\(en what Wi-Fi device is used +.IP \fIcon-name\fP 17 +\(en name of the created hotspot connection profile +.IP \fIssid\fP 17 +\(en SSID of the hotspot +.IP \fIband\fP 17 +\(en Wi-Fi band to use +.IP \fIchannel\fP 17 +\(en Wi-Fi channel to use +.IP \fIpassword\fP 17 +\(en password to use for the created hotspot. If not provided, +nmcli will generate a password. The password is either WPA +pre-shared key or WEP key. +.PP +Note that \fI--show-secrets\fP global option can be used to print the hotspot +password. It is useful especially when the password was generated. +.RE +.TP .B wifi rescan [ifname <ifname>] [[ssid <SSID>] ...] .br Request that \fINetworkManager\fP immediately re-scan for available access points. @@ -813,11 +1030,12 @@ scan more SSIDs. .br This command does not show the APs, use 'nmcli device wifi list' for that. .TP -.B wimax [list [ifname <ifname>] [nsp <name>]] +.B lldp [list [ifname <ifname>]] .br -List available WiMAX NSP. The \fIifname\fP and \fInsp\fP options -can be used to list networks for a particular interface or with a specific -NSP, respectively. +Display information about neighboring devices learned through the Link +Layer Discovery Protocol (LLDP). The \fIifname\fP option can be used to +list neighbors only for a given interface. The protocol must be +enabled in the connection settings. .RE .TP @@ -941,7 +1159,7 @@ shows all connection profile names and their auto-connect property. .IP shows details for "My default em1" connection profile. -.IP "\fB\f(CWnmcli connection show --show-secrets \(dq\&My Home WiFi\(dq\&\fP\fP" +.IP "\fB\f(CWnmcli --show-secrets connection show \(dq\&My Home WiFi\(dq\&\fP\fP" .IP shows details for "My Home WiFi" connection profile with all passwords. Without \fI--show-secrets\fP option, secrets would not be displayed. @@ -980,6 +1198,10 @@ a connection. .IP shows details for wlan0 interface; only GENERAL and WIFI\-PROPERTIES sections will be shown. +.IP "\fB\f(CWnmcli \-f CONNECTIONS device show wlp3s0\fP\fP" +.IP +shows all available connection profiles for your Wi-Fi interface wlp3s0. + .IP "\fB\f(CWnmcli dev wifi\fP\fP" .IP lists available Wi\(hyFi access points known to NetworkManager. @@ -991,6 +1213,11 @@ using password "caffeine". This is mainly useful when connecting to "Cafe Hotspo the first time. Next time, it is better to use 'nmcli con up id "My cafe"' so that the existing connection profile can be used and no additional is created. +.IP "\fB\f(CWnmcli -s dev wifi hotspot con-name QuickHotspot\fP\fP" +.IP +creates a hotspot profile and connects it. Prints the hotspot password the user should use +to connect to the hotspot from other devices. + .IP "\fB\f(CWnmcli connection add type ethernet autoconnect no ifname eth0\fP\fP" .IP non-interactively adds an Ethernet connection tied to eth0 interface with automatic IP configuration (DHCP), @@ -1001,6 +1228,11 @@ and disables the connection's "autoconnect" flag. non-interactively adds a VLAN connection with ID 55. The connection will use eth0 and the VLAN interface will be named Maxipes\(hyfik. +.IP "\fB\f(CWnmcli c a ifname eth0 type ethernet -- ipv4.method disabled ipv6.method link-local\fP\fP" +.IP +non-interactively adds a connection that will use eth0 Ethernet interface and only have an IPv6 link-local +address configured. + .IP "\fB\f(CWnmcli connection edit ethernet\-em1\-2\fP\fP" .IP edits existing "ethernet\(hyem1\(hy2" connection in the interactive editor. @@ -1029,10 +1261,18 @@ appends a Google public DNS server to DNS servers in ABC profile. .IP removes the specified IP address from (static) profile ABC. +.IP "\fB\f(CWnmcli con import type openvpn file ~/Downloads/frootvpn.ovpn\fP\fP" +.IP +imports an OpenVPN configuration to NetworkManager. + +.IP "\fB\f(CWnmcli con export corp-vpnc /home/joe/corpvpn.conf\fP\fP" +.IP +exports NetworkManager VPN profile corp-vpnc as standard Cisco (vpnc) configuration. + .SH NOTES \fInmcli\fP accepts abbreviations, as long as they are a unique prefix in the set of possible options. As new options get added, these abbreviations are not guaranteed -to stay unique. For scripting and long term compatiblity it is therefore strongly +to stay unique. For scripting and long term compatibility it is therefore strongly advised to spell out the full option names. .SH BUGS |