From 7514efc2f38c9ace4557d4e69d68e7d380389030 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Fri, 26 Aug 2016 02:18:32 +0200 Subject: Imported Upstream version 1.4.0 --- man/Makefile.in | 14 +- man/NetworkManager.8 | 23 +- man/NetworkManager.conf.5 | 141 ++- man/NetworkManager.conf.xml | 188 +++- man/NetworkManager.xml | 36 +- man/nm-online.1 | 6 +- man/nm-online.xml | 4 +- man/nm-settings-ifcfg-rh.5 | 86 +- man/nm-settings-ifcfg-rh.xml | 38 +- man/nm-settings-ifcfg-rh.xsl | 19 +- man/nm-settings-keyfile.5 | 6 +- man/nm-settings-keyfile.xml | 16 +- man/nm-settings-keyfile.xsl | 14 +- man/nm-settings.5 | 72 +- man/nm-settings.xml | 642 +++++++------- man/nm-settings.xsl | 10 +- man/nmcli-examples.7 | 9 +- man/nmcli-examples.xml | 19 +- man/nmcli.1 | 1932 ++++++++++++++++++++++++++++-------------- man/nmcli.xml | 1733 ++++++++++++------------------------- man/nmtui.1 | 6 +- man/nmtui.xml | 4 +- 22 files changed, 2721 insertions(+), 2297 deletions(-) (limited to 'man') diff --git a/man/Makefile.in b/man/Makefile.in index b721527b..92bdb087 100644 --- a/man/Makefile.in +++ b/man/Makefile.in @@ -104,8 +104,9 @@ host_triplet = @host@ subdir = man ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 -am__aclocal_m4_deps = $(top_srcdir)/m4/ax_lib_readline.m4 \ - $(top_srcdir)/m4/compiler_warnings.m4 \ +am__aclocal_m4_deps = $(top_srcdir)/m4/attributes.m4 \ + $(top_srcdir)/m4/ax_lib_readline.m4 \ + $(top_srcdir)/m4/compiler_options.m4 \ $(top_srcdir)/m4/gettext.m4 \ $(top_srcdir)/m4/gnome-code-coverage.m4 \ $(top_srcdir)/m4/gtk-doc.m4 $(top_srcdir)/m4/iconv.m4 \ @@ -215,6 +216,7 @@ DHCLIENT_PATH = @DHCLIENT_PATH@ DHCPCD_PATH = @DHCPCD_PATH@ DISTRO_NETWORK_SERVICE = @DISTRO_NETWORK_SERVICE@ DLLTOOL = @DLLTOOL@ +DL_LIBS = @DL_LIBS@ DNSMASQ_PATH = @DNSMASQ_PATH@ DNSSEC_TRIGGER_SCRIPT = @DNSSEC_TRIGGER_SCRIPT@ DSYMUTIL = @DSYMUTIL@ @@ -271,13 +273,14 @@ INTROSPECTION_MAKEFILE = @INTROSPECTION_MAKEFILE@ INTROSPECTION_SCANNER = @INTROSPECTION_SCANNER@ INTROSPECTION_TYPELIBDIR = @INTROSPECTION_TYPELIBDIR@ IPTABLES_PATH = @IPTABLES_PATH@ +JANSSON_CFLAGS = @JANSSON_CFLAGS@ +JANSSON_LIBS = @JANSSON_LIBS@ KERNEL_FIRMWARE_DIR = @KERNEL_FIRMWARE_DIR@ LCOV = @LCOV@ LD = @LD@ LDFLAGS = @LDFLAGS@ LIBAUDIT_CFLAGS = @LIBAUDIT_CFLAGS@ LIBAUDIT_LIBS = @LIBAUDIT_LIBS@ -LIBDL = @LIBDL@ LIBICONV = @LIBICONV@ LIBINTL = @LIBINTL@ LIBM = @LIBM@ @@ -289,6 +292,8 @@ LIBOBJS = @LIBOBJS@ LIBS = @LIBS@ LIBSOUP_CFLAGS = @LIBSOUP_CFLAGS@ LIBSOUP_LIBS = @LIBSOUP_LIBS@ +LIBSYSTEMD_CFLAGS = @LIBSYSTEMD_CFLAGS@ +LIBSYSTEMD_LIBS = @LIBSYSTEMD_LIBS@ LIBTEAMDCTL_CFLAGS = @LIBTEAMDCTL_CFLAGS@ LIBTEAMDCTL_LIBS = @LIBTEAMDCTL_LIBS@ LIBTOOL = @LIBTOOL@ @@ -349,6 +354,8 @@ QT_CFLAGS = @QT_CFLAGS@ QT_LIBS = @QT_LIBS@ RANLIB = @RANLIB@ READLINE_LIBS = @READLINE_LIBS@ +SANITIZERS = @SANITIZERS@ +SANITIZER_ENV = @SANITIZER_ENV@ SED = @SED@ SELINUX_CFLAGS = @SELINUX_CFLAGS@ SELINUX_LIBS = @SELINUX_LIBS@ @@ -384,6 +391,7 @@ ac_ct_AR = @ac_ct_AR@ ac_ct_CC = @ac_ct_CC@ ac_ct_CXX = @ac_ct_CXX@ ac_ct_DUMPBIN = @ac_ct_DUMPBIN@ +ac_ct_RANLIB = @ac_ct_RANLIB@ am__include = @am__include@ am__leading_dot = @am__leading_dot@ am__quote = @am__quote@ diff --git a/man/NetworkManager.8 b/man/NetworkManager.8 index f4ba4fef..6af6a49e 100644 --- a/man/NetworkManager.8 +++ b/man/NetworkManager.8 @@ -2,12 +2,12 @@ .\" Title: NetworkManager .\" Author: .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 08/03/2016 +.\" Date: 08/24/2016 .\" Manual: Network management daemons -.\" Source: NetworkManager 1.2.4 +.\" Source: NetworkManager 1.4.0 .\" Language: English .\" -.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.2\&.4" "Network management daemons" +.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.4\&.0" "Network management daemons" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -41,7 +41,9 @@ NetworkManager will execute scripts in the /etc/NetworkManager/dispatcher\&.d di .PP Each script receives two arguments, the first being the interface name of the device an operation just happened on, and second the action\&. For device actions, the interface is the name of the kernel interface suitable for IP configuration\&. Thus it is either VPN_IP_IFACE, DEVICE_IP_IFACE, or DEVICE_IFACE, as applicable\&. For the \fIhostname\fR -action it is always "none"\&. +and +\fIconnectivity\-change\fR +actions it is always "none"\&. .PP The actions are: .PP @@ -100,6 +102,11 @@ The DHCPv4 lease has changed (renewed, rebound, etc)\&. The DHCPv6 lease has changed (renewed, rebound, etc)\&. .RE .PP +\fIconnectivity\-change\fR +.RS 4 +The network connectivity state has changed (no connectivity, went online, etc)\&. +.RE +.PP 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 @@ -183,6 +190,11 @@ If the connection used DHCP for address configuration, the received DHCP configu The same variables as for IPv4 are available for IPv6, but the prefixes are IP6_ and DHCP6_ instead\&. .RE .PP +\fICONNECTIVITY_STATE\fR +.RS 4 +The network connectivity state, which can take the values defined by the NMConnectivityState type, from the org\&.freedesktop\&.NetworkManager D\-Bus API: unknown, none, portal, limited or full\&. Note: this variable will only be set for connectivity\-change actions\&. +.RE +.PP In case of VPN, VPN_IP_IFACE is set, and IP4_*, IP6_* variables with VPN prefix are exported too, like VPN_IP4_ADDRESS_0, VPN_IP4_NUM_ADDRESSES\&. .PP 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\&.) @@ -307,4 +319,5 @@ to enable debug logging inside NetworkManager itself\&. \fBnm-online\fR(1), \fBnm-settings\fR(5), \fBnm-applet\fR(1), -\fBnm-connection-editor\fR(1)\fBudev\fR(7) +\fBnm-connection-editor\fR(1), +\fBudev\fR(7) diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5 index ca316a03..f1d3d75f 100644 --- a/man/NetworkManager.conf.5 +++ b/man/NetworkManager.conf.5 @@ -2,12 +2,12 @@ .\" Title: NetworkManager.conf .\" Author: .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 08/03/2016 +.\" Date: 08/24/2016 .\" Manual: Configuration -.\" Source: NetworkManager 1.2.4 +.\" Source: NetworkManager 1.4.0 .\" Language: English .\" -.TH "NETWORKMANAGER\&.CON" "5" "" "NetworkManager 1\&.2\&.4" "Configuration" +.TH "NETWORKMANAGER\&.CON" "5" "" "NetworkManager 1\&.4\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -173,13 +173,10 @@ no\-auto\-default=* .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 +This setting is deprecated for the per\-device setting +ignore\-carrier +which overwrites this setting if specified (See +???)\&. Otherwise, it is a list of matches to specify for which device carrier should be ignored\&. See the section called \(lqDevice List Format\(rq for the syntax how to specify a device\&. .RE @@ -214,7 +211,7 @@ to point to the local nameserver\&. 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\&. This implies -\fIrc\-manager\fRunmanaged +rc\-manager\ \&unmanaged .RE .PP \fIrc\-manager\fR @@ -225,7 +222,11 @@ management mode\&. The default value depends on how NetworkManager was built, wh .sp symlink: NetworkManager will symlink /etc/resolv\&.conf -to its private resolv\&.conf file in the runtime state directory\&. +to its private resolv\&.conf file in the runtime state directory\&. If +/etc/resolv\&.conf +already is a symlink pointing to a different location, the file will not be modified\&. This allows the user to disable managing by pointing the link +/etc/resolv\&.conf +to somewhere else\&. .sp file: NetworkManager will write /etc/resolv\&.conf @@ -236,7 +237,7 @@ resolvconf: NetworkManager will run resolvconf to update the DNS configuration\& netconfig: NetworkManager will run netconfig to update the DNS configuration\&. .sp unmanaged: don\*(Aqt touch -resolv\&.conf\&. +/etc/resolv\&.conf\&. .sp none: deprecated alias for symlink\&. @@ -263,7 +264,7 @@ This key is deprecated and has no effect since the hostname is now stored in /et .PP \fIpath\fR .RS 4 -The location where keyfiles are read and stored\&. This defaults to "${prefix}/etc/NetworkManager/conf\&.d"\&. +The location where keyfiles are read and stored\&. This defaults to "/etc/NetworkManager/conf\&.d"\&. .RE .PP \fIunmanaged\-devices\fR @@ -330,7 +331,7 @@ TRACE\&. The ERR level logs only critical errors\&. WARN logs warnings that may .PP \fIdomains\fR .RS 4 -The following log domains are available: PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT\&. +The following log domains are available: PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT, SYSTEMD, VPN_PLUGIN\&. .sp In addition, these special domains can be used: NONE, ALL, DEFAULT, DHCP, IP\&. .sp @@ -449,6 +450,12 @@ DISPATCH : Dispatcher scripts AUDIT : Audit records .RE .RS 4 +SYSTEMD : Messages from internal libsystemd +.RE +.RS 4 +VPN_PLUGIN : logging messages from VPN plugins +.RE +.RS 4 .RE .RS 4 @@ -472,6 +479,15 @@ IP : shortcut for "IP4,IP6" .RS 4 HW : deprecated alias for "PLATFORM" .RE +.PP +In general, the logfile should not contain passwords or private data\&. However, you are always advised to check the file before posting it online or attaching to a bug report\&. +VPN_PLUGIN +is special as it might reveal private information of the VPN plugins with verbose levels\&. Therefore this domain will be excluded when setting +ALL +or +DEFAULT +to more verbose levels then +INFO\&. .RE .PP \fIbackend\fR @@ -517,6 +533,15 @@ for details)\&. A default value is only consulted if the corresponding per\-conn .RS 4 .RE .PP +\fIethernet\&.cloned\-mac\-address\fR +.RS 4 +If left unspecified, it defaults to "permanent"\&. +.RE +.PP +\fIethernet\&.generate\-mac\-address\-mask\fR +.RS 4 +.RE +.PP \fIethernet\&.wake\-on\-lan\fR .RS 4 .RE @@ -550,9 +575,19 @@ is unset, use the content of "/proc/sys/net/ipv6/conf/default/use_tempaddr" as l If left unspecified, default value of 60 seconds is used\&. .RE .PP +\fIwifi\&.cloned\-mac\-address\fR +.RS 4 +If left unspecified, it defaults to "permanent"\&. +.RE +.PP +\fIwifi\&.generate\-mac\-address\-mask\fR +.RS 4 +.RE +.PP \fIwifi\&.mac\-address\-randomization\fR .RS 4 -If left unspecified, MAC address randomization is disabled\&. +If left unspecified, MAC address randomization is disabled\&. This setting is deprecated for +wifi\&.cloned\-mac\-address\&. .RE .PP \fIwifi\&.powersave\fR @@ -623,6 +658,69 @@ property unspecified\&. That is, the search for the property would not continue or [connection]\&. .RE +.SH "DEVICE SECTION" +.PP +Contains per\-device persistent configuration\&. +.PP +Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +[device] +match\-device=interface\-name:eth3 +unmanaged=1 +.fi +.if n \{\ +.RE +.\} +.sp +.SS "Supported Properties" +.PP +The following properties can be configured per\-device\&. +.PP +\fIignore\-carrier\fR +.RS 4 +Specify devices for which NetworkManager will (partially) ignore the carrier state\&. Normally, for device types that support carrier\-detect, such as Ethernet and InfiniBand, NetworkManager will only allow a connection to be activated on the device if carrier is present (ie, a cable is plugged in), and it will deactivate the device if carrier drops for more than a few seconds\&. +.sp +A device with carrier ignored will allow activating connections on that device even when it does not have carrier, provided that the connection uses only statically\-configured IP addresses\&. Additionally, it will allow any active connection (whether static or dynamic) to remain active on the device when carrier is lost\&. +.sp +Note that the "carrier" property of NMDevices and device D\-Bus interfaces will still reflect the actual device state; it\*(Aqs just that NetworkManager will not make use of that information\&. +.sp +This setting overwrites the deprecated +main\&.ignore\-carrier +setting above\&. +.RE +.PP +\fIwifi\&.scan\-rand\-mac\-address\fR +.RS 4 +Configures MAC address randomization of a Wi\-Fi device during scanning\&. This defaults to +yes +in which case a random, locally\-administered MAC address will be used\&. The setting +wifi\&.scan\-generate\-mac\-address\-mask +allows to influence the generated MAC address to use certain vendor OUIs\&. If disabled, the MAC address during scanning is left unchanged to whatever is configured\&. For the configured MAC address while the device is associated, see instead the per\-connection setting +wifi\&.cloned\-mac\-address\&. +.RE +.PP +\fIwifi\&.scan\-generate\-mac\-address\-mask\fR +.RS 4 +Like the per\-connection settings +ethernet\&.generate\-mac\-address\-mask +and +wifi\&.generate\-mac\-address\-mask, this allows to configure the generated MAC addresses during scanning\&. See +\fBnm-settings\fR(5) +for details\&. +.RE +.SS "Sections" +.PP +The +[device] +section works the same as the +[connection] +section\&. That is, multiple sections that all start with the prefix "device" can be specified\&. The settings "match\-device" and "stop\-match" are available to match a device section on a device\&. The order of multiple sections is also top\-down within the file and later files overwrite previous settings\&. See +the section called \(lqSections\(rq +for details\&. .SH "CONNECTIVITY SECTION" .PP This section controls NetworkManager\*(Aqs optional connectivity checking functionality\&. This allows NetworkManager to detect whether or not the system can actually access the internet or whether it is behind a captive portal\&. @@ -828,8 +926,11 @@ or to change the plugin order\&. .PP The configuration options main\&.no\-auto\-default, -main\&.ignore\-carrier, and -keyfile\&.unmanaged\-devices +main\&.ignore\-carrier, +keyfile\&.unmanaged\-devices, +connection*\&.match\-device +and +device*\&.match\-device select devices based on a list of matchings\&. Devices can be specified using the following format: .PP .PP @@ -845,7 +946,7 @@ Case sensitive match of interface name of the device\&. Globbing is not supporte .PP HWADDR .RS 4 -Match the MAC address of the device\&. Globbing is not supported +Match the permanent MAC address of the device\&. Globbing is not supported .RE .PP interface\-name:IFNAME, interface\-name:~IFNAME @@ -865,7 +966,7 @@ is taken literally\&. .PP mac:HWADDR .RS 4 -Match the MAC address of the device\&. Globbing is not supported +Match the permanent MAC address of the device\&. Globbing is not supported .RE .PP s390\-subchannels:HWADDR diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml index ea0573fa..db381f07 100644 --- a/man/NetworkManager.conf.xml +++ b/man/NetworkManager.conf.xml @@ -224,30 +224,12 @@ no-auto-default=* ignore-carrier - 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. - - - 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. - - - 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. - - See for the syntax how to - specify a device. + This setting is deprecated for the per-device setting + ignore-carrier which overwrites this setting + if specified (See ). + Otherwise, it is a list of matches to specify for which device + carrier should be ignored. See for the + syntax how to specify a device. @@ -307,8 +289,8 @@ no-auto-default=* configuration with DNSSEC support. The /etc/resolv.conf will be managed by dnssec-trigger daemon. none: NetworkManager will not - modify resolv.conf. This implies rc-manager - unmanaged + modify resolv.conf. This implies + rc-manager unmanaged @@ -322,7 +304,12 @@ no-auto-default=* always write resolv.conf to its runtime state directory. symlink: NetworkManager will symlink /etc/resolv.conf to its private - resolv.conf file in the runtime state directory. + resolv.conf file in the runtime state directory. If + /etc/resolv.conf + already is a symlink pointing to a different location, the file + will not be modified. This allows the user to disable managing + by pointing the link /etc/resolv.conf to + somewhere else. file: NetworkManager will write /etc/resolv.conf as file. If it finds a symlink, it will follow the symlink and update the target @@ -332,7 +319,7 @@ no-auto-default=* netconfig: NetworkManager will run netconfig to update the DNS configuration. unmanaged: don't touch - resolv.conf. + /etc/resolv.conf. none: deprecated alias for symlink. @@ -461,7 +448,7 @@ 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, AUDIT. + TEAM, CONCHECK, DCB, DISPATCH, AUDIT, SYSTEMD, VPN_PLUGIN. In addition, these special domains can be used: NONE, ALL, DEFAULT, DHCP, IP. You can specify per-domain log level overrides by @@ -507,6 +494,8 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth DCB : Data Center Bridging (DCB) operations DISPATCH : Dispatcher scripts AUDIT : Audit records + SYSTEMD : Messages from internal libsystemd + VPN_PLUGIN : logging messages from VPN plugins NONE : when given by itself logging is disabled ALL : all log domains @@ -517,6 +506,14 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth HW : deprecated alias for "PLATFORM" + + In general, the logfile should not contain passwords or private data. However, + you are always advised to check the file before posting it online or attaching + to a bug report. VPN_PLUGIN is special as it might reveal + private information of the VPN plugins with verbose levels. Therefore this domain + will be excluded when setting ALL or DEFAULT + to more verbose levels then INFO. + backend @@ -558,7 +555,7 @@ ipv6.ip6-privacy=0 Not all properties can be overwritten, only the following properties are supported to have their default values configured - (see nm-settings5 for details). + (see nm-settings5 for details). A default value is only consulted if the corresponding per-connection value explicitly allows for that. @@ -568,6 +565,13 @@ ipv6.ip6-privacy=0 connection.lldp + + ethernet.cloned-mac-address + If left unspecified, it defaults to "permanent". + + + ethernet.generate-mac-address-mask + ethernet.wake-on-lan @@ -595,9 +599,18 @@ ipv6.ip6-privacy=0 vpn.timeout If left unspecified, default value of 60 seconds is used. + + wifi.cloned-mac-address + If left unspecified, it defaults to "permanent". + + + wifi.generate-mac-address-mask + wifi.mac-address-randomization - If left unspecified, MAC address randomization is disabled. + If left unspecified, MAC address randomization is disabled. + This setting is deprecated for wifi.cloned-mac-address. + wifi.powersave @@ -608,7 +621,7 @@ ipv6.ip6-privacy=0 - + Sections You can configure multiple connection @@ -681,6 +694,100 @@ ipv6.ip6-privacy=1 + + <literal>device</literal> section + Contains per-device persistent configuration. + + + Example: + +[device] +match-device=interface-name:eth3 +unmanaged=1 + + + + Supported Properties + + The following properties can be configured per-device. + + + ignore-carrier + + + 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. + + + A device with carrier ignored will allow activating connections on + that device even when it does not have carrier, provided + that the connection uses only statically-configured IP + addresses. Additionally, it will allow any active + connection (whether static or dynamic) to remain active on + the device when carrier is lost. + + + 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. + + + This setting overwrites the deprecated main.ignore-carrier + setting above. + + + + + wifi.scan-rand-mac-address + + + Configures MAC address randomization of a Wi-Fi device during + scanning. This defaults to yes in which case + a random, locally-administered MAC address will be used. + The setting wifi.scan-generate-mac-address-mask + allows to influence the generated MAC address to use certain vendor + OUIs. + If disabled, the MAC address during scanning is left unchanged to + whatever is configured. + For the configured MAC address while the device is associated, see instead + the per-connection setting wifi.cloned-mac-address. + + + + + wifi.scan-generate-mac-address-mask + + + Like the per-connection settings ethernet.generate-mac-address-mask + and wifi.generate-mac-address-mask, this allows to configure the + generated MAC addresses during scanning. See nm-settings5 + for details. + + + + + + + + + Sections + + The [device] section works the same as the [connection] section. + That is, multiple sections that all start with the prefix "device" can be specified. + The settings "match-device" and "stop-match" are available to match a device section + on a device. The order of multiple sections is also top-down within the file and + later files overwrite previous settings. See + for details. + + + + <literal>connectivity</literal> section This section controls NetworkManager's optional connectivity @@ -963,7 +1070,8 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16 Device List Format The configuration options main.no-auto-default, main.ignore-carrier, - and keyfile.unmanaged-devices select devices based on a list of matchings. + keyfile.unmanaged-devices, connection*.match-device and + device*.match-device select devices based on a list of matchings. Devices can be specified using the following format: @@ -978,7 +1086,7 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16 HWADDR - Match the MAC address of the device. Globbing is not supported + Match the permanent MAC address of the device. Globbing is not supported interface-name:IFNAME @@ -993,7 +1101,7 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16 mac:HWADDR - Match the MAC address of the device. Globbing is not supported + Match the permanent MAC address of the device. Globbing is not supported s390-subchannels:HWADDR @@ -1040,11 +1148,11 @@ interface-name:vboxnet*,except:interface-name:vboxnet2 See Also - NetworkManager8, - nmcli1, - nmcli-examples7, - nm-online1, - nm-settings5, + NetworkManager8, + nmcli1, + nmcli-examples7, + nm-online1, + nm-settings5, nm-applet1, nm-connection-editor1 diff --git a/man/NetworkManager.xml b/man/NetworkManager.xml index 0714d002..2cb458a2 100644 --- a/man/NetworkManager.xml +++ b/man/NetworkManager.xml @@ -79,7 +79,8 @@ 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 hostname action it is always "none". + For the hostname and connectivity-change + actions it is always "none". The actions are: @@ -168,6 +169,12 @@ The DHCPv6 lease has changed (renewed, rebound, etc). + + connectivity-change + + The network connectivity state has changed (no connectivity, went online, etc). + + The environment contains more information about the interface and the connection. @@ -281,6 +288,15 @@ and DHCP6_ instead. + + CONNECTIVITY_STATE + The network connectivity state, which can + take the values defined by the NMConnectivityState type, + from the org.freedesktop.NetworkManager D-Bus API: unknown, + none, portal, limited or full. Note: this variable will only + be set for connectivity-change actions. + + @@ -348,7 +364,7 @@ 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 - NetworkManager.conf5 + NetworkManager.conf5 for more information on configuration file. @@ -367,7 +383,7 @@ 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 logging in - NetworkManager.conf5 + NetworkManager.conf5 for more information. @@ -377,7 +393,7 @@ 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 - NetworkManager.conf5 + NetworkManager.conf5 for more information. @@ -490,13 +506,13 @@ See Also - NetworkManager.conf5, - nmcli1, - nmcli-examples7, - nm-online1, - nm-settings5, + NetworkManager.conf5, + nmcli1, + nmcli-examples7, + nm-online1, + nm-settings5, nm-applet1, - nm-connection-editor1 + nm-connection-editor1, udev7 diff --git a/man/nm-online.1 b/man/nm-online.1 index 49f2f2c8..93c1d32c 100644 --- a/man/nm-online.1 +++ b/man/nm-online.1 @@ -2,12 +2,12 @@ .\" Title: nm-online .\" Author: .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 08/03/2016 +.\" Date: 08/24/2016 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.2.4 +.\" Source: NetworkManager 1.4.0 .\" Language: English .\" -.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.2\&.4" "General Commands Manual" +.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.4\&.0" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-online.xml b/man/nm-online.xml index 7fdd2f3e..297920dd 100644 --- a/man/nm-online.xml +++ b/man/nm-online.xml @@ -156,8 +156,8 @@ See Also - nmcli1, - NetworkManager8. + nmcli1, + NetworkManager8. diff --git a/man/nm-settings-ifcfg-rh.5 b/man/nm-settings-ifcfg-rh.5 index 3aa9eff8..7c022bcc 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: .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 08/03/2016 +.\" Date: 08/24/2016 .\" Manual: Configuration -.\" Source: NetworkManager 1.2.4 +.\" Source: NetworkManager 1.4.0 .\" Language: English .\" -.TH "NM\-SETTINGS\-IFCFG\" "5" "" "NetworkManager 1\&.2\&.4" "Configuration" +.TH "NM\-SETTINGS\-IFCFG\" "5" "" "NetworkManager 1\&.4\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -308,6 +308,18 @@ for connection sharing\&. When \fIshared\fR is used, NetworkManager assigns the interface 10\&.42\&.0\&.1, or it uses the first static address, if configured\&. .RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +HWADDR +\- initscripts compare the currently set hardware address of a device, while NetworkManager considers the permanent one\&. +.RE .RE .PP See the next section for detailed mapping of NetworkManager properties and @@ -932,6 +944,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 @@ -949,7 +962,16 @@ UUID\fI(+)\fR T}:T{ \ \& T}:T{ -UUID for the connection profile\&. When missing, NetworkManager creates the UUID itself (by hashing the file)\&. +UUID for the connection profile\&. When missing, NetworkManager creates the UUID itself (by hashing the filename)\&. +T} +T{ +stable\-id +T}:T{ +STABLE_ID\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Token to generate stable IDs\&. T} T{ interface\-name @@ -1421,6 +1443,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 @@ -1548,6 +1571,17 @@ T}:T{ IPV4_ROUTE_METRIC is the default IPv4 metric for routes on this connection\&. If set to \-1, a default metric based on the device type is used\&. T} T{ +dns\-priority +T}:T{ +IPV4_DNS_PRIORITY\fI(+)\fR +T}:T{ +0 +T}:T{ +The priority for DNS servers of this connection\&. Lower values have higher priority\&. If zero, the default value will be used (50 for VPNs, 100 for other connections)\&. A negative value prevents DNS from other connections with greater values to be used\&.\fB + +Example: \fRIPV4_DNS_PRIORITY=20 +T} +T{ dhcp\-client\-id T}:T{ DHCP_CLIENT_ID\fI(+)\fR @@ -1625,6 +1659,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{ method @@ -1739,6 +1775,17 @@ T}:T{ IPV6_ROUTE_METRIC is the default IPv6 metric for routes on this connection\&. If set to \-1, a default metric based on the device type is used\&. T} T{ +dns\-priority +T}:T{ +IPV6_DNS_PRIORITY\fI(+)\fR +T}:T{ +0 +T}:T{ +The priority for DNS servers of this connection\&. Lower values have higher priority\&. If zero, the default value will be used (50 for VPNs, 100 for other connections)\&. A negative value prevents DNS from other connections with greater values to be used\&.\fB + +Example: \fRIPV6_DNS_PRIORITY=20 +T} +T{ ip6\-privacy T}:T{ IPV6_PRIVACY, IPV6_PRIVACY_PREFER_PUBLIC_IP\fI(+)\fR @@ -1764,6 +1811,17 @@ Example: \fRIPV6_ADDR_GEN_MODE=stable\-privacy\fB Allowed values: \fRIPV6_ADDR_GEN_MODE: eui64, stable\-privacy T} +T{ +token +T}:T{ +IPV6_TOKEN +T}:T{ +\ \& +T}:T{ +The IPv6 tokenized interface identifier token\fB + +Example: \fRIPV6_TOKEN=::53 +T} .TE .sp 1 .sp @@ -2012,6 +2070,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{ port @@ -2068,6 +2127,15 @@ T}:T{ Cloned (spoofed) MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:14:5A:99)\&. T} T{ +generate\-mac\-address\-mask +T}:T{ +GENERATE_MAC_ADDRESS_MASK +T}:T{ +\ \& +T}:T{ +the MAC address mask for generating randomized and stable cloned\-mac\-address\&. +T} +T{ mac\-address\-blacklist T}:T{ HWADDR_BLACKLIST\fI(+)\fR @@ -2363,6 +2431,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{ ssid @@ -2458,6 +2527,15 @@ T}:T{ Cloned (spoofed) MAC address in traditional hex\-digits\-and\-colons notation (e\&.g\&. 00:22:68:14:5A:99)\&. T} T{ +generate\-mac\-address\-mask +T}:T{ +GENERATE_MAC_ADDRESS_MASK +T}:T{ +\ \& +T}:T{ +the MAC address mask for generating randomized and stable cloned\-mac\-address\&. +T} +T{ mac\-address\-blacklist T}:T{ HWADDR_BLACKLIST\fI(+)\fR diff --git a/man/nm-settings-ifcfg-rh.xml b/man/nm-settings-ifcfg-rh.xml index 712ad5f3..259459c2 100644 --- a/man/nm-settings-ifcfg-rh.xml +++ b/man/nm-settings-ifcfg-rh.xml @@ -1,6 +1,6 @@ -nm-settings-ifcfg-rhNetworkManager developersnm-settings-ifcfg-rh5NetworkManagerConfiguration1.2.4nm-settings-ifcfg-rhDescription of ifcfg-rh settings pluginDescription +nm-settings-ifcfg-rhNetworkManager developersnm-settings-ifcfg-rh5NetworkManagerConfiguration1.4.0nm-settings-ifcfg-rhDescription of ifcfg-rh settings pluginDescription NetworkManager is based on the concept of connection profiles that contain network configuration (see nm-settings5 for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing @@ -15,7 +15,7 @@ The plugin currently supports reading and writing Ethernet, Wi-Fi, InfiniBand, VLAN, Bond, Bridge, and Team connections. Unsupported connection types (such as WWAN, PPPoE, VPN, or ADSL) are handled by keyfile plugin - (nm-settings-keyfile5). + (nm-settings-keyfile5). The main reason for using ifcfg-rh plugin is the compatibility with legacy configurations for ifup and ifdown (initscripts). @@ -161,7 +161,9 @@ DEVICETYPE=TeamPort link-local addressing using Avahi daemon and shared for connection sharing. When shared is used, NetworkManager assigns the interface 10.42.0.1, or it uses the first static address, - if configured. + if configured.HWADDR - + initscripts compare the currently set hardware address of a device, while + NetworkManager considers the permanent one. See the next section for detailed mapping of NetworkManager properties and ifcfg-rh variables. Variable names, format and usage differences in NetworkManager and initscripts are documented in the tables below. @@ -223,7 +225,7 @@ Allowed values: 6 - 40ageing-t Allowed values: 0 - 1000000multicast-snoopingBRIDGING_OPTS: multicast_snooping=1IGMP snooping support. -Allowed values: 0 or 1connection settingPropertyIfcfg-rh VariableDefaultDescriptionidNAME(+)User friendly name for the connection profile.uuidUUID(+)UUID for the connection profile. When missing, NetworkManager creates the UUID itself (by hashing the file).interface-nameDEVICEInterface 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.typeTYPE (DEVICETYPE, DEVICE)Base type of the connection. DEVICETYPE is used for teaming connections. +Allowed values: 0 or 1
connection settingPropertyIfcfg-rh VariableDefaultDescriptionidNAME(+)User friendly name for the connection profile.uuidUUID(+)UUID for the connection profile. When missing, NetworkManager creates the UUID itself (by hashing the filename).stable-idSTABLE_ID(+)Token to generate stable IDs.interface-nameDEVICEInterface 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.typeTYPE (DEVICETYPE, DEVICE)Base type of the connection. DEVICETYPE is used for teaming connections. Example: TYPE=Ethernet; TYPE=Bond; TYPE=Bridge; DEVICETYPE=TeamPort @@ -284,7 +286,9 @@ Example: DNS1=1.2.3.4 DNS2=10.0.0.254 DNS3=8.8.8.8 Example: IPADDR=10.5.5.23 PREFIX=24 IPADDR1=1.1.1.2 PREFIX1=16gatewayGATEWAYGateway IP address. -Example: GATEWAY=10.5.5.1routesADDRESS1, NETMASK1, GATEWAY1, METRIC1, ...List of static routes. They are not stored in ifcfg-* file, but in route-* file instead.ignore-auto-routesPEERROUTES(+)yesPEERROUTES has the opposite meaning as 'ignore-auto-routes' property.ignore-auto-dnsPEERDNSyesPEERDNS has the opposite meaning as 'ignore-auto-dns' property.dhcp-send-hostnameDHCP_SEND_HOSTNAME(+)yesWhether DHCP_HOSTNAME should be sent to the DHCP server.dhcp-hostnameDHCP_HOSTNAMEHostname to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used.never-defaultDEFROUTE (GATEWAYDEV in /etc/sysconfig/network)yesDEFROUTE=no tells NetworkManager that this connection should not be assigned the default route. DEFROUTE has the opposite meaning as 'never-default' property.may-failIPV4_FAILURE_FATAL(+)noIPV4_FAILURE_FATAL has the opposite meaning as 'may-fail' property.route-metricIPV4_ROUTE_METRIC(+)-1IPV4_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.dhcp-client-idDHCP_CLIENT_ID(+)A string sent to the DHCP server to identify the local machine. +Example: GATEWAY=10.5.5.1routesADDRESS1, NETMASK1, GATEWAY1, METRIC1, ...List of static routes. They are not stored in ifcfg-* file, but in route-* file instead.ignore-auto-routesPEERROUTES(+)yesPEERROUTES has the opposite meaning as 'ignore-auto-routes' property.ignore-auto-dnsPEERDNSyesPEERDNS has the opposite meaning as 'ignore-auto-dns' property.dhcp-send-hostnameDHCP_SEND_HOSTNAME(+)yesWhether DHCP_HOSTNAME should be sent to the DHCP server.dhcp-hostnameDHCP_HOSTNAMEHostname to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used.never-defaultDEFROUTE (GATEWAYDEV in /etc/sysconfig/network)yesDEFROUTE=no tells NetworkManager that this connection should not be assigned the default route. DEFROUTE has the opposite meaning as 'never-default' property.may-failIPV4_FAILURE_FATAL(+)noIPV4_FAILURE_FATAL has the opposite meaning as 'may-fail' property.route-metricIPV4_ROUTE_METRIC(+)-1IPV4_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.dns-priorityIPV4_DNS_PRIORITY(+)0The priority for DNS servers of this connection. Lower values have higher priority. If zero, the default value will be used (50 for VPNs, 100 for other connections). A negative value prevents DNS from other connections with greater values to be used. + +Example: IPV4_DNS_PRIORITY=20dhcp-client-idDHCP_CLIENT_ID(+)A string sent to the DHCP server to identify the local machine. Example: DHCP_CLIENT_ID=ax-srv-1dad-timeoutARPING_WAITmissing variable means global default (config override or 3)Timeout (in seconds) for performing DAD before configuring IPv4 addresses. 0 turns off the DAD completely, -1 means default value. @@ -296,7 +300,9 @@ Example: DHCP_FQDN=foo.bar.com
Example: IPV6ADDR=ab12:9876::1 IPV6ADDR_SECONDARIES="ab12:9876::2 ab12:9876::3"gatewayIPV6_DEFAULTGWGateway IP address. -Example: IPV6_DEFAULTGW=abbe::1routes(none)List of static routes. They are not stored in ifcfg-* file, but in route6-* file instead in the form of command line for 'ip route add'.ignore-auto-routesIPV6_PEERROUTES(+)yesIPV6_PEERROUTES has the opposite meaning as 'ignore-auto-routes' property.ignore-auto-dnsIPV6_PEERDNS(+)yesIPV6_PEERDNS has the opposite meaning as 'ignore-auto-dns' property.dhcp-hostnameDHCP_HOSTNAMEHostname to send the DHCP server.never-defaultIPV6_DEFROUTE(+), (and IPV6_DEFAULTGW, IPV6_DEFAULTDEV in /etc/sysconfig/network)IPV6_DEFROUTE=yes (when no variable specified)IPV6_DEFROUTE=no tells NetworkManager that this connection should not be assigned the default IPv6 route. IPV6_DEFROUTE has the opposite meaning as 'never-default' property.may-failIPV6_FAILURE_FATAL(+)noIPV6_FAILURE_FATAL has the opposite meaning as 'may-fail' property.route-metricIPV6_ROUTE_METRIC(+)-1IPV6_ROUTE_METRIC is the default IPv6 metric for routes on this connection. If set to -1, a default metric based on the device type is used.ip6-privacyIPV6_PRIVACY, IPV6_PRIVACY_PREFER_PUBLIC_IP(+)noConfigure IPv6 Privacy Extensions for SLAAC (RFC4941). +Example: IPV6_DEFAULTGW=abbe::1routes(none)List of static routes. They are not stored in ifcfg-* file, but in route6-* file instead in the form of command line for 'ip route add'.ignore-auto-routesIPV6_PEERROUTES(+)yesIPV6_PEERROUTES has the opposite meaning as 'ignore-auto-routes' property.ignore-auto-dnsIPV6_PEERDNS(+)yesIPV6_PEERDNS has the opposite meaning as 'ignore-auto-dns' property.dhcp-hostnameDHCP_HOSTNAMEHostname to send the DHCP server.never-defaultIPV6_DEFROUTE(+), (and IPV6_DEFAULTGW, IPV6_DEFAULTDEV in /etc/sysconfig/network)IPV6_DEFROUTE=yes (when no variable specified)IPV6_DEFROUTE=no tells NetworkManager that this connection should not be assigned the default IPv6 route. IPV6_DEFROUTE has the opposite meaning as 'never-default' property.may-failIPV6_FAILURE_FATAL(+)noIPV6_FAILURE_FATAL has the opposite meaning as 'may-fail' property.route-metricIPV6_ROUTE_METRIC(+)-1IPV6_ROUTE_METRIC is the default IPv6 metric for routes on this connection. If set to -1, a default metric based on the device type is used.dns-priorityIPV6_DNS_PRIORITY(+)0The priority for DNS servers of this connection. Lower values have higher priority. If zero, the default value will be used (50 for VPNs, 100 for other connections). A negative value prevents DNS from other connections with greater values to be used. + +Example: IPV6_DNS_PRIORITY=20ip6-privacyIPV6_PRIVACY, IPV6_PRIVACY_PREFER_PUBLIC_IP(+)noConfigure IPv6 Privacy Extensions for SLAAC (RFC4941). Example: IPV6_PRIVACY=rfc3041 IPV6_PRIVACY_PREFER_PUBLIC_IP=yes @@ -304,7 +310,9 @@ Allowed values: IPV6_PRIVACY: no, yes (rfc3041 or rfc4941); IPV6_PRIV Example: IPV6_ADDR_GEN_MODE=stable-privacy -Allowed values: IPV6_ADDR_GEN_MODE: eui64, stable-privacymacvlan settingPropertyIfcfg-rh VariableDefaultDescription
team-port settingPropertyIfcfg-rh VariableDefaultDescriptionconfigTEAM_PORT_CONFIGTeam port configuration in JSON. See man teamd.conf for details.
team settingPropertyIfcfg-rh VariableDefaultDescriptionconfigTEAM_CONFIGTeam configuration in JSON. See man teamd.conf for details.
tun settingPropertyIfcfg-rh VariableDefaultDescription
vlan settingPropertyIfcfg-rh VariableDefaultDescriptionparentDEVICE or PHYSDEVParent interface of the VLAN.idVLAN_ID or DEVICEVLAN identifier.flagsGVRP, MVRP, VLAN_FLAGSVLAN flags. +Allowed values: IPV6_ADDR_GEN_MODE: eui64, stable-privacytokenIPV6_TOKENThe IPv6 tokenized interface identifier token + +Example: IPV6_TOKEN=::53
macvlan settingPropertyIfcfg-rh VariableDefaultDescription
team-port settingPropertyIfcfg-rh VariableDefaultDescriptionconfigTEAM_PORT_CONFIGTeam port configuration in JSON. See man teamd.conf for details.
team settingPropertyIfcfg-rh VariableDefaultDescriptionconfigTEAM_CONFIGTeam configuration in JSON. See man teamd.conf for details.
tun settingPropertyIfcfg-rh VariableDefaultDescription
vlan settingPropertyIfcfg-rh VariableDefaultDescriptionparentDEVICE or PHYSDEVParent interface of the VLAN.idVLAN_ID or DEVICEVLAN identifier.flagsGVRP, MVRP, VLAN_FLAGSVLAN flags. Allowed values: "yes or "no" for GVRP and MVRP; "LOOSE_BINDING" and "NO_REORDER_HDR" for VLAN_FLAGSingress-priority-mapVLAN_INGRESS_PRIORITY_MAPIngress priority mapping. @@ -312,7 +320,7 @@ Example: VLAN_INGRESS_PRIORITY_MAP=4:2,3:5VLAN_EGRESS_PRIORITY_MAP=5:4,4:1,3:7interface-namePHYSDEV and VLAN_ID, or DEVICEVLAN 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. -Example: PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12
vxlan settingPropertyIfcfg-rh VariableDefaultDescription
802-3-ethernet settingPropertyIfcfg-rh VariableDefaultDescriptionport(none)The property is not saved by the plugin.speed(none)The property is not saved by the plugin.duplex(none)The property is not saved by the plugin.auto-negotiate(none)The property is not saved by the plugin.mac-addressHWADDRHardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05).cloned-mac-addressMACADDRCloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).mac-address-blacklistHWADDR_BLACKLIST(+)It denies usage of the connection for any device whose address is listed. +Example: PHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0.12
vxlan settingPropertyIfcfg-rh VariableDefaultDescription
802-3-ethernet settingPropertyIfcfg-rh VariableDefaultDescriptionport(none)The property is not saved by the plugin.speed(none)The property is not saved by the plugin.duplex(none)The property is not saved by the plugin.auto-negotiate(none)The property is not saved by the plugin.mac-addressHWADDRHardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05).cloned-mac-addressMACADDRCloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).generate-mac-address-maskGENERATE_MAC_ADDRESS_MASKthe MAC address mask for generating randomized and stable cloned-mac-address.mac-address-blacklistHWADDR_BLACKLIST(+)It denies usage of the connection for any device whose address is listed. Example: HWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55"mtuMTUMTU of the interface.s390-subchannelsSUBCHANNELSSubchannels for IBM S390 hosts. @@ -348,7 +356,7 @@ Allowed values: a, bgchannelCHANNEL=6bssidBSSID(+)Restricts association only to a single AP. -Example: BSSID=00:1E:BD:64:83:21rate(none)This property is not handled by ifcfg-rh plugin.tx-power(none)This property is not handled by ifcfg-rh plugin.mac-addressHWADDRHardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05).cloned-mac-addressMACADDRCloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).mac-address-blacklistHWADDR_BLACKLIST(+)It denies usage of the connection for any device whose address is listed.seen-bssids(none)This property is not handled by ifcfg-rh plugin.mtuMTUMTU of the wireless interface.hiddenSSID_HIDDEN(+)Whether the network hides the SSID.powersavePOWERSAVE(+)Enables or disables Wi-Fi power saving. +Example: BSSID=00:1E:BD:64:83:21rate(none)This property is not handled by ifcfg-rh plugin.tx-power(none)This property is not handled by ifcfg-rh plugin.mac-addressHWADDRHardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05).cloned-mac-addressMACADDRCloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).generate-mac-address-maskGENERATE_MAC_ADDRESS_MASKthe MAC address mask for generating randomized and stable cloned-mac-address.mac-address-blacklistHWADDR_BLACKLIST(+)It denies usage of the connection for any device whose address is listed.seen-bssids(none)This property is not handled by ifcfg-rh plugin.mtuMTUMTU of the wireless interface.hiddenSSID_HIDDEN(+)Whether the network hides the SSID.powersavePOWERSAVE(+)Enables or disables Wi-Fi power saving. Example: POWERSAVE=enable @@ -367,9 +375,9 @@ Allowed values: default, never, alwaysask - the associated password is not saved but it will be requested from the user each time it is required.unused - in some situations it cannot be automatically determined that a secret is required or not. This flag hints that the secret is not required and should - not be requested from the user.Files/etc/sysconfig/network-scripts/ifcfg-*/etc/sysconfig/network-scripts/keys-*/etc/sysconfig/network-scripts/route-*/etc/sysconfig/network-scripts/route6-*/usr/share/doc/initscripts/sysconfig.txtSee Alsonm-settings5, - nm-settings-keyfile5, - NetworkManager8, - NetworkManager.conf5, - nmcli1, - nmcli-examples7 + not be requested from the user.Files/etc/sysconfig/network-scripts/ifcfg-*/etc/sysconfig/network-scripts/keys-*/etc/sysconfig/network-scripts/route-*/etc/sysconfig/network-scripts/route6-*/usr/share/doc/initscripts/sysconfig.txtSee Alsonm-settings5, + nm-settings-keyfile5, + NetworkManager8, + NetworkManager.conf5, + nmcli1, + nmcli-examples7 diff --git a/man/nm-settings-ifcfg-rh.xsl b/man/nm-settings-ifcfg-rh.xsl index 5a9f8d6a..80d33f2b 100644 --- a/man/nm-settings-ifcfg-rh.xsl +++ b/man/nm-settings-ifcfg-rh.xsl @@ -53,7 +53,7 @@ The plugin currently supports reading and writing Ethernet, Wi-Fi, InfiniBand, VLAN, Bond, Bridge, and Team connections. Unsupported connection types (such as WWAN, PPPoE, VPN, or ADSL) are handled by keyfile plugin - (nm-settings-keyfile5). + (nm-settings-keyfile5). The main reason for using ifcfg-rh plugin is the compatibility with legacy configurations for ifup and ifdown (initscripts). @@ -257,6 +257,11 @@ DEVICETYPE=TeamPort assigns the interface 10.42.0.1, or it uses the first static address, if configured. + + HWADDR - + initscripts compare the currently set hardware address of a device, while + NetworkManager considers the permanent one. + @@ -311,12 +316,12 @@ DEVICETYPE=TeamPort /usr/share/doc/initscripts/sysconfig.txt See Also - nm-settings5, - nm-settings-keyfile5, - NetworkManager8, - NetworkManager.conf5, - nmcli1, - nmcli-examples7 + nm-settings5, + nm-settings-keyfile5, + NetworkManager8, + NetworkManager.conf5, + nmcli1, + nmcli-examples7 diff --git a/man/nm-settings-keyfile.5 b/man/nm-settings-keyfile.5 index 0d3930ad..72a364a8 100644 --- a/man/nm-settings-keyfile.5 +++ b/man/nm-settings-keyfile.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-keyfile .\" Author: .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 08/03/2016 +.\" Date: 08/24/2016 .\" Manual: Configuration -.\" Source: NetworkManager 1.2.4 +.\" Source: NetworkManager 1.4.0 .\" Language: English .\" -.TH "NM\-SETTINGS\-KEYFIL" "5" "" "NetworkManager 1\&.2\&.4" "Configuration" +.TH "NM\-SETTINGS\-KEYFIL" "5" "" "NetworkManager 1\&.4\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-settings-keyfile.xml b/man/nm-settings-keyfile.xml index 849b3da9..1bf66c7e 100644 --- a/man/nm-settings-keyfile.xml +++ b/man/nm-settings-keyfile.xml @@ -1,6 +1,6 @@ -nm-settings-keyfileNetworkManager developersnm-settings-keyfile5NetworkManagerConfiguration1.2.4nm-settings-keyfileDescription of keyfile settings pluginDescription +nm-settings-keyfileNetworkManager developersnm-settings-keyfile5NetworkManagerConfiguration1.4.0nm-settings-keyfileDescription of keyfile settings pluginDescription NetworkManager is based on the concept of connection profiles that contain network configuration (see nm-settings5 for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing @@ -128,7 +128,7 @@ id=4 There are several exceptions to this rule, mainly for making keyfile syntax easier for humans. The exceptions handled specially by keyfile plugin are listed below. Refer to - nm-settings5 + nm-settings5 for all available settings and properties and their description. Name aliases Some of the NetworkManager setting names are somewhat hard to type or remember. Therefore @@ -234,9 +234,9 @@ Example: mac-address-blacklist= 00:22:68:12:79:A6;00:22:68:12:79:782 - (not-saved) - this secret should not be saved but should be requested from the user each time it is required.4 - (not-required) - in some situations it cannot be automatically determined that a secret is required or not. This flag hints that the secret is not required - and should not be requested from the user.Files/etc/NetworkManager/system-connections/*See Alsonm-settings5, - nm-settings-ifcfg-rh5, - NetworkManager8, - NetworkManager.conf5, - nmcli1, - nmcli-examples7 + and should not be requested from the user.Files/etc/NetworkManager/system-connections/*See Alsonm-settings5, + nm-settings-ifcfg-rh5, + NetworkManager8, + NetworkManager.conf5, + nmcli1, + nmcli-examples7 diff --git a/man/nm-settings-keyfile.xsl b/man/nm-settings-keyfile.xsl index 41e7dcdb..486a4c53 100644 --- a/man/nm-settings-keyfile.xsl +++ b/man/nm-settings-keyfile.xsl @@ -195,7 +195,7 @@ id=4 There are several exceptions to this rule, mainly for making keyfile syntax easier for humans. The exceptions handled specially by keyfile plugin are listed below. Refer to - nm-settings5 + nm-settings5 for all available settings and properties and their description. Name aliases @@ -246,12 +246,12 @@ id=4 See Also - nm-settings5, - nm-settings-ifcfg-rh5, - NetworkManager8, - NetworkManager.conf5, - nmcli1, - nmcli-examples7 + nm-settings5, + nm-settings-ifcfg-rh5, + NetworkManager8, + NetworkManager.conf5, + nmcli1, + nmcli-examples7 diff --git a/man/nm-settings.5 b/man/nm-settings.5 index 08312995..e963f5ef 100644 --- a/man/nm-settings.5 +++ b/man/nm-settings.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings .\" Author: .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 08/03/2016 +.\" Date: 08/24/2016 .\" Manual: Configuration -.\" Source: NetworkManager 1.2.4 +.\" Source: NetworkManager 1.4.0 .\" Language: English .\" -.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.2\&.4" "Configuration" +.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.4\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -921,6 +921,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 @@ -1049,6 +1050,15 @@ T}:T{ Setting name of the device type of this slave\*(Aqs master connection (eg, "bond"), or NULL if this connection is not a slave\&. T} T{ +stable\-id +T}:T{ +string +T}:T{ +\ \& +T}:T{ +This token to generate stable IDs for the connection\&. If unset, the UUID will be used instead\&. The stable\-id is used instead of the connection UUID for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. +T} +T{ timestamp T}:T{ uint64 @@ -1811,6 +1821,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{ addr\-gen\-mode @@ -2010,6 +2021,15 @@ T}:T{ T}:T{ Deprecated in favor of the \*(Aqroute\-data\*(Aq property, but this can be used for backward\-compatibility with older daemons\&. Note that if you send this property the daemon will ignore \*(Aqroute\-data\*(Aq\&. Array of IPv6 route structures\&. Each IPv6 route structure is composed of an IPv6 address, a prefix length (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\&. T} +T{ +token +T}:T{ +string +T}:T{ +\ \& +T}:T{ +Configure the token for draft\-chown\-6man\-tokenised\-ipv6\-identifiers\-02 IPv6 tokenized interface identifiers\&. Useful with eui64 addr\-gen\-mode\&. +T} .TE .sp 1 .sp @@ -3297,8 +3317,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{ +assigned\-mac\-address +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The new field for the cloned MAC address\&. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable"\&. This field replaces the deprecated "cloned\-mac\-address" on D\-Bus, which can only contain explict hardware addresses\&. +T} +T{ auto\-negotiate T}:T{ boolean @@ -3314,7 +3345,7 @@ byte array T}:T{ \ \& T}:T{ -If specified, request that the device use this MAC address instead of its permanent MAC address\&. This is known as MAC cloning or spoofing\&. +This D\-Bus field is deprecated in favor of "assigned\-mac\-address" which is more flexible and allows specifying special variants like "random"\&. T} T{ duplex @@ -3326,6 +3357,15 @@ T}:T{ If specified, request that the device only use the specified duplex mode\&. Either "half" or "full"\&. T} T{ +generate\-mac\-address\-mask +T}:T{ +string +T}:T{ +\ \& +T}:T{ +With "cloned\-mac\-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally\-administered, unicast MAC address is created\&. This property allows to specify that certain bits are fixed\&. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address\&. If the property is NULL, it is eligible to be overwritten by a default connection setting\&. If the value is still NULL or an empty string, the default is to create a locally\-administered, unicast MAC address\&. If the value contains one MAC address, this address is used as mask\&. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization\&. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm\&. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized\&. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized\&. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally\-administered, burned\-in MAC address\&. If the value contains more then one additional MAC addresses, one of them is chosen randomly\&. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered\&. +T} +T{ mac\-address T}:T{ byte array @@ -3461,8 +3501,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{ +assigned\-mac\-address +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The new field for the cloned MAC address\&. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable"\&. This field replaces the deprecated "cloned\-mac\-address" on D\-Bus, which can only contain explict hardware addresses\&. +T} +T{ band T}:T{ string @@ -3496,7 +3547,16 @@ byte array T}:T{ \ \& T}:T{ -If specified, request that the Wi\-Fi device use this MAC address instead of its permanent MAC address\&. This is known as MAC cloning or spoofing\&. +This D\-Bus field is deprecated in favor of "assigned\-mac\-address" which is more flexible and allows specifying special variants like "random"\&. +T} +T{ +generate\-mac\-address\-mask +T}:T{ +string +T}:T{ +\ \& +T}:T{ +With "cloned\-mac\-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally\-administered, unicast MAC address is created\&. This property allows to specify that certain bits are fixed\&. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address\&. If the property is NULL, it is eligible to be overwritten by a default connection setting\&. If the value is still NULL or an empty string, the default is to create a locally\-administered, unicast MAC address\&. If the value contains one MAC address, this address is used as mask\&. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization\&. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm\&. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized\&. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized\&. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally\-administered, burned\-in MAC address\&. If the value contains more then one additional MAC addresses, one of them is chosen randomly\&. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered\&. T} T{ hidden @@ -3532,7 +3592,7 @@ 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)\&. +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)\&. Deprecated: 1 T} T{ mode diff --git a/man/nm-settings.xml b/man/nm-settings.xml index 06146e5e..5f34d9ee 100644 --- a/man/nm-settings.xml +++ b/man/nm-settings.xml @@ -1,6 +1,6 @@ -nm-settingsNetworkManager developersnm-settings5NetworkManagerConfiguration1.2.4nm-settingsDescription of settings and properties of NetworkManager connection profilesDescription +nm-settingsNetworkManager developersnm-settings5NetworkManagerConfiguration1.4.0nm-settingsDescription of settings and properties of NetworkManager connection profilesDescription 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 @@ -34,377 +34,383 @@ and properties of this page.
802-1x settingKey NameValue TypeDefault ValueValue Description - altsubject-matchesarray of string[]List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed. - anonymous-identitystringAnonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS. - ca-certbyte arrayContains the CA certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. - ca-pathstringUTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property. - client-certbyte arrayContains the client certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. - domain-suffix-matchstringConstraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. - eaparray of string[]The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations. - identitystringIdentity string for EAP authentication methods. Often the user's user or login name. - namestring802-1xThe 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". - pac-filestringUTF-8 encoded file path containing PAC for EAP-FAST. - passwordstringUTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred. - password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property. (see for flag values) - password-rawbyte arrayPassword used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred. - password-raw-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password-raw" property. (see for flag values) - phase1-fast-provisioningstringEnables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details. - phase1-peaplabelstringForces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details. - phase1-peapverstringForces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version. - phase2-altsubject-matchesarray of string[]List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed. - phase2-authstringSpecifies the allowed "phase 2" inner non-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. Recognized non-EAP "phase 2" methods are "pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. - phase2-autheapstringSpecifies the allowed "phase 2" inner EAP-based authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. - phase2-ca-certbyte arrayContains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. - phase2-ca-pathstringUTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property. - phase2-client-certbyte arrayContains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. - phase2-domain-suffix-matchstringConstraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. - phase2-private-keybyte arrayContains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. - phase2-private-key-passwordstringThe password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key. - phase2-private-key-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "phase2-private-key-password" property. (see for flag values) - phase2-subject-matchstringSubstring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match. - pinstringPIN used for EAP authentication methods. - pin-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "pin" property. (see for flag values) - private-keybyte arrayContains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data. - private-key-passwordstringThe password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key. - private-key-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "private-key-password" property. (see for flag values) - subject-matchstringSubstring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match. - system-ca-certsbooleanFALSEWhen TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant). + altsubject-matchesarray of string[]List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed. + anonymous-identitystringAnonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS. + ca-certbyte arrayContains the CA certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. + ca-pathstringUTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property. + client-certbyte arrayContains the client certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. + domain-suffix-matchstringConstraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. + eaparray of string[]The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations. + identitystringIdentity string for EAP authentication methods. Often the user's user or login name. + namestring802-1xThe 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". + pac-filestringUTF-8 encoded file path containing PAC for EAP-FAST. + passwordstringUTF-8 encoded password used for EAP authentication methods. If both the "password" property and the "password-raw" property are specified, "password" is preferred. + password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property. (see for flag values) + password-rawbyte arrayPassword used for EAP authentication methods, given as a byte array to allow passwords in other encodings than UTF-8 to be used. If both the "password" property and the "password-raw" property are specified, "password" is preferred. + password-raw-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password-raw" property. (see for flag values) + phase1-fast-provisioningstringEnables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the "eap" property. Recognized values are "0" (disabled), "1" (allow unauthenticated provisioning), "2" (allow authenticated provisioning), and "3" (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details. + phase1-peaplabelstringForces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details. + phase1-peapverstringForces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version. + phase2-altsubject-matchesarray of string[]List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed. + phase2-authstringSpecifies the allowed "phase 2" inner non-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. Recognized non-EAP "phase 2" methods are "pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. + phase2-autheapstringSpecifies the allowed "phase 2" inner EAP-based authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details. + phase2-ca-certbyte arrayContains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. + phase2-ca-pathstringUTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property. + phase2-client-certbyte arrayContains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended. + phase2-domain-suffix-matchstringConstraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison. + phase2-private-keybyte arrayContains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. + phase2-private-key-passwordstringThe password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key. + phase2-private-key-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "phase2-private-key-password" property. (see for flag values) + phase2-subject-matchstringSubstring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match. + pinstringPIN used for EAP authentication methods. + pin-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "pin" property. (see for flag values) + private-keybyte arrayContains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data. + private-key-passwordstringThe password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key. + private-key-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "private-key-password" property. (see for flag values) + subject-matchstringSubstring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match. + system-ca-certsbooleanFALSEWhen TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).
adsl settingKey NameValue TypeDefault ValueValue Description - encapsulationstringEncapsulation of ADSL connection. Can be "vcmux" or "llc". - namestringadslThe 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". - passwordstringPassword used to authenticate with the ADSL service. - password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property. (see for flag values) - protocolstringADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm". - usernamestringUsername used to authenticate with the ADSL service. - vciuint320VCI of ADSL connection - vpiuint320VPI of ADSL connection + encapsulationstringEncapsulation of ADSL connection. Can be "vcmux" or "llc". + namestringadslThe 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". + passwordstringPassword used to authenticate with the ADSL service. + password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property. (see for flag values) + protocolstringADSL connection protocol. Can be "pppoa", "pppoe" or "ipoatm". + usernamestringUsername used to authenticate with the ADSL service. + vciuint320VCI of ADSL connection + vpiuint320VPI of ADSL connection
bluetooth settingKey NameValue TypeDefault ValueValue Description - bdaddrbyte arrayThe Bluetooth address of the device. - namestringbluetoothThe 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". - typestringEither "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile. + bdaddrbyte arrayThe Bluetooth address of the device. + namestringbluetoothThe 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". + typestringEither "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.
bond settingKey NameValue TypeDefault ValueValue Description - interface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name. - namestringbondThe 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". - optionsdict of string to string{'mode': 'balance-rr'}Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). + interface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name. + namestringbondThe 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". + optionsdict of string to string{'mode': 'balance-rr'}Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).
bridge settingKey NameValue TypeDefault ValueValue Description - ageing-timeuint32300The Ethernet MAC address aging time, in seconds. - forward-delayuint3215The Spanning Tree Protocol (STP) forwarding delay, in seconds. - hello-timeuint322The Spanning Tree Protocol (STP) hello time, in seconds. - interface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name. - mac-addressbyte arrayIf 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. - max-ageuint3220The Spanning Tree Protocol (STP) maximum message age, in seconds. - multicast-snoopingbooleanTRUEControls 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. - namestringbridgeThe 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". - priorityuint3232768Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge. - stpbooleanTRUEControls whether Spanning Tree Protocol (STP) is enabled for this bridge. + ageing-timeuint32300The Ethernet MAC address aging time, in seconds. + forward-delayuint3215The Spanning Tree Protocol (STP) forwarding delay, in seconds. + hello-timeuint322The Spanning Tree Protocol (STP) hello time, in seconds. + interface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name. + mac-addressbyte arrayIf 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. + max-ageuint3220The Spanning Tree Protocol (STP) maximum message age, in seconds. + multicast-snoopingbooleanTRUEControls 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. + namestringbridgeThe 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". + priorityuint3232768Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge. + stpbooleanTRUEControls whether Spanning Tree Protocol (STP) is enabled for this bridge.
bridge-port settingKey NameValue TypeDefault ValueValue Description - hairpin-modebooleanFALSEEnables or disabled "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on. - namestringbridge-portThe 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". - path-costuint32100The Spanning Tree Protocol (STP) port cost for destinations via this port. - priorityuint3232The Spanning Tree Protocol (STP) priority of this bridge port. + hairpin-modebooleanFALSEEnables or disabled "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on. + namestringbridge-portThe 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". + path-costuint32100The Spanning Tree Protocol (STP) port cost for destinations via this port. + priorityuint3232The Spanning Tree Protocol (STP) priority of this bridge port.
cdma settingKey NameValue TypeDefault ValueValue Description - namestringcdmaThe 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". - numberstringThe number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required. - passwordstringThe password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here. - password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property. (see for flag values) - usernamestringThe 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. + namestringcdmaThe 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". + numberstringThe number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required. + passwordstringThe password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here. + password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property. (see for flag values) + usernamestringThe 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.
connection settingKey NameValue TypeDefault ValueValue Description - autoconnectbooleanTRUEWhether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection. - autoconnect-priorityint320The autoconnect priority. If the connection is set to autoconnect, connections with higher priority will be preferred. Defaults to 0. The higher number means higher priority. - autoconnect-slavesNMSettingConnectionAutoconnectSlaves (int32)Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0. - gateway-ping-timeoutuint320If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping. - idstringA human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G". - interface-namestringThe 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. - lldpint32-1Whether LLDP is enabled for the connection. - masterstringInterface name of the master device or UUID of the master connection. - meteredNMMetered (int32)Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately. - namestringconnectionThe 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". - permissionsarray of string[]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. - read-onlybooleanFALSEFALSE 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. - secondariesarray of string[]List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported. - slave-typestringSetting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave. - timestampuint640The 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). - typestringBase 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). - uuidstringA 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 "-"). - zonestringThe 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. + autoconnectbooleanTRUEWhether or not the connection should be automatically connected by NetworkManager when the resources for the connection are available. TRUE to automatically activate the connection, FALSE to require manual intervention to activate the connection. + autoconnect-priorityint320The autoconnect priority. If the connection is set to autoconnect, connections with higher priority will be preferred. Defaults to 0. The higher number means higher priority. + autoconnect-slavesNMSettingConnectionAutoconnectSlaves (int32)Whether or not slaves of this connection should be automatically brought up when NetworkManager activates this connection. This only has a real effect for master connections. The permitted values are: 0: leave slave connections untouched, 1: activate all the slave connections with this connection, -1: default. If -1 (default) is set, global connection.autoconnect-slaves is read to determine the real value. If it is default as well, this fallbacks to 0. + gateway-ping-timeoutuint320If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping. + idstringA human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G". + interface-namestringThe 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. + lldpint32-1Whether LLDP is enabled for the connection. + masterstringInterface name of the master device or UUID of the master connection. + meteredNMMetered (int32)Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately. + namestringconnectionThe 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". + permissionsarray of string[]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. + read-onlybooleanFALSEFALSE 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. + secondariesarray of string[]List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported. + slave-typestringSetting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave. + stable-idstringThis token to generate stable IDs for the connection. If unset, the UUID will be used instead. The stable-id is used instead of the connection UUID for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. + timestampuint640The 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). + typestringBase 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). + uuidstringA 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 "-"). + zonestringThe 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.
dcb settingKey NameValue TypeDefault ValueValue Description - app-fcoe-flagsNMSettingDcbFlags (uint32)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). - app-fcoe-modestring"fabric"The FCoE controller mode; either "fabric" (default) or "vn2vn". - app-fcoe-priorityint32-1The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag. - app-fip-flagsNMSettingDcbFlags (uint32)Specifies the NMSettingDcbFlags for the DCB FIP 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). - app-fip-priorityint32-1The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag. - app-iscsi-flagsNMSettingDcbFlags (uint32)Specifies the NMSettingDcbFlags for the DCB iSCSI 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). - app-iscsi-priorityint32-1The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag. - namestringdcbThe 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". - priority-bandwidtharray of uint32[0, 0, 0, 0, 0, 0, 0, 0]An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percent. - priority-flow-controlarray of uint32[0, 0, 0, 0, 0, 0, 0, 0]An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause. - priority-flow-control-flagsNMSettingDcbFlags (uint32)Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). 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). - priority-group-bandwidtharray of uint32[0, 0, 0, 0, 0, 0, 0, 0]An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percent. - priority-group-flagsNMSettingDcbFlags (uint32)Specifies the NMSettingDcbFlags for DCB Priority Groups. 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). - priority-group-idarray of uint32[0, 0, 0, 0, 0, 0, 0, 0]An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group. - priority-strict-bandwidtharray of uint32[0, 0, 0, 0, 0, 0, 0, 0]An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group. - priority-traffic-classarray of uint32[0, 0, 0, 0, 0, 0, 0, 0]An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped. + app-fcoe-flagsNMSettingDcbFlags (uint32)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). + app-fcoe-modestring"fabric"The FCoE controller mode; either "fabric" (default) or "vn2vn". + app-fcoe-priorityint32-1The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag. + app-fip-flagsNMSettingDcbFlags (uint32)Specifies the NMSettingDcbFlags for the DCB FIP 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). + app-fip-priorityint32-1The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority. Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag. + app-iscsi-flagsNMSettingDcbFlags (uint32)Specifies the NMSettingDcbFlags for the DCB iSCSI 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). + app-iscsi-priorityint32-1The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag. + namestringdcbThe 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". + priority-bandwidtharray of uint32[0, 0, 0, 0, 0, 0, 0, 0]An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percent. + priority-flow-controlarray of uint32[0, 0, 0, 0, 0, 0, 0, 0]An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause. + priority-flow-control-flagsNMSettingDcbFlags (uint32)Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). 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). + priority-group-bandwidtharray of uint32[0, 0, 0, 0, 0, 0, 0, 0]An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percent. + priority-group-flagsNMSettingDcbFlags (uint32)Specifies the NMSettingDcbFlags for DCB Priority Groups. 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). + priority-group-idarray of uint32[0, 0, 0, 0, 0, 0, 0, 0]An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID. Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group. + priority-strict-bandwidtharray of uint32[0, 0, 0, 0, 0, 0, 0, 0]An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group. + priority-traffic-classarray of uint32[0, 0, 0, 0, 0, 0, 0, 0]An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.
generic settingKey NameValue TypeDefault ValueValue Description - namestringgenericThe 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". + namestringgenericThe 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".
gsm settingKey NameValue TypeDefault ValueValue Description - apnstringThe 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. - device-idstringThe 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. - home-onlybooleanFALSEWhen TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made. - namestringgsmThe 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". - network-idstringThe 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. - numberstringNumber to dial when establishing a PPP data session with the GSM-based mobile broadband network. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which allows NetworkManager to select the appropriate settings automatically. - passwordstringThe password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here. - password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property. (see for flag values) - pinstringIf 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. - pin-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "pin" property. (see for flag values) - sim-idstringThe 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. - sim-operator-idstringA 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. - usernamestringThe 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. + apnstringThe 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. + device-idstringThe 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. + home-onlybooleanFALSEWhen TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made. + namestringgsmThe 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". + network-idstringThe 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. + numberstringNumber to dial when establishing a PPP data session with the GSM-based mobile broadband network. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which allows NetworkManager to select the appropriate settings automatically. + passwordstringThe password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here. + password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property. (see for flag values) + pinstringIf 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. + pin-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "pin" property. (see for flag values) + sim-idstringThe 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. + sim-operator-idstringA 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. + usernamestringThe 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.
infiniband settingKey NameValue TypeDefault ValueValue Description - mac-addressbyte arrayIf specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing). - mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames. - namestringinfinibandThe 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". - p-keyint32-1The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key. - parentstringThe interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address". - transport-modestringThe IP-over-InfiniBand transport mode. Either "datagram" or "connected". + mac-addressbyte arrayIf specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing). + mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames. + namestringinfinibandThe 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". + p-keyint32-1The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key. + parentstringThe interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address". + transport-modestringThe IP-over-InfiniBand transport mode. Either "datagram" or "connected".
ipv4 settingKey NameValue TypeDefault ValueValue Description - address-dataarray of vardictArray 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. - addressesarray of array of uint32[]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. - dad-timeoutint32-1Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or 3 seconds). A value greater than zero is a timeout in milliseconds. - dhcp-client-idstringA string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. - dhcp-fqdnstringIf 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. - dhcp-hostnamestringIf 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. - dhcp-send-hostnamebooleanTRUEIf 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. - dhcp-timeoutint320A timeout for a DHCP transaction in seconds. - dnsarray of uint32[]Array of IP addresses of DNS servers (as network-byte-order integers) - dns-optionsarray of string[]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. - dns-priorityint320DNS priority. The relative priority to be used when determining the order of DNS servers in resolv.conf. A lower value means that servers will be on top of the file. Zero selects the default value, which is 50 for VPNs and 100 for other connections. When multiple devices have configurations with the same priority, the one with an active default route will be preferred. Note that when using dns=dnsmasq the order is meaningless since dnsmasq forwards queries to all known servers at the same time. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from configurations with the lowest priority value will be used. - dns-searcharray of string[]Array of DNS search domains. - gatewaystringThe gateway associated with this configuration. This is only meaningful if "addresses" is also set. - ignore-auto-dnsbooleanFALSEWhen "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. - ignore-auto-routesbooleanFALSEWhen "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. - may-failbooleanTRUEIf 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. - methodstringIP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. - namestringipv4The 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". - never-defaultbooleanFALSEIf TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager. - route-dataarray of vardictArray of IPv4 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'gateway' entry, containing the gateway IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes. - route-metricint64-1The 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. - routesarray of array of uint32[]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.) + address-dataarray of vardictArray 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. + addressesarray of array of uint32[]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. + dad-timeoutint32-1Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or 3 seconds). A value greater than zero is a timeout in milliseconds. + dhcp-client-idstringA string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. + dhcp-fqdnstringIf 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. + dhcp-hostnamestringIf 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. + dhcp-send-hostnamebooleanTRUEIf 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. + dhcp-timeoutint320A timeout for a DHCP transaction in seconds. + dnsarray of uint32[]Array of IP addresses of DNS servers (as network-byte-order integers) + dns-optionsarray of string[]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. + dns-priorityint320DNS priority. The relative priority to be used when determining the order of DNS servers in resolv.conf. A lower value means that servers will be on top of the file. Zero selects the default value, which is 50 for VPNs and 100 for other connections. When multiple devices have configurations with the same priority, the one with an active default route will be preferred. Note that when using dns=dnsmasq the order is meaningless since dnsmasq forwards queries to all known servers at the same time. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from configurations with the lowest priority value will be used. + dns-searcharray of string[]Array of DNS search domains. + gatewaystringThe gateway associated with this configuration. This is only meaningful if "addresses" is also set. + ignore-auto-dnsbooleanFALSEWhen "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. + ignore-auto-routesbooleanFALSEWhen "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. + may-failbooleanTRUEIf 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. + methodstringIP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. + namestringipv4The 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". + never-defaultbooleanFALSEIf TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager. + route-dataarray of vardictArray of IPv4 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'gateway' entry, containing the gateway IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes. + route-metricint64-1The 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. + routesarray of array of uint32[]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.)
ipv6 settingKey NameValue TypeDefault ValueValue Description - addr-gen-modeint321Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: "eui64", or "stable-privacy". 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. On D-Bus, the absence of an addr-gen-mode setting equals enabling "stable-privacy". For keyfile plugin, the absence of the setting on disk means "eui64" so that the property doesn't change on upgrade from older versions. Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option. - address-dataarray of vardictArray 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. - addressesarray of legacy IPv6 address struct (a(ayuay))[]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. - dad-timeoutint32-1Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or 3 seconds). A value greater than zero is a timeout in milliseconds. - dhcp-hostnamestringIf 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. - dhcp-send-hostnamebooleanTRUEIf 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. - dhcp-timeoutint320A timeout for a DHCP transaction in seconds. - dnsarray of byte array[]Array of IP addresses of DNS servers (in network byte order) - dns-optionsarray of string[]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. - dns-priorityint320DNS priority. The relative priority to be used when determining the order of DNS servers in resolv.conf. A lower value means that servers will be on top of the file. Zero selects the default value, which is 50 for VPNs and 100 for other connections. When multiple devices have configurations with the same priority, the one with an active default route will be preferred. Note that when using dns=dnsmasq the order is meaningless since dnsmasq forwards queries to all known servers at the same time. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from configurations with the lowest priority value will be used. - dns-searcharray of string[]Array of DNS search domains. - gatewaystringThe gateway associated with this configuration. This is only meaningful if "addresses" is also set. - ignore-auto-dnsbooleanFALSEWhen "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. - ignore-auto-routesbooleanFALSEWhen "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. - ip6-privacyNMSettingIP6ConfigPrivacy (int32)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. - may-failbooleanTRUEIf 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. - methodstringIP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. - namestringipv6The 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". - never-defaultbooleanFALSEIf TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager. - route-dataarray of vardictArray of IPv6 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes. - route-metricint64-1The 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. - routesarray of legacy IPv6 route struct (a(ayuayu))[]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. + addr-gen-modeint321Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: "eui64", or "stable-privacy". 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. On D-Bus, the absence of an addr-gen-mode setting equals enabling "stable-privacy". For keyfile plugin, the absence of the setting on disk means "eui64" so that the property doesn't change on upgrade from older versions. Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option. + address-dataarray of vardictArray 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. + addressesarray of legacy IPv6 address struct (a(ayuay))[]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. + dad-timeoutint32-1Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or 3 seconds). A value greater than zero is a timeout in milliseconds. + dhcp-hostnamestringIf 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. + dhcp-send-hostnamebooleanTRUEIf 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. + dhcp-timeoutint320A timeout for a DHCP transaction in seconds. + dnsarray of byte array[]Array of IP addresses of DNS servers (in network byte order) + dns-optionsarray of string[]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. + dns-priorityint320DNS priority. The relative priority to be used when determining the order of DNS servers in resolv.conf. A lower value means that servers will be on top of the file. Zero selects the default value, which is 50 for VPNs and 100 for other connections. When multiple devices have configurations with the same priority, the one with an active default route will be preferred. Note that when using dns=dnsmasq the order is meaningless since dnsmasq forwards queries to all known servers at the same time. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from configurations with the lowest priority value will be used. + dns-searcharray of string[]Array of DNS search domains. + gatewaystringThe gateway associated with this configuration. This is only meaningful if "addresses" is also set. + ignore-auto-dnsbooleanFALSEWhen "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. + ignore-auto-routesbooleanFALSEWhen "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. + ip6-privacyNMSettingIP6ConfigPrivacy (int32)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. + may-failbooleanTRUEIf 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. + methodstringIP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty. For IPv4 method "shared", the IP subnet can be configured by adding one manual IPv4 address or otherwise 10.42.x.0/24 is chosen. + namestringipv6The 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". + never-defaultbooleanFALSEIf TRUE, this connection will never be the default connection for this IP type, meaning it will never be assigned the default route by NetworkManager. + route-dataarray of vardictArray of IPv6 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'next-hop' entry, containing the next hop IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes. + route-metricint64-1The 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. + routesarray of legacy IPv6 route struct (a(ayuayu))[]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. + tokenstringConfigure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.
ip-tunnel settingKey NameValue TypeDefault ValueValue Description - encapsulation-limituint320How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. - flow-labeluint320The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels. - input-keystringThe key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used. - localstringThe local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address. - modeuint320The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2). - mtuuint320None - namestringip-tunnelThe 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". - output-keystringThe key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used. - parentstringIf 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. - path-mtu-discoverybooleanTRUEWhether to enable Path MTU Discovery on this tunnel. - remotestringThe remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address. - tosuint320The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets. - ttluint320The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value. + encapsulation-limituint320How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. + flow-labeluint320The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels. + input-keystringThe key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used. + localstringThe local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address. + modeuint320The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2). + mtuuint320None + namestringip-tunnelThe 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". + output-keystringThe key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used. + parentstringIf 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. + path-mtu-discoverybooleanTRUEWhether to enable Path MTU Discovery on this tunnel. + remotestringThe remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address. + tosuint320The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets. + ttluint320The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.
macvlan settingKey NameValue TypeDefault ValueValue Description - modeuint320The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device. - namestringmacvlanThe 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". - parentstringIf 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. - promiscuousbooleanTRUEWhether the interface should be put in promiscuous mode. - tapbooleanFALSEWhether the interface should be a MACVTAP. + modeuint320The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device. + namestringmacvlanThe 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". + parentstringIf 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. + promiscuousbooleanTRUEWhether the interface should be put in promiscuous mode. + tapbooleanFALSEWhether the interface should be a MACVTAP.
802-11-olpc-mesh settingKey NameValue TypeDefault ValueValue Description - channeluint320Channel on which the mesh network to join is located. - dhcp-anycast-addressbyte arrayAnycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. - namestring802-11-olpc-meshThe 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". - ssidbyte arraySSID of the mesh network to join. + channeluint320Channel on which the mesh network to join is located. + dhcp-anycast-addressbyte arrayAnycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. + namestring802-11-olpc-meshThe 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". + ssidbyte arraySSID of the mesh network to join.
ppp settingKey NameValue TypeDefault ValueValue Description - bauduint320If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed. - crtsctsbooleanFALSEIf TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE. - lcp-echo-failureuint320If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used. - lcp-echo-intervaluint320If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this. - mppe-statefulbooleanFALSEIf TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE. - mruuint320If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384. - mtuuint320If non-zero, instruct pppd to send packets no larger than the specified size. - namestringpppThe 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". - no-vj-compbooleanFALSEIf TRUE, Van Jacobsen TCP header compression will not be requested. - noauthbooleanTRUEIf TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE. - nobsdcompbooleanFALSEIf TRUE, BSD compression will not be requested. - nodeflatebooleanFALSEIf TRUE, "deflate" compression will not be requested. - refuse-chapbooleanFALSEIf TRUE, the CHAP authentication method will not be used. - refuse-eapbooleanFALSEIf TRUE, the EAP authentication method will not be used. - refuse-mschapbooleanFALSEIf TRUE, the MSCHAP authentication method will not be used. - refuse-mschapv2booleanFALSEIf TRUE, the MSCHAPv2 authentication method will not be used. - refuse-papbooleanFALSEIf TRUE, the PAP authentication method will not be used. - require-mppebooleanFALSEIf TRUE, MPPE (Microsoft Point-to-Point Encrpytion) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections. - require-mppe-128booleanFALSEIf TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail. + bauduint320If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed. + crtsctsbooleanFALSEIf TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE. + lcp-echo-failureuint320If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used. + lcp-echo-intervaluint320If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this. + mppe-statefulbooleanFALSEIf TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE. + mruuint320If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384. + mtuuint320If non-zero, instruct pppd to send packets no larger than the specified size. + namestringpppThe 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". + no-vj-compbooleanFALSEIf TRUE, Van Jacobsen TCP header compression will not be requested. + noauthbooleanTRUEIf TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE. + nobsdcompbooleanFALSEIf TRUE, BSD compression will not be requested. + nodeflatebooleanFALSEIf TRUE, "deflate" compression will not be requested. + refuse-chapbooleanFALSEIf TRUE, the CHAP authentication method will not be used. + refuse-eapbooleanFALSEIf TRUE, the EAP authentication method will not be used. + refuse-mschapbooleanFALSEIf TRUE, the MSCHAP authentication method will not be used. + refuse-mschapv2booleanFALSEIf TRUE, the MSCHAPv2 authentication method will not be used. + refuse-papbooleanFALSEIf TRUE, the PAP authentication method will not be used. + require-mppebooleanFALSEIf TRUE, MPPE (Microsoft Point-to-Point Encrpytion) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections. + require-mppe-128booleanFALSEIf TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.
pppoe settingKey NameValue TypeDefault ValueValue Description - namestringpppoeThe 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". - passwordstringPassword used to authenticate with the PPPoE service. - password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property. (see for flag values) - servicestringIf specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required. - usernamestringUsername used to authenticate with the PPPoE service. + namestringpppoeThe 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". + passwordstringPassword used to authenticate with the PPPoE service. + password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property. (see for flag values) + servicestringIf specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required. + usernamestringUsername used to authenticate with the PPPoE service.
serial settingKey NameValue TypeDefault ValueValue Description - bauduint3257600Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed. - bitsuint328Byte-width of the serial communication. The 8 in "8n1" for example. - namestringserialThe 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". - paritybyteThe connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none. - send-delayuint640Time to delay between each byte sent to the modem, in microseconds. - stopbitsuint321Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example. + bauduint3257600Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed. + bitsuint328Byte-width of the serial communication. The 8 in "8n1" for example. + namestringserialThe 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". + paritybyteThe connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none. + send-delayuint640Time to delay between each byte sent to the modem, in microseconds. + stopbitsuint321Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.
team settingKey NameValue TypeDefault ValueValue Description - configstringThe JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details. - interface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name. - namestringteamThe 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". + configstringThe JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details. + interface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name. + namestringteamThe 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".
team-port settingKey NameValue TypeDefault ValueValue Description - configstringThe 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. - namestringteam-portThe 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". + configstringThe 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. + namestringteam-portThe 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".
tun settingKey NameValue TypeDefault ValueValue Description - groupstringThe group ID which will own the device. If set to NULL everyone will be able to use the device. - modeuint321The 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. - multi-queuebooleanFALSEIf 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. - namestringtunThe 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". - ownerstringThe user ID which will own the device. If set to NULL everyone will be able to use the device. - pibooleanFALSEIf TRUE the interface will prepend a 4 byte header describing the physical interface to the packets. - vnet-hdrbooleanFALSEIf TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header. + groupstringThe group ID which will own the device. If set to NULL everyone will be able to use the device. + modeuint321The 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. + multi-queuebooleanFALSEIf 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. + namestringtunThe 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". + ownerstringThe user ID which will own the device. If set to NULL everyone will be able to use the device. + pibooleanFALSEIf TRUE the interface will prepend a 4 byte header describing the physical interface to the packets. + vnet-hdrbooleanFALSEIf TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.
vlan settingKey NameValue TypeDefault ValueValue Description - egress-priority-maparray of string[]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". - flagsNMVlanFlags (uint32)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. - iduint320The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095. - ingress-priority-maparray of string[]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". - interface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name. - namestringvlanThe 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". - parentstringIf given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property. + egress-priority-maparray of string[]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". + flagsNMVlanFlags (uint32)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. + iduint320The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095. + ingress-priority-maparray of string[]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". + interface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name. + namestringvlanThe 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". + parentstringIf given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
vpn settingKey NameValue TypeDefault ValueValue Description - datadict of string to string{}Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings. - namestringvpnThe 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". - persistentbooleanFALSEIf 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. - secretsdict of string to string{}Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings. - service-typestringD-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. - timeoutuint320Timeout 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. - user-namestringIf 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. + datadict of string to string{}Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings. + namestringvpnThe 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". + persistentbooleanFALSEIf 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. + secretsdict of string to string{}Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings. + service-typestringD-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. + timeoutuint320Timeout 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. + user-namestringIf 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.
vxlan settingKey NameValue TypeDefault ValueValue Description - ageinguint32300Specifies the lifetime in seconds of FDB entries learnt by the kernel. - destination-portuint328472Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint. - iduint320Specifies the VXLAN Network Identifer (or VXLAN Segment Identifier) to use. - l2-missbooleanFALSESpecifies whether netlink LL ADDR miss notifications are generated. - l3-missbooleanFALSESpecifies whether netlink IP ADDR miss notifications are generated. - learningbooleanTRUESpecifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database. - limituint320Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries. - localstringIf given, specifies the source IP address to use in outgoing packets. - namestringvxlanThe 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". - parentstringIf given, specifies the parent interface name or parent connection UUID. - proxybooleanFALSESpecifies whether ARP proxy is turned on. - remotestringSpecifies 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. - rscbooleanFALSESpecifies whether route short circuit is turned on. - source-port-maxuint320Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint. - source-port-minuint320Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint. - tosuint320Specifies the TOS value to use in outgoing packets. - ttluint320Specifies the time-to-live value to use in outgoing packets. + ageinguint32300Specifies the lifetime in seconds of FDB entries learnt by the kernel. + destination-portuint328472Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint. + iduint320Specifies the VXLAN Network Identifer (or VXLAN Segment Identifier) to use. + l2-missbooleanFALSESpecifies whether netlink LL ADDR miss notifications are generated. + l3-missbooleanFALSESpecifies whether netlink IP ADDR miss notifications are generated. + learningbooleanTRUESpecifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database. + limituint320Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries. + localstringIf given, specifies the source IP address to use in outgoing packets. + namestringvxlanThe 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". + parentstringIf given, specifies the parent interface name or parent connection UUID. + proxybooleanFALSESpecifies whether ARP proxy is turned on. + remotestringSpecifies 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. + rscbooleanFALSESpecifies whether route short circuit is turned on. + source-port-maxuint320Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint. + source-port-minuint320Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint. + tosuint320Specifies the TOS value to use in outgoing packets. + ttluint320Specifies the time-to-live value to use in outgoing packets.
wimax settingKey NameValue TypeDefault ValueValue Description - mac-addressbyte arrayIf 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 - namestringwimaxThe 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". - network-namestringNetwork Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1 + mac-addressbyte arrayIf 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 + namestringwimaxThe 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". + network-namestringNetwork Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1
802-3-ethernet settingKey NameValue TypeDefault ValueValue Description - auto-negotiatebooleanTRUEIf 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. - cloned-mac-addressbyte arrayIf specified, request that the device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing. - duplexstringIf specified, request that the device only use the specified duplex mode. Either "half" or "full". - mac-addressbyte arrayIf specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing). - mac-address-blacklistarray of string[]If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55). - mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames. - namestring802-3-ethernetThe 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". - portstringSpecific port type to use if multiple the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface. If the device supports only one port type, this setting is ignored. - s390-nettypestrings390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems. - s390-optionsdict of string to string{}Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). - s390-subchannelsarray of string[]Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character. - speeduint320If non-zero, request that the device use only the specified speed. In Mbit/s, ie 100 == 100Mbit/s. - wake-on-lanuint321The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager). - wake-on-lan-passwordstringIf specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required. + assigned-mac-addressstringThe new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explict hardware addresses. + auto-negotiatebooleanTRUEIf 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. + cloned-mac-addressbyte arrayThis D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". + duplexstringIf specified, request that the device only use the specified duplex mode. Either "half" or "full". + generate-mac-address-maskstringWith "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more then one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered. + mac-addressbyte arrayIf specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing). + mac-address-blacklistarray of string[]If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55). + mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames. + namestring802-3-ethernetThe 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". + portstringSpecific port type to use if multiple the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface. If the device supports only one port type, this setting is ignored. + s390-nettypestrings390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems. + s390-optionsdict of string to string{}Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]). + s390-subchannelsarray of string[]Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character. + speeduint320If non-zero, request that the device use only the specified speed. In Mbit/s, ie 100 == 100Mbit/s. + wake-on-lanuint321The NMSettingWiredWakeOnLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRED_WAKE_ON_LAN_PHY (0x2), NM_SETTING_WIRED_WAKE_ON_LAN_UNICAST (0x4), NM_SETTING_WIRED_WAKE_ON_LAN_MULTICAST (0x8), NM_SETTING_WIRED_WAKE_ON_LAN_BROADCAST (0x10), NM_SETTING_WIRED_WAKE_ON_LAN_ARP (0x20), NM_SETTING_WIRED_WAKE_ON_LAN_MAGIC (0x40) or the special values NM_SETTING_WIRED_WAKE_ON_LAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRED_WAKE_ON_LAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager). + wake-on-lan-passwordstringIf specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.
802-11-wireless settingKey NameValue TypeDefault ValueValue Description - bandstring802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers. - bssidbyte arrayIf specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future. - channeluint320Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set. - cloned-mac-addressbyte arrayIf specified, request that the Wi-Fi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing. - hiddenbooleanFALSEIf 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. - mac-addressbyte arrayIf 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). - mac-address-blacklistarray of string[]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"). - mac-address-randomizationuint320One 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). - modestringWi-Fi network mode; one of "infrastructure", "adhoc" or "ap". If blank, infrastructure is assumed. - mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames. - namestring802-11-wirelessThe 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". - powersaveuint320One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved. - rateuint320If 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. - securityNoneThis 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. - seen-bssidsarray of string[]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. - ssidbyte arraySSID of the Wi-Fi network. Must be specified. - tx-poweruint320If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power. + assigned-mac-addressstringThe new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explict hardware addresses. + bandstring802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers. + bssidbyte arrayIf specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future. + channeluint320Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set. + cloned-mac-addressbyte arrayThis D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". + generate-mac-address-maskstringWith "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more then one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered. + hiddenbooleanFALSEIf 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. + mac-addressbyte arrayIf 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). + mac-address-blacklistarray of string[]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"). + mac-address-randomizationuint320One 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). Deprecated: 1 + modestringWi-Fi network mode; one of "infrastructure", "adhoc" or "ap". If blank, infrastructure is assumed. + mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames. + namestring802-11-wirelessThe 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". + powersaveuint320One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved. + rateuint320If 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. + securityNoneThis 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. + seen-bssidsarray of string[]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. + ssidbyte arraySSID of the Wi-Fi network. Must be specified. + tx-poweruint320If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.
802-11-wireless-security settingKey NameValue TypeDefault ValueValue Description - auth-algstringWhen WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified. - grouparray of string[]A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp". - key-mgmtstringKey management used for the connection. One of "none" (WEP), "ieee8021x" (Dynamic WEP), "wpa-none" (Ad-Hoc WPA-PSK), "wpa-psk" (infrastructure WPA-PSK), or "wpa-eap" (WPA-Enterprise). This property must be set for any Wi-Fi connection that uses security. - leap-passwordstringThe login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap"). - leap-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "leap-password" property. (see for flag values) - leap-usernamestringThe login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap"). - namestring802-11-wireless-securityThe 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". - pairwisearray of string[]A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp". - protoarray of string[]List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed. - pskstringPre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the Wi-Fi network. - psk-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "psk" property. (see for flag values) - wep-key-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties. (see for flag values) - wep-key-typeNMWepKeyType (uint32)Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key. - wep-key0stringIndex 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted. - wep-key1stringIndex 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted. - wep-key2stringIndex 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted. - wep-key3stringIndex 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted. - wep-tx-keyidxuint320When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4. + auth-algstringWhen WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified. + grouparray of string[]A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp". + key-mgmtstringKey management used for the connection. One of "none" (WEP), "ieee8021x" (Dynamic WEP), "wpa-none" (Ad-Hoc WPA-PSK), "wpa-psk" (infrastructure WPA-PSK), or "wpa-eap" (WPA-Enterprise). This property must be set for any Wi-Fi connection that uses security. + leap-passwordstringThe login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap"). + leap-password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "leap-password" property. (see for flag values) + leap-usernamestringThe login username for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap"). + namestring802-11-wireless-securityThe 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". + pairwisearray of string[]A list of pairwise encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "tkip" or "ccmp". + protoarray of string[]List of strings specifying the allowed WPA protocol versions to use. Each element may be one "wpa" (allow WPA) or "rsn" (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed. + pskstringPre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the Wi-Fi network. + psk-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "psk" property. (see for flag values) + wep-key-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "wep-key0", "wep-key1", "wep-key2", and "wep-key3" properties. (see for flag values) + wep-key-typeNMWepKeyType (uint32)Controls the interpretation of WEP keys. Allowed values are NM_WEP_KEY_TYPE_KEY (1), in which case the key is either a 10- or 26-character hexadecimal string, or a 5- or 13-character ASCII password; or NM_WEP_KEY_TYPE_PASSPHRASE (2), in which case the passphrase is provided as a string and will be hashed using the de-facto MD5 method to derive the actual WEP key. + wep-key0stringIndex 0 WEP key. This is the WEP key used in most networks. See the "wep-key-type" property for a description of how this key is interpreted. + wep-key1stringIndex 1 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted. + wep-key2stringIndex 2 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted. + wep-key3stringIndex 3 WEP key. This WEP index is not used by most networks. See the "wep-key-type" property for a description of how this key is interpreted. + wep-tx-keyidxuint320When static WEP is used (ie, key-mgmt = "none") and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.
Secret flag types: Each secret property in a setting has an associated flags property @@ -414,7 +420,7 @@ this secret; when it is required, agents will be asked to provide it.0x2 (not-saved) - this secret should not be saved but should be requested from the user each time it is required. This flag should be used for One-Time-Pad secrets, PIN codes from hardware tokens, or if the user simply does not want to save the secret.0x4 (not-required) - in some situations it cannot be automatically determined that a secret - is required or not. This flag hints that the secret is not required and should not be requested from the user.Files/etc/NetworkManager/system-connections or distro plugin-specific locationSee AlsoNetworkManager8, - nmcli1, - nmcli-examples7, - NetworkManager.conf5 + is required or not. This flag hints that the secret is not required and should not be requested from the user.Files/etc/NetworkManager/system-connections or distro plugin-specific locationSee AlsoNetworkManager8, + nmcli1, + nmcli-examples7, + NetworkManager.conf5 diff --git a/man/nm-settings.xsl b/man/nm-settings.xsl index 0fe4cabe..03a10766 100644 --- a/man/nm-settings.xsl +++ b/man/nm-settings.xsl @@ -117,10 +117,10 @@ See Also - NetworkManager8, - nmcli1, - nmcli-examples7, - NetworkManager.conf5 + NetworkManager8, + nmcli1, + nmcli-examples7, + NetworkManager.conf5 @@ -147,7 +147,7 @@ - + nm-settings.property.. (see for flag values) diff --git a/man/nmcli-examples.7 b/man/nmcli-examples.7 index a1056f02..5d8c680b 100644 --- a/man/nmcli-examples.7 +++ b/man/nmcli-examples.7 @@ -2,12 +2,12 @@ .\" Title: nmcli-examples .\" Author: .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 08/03/2016 +.\" Date: 08/24/2016 .\" Manual: Examples -.\" Source: NetworkManager 1.2.4 +.\" Source: NetworkManager 1.4.0 .\" Language: English .\" -.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.2\&.4" "Examples" +.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.4\&.0" "Examples" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -139,7 +139,8 @@ org\&.freedesktop\&.NetworkManager\&.wifi\&.share\&.open yes org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.system yes org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.own yes org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.hostname auth -org\&.freedesktop\&.NetworkManager\&.reload no +org\&.freedesktop\&.NetworkManager\&.settings\&.modify\&.global\-dns auth +org\&.freedesktop\&.NetworkManager\&.reload auth .fi .if n \{\ .RE diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml index d0485bc5..864e6504 100644 --- a/man/nmcli-examples.xml +++ b/man/nmcli-examples.xml @@ -54,7 +54,7 @@ nmcli is a command-line client for NetworkManager. It allows controlling NetworkManager and reporting its status. For more information - please refer to nmcli1 + please refer to nmcli1 manual page. @@ -141,7 +141,8 @@ org.freedesktop.NetworkManager.wifi.share.open yes org.freedesktop.NetworkManager.settings.modify.system yes org.freedesktop.NetworkManager.settings.modify.own yes org.freedesktop.NetworkManager.settings.modify.hostname auth -org.freedesktop.NetworkManager.reload no +org.freedesktop.NetworkManager.settings.modify.global-dns auth +org.freedesktop.NetworkManager.reload auth This command shows configured polkit permissions for various NetworkManager operations. These permissions or actions (using polkit language) are configured @@ -172,7 +173,7 @@ B,DISPATCH 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 - NetworkManager.conf5 manual page + NetworkManager.conf5 manual page for available logging levels and domains. @@ -296,7 +297,7 @@ fi 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 NetworkManager8 + See NetworkManager8 manual page for more information about NetworkManager dispatcher scripts. @@ -542,11 +543,11 @@ Connection 'ethernet-4' (de89cdeb-a3e1-4d53-8fa0-c22546c775f4) successfully See Also - nmcli1, - NetworkManager8, - NetworkManager.conf5, - nm-settings5, - nm-online1, + nmcli1, + NetworkManager8, + NetworkManager.conf5, + nm-settings5, + nm-online1, nm-applet1, nm-connection-editor1 diff --git a/man/nmcli.1 b/man/nmcli.1 index e0b9e527..2eaef626 100644 --- a/man/nmcli.1 +++ b/man/nmcli.1 @@ -2,12 +2,12 @@ .\" Title: nmcli .\" Author: .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 08/03/2016 +.\" Date: 08/24/2016 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.2.4 +.\" Source: NetworkManager 1.4.0 .\" Language: English .\" -.TH "NMCLI" "1" "" "NetworkManager 1\&.2\&.4" "General Commands Manual" +.TH "NMCLI" "1" "" "NetworkManager 1\&.4\&.0" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -140,7 +140,7 @@ only produces colors when standard output is directed to a terminal\&. The defau auto\&. .RE .PP -\fB\-f\fR | \fB\-\-fields\fR {[\fIfield\fR...] | all | common} +\fB\-f\fR | \fB\-\-fields\fR {\fIfield1\fR,\fIfield2\fR... | all | common} .RS 4 This option is used to specify what fields (column names) should be printed\&. Valid field names differ for specific commands\&. List available fields by providing an invalid value to the \fB\-\-fields\fR @@ -187,7 +187,7 @@ When using this option will display passwords and secrets that might be present in an output of an operation\&. This option also influences echoing passwords typed by user as an input\&. .RE .PP -[\fB\-w\fR\ |\ \fB\-\-wait\fR\ \fIseconds\fR...] +\fB\-w\fR | \fB\-\-wait\fR \fIseconds\fR .RS 4 This option sets a timeout period for which \fBnmcli\fR @@ -200,6 +200,19 @@ instructs not to wait but to exit immediately with a status of success\&. The default value depends on the executed command\&. .RE .PP +\fB\-\-complete\-args\fR +.RS 4 +Instead of conducting the desired action, +\fBnmcli\fR +will list possible completions for the last argument\&. This is useful to implement argument completion in shell\&. +.sp +The +exit status +will indicate success or return a code 65 to indicate the last argument is a file name\&. +.sp +NetworkManager ships with command completion support for GNU Bash\&. +.RE +.PP \fB\-v\fR | \fB\-\-version\fR .RS 4 Show @@ -239,7 +252,7 @@ file when it starts\&. Show the permissions a caller has for various authenticated operations that NetworkManager provides, like enable and disable networking, changing Wi\-Fi and WWAN state, modifying connections, etc\&. .RE .PP -\fBlogging\fR [\fBlevel\fR\ \fIlevel\fR] [\fBdomain\fR\ \fIdomains\fR...] +\fBlogging\fR [\fBlevel\fR\ \fIlevel\fR] [\fBdomains\fR\ \fIdomains\fR...] .RS 4 Get and change NetworkManager logging level and domains\&. Without any argument current logging level and domains are shown\&. In order to change logging state, provide \fBlevel\fR @@ -334,7 +347,7 @@ and to watch for changes in certain devices or connections\&. .SH "CONNECTION MANAGEMENT COMMANDS" .HP \w'\fBnmcli\ connection\fR\ 'u -\fBnmcli connection\fR {\fBshow\fR | \fBup\fR | \fBdown\fR | \fBadd\fR | \fBedit\fR | \fBmodify\fR | \fBdelete\fR | \fBmonitor\fR | \fBreload\fR | \fBload\fR} [\fIARGUMENTS\fR...] +\fBnmcli connection\fR {\fBshow\fR | \fBup\fR | \fBdown\fR | \fBmodify\fR | \fBadd\fR | \fBedit\fR | \fBclone\fR | \fBdelete\fR | \fBmonitor\fR | \fBreload\fR | \fBload\fR | \fBimport\fR | \fBexport\fR} [\fIARGUMENTS\fR...] .PP NetworkManager stores all network configuration as "connections", which are collections of data (Layer2 details, IP addressing, etc\&.) that describe how to create or connect to a network\&. A connection is "active" when a device uses that connection\*(Aqs configuration to create or connect to a network\&. There may be multiple connections that apply to a device, but only one of them can be active on that device at any given time\&. The additional connections can be used to allow quick switching between different networks and configurations\&. .PP @@ -435,7 +448,7 @@ When no command is given to the \fBnmcli connection show\fR\&. .RE .PP -\fBup\fR [\fBid\fR | \fBuuid\fR | \fBpath\fR] \fIID\fR... [\fBifname\fR\ \fIifname\fR] [\fBap\fR\ \fIBSSID\fR] [\fBpasswd\-file\fR\ \fIfile\fR] +\fBup\fR [\fBid\fR | \fBuuid\fR | \fBpath\fR] \fIID\fR [\fBifname\fR\ \fIifname\fR] [\fBap\fR\ \fIBSSID\fR] [\fBpasswd\-file\fR\ \fIfile\fR] .RS 4 Activate a connection\&. The connection is identified by its name, UUID or D\-Bus path\&. If \fIID\fR @@ -561,634 +574,330 @@ If option is not specified, the default timeout will be 10 seconds\&. .RE .PP -\fBadd\fR \fBifname\fR\ \fIifname\fR [con\-name\ \fIname\fR] [\fBautoconnect\fR\ {yes\ |\ no}] [\fBsave\fR\ {yes\ |\ no}] [master\ \fImaster\fR] [slave\-type\ \fItype\fR] [type\ \fItype\fR] [\fIARGUMENTS\fR...] [ip4\ \fIaddr\fR] [gw4\ \fIaddr\fR] [ip6\ \fIaddr\fR] [gw6\ \fIaddr\fR] [\fB\-\-\fR\ [+|\-]\fIsetting\fR\&.\fIproperty\fR\ \fIvalue\fR\ ...] -.RS 4 -Add a connection for NetworkManager\&. Arguments differ according to connection types, see below\&. -.PP -\fBifname\fR -.RS 4 -interface to bind the connection to\&. The connection will only be applicable to this interface name\&. A special value of -* -can be used for interface\-independent connections\&. The -\fBifname\fR -argument is mandatory for all connection types except bond, team, bridge and vlan\&. Note: use quotes around -* -to suppress shell expansion\&. -.RE -.PP -\fBcon\-name\fR -.RS 4 -connection name (when not provided a default name is generated: [\-][\-])\&. -.RE -.PP -\fBautoconnect\fR -.RS 4 -whether the connection profile can be automatically activated (default: yes)\&. -.RE -.PP -\fBsave\fR -.RS 4 -whether the connection should be persistent, i\&.e\&. NetworkManager should store it on disk (default: -yes)\&. -.RE -.PP -\fBmaster\fR -.RS 4 -master interface name, or connection UUID or ID of master connection profile\&. The value can be prefixed with -ifname/, -uuid/ -or -id/ -to disambiguate it\&. -.RE -.PP -\fBslave\-type\fR -.RS 4 -type of master connection\&. Only required when it can not be inferred (i\&.e\&. the master connection does not exist yet)\&. -.RE -.PP -\fBtype\fR +\fBmodify\fR [\fB\-\-temporary\fR] [\fBid\fR | \fBuuid\fR | \fBpath\fR] \fIID\fR {\fIoption\fR\ \fIvalue\fR\ |\ [+|\-]\fIsetting\fR\&.\fIproperty\fR\ \fIvalue\fR}... .RS 4 -connection type; see below for allowed values\&. Note that types -\fBbond\-slave\fR, -\fBteam\-slave\fR +Add, modify or remove properties in the connection profile\&. +.sp +To set the property just specify the property name followed by the value\&. An empty value ("") removes the property value\&. +.sp +In addition to the properties, you can also use short names for some of the properties\&. Consult the +PROPERTY ALIASES +section for details\&. +.sp +If you want to append an item to the existing value, use ++ +prefix for the property name\&. If you want to remove just one item from container\-type property, use +\- +prefix for the property name and specify a value or an zero\-based index of the item to remove (or option name for properties with named options) as +\fIvalue\fR\&. The ++ and -\fBbridge\-slave\fR -create -\fBethernet\fR -connection profiles\&. Their use is discouraged in favor of using a specific type with -\fBmaster\fR -option\&. -.RE -.PP -\fBtype ethernet\fR [\fBmac\fR\ \fIaddr\fR] [\fBcloned\-mac\fR\ \fIaddr\fR] [\fBmtu\fR\ \fImtu\fR] -.RS 4 -.PP -\fBmac\fR -.RS 4 -MAC address of the device this connection is locked to\&. -.RE -.PP -\fBcloned\-mac\fR -.RS 4 -cloned MAC\&. -.RE -.PP -\fBmtu\fR -.RS 4 -MTU\&. -.RE -.RE -.PP -\fBtype wifi\fR \fBssid\fR\ \fISSID\fR [\fBmac\fR\ \fIaddr\fR] [\fBcloned\-mac\fR\ \fIaddr\fR] [\fBmode\fR\ {infrastructure\ |\ ap\ |\ adhoc}] [\fBmtu\fR\ \fImtu\fR] -.RS 4 -.PP -\fBssid\fR -.RS 4 -SSID\&. -.RE -.PP -\fBmac\fR -.RS 4 -MAC address of the device this connection is locked to\&. -.RE -.PP -\fBcloned\-mac\fR -.RS 4 -cloned MAC\&. -.RE -.PP -\fBmode\fR -.RS 4 -Wi\-Fi network mode\&. If blank, -infrastructure -is assumed\&. -.RE -.PP -\fBmtu\fR -.RS 4 -MTU\&. -.RE -.RE -.PP -\fBtype wimax\fR [\fBmac\fR\ \fIaddr\fR] [\fBnsp\fR\ \fInsp\fR] -.RS 4 -.PP -\fBmac\fR -.RS 4 -MAC address of the device this connection is locked to\&. -.RE -.PP -\fBnsp\fR -.RS 4 -Network Service Provider name\&. -.RE -.RE -.PP -\fBtype pppoe\fR \fBusername\fR\ \fIuser\fR [\fBpassword\fR\ \fIpasswd\fR] [\fBservice\fR\ \fIname\fR] [\fBmtu\fR\ \fImtu\fR] [\fBmac\fR\ \fIaddr\fR] -.RS 4 -.PP -\fBusername\fR -.RS 4 -PPPoE username\&. -.RE -.PP -\fBpassword\fR -.RS 4 -Password for the PPPoE username\&. -.RE -.PP -\fBservice\fR -.RS 4 -PPPoE service name (if required by concentrator)\&. -.RE -.PP -\fBmtu\fR -.RS 4 -MTU\&. -.RE -.PP -\fBmac\fR -.RS 4 -MAC address of the device this connection is locked to\&. -.RE -.RE -.PP -\fBtype gsm\fR [\fBapn\fR\ \fIAPN\fR] [\fBusername\fR\ \fIuser\fR] [\fBpassword\fR\ \fIpasswd\fR] -.RS 4 -.PP -\fBapn\fR -.RS 4 -APN \- GSM Access Point Name\&. -.RE -.PP -\fBuser\fR -.RS 4 -user name\&. -.RE -.PP -\fBpassword\fR -.RS 4 -password\&. -.RE -.RE -.PP -\fBtype cdma\fR [\fBusername\fR\ \fIuser\fR] [\fBpassword\fR\ \fIpasswd\fR] -.RS 4 -.PP -\fBuser\fR -.RS 4 -user name\&. -.RE -.PP -\fBpassword\fR -.RS 4 -password\&. -.RE -.RE -.PP -\fBtype infiniband\fR [\fBmac\fR\ \fIaddr\fR] [\fBmtu\fR\ \fImtu\fR] [\fBtransport\-mode\fR\ {datagram\ |\ connected}] [\fBparent\fR\ \fIdevice\fR] [\fBp\-key\fR\ \fIkey\fR] -.RS 4 -.PP -\fBmac\fR -.RS 4 -MAC address of the device this connection is locked to (InfiniBand MAC is 20 bytes)\&. -.RE -.PP -\fBmtu\fR -.RS 4 -MTU\&. -.RE -.PP -\fBtransport\-mode\fR -.RS 4 -InfiniBand transport mode\&. -.RE -.PP -\fBparent\fR -.RS 4 -the interface name of the parent device (if any)\&. -.RE -.PP -\fBp\-key\fR -.RS 4 -the InfiniBand P_Key (16\-bit unsigned integer)\&. -.RE -.RE -.PP -\fBtype bluetooth\fR [\fBaddr\fR\ \fIaddr\fR] [\fBbt\-type\fR\ {panu\ |\ dun\-gsm\ |\ dun\-cdma}] -.RS 4 -.PP -\fBaddr\fR -.RS 4 -Bluetooth device address (MAC)\&. -.RE -.PP -\fBbt\-type\fR -.RS 4 -Bluetooth connection type\&. -.RE -.RE -.PP -\fBtype vlan\fR \fBdev\fR\ \fIdevice\fR \fBid\fR\ \fIid\fR [\fBflags\fR\ \fIflags\fR] [\fBingress\fR\ \fImapping\fR] [\fBegress\fR\ \fImapping\fR] [\fBmtu\fR\ \fImtu\fR] -.RS 4 -.PP -\fBdev\fR -.RS 4 -parent device this VLAN is on\&. -.RE -.PP -\fBid\fR -.RS 4 -VLAN ID in range 0\-4095\&. -.RE -.PP -\fBflags\fR -.RS 4 -flags\&. -.RE -.PP -\fBingress\fR -.RS 4 -VLAN ingress priority mapping\&. -.RE -.PP -\fBegress\fR -.RS 4 -VLAN egress priority mapping\&. -.RE -.PP -\fBmtu\fR -.RS 4 -MTU\&. -.RE -.RE -.PP -\fBtype bond\fR [\fBmode\fR\ {active\-backup\ |\ balance\-xor\ |\ broadcast\ |\ 802\&.3ad\ |\ balance\-tlb\ |\ balance\-alb\ |\ \fInum\fR}] [\fBprimary\fR\ \fIifname\fR] [\fBmiimon\fR\ \fInum\fR] [\fBdowndelay\fR\ \fInum\fR] [\fBupdelay\fR\ \fInum\fR] [\fBarp\-interval\fR\ \fInum\fR] [\fBarp\-ip\-target\fR\ \fInum\fR] -.RS 4 -.PP -\fBmode\fR -.RS 4 -bonding mode (default: -balance\-rr)\&. -.RE -.PP -\fBprimary\fR -.RS 4 -primary interface name (for -active\-backup -mode)\&. -.RE -.PP -\fBmiimon\fR -.RS 4 -miimon (default: -100)\&. -.RE -.PP -\fBdowndelay\fR -.RS 4 -downdelay (default: -0)\&. -.RE -.PP -\fBupdelay\fR -.RS 4 -updelay (default: -0)\&. -.RE -.PP -\fBarp\-interval\fR -.RS 4 -ARP interval (default: -0)\&. -.RE -.PP -\fBarp\-ip\-target\fR -.RS 4 -ARP IP target\&. -.RE -.RE -.PP -\fBtype bond\-slave\fR [\fBmaster\fR\ \fImaster\fR] -.RS 4 -.PP -\fBmaster\fR -.RS 4 -master bond interface name, or connection UUID or ID of bond master connection profile\&. The value can be prefixed with -ifname/, -uuid/ -or -id/ -to disambiguate it\&. -.RE -.RE -.PP -\fBtype team\fR [\fBconfig\fR\ {file\ |\ \fIJSON\fR}] -.RS 4 -.PP -\fBconfig\fR -.RS 4 -JSON configuration for team\&. -.RE -.RE -.PP -\fBtype team\-slave\fR [\fBconfig\fR\ \fB\fIJSON\fR\fR] -.RS 4 -.PP -\fBmaster\fR -.RS 4 -master team interface name, or connection UUID or ID of team master connection profile\&. The value can be prefixed with -ifname/, -uuid/ -or -id/to disambiguate it\&. -.RE -.PP -\fBconfig\fR -.RS 4 -JSON configuration for team\&. -.RE -.RE -.PP -\fBtype bridge\fR [\fBstp\fR\ {yes\ |\ no}] [\fBpriority\fR\ \fInum\fR] [\fBforward\-delay\fR\ \fI2\-30\fR] [\fBhello\-time\fR\ \fI1\-10\fR] [\fBmax\-age\fR\ \fI6\-42\fR] [\fBageing\-time\fR\ \fI0\-1000000\fR] [\fBmulticast\-snooping\fR\ {yes\ |\ no}] [\fBmac\fR\ \fIaddr\fR] -.RS 4 -.PP -\fBstp\fR -.RS 4 -controls whether Spanning Tree Protocol (STP) is enabled for this bridge (default: -yes)\&. -.RE -.PP -\fBpriority\fR -.RS 4 -sets STP priority (default: -128)\&. -.RE -.PP -\fBforward\-delay\fR -.RS 4 -STP forwarding delay, in seconds (default: -15)\&. -.RE -.PP -\fBhello\-time\fR -.RS 4 -STP hello time, in seconds (default: -2)\&. -.RE -.PP -\fBmax\-age\fR -.RS 4 -STP maximum message age, in seconds (default: -20)\&. -.RE -.PP -\fBageing\-time\fR -.RS 4 -the Ethernet MAC address aging time, in seconds (default: -300)\&. -.RE -.PP -\fBmulticast\-snooping\fR -.RS 4 -controls whether IGMP snooping is enabled (default: -yes)\&. -.RE -.PP -\fBmac\fR -.RS 4 -MAC address of the bridge (note: this requires a recent kernel feature, originally introduced in 3\&.15 upstream kernel)\&. -.RE -.RE -.PP -\fBtype bridge\-slave\fR [\fBmaster\fR\ \fImaster\fR] [\fBpriority\fR\ \fInum\fR] [\fBpath\-cost\fR\ \fI1\-65535\fR] [\fBhairpin\fR\ {yes\ |\ no}] -.RS 4 -.PP -\fBmaster\fR -.RS 4 -master bridge interface name, or connection UUID or ID of bridge master connection profile\&. The value can be prefixed with -ifname/, -uuid/ +\- +modifies only have a real effect for multi\-value (container) properties like +ipv4\&.dns, +ipv4\&.addresses, +bond\&.options, etc\&. +.sp +See +\fBnm-settings\fR(5) +for complete reference of setting and property names, their descriptions and default values\&. The +\fIsetting\fR +and +\fIproperty\fR +can be abbreviated provided they are unique\&. +.sp +The connection is identified by its name, UUID or D\-Bus path\&. If +\fIID\fR +is ambiguous, a keyword +\fBid\fR, +\fBuuid\fR or -id/ -to disambiguate it\&. -.RE -.PP -\fBpriority\fR -.RS 4 -STP priority of this slave (default: -32)\&. -.RE -.PP -\fBpath\-cost\fR -.RS 4 -STP port cost for destinations via this slave (default: -100)\&. -.RE -.PP -\fBhairpin\fR -.RS 4 -\*(Aqhairpin mode\*(Aq for the slave, which allows frames to be sent back out through the slave the frame was received on (default: -yes)\&. -.RE -.RE -.PP -\fBtype vpn\fR [\fBtype\fR\ \fItype\fR] [\fBuser\fR\ \fIusername\fR] -.RS 4 -.PP -\fBvpn\-type\fR -.RS 4 -VPN type\&. -.RE -.PP -\fBuser\fR -.RS 4 -VPN username\&. -.RE -.RE -.PP -\fBtype olpc\-mesh\fR \fBssid\fR\ \fISSID\fR [\fBchannel\fR\ \fI1\-13\fR] [\fBdhcp\-anycast\fR\ \fIMAC\fR] -.RS 4 -.PP -\fBssid\fR -.RS 4 -SSID\&. -.RE -.PP -\fBchannel\fR -.RS 4 -channel to use for the network\&. -.RE -.PP -\fBdhcp\-anycast\fR -.RS 4 -anycast DHCP MAC address used when requesting an IP address via DHCP\&. -.RE -.RE -.PP -\fBtype adsl\fR \fBusername\fR\ \fIusername\fR \fBprotocol\fR\ {pppoa\ |\ pppoe\ |\ ipoatm} [\fBpassword\fR\ \fIpasswd\fR] [\fBencapsulation\fR\ {vcmux\ |\ llc}] -.RS 4 -.PP -\fBusername\fR -.RS 4 -ADSL user name\&. -.RE -.PP -\fBprotocol\fR -.RS 4 -ADSL protocol\&. +\fBpath\fR +can be used\&. .RE .PP -\fBpassword\fR +\fBadd\fR [\fBsave\fR\ {yes\ |\ no}] {\fIoption\fR\ \fIvalue\fR\ |\ [+|\-]\fIsetting\fR\&.\fIproperty\fR\ \fIvalue\fR}... .RS 4 -ADSL password\&. -.RE -.PP -\fBencapsulation\fR +Create a new connection using specified properties\&. +.sp +You need to describe the newly created connections with the property and value pairs\&. See +\fBnm-settings\fR(5) +for the complete reference\&. You can also use the aliases described in +PROPERTY ALIASES +section\&. The syntax is the same as of the +\fBnmcli connection modify\fR +command\&. +.sp +To construct a meaningful connection you at the very least need to set the +\fBconnection\&.type\fR +property (or use the +\fBtype\fR +alias) to one of known NetworkManager connection types: +.sp .RS 4 -ADSL encapsulation\&. -.RE +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +ethernet .RE -.PP -\fBtype tun\fR \fBmode\fR\ {tun\ |\ tap} [\fBowner\fR\ \fIUID\fR] [\fBgroup\fR\ \fIGID\fR] [\fBpi\fR\ {yes\ |\ no}] [\fBvnet\-hdr\fR\ {yes\ |\ no}] [\fBmulti\-queue\fR\ {yes\ |\ no}] -.RS 4 -.PP -\fBmode\fR +.sp .RS 4 -Mode for the device\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +wifi .RE -.PP -\fBowner\fR +.sp .RS 4 -UID of the owner\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +wimax .RE -.PP -\fBgroup\fR +.sp .RS 4 -GID of the group\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +pppoe .RE -.PP -\fBpi\fR +.sp .RS 4 -include packet information (~IFF_NO_PI flag)\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +gsm .RE -.PP -\fBvnet\-hdr\fR +.sp .RS 4 -send and receive large (i\&.e\&. GSO) packets and packets with partial checksums (IFF_VNET_HDR flag)\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +cdma .RE -.PP -\fBmulti\-queue\fR +.sp .RS 4 -multi\-queue support for tun/tap device (IFF_MULTI_QUEUE flag)\&. -.RE +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +infiniband .RE -.PP -\fBtype ip\-tunnel\fR \fBmode\fR\ {ipip\ |\ gre\ |\ sit\ |\ isatap\ |\ vti\ |\ ip6ip6\ |\ ipip6\ |\ ip6gre\ |\ vti6\ |\ tun} \fBremote\fR\ \fIaddr\fR [\fBlocal\fR\ \fIaddr\fR] [\fBdev\fR\ \fIdevice\fR] -.RS 4 -.PP -\fBmode\fR +.sp .RS 4 -tunnel mode\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +bluetooth .RE -.PP -\fBremote\fR +.sp .RS 4 -IPv4 or IPv6 address of the remote tunnel endpoint\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +vlan .RE -.PP -\fBlocal\fR +.sp .RS 4 -IPv4 or IPv6 address of the local tunnel endpoint\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +bond .RE -.PP -\fBdev\fR +.sp .RS 4 -device to use for tunnel endpoint communication\&. -.RE +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +bond\-slave .RE -.PP -\fBtype macvlan\fR \fBdev\fR\ \fIdevice\fR \fBmode\fR\ {vepa\ |\ bridge\ |\ private\ |\ passthru\ |\ source} [\fBtap\fR\ {yes\ |\ no}] -.RS 4 -.PP -\fBdev\fR +.sp .RS 4 -parent device this MACVLAN is on\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +team .RE -.PP -\fBmode\fR +.sp .RS 4 -MACVLAN mode, which specifies the communication mechanism between multiple MACVLANs on the same lower device\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +team\-slave .RE -.PP -\fBtap\fR +.sp .RS 4 -controls the device type\&. If set to \*(Aqyes\*(Aq a MACVTAP will be created (default: -no)\&. -.RE +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +bridge .RE -.PP -\fBtype vxlan\fR \fBid\fR\ \fIid\fR \fBremote\fR\ \fIaddr\fR [\fBdev\fR\ \fIparent\ device\ (ifname\ or\ connection\ UUID)\fR] [\fBlocal\fR\ \fIaddr\fR] [\fBsource\-port\-min\fR\ \fI0\-65535\fR] [\fBsource\-port\-max\fR\ \fI0\-65535\fR] [\fBdestination\-port\fR\ \fI0\-65535\fR] -.RS 4 -.PP -\fBid\fR +.sp .RS 4 -VXLAN Network Identifer to use\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +bridge\-slave .RE -.PP -\fBremote\fR +.sp .RS 4 -unicast destination IP address or multicast IP address to join\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +vpn .RE -.PP -\fBdev\fR +.sp .RS 4 -device to use for tunnel endpoint communication\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +olpc\-mesh .RE -.PP -\fBlocal\fR +.sp .RS 4 -source IP address\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +adsl .RE -.PP -\fBsource\-port\-min\fR +.sp .RS 4 -minimum UDP source port to communicate to the remote VXLAN tunnel endpoint\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +tun .RE -.PP -\fBsource\-port\-max\fR +.sp .RS 4 -maximum UDP source port to communicate to the remote VXLAN tunnel endpoint\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +ip\-tunnel .RE -.PP -\fBdestination\-port\fR +.sp .RS 4 -UDP destination port to communicate to the remote VXLAN tunnel endpoint\&. -.RE +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +macvlan .RE -.PP -\fBip4\fR, \fBgw4\fR +.sp .RS 4 -IPv4 addresses\&. +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +vxlan .RE +.sp +The most typical uses are described in the +EXAMPLES +section\&. +.sp +Aside from the properties and values two special options are accepted: .PP -\fBip6\fR, \fBgw6\fR +\fBsave\fR .RS 4 -IPv6 addresses\&. +Controls whether the connection should be persistent, i\&.e\&. NetworkManager should store it on disk (default: +yes)\&. .RE .PP \fB\-\-\fR .RS 4 -If a +If a single \fB\-\-\fR -argument is encountered, the rest of command line is interpreted as property list in the same format as -\fBconnection modify\fR -command accepts\&. This makes it possible to adjust the connection properties before it\*(Aqs added\&. +argument is encountered it is ignored\&. This is for compatibility with older versions on +\fBnmcli\fR\&. .RE .RE .PP -\fBedit\fR {[\fBid\fR\ |\ \fBuuid\fR\ |\ \fBpath\fR]\ \fIID\fR... | [\fBtype\fR\ \fItype\fR]\ [\fBcon\-name\fR\ \fIname\fR] } +\fBedit\fR {[\fBid\fR\ |\ \fBuuid\fR\ |\ \fBpath\fR]\ \fIID\fR | [\fBtype\fR\ \fItype\fR]\ [\fBcon\-name\fR\ \fIname\fR] } .RS 4 Edit an existing connection or add a new one, using an interactive editor\&. .sp @@ -1228,43 +937,7 @@ for all NetworkManager settings and property names, and their descriptions; and for sample editor sessions\&. .RE .PP -\fBmodify\fR [\fB\-\-temporary\fR] [\fBid\fR | \fBuuid\fR | \fBpath\fR] \fIID\fR [+|\-]\fIsetting\fR\&.\fIproperty\fR\ \fIvalue\fR... -.RS 4 -Modify one or more properties in the connection profile\&. -.sp -The connection is identified by its name, UUID or D\-Bus path\&. If -\fIID\fR -is ambiguous, a keyword -\fBid\fR, -\fBuuid\fR -or -\fBpath\fR -can be used\&. See -\fBnm-settings\fR(5) -for setting and property names, their descriptions and default values\&. This command supports abbreviations for -\fIsetting\fR -and -\fIproperty\fR -provided they are unique\&. Empty -\fIvalue\fR -("") removes the property value (sets the property to the default value)\&. The provided value overwrites the existing property value\&. -.sp -If you want to append an item to the existing value, use -+ -prefix for the property name\&. If you want to remove just one item from container\-type property, use -\- -prefix for the property name and specify a value or an zero\-based index of the item to remove (or option name for properties with named options) as -\fIvalue\fR\&. Of course, -+ -and -\- -only have a real effect for multi\-value (container) properties like -ipv4\&.dns, -ipv4\&.addresses, -bond\&.options, etc\&. -.RE -.PP -\fBclone\fR [\fB\-\-temporary\fR] [\fBid\fR | \fBuuid\fR | \fBpath\fR] \fIID\fR... \fBnew\fR\ \fIname\fR +\fBclone\fR [\fB\-\-temporary\fR] [\fBid\fR | \fBuuid\fR | \fBpath\fR] \fIID\fR \fInew_name\fR .RS 4 Clone a connection\&. The connection to be cloned is identified by its name, UUID or D\-Bus path\&. If \fIID\fR @@ -1277,8 +950,8 @@ can be used\&. See \fBconnection show\fR above for the description of the \fIID\fR\-specifying keywords\&. -\fIname\fR -is the name of the new cloned connection\&. The new connection will be the exact copy except the connection\&.id (\fIname\fR) and connection\&.uuid (generated) properties\&. +\fInew_name\fR +is the name of the new cloned connection\&. The new connection will be the exact copy except the connection\&.id (\fInew_name\fR) and connection\&.uuid (generated) properties\&. .sp The new connection profile will be saved as persistent unless \fB\-\-temporary\fR @@ -1334,7 +1007,7 @@ Reload all connection files from disk\&. NetworkManager does not monitor changes Load/reload one or more connection files from disk\&. Use this after manually editing a connection file to ensure that NetworkManager is aware of its latest state\&. .RE .PP -\fBimport\fR [\fB\-\-temporary\fR] [\fBtype\fR\ \fItype\fR] [\fBfile\fR\ \fIfile\fR] +\fBimport\fR [\fB\-\-temporary\fR] \fBtype\fR\ \fItype\fR \fBfile\fR\ \fIfile\fR .RS 4 Import an external/foreign configuration as a NetworkManager connection profile\&. The type of the input file is specified by \fBtype\fR @@ -1366,7 +1039,7 @@ is provided, the VPN configuration data will be printed to standard output\&. .RE .SH "DEVICE MANAGEMENT COMMANDS" .HP \w'\fBnmcli\ device\fR\ 'u -\fBnmcli device\fR {\fBstatus\fR | \fBshow\fR | \fBset\fR | \fBconnect\fR | \fBreapply\fR | \fBdisconnect\fR | \fBdelete\fR | \fBmonitor\fR | \fBwifi\fR | \fBlldp\fR} [\fIARGUMENTS\fR...] +\fBnmcli device\fR {\fBstatus\fR | \fBshow\fR | \fBset\fR | \fBconnect\fR | \fBreapply\fR | \fBmodify\fR | \fBdisconnect\fR | \fBdelete\fR | \fBmonitor\fR | \fBwifi\fR | \fBlldp\fR} [\fIARGUMENTS\fR...] .PP Show and manage network interfaces\&. .PP @@ -1388,7 +1061,7 @@ Show detailed information about devices\&. Without an argument, all devices are Set device properties\&. .RE .PP -\fBconnect\fR [\fIifname\fR] +\fBconnect\fR \fIifname\fR .RS 4 Connect the device\&. NetworkManager will try to find a suitable connection that will be activated\&. It will also consider connections that are not set to auto connect\&. .sp @@ -1397,12 +1070,29 @@ If option is not specified, the default timeout will be 90 seconds\&. .RE .PP -\fBreapply\fR [\fIifname\fR] +\fBreapply\fR \fIifname\fR .RS 4 Attempt to update device with changes to the currently active connection made since it was last applied\&. .RE .PP -\fBdisconnect\fR [\fIifname\fR...] +\fBmodify\fR \fIifname\fR {\fIoption\fR\ \fIvalue\fR\ |\ [+|\-]\fIsetting\fR\&.\fIproperty\fR\ \fIvalue\fR}... +.RS 4 +Modify the settings currently active on the device\&. +.sp +This command lets you do temporary changes to a configuration active on a particular device\&. The changes are not preserved in the connection profile\&. +.sp +See +\fBnm-settings\fR(5) +for the list of available properties\&. Please note that some properties can\*(Aqt be changed on an already connected device\&. +.sp +You can also use the aliases described in +PROPERTY ALIASES +section\&. The syntax is the same as of the +\fBnmcli connection modify\fR +command\&. +.RE +.PP +\fBdisconnect\fR \fIifname\fR... .RS 4 Disconnect a device and prevent the device from automatically activating further connections without user/manual intervention\&. Note that disconnecting software devices may mean that the devices will disappear\&. .sp @@ -1411,7 +1101,7 @@ If option is not specified, the default timeout will be 10 seconds\&. .RE .PP -\fBdelete\fR [\fIifname\fR...] +\fBdelete\fR \fIifname\fR... .RS 4 Delete a device\&. The command removes the interface from the system\&. Note that this only works for software devices like bonds, bridges, teams, etc\&. Hardware devices (like Ethernet) cannot be deleted by the command\&. .sp @@ -1592,6 +1282,987 @@ Runs \fBnmcli\fR as both NetworkManager secret and a polkit agent\&. .RE +.SH "PROPERTY ALIASES" +.PP +Apart from the property\-value pairs, +\fBconnection add\fR, +\fBconnection modify\fR +and +\fBdevice modify\fR +also accept short forms of some properties\&. They exist for convenience and compatiblity with older versions of +\fBnmcli\fR +that could not accept the raw properties\&. +.PP +The overview of the aliases is below\&. An actual connection type is used to disambiguate these options from the options of the same name that are valid for multiple connection types (such as +\fBmtu\fR)\&. +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&1.\ \&Options for all connections +.TS +allbox tab(:); +lB lB lB. +T{ +Alias +T}:T{ +Property +T}:T{ +Note +T} +.T& +l l lt +l l lt +l l l +l l lt +l l lt +l l l. +T{ +type +T}:T{ +connection.type +T}:T{ +This option also accepts values of \fBbond\-slave\fR, +\fBteam\-slave\fR and \fBbridge\-slave\fR\&. They create +\fBethernet\fR connection profiles\&. Their use is discouraged in +favor of using a specific type with \fBmaster\fR option\&. +T} +T{ +con\-name +T}:T{ +connection.id +T}:T{ +When not provided a default name is generated: [\-][\-])\&. +T} +T{ +autoconnect +T}:T{ +connection.autoconnect +T}:T{ +\ \& +T} +T{ +ifname +T}:T{ +connection.interface-name +T}:T{ +A value of * will be interpreted as +no value, making the connection profile interface\-independent\&. +Note: use quotes around * to suppress shell expansion\&. +For bond, team and bridge connections a default name will be generated if not set\&. +T} +T{ +master +T}:T{ +connection.master +T}:T{ +Value specified here will be canonicalized\&. +It can be prefixed with ifname/, uuid/ +or id/ to disambiguate it\&. +T} +T{ +slave\-type +T}:T{ +connection.slave-type +T}:T{ +\ \& +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&2.\ \&PPPoE options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l +l l. +T{ +username +T}:T{ +pppoe.username +T} +T{ +password +T}:T{ +pppoe.password +T} +T{ +service +T}:T{ +pppoe.service +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&3.\ \&Wired Ethernet options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l +l l. +T{ +mtu +T}:T{ +wired.mtu +T} +T{ +mac +T}:T{ +wired.mac-address +T} +T{ +cloned\-mac +T}:T{ +wired.cloned-mac-address +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&4.\ \&Infiniband options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l +l l +l l +l l. +T{ +mtu +T}:T{ +infiniband.mtu +T} +T{ +mac +T}:T{ +infiniband.mac-address +T} +T{ +transport\-mode +T}:T{ +infiniband.transport-mode +T} +T{ +parent +T}:T{ +infiniband.parent +T} +T{ +p\-key +T}:T{ +infiniband.p-key +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&5.\ \&Wi-Fi options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l +l l +l l +l l. +T{ +ssid +T}:T{ +wireless.ssid +T} +T{ +mode +T}:T{ +wireless.mode +T} +T{ +mtu +T}:T{ +wireless.mtu +T} +T{ +mac +T}:T{ +wireless.mac-address +T} +T{ +cloned\-mac +T}:T{ +wireless.cloned-mac-address +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&6.\ \&WiMax options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l. +T{ +nsp +T}:T{ +wimax.network-name +T} +T{ +mac +T}:T{ +wimax.mac-address +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&7.\ \&GSM options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l +l l. +T{ +apn +T}:T{ +gsm.apn +T} +T{ +user +T}:T{ +gsm.username +T} +T{ +password +T}:T{ +gsm.password +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&8.\ \&CDMA options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l. +T{ +user +T}:T{ +cdma.username +T} +T{ +password +T}:T{ +cdma.password +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&9.\ \&Bluetooth options +.TS +allbox tab(:); +lB lB lB. +T{ +Alias +T}:T{ +Property +T}:T{ +Note +T} +.T& +l l l +l l lt. +T{ +addr +T}:T{ +bluetooth.bdaddr +T}:T{ +\ \& +T} +T{ +bt\-type +T}:T{ +bluetooth.type +T}:T{ +Apart from the usual dun and +panu options, the values of dun\-gsm +and dun\-cdma can be used for compatibility with older +versions\&. They are equivalent to using dun and setting +appropriate gsm\&.* or cdma\&.* properties\&. +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&10.\ \&VLAN options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l +l l +l l +l l. +T{ +dev +T}:T{ +vlan.parent +T} +T{ +id +T}:T{ +vlan.id +T} +T{ +flags +T}:T{ +vlan.flags +T} +T{ +ingress +T}:T{ +vlan.ingress-priority-map +T} +T{ +egress +T}:T{ +vlan.egress-priority-map +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&11.\ \&Bonding options +.TS +allbox tab(:); +lB lB lB. +T{ +Alias +T}:T{ +Property +T}:T{ +Note +T} +.T& +l l lt +l ^ ^ +l ^ ^ +l ^ ^ +l ^ ^ +l ^ ^ +l ^ ^ +l ^ ^. +T{ +mode +T}:T{ +bond\&.options +T}:T{ +Setting each of these adds the option to bond\&.options property\&. +It\*(Aqs equivalent of using the +bond\&.options \*(Aqoption=value\*(Aq syntax\&. +T} +T{ +primary +T}:: +T{ +miimon +T}:: +T{ +downdelay +T}:: +T{ +updelay +T}:: +T{ +arp\-interval +T}:: +T{ +arp\-ip\-target +T}:: +T{ +lacp\-rate +T}:: +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&12.\ \&Team options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l. +T{ +config +T}:T{ +team.config +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&13.\ \&Team port options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l. +T{ +config +T}:T{ +team-port.config +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&14.\ \&Bridge options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l +l l. +T{ +stp +T}:T{ +bridge.stp +T} +T{ +priority +T}:T{ +bridge.priority +T} +T{ +forward\-delay +T}:T{ +bridge.forward-delay +T} +T{ +hello\-time +T}:T{ +bridge.hello-time +T} +T{ +max\-age +T}:T{ +bridge.max-age +T} +T{ +ageing\-time +T}:T{ +bridge.ageing-time +T} +T{ +multicast\-snooping +T}:T{ +bridge.multicast-snooping +T} +T{ +mac +T}:T{ +bridge.mac-address +T} +T{ +priority +T}:T{ +bridge-port.priority +T} +T{ +path\-cost +T}:T{ +bridge-port.path-cost +T} +T{ +hairpin +T}:T{ +bridge-port.hairpin-mode +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&15.\ \&VPN options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l. +T{ +vpn\-type +T}:T{ +vpn.service-type +T} +T{ +user +T}:T{ +vpn.user-name +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&16.\ \&OLPC Mesh options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l +l l. +T{ +ssid +T}:T{ +olpc-mesh.ssid +T} +T{ +channel +T}:T{ +olpc-mesh.channel +T} +T{ +dhcp\-anycast +T}:T{ +olpc-mesh.dhcp-anycast-address +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&17.\ \&ADSL options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l +l l +l l. +T{ +username +T}:T{ +adsl.username +T} +T{ +protocol +T}:T{ +adsl.protocol +T} +T{ +password +T}:T{ +adsl.password +T} +T{ +encapsulation +T}:T{ +adsl.encapsulation +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&18.\ \&MACVLAN options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l +l l. +T{ +dev +T}:T{ +macvlan.parent +T} +T{ +mode +T}:T{ +macvlan.mode +T} +T{ +tap +T}:T{ +macvlan.tap +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&19.\ \&VxLAN options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l +l l +l l +l l +l l +l l. +T{ +id +T}:T{ +vxlan.id +T} +T{ +remote +T}:T{ +vxlan.remote +T} +T{ +dev +T}:T{ +vxlan.parent +T} +T{ +local +T}:T{ +vxlan.local +T} +T{ +source\-port\-min +T}:T{ +vxlan.source-port-min +T} +T{ +source\-port\-max +T}:T{ +vxlan.source-port-max +T} +T{ +destination\-port +T}:T{ +vxlan.destination-port +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&20.\ \&Tun options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l +l l +l l +l l +l l. +T{ +mode +T}:T{ +tun.mode +T} +T{ +owner +T}:T{ +tun.owner +T} +T{ +group +T}:T{ +tun.group +T} +T{ +pi +T}:T{ +tun.pi +T} +T{ +vnet\-hdr +T}:T{ +tun.vnet-hdr +T} +T{ +multi\-queue +T}:T{ +tun.multi-queue +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&21.\ \&IP tunneling options +.TS +allbox tab(:); +lB lB. +T{ +Alias +T}:T{ +Property +T} +.T& +l l +l l +l l +l l. +T{ +mode +T}:T{ +ip-tunnel.mode +T} +T{ +local +T}:T{ +ip-tunnel.local +T} +T{ +remote +T}:T{ +ip-tunnel.remote +T} +T{ +dev +T}:T{ +ip-tunnel.parent +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&22.\ \&IPv4 options +.TS +allbox tab(:); +lB lB lB. +T{ +Alias +T}:T{ +Property +T}:T{ +Note +T} +.T& +l l lt +l l l. +T{ +ip4 +T}:T{ +ipv4.addresses +T}:T{ +This option can be specified multiple times\&. +It\*(Aqs equivalent of using +ipv4\&.addresses syntax\&. +T} +T{ +gw4 +T}:T{ +ipv4.gateway +T}:T{ +\ \& +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&23.\ \&IPv6 options +.TS +allbox tab(:); +lB lB lB. +T{ +Alias +T}:T{ +Property +T}:T{ +Note +T} +.T& +l l lt +l l l. +T{ +ip6 +T}:T{ +ipv6.addresses +T}:T{ +This option can be specified multiple times\&. +It\*(Aqs equivalent of using +ipv6\&.addresses syntax\&. +T} +T{ +gw6 +T}:T{ +ipv6.gateway +T}:T{ +\ \& +T} +.TE +.sp 1 .SH "ENVIRONMENT VARIABLES" .PP \fBnmcli\fR\*(Aqs behavior is affected by the following environment variables\&. @@ -1692,6 +2363,13 @@ NetworkManager is not running\&. .RS 4 Connection, device, or access point does not exist\&. .RE +.PP +\fB65\fR +.RS 4 +When used with +\fB\-\-complete\-args\fR +option, a file name is expected to follow\&. +.RE .SH "EXAMPLES" .PP This section presents various examples of @@ -1806,6 +2484,16 @@ so that the existing connection profile can be used and no additional is created creates a hotspot profile and connects it\&. Prints the hotspot password the user should use to connect to the hotspot from other devices\&. .RE .PP +\fBnmcli dev modify em1 ipv4\&.method shared\fR +.RS 4 +starts IPv4 connection sharing using em1 device\&. The sharing will be active until the device is disconnected\&. +.RE +.PP +\fBnmcli dev modify em1 ipv6\&.address 2001:db8::a:bad:c0de\fR +.RS 4 +temporarily adds an IP address to a device\&. The address will be removed when the same connection is activated again\&. +.RE +.PP \fBnmcli connection add type ethernet autoconnect no ifname eth0\fR .RS 4 non\-interactively adds an Ethernet connection tied to eth0 interface with automatic IP configuration (DHCP), and disables the connection\*(Aqs @@ -1818,7 +2506,7 @@ flag\&. non\-interactively adds a VLAN connection with ID 55\&. The connection will use eth0 and the VLAN interface will be named Maxipes\-fik\&. .RE .PP -\fBnmcli c a ifname eth0 type ethernet \-\- ipv4\&.method disabled ipv6\&.method link\-local\fR +\fBnmcli c a ifname eth0 type ethernet ipv4\&.method disabled ipv6\&.method link\-local\fR .RS 4 non\-interactively adds a connection that will use eth0 Ethernet interface and only have an IPv6 link\-local address configured\&. .RE diff --git a/man/nmcli.xml b/man/nmcli.xml index ee5a4495..5a936335 100644 --- a/man/nmcli.xml +++ b/man/nmcli.xml @@ -78,7 +78,7 @@ terse output format which is better suited for script processing. Note that NetworkManager can also execute scripts, called "dispatcher scripts", in response to network events. See - NetworkManager8 + NetworkManager8 for details about these dispatcher scripts. @@ -191,7 +191,7 @@ - field + field1,field2 all common @@ -258,13 +258,11 @@ - - - - - - seconds - + + + + seconds + This option sets a timeout period for which nmcli will @@ -278,6 +276,23 @@ + + + + + + + Instead of conducting the desired action, nmcli + will list possible completions for the last argument. This is useful to implement + argument completion in shell. + + The exit status will indicate success + or return a code 65 to indicate the last argument is a file name. + + NetworkManager ships with command completion support for GNU Bash. + + + @@ -363,7 +378,7 @@ logging level - domains + domains @@ -371,7 +386,7 @@ domains. Without any argument current logging level and domains are shown. In order to change logging state, provide and, or, parameters. See - NetworkManager.conf5 + NetworkManager.conf5 for available level and domain values. @@ -544,13 +559,16 @@ show up down + modify add edit - modify + clone delete monitor reload load + import + export ARGUMENTS @@ -699,7 +717,7 @@ - ID + ID ifname BSSID file @@ -811,1156 +829,122 @@ - add - ifname - con-name name - - - - yes - no - - - - + modify + + + + + + + ID + - yes - no + option value + [+|-]setting.property value - master master - slave-type type - type type - ARGUMENTS - ip4 addr - gw4 addr - ip6 addr - gw6 addr - - - - [+|-]setting.property - value - - - Add a connection for NetworkManager. Arguments differ according to connection types, see below. - - + Add, modify or remove properties in the connection profile. - - - - interface to bind the connection to. The connection will only be - applicable to this interface name. A special value of * - can be used for interface-independent connections. The - argument is mandatory for all connection types - except bond, team, bridge and vlan. Note: use quotes around - * to suppress shell expansion. - - + To set the property just specify the property name followed by the + value. An empty value ("") removes the property value. - - - - connection name (when not provided a default name is generated: - <type>[-<ifname>][-<num>]). - - + In addition to the properties, you can also use short names for some of + the properties. Consult the + section for details. - - - - whether the connection profile can be automatically activated (default: - yes). - - - - - - - whether the connection should be persistent, i.e. NetworkManager should - store it on disk (default: yes). - - - - - - - master interface name, or connection UUID or ID of master connection - profile. The value can be prefixed with ifname/, - uuid/ or id/ to disambiguate it. - - - - - - - type of master connection. Only required when it can not be inferred - (i.e. the master connection does - not exist yet). - - - - - - - connection type; see below for allowed values. Note that types - , and - create connection - profiles. Their use is discouraged in favor of using a specific type with - option. - - - - - - - addr - addr - mtu - - - - - - - MAC address of the device this connection is locked to. - - - - - - - cloned MAC. - - - - - - - MTU. - - - - - - - - - - SSID - addr - addr - - - - infrastructure - ap - adhoc - - - mtu - - - - - - - SSID. - - - - - - - MAC address of the device this connection is locked to. - - - - - - - cloned MAC. - - - - - - - Wi-Fi network mode. If blank, infrastructure - is assumed. - - - - - - - MTU. - - - - - - - - - - addr - nsp - - - - - - - MAC address of the device this connection is locked to. - - - - - - - Network Service Provider name. - - - - - - - - - - user - passwd - name - mtu - addr - - - - - - - PPPoE username. - - - - - - - Password for the PPPoE username. - - - - - - - PPPoE service name (if required by concentrator). - - - - - - - MTU. - - - - - - - MAC address of the device this connection is locked to. - - - - - - - - - - APN - user - passwd - - - - - - - APN - GSM Access Point Name. - - - - - - - user name. - - - - - - - password. - - - - - - - - - - user - passwd - - - - - - - user name. - - - - - - - password. - - - - - - - - - - addr - mtu - - - - datagram - connected - - - device - key - - - - - - - MAC address of the device this connection is locked to - (InfiniBand MAC is 20 bytes). - - - - - - - MTU. - - - - - - - InfiniBand transport mode. - - - - - - - the interface name of the parent device (if any). - - - - - - - the InfiniBand P_Key (16-bit unsigned integer). - - - - - - - - - - addr - - - - panu - dun-gsm - dun-cdma - - - - - - - - - Bluetooth device address (MAC). - - - - - - - Bluetooth connection type. - - - - - - - - - - device - id - flags - mapping - mapping - mtu - - - - - - - parent device this VLAN is on. - - - - - - - VLAN ID in range 0-4095. - - - - - - - flags. - - - - - - - VLAN ingress priority mapping. - - - - - - - VLAN egress priority mapping. - - - - - - - MTU. - - - - - - - - - - - - - active-backup - balance-xor - broadcast - 802.3ad - balance-tlb - balance-alb - num - - - ifname - num - num - num - num - num - - - - - - - - bonding mode (default: balance-rr). - - - - - - - primary interface name (for active-backup mode). - - - - - - - miimon (default: 100). - - - - - - - downdelay (default: 0). - - - - - - - updelay (default: 0). - - - - - - - ARP interval (default: 0). - - - - - - - ARP IP target. - - - - - - - - - - master - - - - - - - master bond interface name, or connection UUID or - ID of bond master connection profile. The value can be - prefixed with ifname/, - uuid/ or id/ to - disambiguate it. - - - - - - - - - - - - - file - JSON - - - - - - - - - - JSON configuration for team. - - - - - - - - - - - - - - - - - - - - master team interface name, or connection UUID or - ID of team master connection profile. The value can be - prefixed with ifname/, - uuid/ or id/to - disambiguate it. - - - - - - - JSON configuration for team. - - - - - - - - - - - - - yes - no - - - num - 2-30 - 1-10 - 6-42 - 0-1000000 - - - - yes - no - - - addr - - - - - - - controls whether Spanning Tree Protocol (STP) is enabled for this bridge - (default: yes). - - - - - - - sets STP priority (default: 128). - - - - - - - STP forwarding delay, in seconds (default: 15). - - - - - - - STP hello time, in seconds (default: 2). - - - - - - - STP maximum message age, in seconds (default: 20). - - - - - - - the Ethernet MAC address aging time, in seconds (default: 300). - - - - - - - controls whether IGMP snooping is enabled (default: yes). - - - - - - - MAC address of the bridge (note: this requires a recent kernel feature, - originally introduced in 3.15 upstream kernel). - - - - - - - - - - master - num - 1-65535 - - - - yes - no - - - - - - - - - master bridge interface name, or connection UUID - or ID of bridge master connection profile. The value - can be prefixed with ifname/, - uuid/ or id/ - to disambiguate it. - - - - - - - STP priority of this slave (default: 32). - - - - - - - STP port cost for destinations via this slave (default: 100). - - - - - - - 'hairpin mode' for the slave, which allows frames to be sent back out - through the slave the frame was received on (default: yes). - - - - - - - - - - type - username - - - - - - - VPN type. - - - - - - - VPN username. - - - - - + If you want to append an item to the existing value, use + + prefix for the property name. If you want to remove just + one item from container-type property, use - prefix for + the property name and specify a value or an zero-based index of the item to + remove (or option name for properties with named options) as + value. The + and - + modifies only have a real effect for multi-value (container) + properties like ipv4.dns, ipv4.addresses, + bond.options, etc. - - - - SSID - 1-13 - MAC - - - - - - - SSID. - - - - - - - channel to use for the network. - - - - - - - anycast DHCP MAC address used when requesting an IP address via DHCP. - - - - - + See nm-settings5 + for complete reference of setting and property names, their descriptions + and default values. The setting and + property can be abbreviated provided they are unique. - - - - username - - - - pppoa - pppoe - ipoatm - - - passwd - - - - vcmux - llc - - - - - - - - - ADSL user name. - - - - - - - ADSL protocol. - - - - - - - ADSL password. - - - - - - - ADSL encapsulation. - - - - - + The connection is identified by its name, UUID or D-Bus path. If + ID is ambiguous, a keyword , + or can be used. + + - - - - - - - tun - tap - - - UID - GID - - - - yes - no - - - - - - yes - no - - - - - - yes - no - - - - - - - - - Mode for the device. - - - - - - - UID of the owner. - - - - - - - GID of the group. - - - - - - - include packet information (~IFF_NO_PI flag). - - - - - - - send and receive large (i.e. GSO) packets and packets with partial - checksums (IFF_VNET_HDR flag). - - - - - - - multi-queue support for tun/tap device (IFF_MULTI_QUEUE flag). - - - - - - - - - - - - ipip - gre - sit - isatap - vti - ip6ip6 - ipip6 - ip6gre - vti6 - tun - - - addr - addr - device - - - - - - - tunnel mode. - - - - - - - IPv4 or IPv6 address of the remote tunnel endpoint. - - - - - - - IPv4 or IPv6 address of the local tunnel endpoint. - - - - - - - device to use for tunnel endpoint communication. - - - - - + + + add + yesno + + + option value + [+|-]setting.property value + + + - - - - device - - - - vepa - bridge - private - passthru - source - - - - - - yes - no - - - - - - - - - parent device this MACVLAN is on. - - - - - - - MACVLAN mode, which specifies the communication mechanism between - multiple MACVLANs on the same lower device. - - - - - - - controls the device type. If set to 'yes' a MACVTAP will be created - (default: no). - - - - - + + Create a new connection using specified properties. + + You need to describe the newly created connections with the property and value pairs. + See nm-settings5 + for the complete reference. You can also use the aliases described in + section. The syntax is + the same as of the nmcli connection modify command. + + To construct a meaningful connection you at the very least need to set the + property (or use the alias) + to one of known NetworkManager connection types: + + + ethernet + wifi + wimax + pppoe + gsm + cdma + infiniband + bluetooth + vlan + bond + bond-slave + team + team-slave + bridge + bridge-slave + vpn + olpc-mesh + adsl + tun + ip-tunnel + macvlan + vxlan + - - - - id - addr - parent device (ifname or connection UUID) - addr - 0-65535 - 0-65535 - 0-65535 - - - - - - - VXLAN Network Identifer to use. - - - - - - - unicast destination IP address or multicast IP address to join. - - - - - - - device to use for tunnel endpoint communication. - - - - - - - source IP address. - - - - - - - minimum UDP source port to communicate to the remote VXLAN tunnel endpoint. - - - - - - - maximum UDP source port to communicate to the remote VXLAN tunnel endpoint. - - - - - - - UDP destination port to communicate to the remote VXLAN tunnel endpoint. - - - - - + The most typical uses are described in the section. - - - - - IPv4 addresses. - - + Aside from the properties and values two special options are accepted: + - - + - IPv6 addresses. + Controls whether the connection should be persistent, i.e. NetworkManager should + store it on disk (default: yes). - If a argument is encountered, the rest of command - line is interpreted as property list in the same format as connection - modify command accepts. This makes it possible to adjust the - connection properties before it's added. + If a single argument is encountered it is ignored. + This is for compatibility with older versions on nmcli. @@ -1977,7 +961,7 @@ - ID + ID type @@ -2023,53 +1007,11 @@ nm-settings5 for all NetworkManager settings and property names, and their descriptions; and - nmcli-examples7 + nmcli-examples7 for sample editor sessions. - - - modify - - - - - - - ID - - [+|-]setting.property - value - - - - - Modify one or more properties in the connection profile. - - The connection is identified by its name, UUID or D-Bus path. If - ID is ambiguous, a keyword , - or can be used. See - nm-settings5 - for setting and property names, their descriptions and default - values. This command supports abbreviations for setting - and property provided they are unique. Empty - value ("") removes the property value (sets - the property to the default value). The provided value overwrites the existing - property value. - - If you want to append an item to the existing value, use - + prefix for the property name. If you want to remove just - one item from container-type property, use - prefix for - the property name and specify a value or an zero-based index of the item to - remove (or option name for properties with named options) as - value. Of course, + and - - only have a real effect for multi-value (container) - properties like ipv4.dns, ipv4.addresses, - bond.options, etc. - - - clone @@ -2079,8 +1021,8 @@ - ID - name + ID + new_name @@ -2088,9 +1030,9 @@ name, UUID or D-Bus path. If ID is ambiguous, a keyword , or can be used. See connection show above for the description - of the ID-specifying keywords. name is + of the ID-specifying keywords. new_name is the name of the new cloned connection. The new connection will be the exact - copy except the connection.id (name) and + copy except the connection.id (new_name) and connection.uuid (generated) properties. The new connection profile will be saved as persistent unless @@ -2161,7 +1103,7 @@ disk when a change was made to them. However, the auto-loading feature can be enabled and then NetworkManager will reload connection files any time they change (monitor-connection-files=true in - NetworkManager.conf5). + NetworkManager.conf5). @@ -2183,8 +1125,8 @@ import - type - file + type + file @@ -2239,6 +1181,7 @@ set connect reapply + modify disconnect delete monitor @@ -2305,7 +1248,7 @@ connect - ifname + ifname @@ -2321,7 +1264,7 @@ reapply - ifname + ifname @@ -2330,10 +1273,38 @@ + + + modify + ifname + + + option value + [+|-]setting.property value + + + + + + Modify the settings currently active on the device. + + This command lets you do temporary changes to a configuration active on + a particular device. The changes are not preserved in the connection profile. + + See nm-settings5 + for the list of available properties. Please note that some + properties can't be changed on an already connected device. + + You can also use the aliases described in + section. The syntax is + the same as of the nmcli connection modify command. + + + disconnect - ifname + ifname @@ -2350,7 +1321,7 @@ delete - ifname + ifname @@ -2673,6 +1644,343 @@ + Property Aliases + + Apart from the property-value pairs, connection add, + connection modify and device modify also + accept short forms of some properties. They exist for convenience and compatiblity + with older versions of nmcli that could not accept the raw + properties. + + The overview of the aliases is below. An actual connection type is used to + disambiguate these options from the options of the same name that are valid for + multiple connection types (such as ). + + Options for all connections + + AliasPropertyNote + + + + type + connection.type + This option also accepts values of , + and . They create + connection profiles. Their use is discouraged in +favor of using a specific type with option. + + + con-name + connection.id + When not provided a default name is generated: <type>[-<ifname>][-<num>]). + + autoconnectconnection.autoconnect + + ifname + connection.interface-name + A value of * will be interpreted as +no value, making the connection profile interface-independent. +Note: use quotes around * to suppress shell expansion. +For bond, team and bridge connections a default name will be generated if not set. + + + master + connection.master + Value specified here will be canonicalized. +It can be prefixed with ifname/, uuid/ +or id/ to disambiguate it. +If the master connection can be found this will set connection.slave-type +property as well. + + slave-typeconnection.slave-type + +
+ + PPPoE options + + AliasProperty + + + usernamepppoe.username + passwordpppoe.password + servicepppoe.service + +
+ + Wired Ethernet options + + AliasProperty + + + mtuwired.mtu + macwired.mac-address + cloned-macwired.cloned-mac-address + +
+ + Infiniband options + + AliasProperty + + + mtuinfiniband.mtu + macinfiniband.mac-address + transport-modeinfiniband.transport-mode + parentinfiniband.parent + p-keyinfiniband.p-key + +
+ + Wi-Fi options + + AliasProperty + + + ssidwireless.ssid + modewireless.mode + mtuwireless.mtu + macwireless.mac-address + cloned-macwireless.cloned-mac-address + +
+ + WiMax options + + AliasProperty + + + nspwimax.network-name + macwimax.mac-address + +
+ + GSM options + + AliasProperty + + + apngsm.apn + usergsm.username + passwordgsm.password + +
+ + CDMA options + + AliasProperty + + + usercdma.username + passwordcdma.password + +
+ + Bluetooth options + + AliasPropertyNote + + + addrbluetooth.bdaddr + + bt-type + bluetooth.type + Apart from the usual dun and +panu options, the values of dun-gsm +and dun-cdma can be used for compatibility with older +versions. They are equivalent to using dun and setting +appropriate gsm.* or cdma.* properties. + + +
+ + VLAN options + + AliasProperty + + + devvlan.parent + idvlan.id + flagsvlan.flags + ingressvlan.ingress-priority-map + egressvlan.egress-priority-map + +
+ + Bonding options + + AliasPropertyNote + + + + mode + bond.options + Setting each of these adds the option to bond.options property. +It's equivalent of using the +bond.options 'option=value' syntax. + + primary + miimon + downdelay + updelay + arp-interval + arp-ip-target + lacp-rate + +
+ + Team options + + AliasProperty + + + configteam.config + +
+ + Team port options + + AliasProperty + + + configteam-port.config + +
+ + Bridge options + + AliasProperty + + + stpbridge.stp + prioritybridge.priority + forward-delaybridge.forward-delay + hello-timebridge.hello-time + max-agebridge.max-age + ageing-timebridge.ageing-time + multicast-snoopingbridge.multicast-snooping + macbridge.mac-address + prioritybridge-port.priority + path-costbridge-port.path-cost + hairpinbridge-port.hairpin-mode + +
+ + VPN options + + AliasProperty + + + vpn-typevpn.service-type + uservpn.user-name + +
+ + OLPC Mesh options + + AliasProperty + + + ssidolpc-mesh.ssid + channelolpc-mesh.channel + dhcp-anycastolpc-mesh.dhcp-anycast-address + +
+ + ADSL options + + AliasProperty + + + usernameadsl.username + protocoladsl.protocol + passwordadsl.password + encapsulationadsl.encapsulation + +
+ + MACVLAN options + + AliasProperty + + + devmacvlan.parent + modemacvlan.mode + tapmacvlan.tap + +
+ + VxLAN options + + AliasProperty + + + idvxlan.id + remotevxlan.remote + devvxlan.parent + localvxlan.local + source-port-minvxlan.source-port-min + source-port-maxvxlan.source-port-max + destination-portvxlan.destination-port + +
+ + Tun options + + AliasProperty + + + modetun.mode + ownertun.owner + grouptun.group + pitun.pi + vnet-hdrtun.vnet-hdr + multi-queuetun.multi-queue + +
+ + IP tunneling options + + AliasProperty + + + modeip-tunnel.mode + localip-tunnel.local + remoteip-tunnel.remote + devip-tunnel.parent + +
+ + IPv4 options + + AliasPropertyNote + + + + ip4 + ipv4.addresses + This option can be specified multiple times. +It's equivalent of using +ipv4.addresses syntax. + + gw4ipv4.gateway + +
+ + IPv6 options + + AliasPropertyNote + + + + ip6 + ipv6.addresses + This option can be specified multiple times. +It's equivalent of using +ipv6.addresses syntax. + + gw6ipv6.gateway + +
+ + + Environment Variables nmcli's behavior is affected by the following @@ -2798,14 +2106,21 @@ Connection, device, or access point does not exist. + + + 65 + + When used with option, a file name is expected to follow. + + - Examples + Examples This section presents various examples of nmcli usage. If you want even more, please refer to - nmcli-examples7 + nmcli-examples7 manual page. @@ -2967,6 +2282,22 @@ + + nmcli dev modify em1 ipv4.method shared + + starts IPv4 connection sharing using em1 device. The sharing will be active + until the device is disconnected. + + + + + nmcli dev modify em1 ipv6.address 2001:db8::a:bad:c0de + + temporarily adds an IP address to a device. The address will be removed + when the same connection is activated again. + + + nmcli connection add type ethernet autoconnect no ifname eth0 @@ -2985,7 +2316,7 @@ - nmcli c a ifname eth0 type ethernet -- ipv4.method disabled ipv6.method link-local + nmcli c a ifname eth0 type ethernet ipv4.method disabled ipv6.method link-local non-interactively adds a connection that will use eth0 Ethernet interface and only have an IPv6 link-local address configured. @@ -3074,11 +2405,11 @@ See Also - nmcli-examples7, - nm-online1, - NetworkManager8, - NetworkManager.conf5, - nm-settings5, + nmcli-examples7, + nm-online1, + NetworkManager8, + NetworkManager.conf5, + nm-settings5, nm-applet1, nm-connection-editor1. diff --git a/man/nmtui.1 b/man/nmtui.1 index 984fb79c..6f0d2c74 100644 --- a/man/nmtui.1 +++ b/man/nmtui.1 @@ -2,12 +2,12 @@ .\" Title: nmtui .\" Author: .\" Generator: DocBook XSL Stylesheets v1.78.1 -.\" Date: 08/03/2016 +.\" Date: 08/24/2016 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.2.4 +.\" Source: NetworkManager 1.4.0 .\" Language: English .\" -.TH "NMTUI" "1" "" "NetworkManager 1\&.2\&.4" "General Commands Manual" +.TH "NMTUI" "1" "" "NetworkManager 1\&.4\&.0" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nmtui.xml b/man/nmtui.xml index 357472fe..8bf6dd58 100644 --- a/man/nmtui.xml +++ b/man/nmtui.xml @@ -120,10 +120,10 @@ See Also - nmcli1, + nmcli1, nm-applet1, nm-connection-editor1, - NetworkManager8. + NetworkManager8. -- cgit 1.3.0-6-gf8a5