diff options
Diffstat (limited to 'man/NetworkManager.conf.5')
| -rw-r--r-- | man/NetworkManager.conf.5 | 222 |
1 files changed, 199 insertions, 23 deletions
diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5 index 9cfcc93f..ae18f4f6 100644 --- a/man/NetworkManager.conf.5 +++ b/man/NetworkManager.conf.5 @@ -2,7 +2,7 @@ .\" Title: NetworkManager.conf .\" Author: .\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/> -.\" Date: 05/05/2015 +.\" Date: 07/14/2015 .\" Manual: Configuration .\" Source: NetworkManager 1.0 .\" Language: English @@ -50,7 +50,9 @@ directory\&. These will be read in order, with later files overriding earlier on .PP The configuration file format is so\-called key file (sort of ini\-style format)\&. It consists of sections (groups) of key\-value pairs\&. Lines beginning with a \*(Aq#\*(Aq and blank lines are considered comments\&. Sections are started by a header line containing the section enclosed in \*(Aq[\*(Aq and \*(Aq]\*(Aq, and ended implicitly by the start of the next section or the end of the file\&. Each key\-value pair must be contained in a section\&. .PP -For keys that take a list of devices as their value, you can specify devices by their MAC addresses or interface names, or "*" to specify all devices\&. +For keys that take a list of devices as their value, you can specify devices by their MAC addresses or interface names, or "*" to specify all devices\&. See +the section called \(lqDevice List Format\(rq +below\&. .PP Minimal system settings configuration file looks like this: .sp @@ -73,6 +75,7 @@ As an extension to the normal keyfile format, you can also append a value to a p .\} .nf plugins+=another\-plugin + plugins\-=remove\-me .fi .if n \{\ @@ -125,7 +128,7 @@ internal\&. .PP \fIno\-auto\-default\fR .RS 4 -Comma\-separated list of devices for which NetworkManager shouldn\*(Aqt create default wired connection (Auto eth0)\&. By default, NetworkManager creates a temporary wired connection for any Ethernet device that is managed and doesn\*(Aqt have a connection configured\&. List a device in this option to inhibit creating the default connection for the device\&. May have the special value +Specify devices for which NetworkManager shouldn\*(Aqt create default wired connection (Auto eth0)\&. By default, NetworkManager creates a temporary wired connection for any Ethernet device that is managed and doesn\*(Aqt have a connection configured\&. List a device in this option to inhibit creating the default connection for the device\&. May have the special value * to apply to all devices\&. .sp @@ -133,13 +136,19 @@ When the default wired connection is deleted or saved to a new persistent connec /var/run/NetworkManager/no\-auto\-default\&.state to prevent creating the default connection for that device again\&. .sp +See +the section called \(lqDevice List Format\(rq +for the syntax how to specify a device\&. +.sp +Example: +.sp .if n \{\ .RS 4 .\} .nf - no\-auto\-default=00:22:68:5c:5d:c4,00:1e:65:ff:aa:ee - no\-auto\-default=eth0,eth1 - no\-auto\-default=* +no\-auto\-default=00:22:68:5c:5d:c4,00:1e:65:ff:aa:ee +no\-auto\-default=eth0,eth1 +no\-auto\-default=* .fi .if n \{\ @@ -150,15 +159,24 @@ to prevent creating the default connection for that device again\&. .PP \fIignore\-carrier\fR .RS 4 -Comma\-separated list of 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\&. +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 -May have the special value -* -to apply to all devices\&. -.sp Note that the "carrier" property of NMDevices and device D\-Bus interfaces will still reflect the actual device state; it\*(Aqs just that NetworkManager will not make use of that information\&. +.sp +See +the section called \(lqDevice List Format\(rq +for the syntax how to specify a device\&. +.RE +.PP +\fIassume\-ipv6ll\-only\fR +.RS 4 +Specify devices for which NetworkManager will try to generate a connection based on initial configuration when the device only has an IPv6 link\-local address\&. +.sp +See +the section called \(lqDevice List Format\(rq +for the syntax how to specify a device\&. .RE .PP \fIconfigure\-and\-quit\fR @@ -205,19 +223,11 @@ Set a persistent hostname\&. .PP \fIunmanaged\-devices\fR .RS 4 -Set devices that should be ignored by NetworkManager when using the -keyfile -plugin\&. Devices are specified in the following format: +Set devices that should be ignored by NetworkManager\&. .sp -mac:<hwaddr> -or -interface\-name:<ifname>\&. Here -hwaddr -is the MAC address of the device to be ignored, in hex\-digits\-and\-colons notation\&. -ifname -is the interface name of the ignored device\&. -.sp -Multiple entries are separated with semicolons\&. No spaces are allowed in the value\&. +See +the section called \(lqDevice List Format\(rq +for the syntax how to specify a device\&. .sp Example: .sp @@ -415,6 +425,86 @@ IP : shortcut for "IP4,IP6" HW : deprecated alias for "PLATFORM" .RE .RE +.SH "CONNECTION SECTION" +.PP +This section allows to specify default values for connections\&. Not all properties can be overwritten, only a selected list below\&. You can have multiple +connection +sections, by having different sections with a name that all start with "connection"\&. +.PP +Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +[connection] +ipv6\&.ip6\-privacy=0 +connection\&.autoconnect\-slaves=1 + +[connection\-wifi\-wlan0] +match\-device=interface\-name:wlan0 +ipv4\&.route\-metric=50 + +[connection\-wifi\-other] +match\-device=type:wifi +ipv4\&.route\-metric=55 +ipv6\&.ip6\-privacy=1 +.fi +.if n \{\ +.RE +.\} +.PP +The sections within one file are considered in order of appearance, with the exception that the +[connection] +section is always considered last\&. In the example above, this order is +[connection\-wifi\-wlan0], +[connection\-wlan\-other], and +[connection]\&. When checking for a default configuration value, the section are searched until the requested value is found\&. In the example above, "ipv4\&.route\-metric" for wlan0 interface is set to 50, and for all other Wi\-Fi typed interfaces to 55\&. Also, Wi\-Fi devices would have IPv6 private addresses enabled by default, but other devices would have it disabled\&. Note that also "wlan0" gets "ipv6\&.ip6\-privacy=1", because although the section "[connection\-wifi\-wlan0]" matches the device, it does not contain that property and the search continues\&. +.PP +When having different sections in multiple files, sections from files that are read later have higher priority\&. So within one file the priority of the sections is top\-to\-bottom\&. Across multiple files later definitions take precedence\&. +.PP +.PP +\fImatch\-device\fR +.RS 4 +An optional device spec that restricts when the section applies\&. See +the section called \(lqDevice List Format\(rq +for the possible values\&. +.RE +.PP +\fIstop\-match\fR +.RS 4 +An optional boolean value which defaults to +no\&. If the section matches (based on +match\-device), further sections will not be considered even if the property in question is not present\&. In the example above, if +[connection\-wifi\-wlan0] +would have +stop\-match +set to +yes, its +ipv6\&.ip6\-privacy +value would be unspecified\&. +.RE +.PP +The following properties are supported to have their default values configured: +.PP +\fIipv4\&.route\-metric\fR +.RS 4 +.RE +.PP +\fIipv6\&.ip6\-privacy\fR +.RS 4 +If +ipv6\&.ip6\-privacy +is unset, use the content of "/proc/sys/net/ipv6/conf/default/use_tempaddr" as last fallback\&. +.RE +.PP +\fIipv6\&.route\-metric\fR +.RS 4 +.RE +.PP +\fIconnection\&.autoconnect\-slaves\fR +.RS 4 +.RE .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\&. @@ -479,6 +569,92 @@ plugin instead\&. .RS 4 This plugin allows to read iBFT configuration (iSCSI Boot Firmware Table)\&. The configuration is read using /sbin/iscsiadm\&. Users are expected to configure iBFT connections via the firmware interfaces\&. .RE +.SH "APPENDIX" +.SS "Device List Format" +.PP +The configuration options +main\&.no\-auto\-default, +main\&.ignore\-carrier, and +keyfile\&.unmanaged\-devices +select devices based on a list of matchings\&. Devices can be specified using the following format: +.PP +.PP +* +.RS 4 +Matches every device\&. +.RE +.PP +IFNAME +.RS 4 +Case sensitive match of interface name of the device\&. Globbing is not supported\&. +.RE +.PP +HWADDR +.RS 4 +Match the MAC address of the device\&. Globbing is not supported +.RE +.PP +interface\-name:IFNAME, interface\-name:~IFNAME +.RS 4 +Case sensitive match of interface name of the device\&. Simple globbing is supported with +* +and +?\&. Ranges and escaping is not supported\&. +.RE +.PP +interface\-name:=IFNAME +.RS 4 +Case sensitive match of interface name of the device\&. Globbing is disabled and +IFNAME +is taken literally\&. +.RE +.PP +mac:HWADDR +.RS 4 +Match the MAC address of the device\&. Globbing is not supported +.RE +.PP +s390\-subchannels:HWADDR +.RS 4 +Match the device based on the subchannel address\&. Globbing is not supported +.RE +.PP +type:TYPE +.RS 4 +Match the device type\&. Valid type names are as reported by "nmcli \-f GENERAL\&.TYPE device show"\&. Globbing is not supported\&. +.RE +.PP +except:SPEC +.RS 4 +Negative match of a device\&. +SPEC +must be explicitly qualified with a prefix such as +interface\-name:\&. A negative match has higher priority then the positive matches above\&. +.RE +.PP +SPEC[,;]SPEC +.RS 4 +Multiple specs can be concatenated with comman or semicolon\&. The order does not matter as matches are either positive (inclusive) or negative, with negative matches having higher priority\&. +.sp +Backslash is supported to escape the separators \*(Aq;\*(Aq and \*(Aq,\*(Aq, and to express special characters such as newline (\*(Aq\en\*(Aq), tabulator (\*(Aq\et\*(Aq), whitespace (\*(Aq\es\*(Aq) and backslash (\*(Aq\e\e\*(Aq)\&. The globbing of interface names cannot be escaped\&. Whitespace is taken literally so usually the specs will be concatenated without spaces\&. +.RE +.PP +Example: +.sp +.if n \{\ +.RS 4 +.\} +.nf +interface\-name:em4 +mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface\-name:eth2 +interface\-name:vboxnet*,except:interface\-name:vboxnet2 +*,except:mac:00:22:68:1c:59:b1 + +.fi +.if n \{\ +.RE +.\} +.sp .SH "SEE ALSO" .PP \fBNetworkManager\fR(8), |