From 90e8691111889a7b5f3c812f5a41f15a8a058913 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 7 Nov 2017 00:14:39 +0100 Subject: New upstream version 1.9.90 --- man/NetworkManager.8 | 6 +- man/NetworkManager.conf.5 | 48 +++++- man/NetworkManager.conf.xml | 68 ++++++++- man/nm-online.1 | 6 +- man/nm-openvswitch.7 | 236 +++++++++++++++++++++++++++++ man/nm-openvswitch.xml | 204 +++++++++++++++++++++++++ man/nm-settings-ifcfg-rh.5 | 282 +++++++++++++++++++++++++++++----- man/nm-settings-ifcfg-rh.xml | 40 +++-- man/nm-settings-ifcfg-rh.xsl | 5 +- man/nm-settings-keyfile.5 | 6 +- man/nm-settings-keyfile.xml | 7 +- man/nm-settings.5 | 353 ++++++++++++++++++++++++++++++++++++++++--- man/nm-settings.xml | 82 +++++++--- man/nm-settings.xsl | 9 +- man/nmcli-examples.7 | 6 +- man/nmcli.1 | 133 +++++++++++++--- man/nmcli.xml | 47 ++++-- man/nmtui.1 | 6 +- 18 files changed, 1368 insertions(+), 176 deletions(-) create mode 100644 man/nm-openvswitch.7 create mode 100644 man/nm-openvswitch.xml (limited to 'man') diff --git a/man/NetworkManager.8 b/man/NetworkManager.8 index 1ee33bb4..5615216b 100644 --- a/man/NetworkManager.8 +++ b/man/NetworkManager.8 @@ -2,12 +2,12 @@ .\" Title: NetworkManager .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 09/20/2017 +.\" Date: 11/03/2017 .\" Manual: Network management daemons -.\" Source: NetworkManager 1.8.4 +.\" Source: NetworkManager 1.9.90 .\" Language: English .\" -.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.8\&.4" "Network management daemons" +.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.9\&.90" "Network management daemons" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5 index fffa8888..c45f42fd 100644 --- a/man/NetworkManager.conf.5 +++ b/man/NetworkManager.conf.5 @@ -2,12 +2,12 @@ .\" Title: NetworkManager.conf .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 09/20/2017 +.\" Date: 11/03/2017 .\" Manual: Configuration -.\" Source: NetworkManager 1.8.4 +.\" Source: NetworkManager 1.9.90 .\" Language: English .\" -.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.8\&.4" "Configuration" +.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.9\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -187,7 +187,7 @@ ignore\-carrier which overwrites this setting if specified (See \fIignore\-carrier\fR)\&. Otherwise, it is a list of matches to specify for which device carrier should be ignored\&. See the section called \(lqDevice List Format\(rq -for the syntax how to specify a device\&. +for the syntax how to specify a device\&. Note that master types like bond, bridge, and team ignore carrier by default\&. You can however revert that default using the "except:" specifier (or better, use the per\-device setting instead of the deprecated setting)\&. .RE .PP \fIassume\-ipv6ll\-only\fR @@ -293,7 +293,7 @@ fatal\-warnings: set g_log_set_always_fatal() to core dump on warning messages f .RS 4 The number of times a connection activation should be automatically tried before switching to another one\&. This value applies only to connections that can auto\-connect and have a connection\&.autoconnect\-retries -property set to \-1\&. If not specified, connections will be retried 4 times\&. +property set to \-1\&. If not specified, connections will be tried 4 times\&. Setting this value to 1 means to try activation once, without retry\&. .RE .PP \fIslaves\-order\fR @@ -579,6 +579,11 @@ Not all properties can be overwritten, only the following properties are support \fBnm-settings\fR(5) for details)\&. A default value is only consulted if the corresponding per\-connection value explicitly allows for that\&. .PP +\fIconnection\&.auth\-retries\fR +.RS 4 +If left unspecified, the default value is 3 tries before failing the connection\&. +.RE +.PP \fIconnection\&.autoconnect\-slaves\fR .RS 4 .RE @@ -632,6 +637,16 @@ If left unspecified, the default value for the interface type is used\&. .RS 4 .RE .PP +\fIipv4\&.route\-table\fR +.RS 4 +If left unspecified, routes are only added to the main table\&. Note that this is different from explicitly selecting the main table 254, because of how NetworkManager removes extraneous routes from the tables\&. +.RE +.PP +\fIipv6\&.dhcp\-timeout\fR +.RS 4 +If left unspecified, the default value for the interface type is used\&. +.RE +.PP \fIipv6\&.ip6\-privacy\fR .RS 4 If @@ -643,6 +658,11 @@ is unset, use the content of "/proc/sys/net/ipv6/conf/default/use_tempaddr" as l .RS 4 .RE .PP +\fIipv6\&.route\-table\fR +.RS 4 +If left unspecified, routes are only added to the main table\&. Note that this is different from explicitly selecting the main table 254, because of how NetworkManager removes extraneous routes from the tables\&. +.RE +.PP \fIvpn\&.timeout\fR .RS 4 If left unspecified, default value of 60 seconds is used\&. @@ -672,6 +692,11 @@ If configured explicitly to 0, the MTU is not reconfigured during device activat .RS 4 If left unspecified, the default value "ignore" will be used\&. .RE +.PP +\fIwifi\-sec\&.pmf\fR +.RS 4 +If left unspecified, the default value "optional" will be used\&. +.RE .SS "Sections" .PP You can configure multiple @@ -748,7 +773,7 @@ Example: .nf [device] match\-device=interface\-name:eth3 -unmanaged=1 +managed=1 .fi .if n \{\ .RE @@ -758,6 +783,11 @@ unmanaged=1 .PP The following properties can be configured per\-device\&. .PP +\fImanaged\fR +.RS 4 +Whether the device is managed or not\&. A device can be marked as managed via udev rules (ENV{NM_UNMANAGED}), or via setting plugins (keyfile\&.unmanaged\-devices)\&. This is yet another way\&. Note that this configuration can be overruled at runtime via D\-Bus\&. Also, it has higher priority then udev rules\&. +.RE +.PP \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\&. @@ -766,6 +796,8 @@ A device with carrier ignored will allow activating connections on that device e .sp Note that the "carrier" property of NMDevices and device D\-Bus interfaces will still reflect the actual device state; it\*(Aqs just that NetworkManager will not make use of that information\&. .sp +Master types like bond, bridge and team ignore carrier by default, while other device types react on carrier changes by default\&. +.sp This setting overwrites the deprecated main\&.ignore\-carrier setting above\&. @@ -961,7 +993,9 @@ keyfile plugin is the generic plugin that supports all the connection types and capabilities that NetworkManager has\&. It writes files out in an \&.ini\-style format in /etc/NetworkManager/system\-connections\&. .sp -The stored connection file may contain passwords and private keys, so it will be made readable only to root, and the plugin will ignore files that are readable or writable by any user or group other than root\&. +The stored connection file may contain passwords, secrets and private keys in plain text, so it will be made readable only to root, and the plugin will ignore files that are readable or writable by any user or group other than root\&. See "Secret flag types" in +\fBnm-settings\fR(5) +for how to avoid storing passwords in plain text\&. .sp This plugin is always active, and will automatically be used to store any connections that aren\*(Aqt supported by any other active plugin\&. .RE diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml index 9e0ad9ba..e2a91426 100644 --- a/man/NetworkManager.conf.xml +++ b/man/NetworkManager.conf.xml @@ -233,7 +233,10 @@ no-auto-default=* 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. + syntax how to specify a device. Note that master types like + bond, bridge, and team ignore carrier by default. You can however + revert that default using the "except:" specifier (or better, + use the per-device setting instead of the deprecated setting). @@ -403,8 +406,9 @@ no-auto-default=* value applies only to connections that can auto-connect and have a connection.autoconnect-retries property - set to -1. If not specified, connections will be retried 4 - times. + set to -1. If not specified, connections will be tried 4 + times. Setting this value to 1 means to try activation once, + without retry. @@ -637,6 +641,11 @@ ipv6.ip6-privacy=0 A default value is only consulted if the corresponding per-connection value explicitly allows for that. + + connection.auth-retries + If left unspecified, the default value is 3 tries before failing the connection. + + connection.autoconnect-slaves @@ -679,6 +688,18 @@ ipv6.ip6-privacy=0 ipv4.route-metric + + ipv4.route-table + If left unspecified, routes are only added to the main table. Note that this + is different from explicitly selecting the main table 254, because of how NetworkManager + removes extraneous routes from the tables. + + + + ipv6.dhcp-timeout + If left unspecified, the default value for + the interface type is used. + ipv6.ip6-privacy If ipv6.ip6-privacy is unset, use the content of @@ -688,6 +709,13 @@ ipv6.ip6-privacy=0 ipv6.route-metric + + ipv6.route-table + If left unspecified, routes are only added to the main table. Note that this + is different from explicitly selecting the main table 254, because of how NetworkManager + removes extraneous routes from the tables. + + vpn.timeout If left unspecified, default value of 60 seconds is used. @@ -714,6 +742,11 @@ ipv6.ip6-privacy=0 If left unspecified, the default value "ignore" will be used. + + wifi-sec.pmf + If left unspecified, the default value + "optional" will be used. + @@ -800,7 +833,7 @@ ipv6.ip6-privacy=1 [device] match-device=interface-name:eth3 -unmanaged=1 +managed=1 @@ -808,6 +841,19 @@ unmanaged=1 The following properties can be configured per-device. + + managed + + + Whether the device is managed or not. A device can be + marked as managed via udev rules (ENV{NM_UNMANAGED}), + or via setting plugins (keyfile.unmanaged-devices). + This is yet another way. Note that this configuration + can be overruled at runtime via D-Bus. Also, it has + higher priority then udev rules. + + + ignore-carrier @@ -834,6 +880,10 @@ unmanaged=1 interfaces will still reflect the actual device state; it's just that NetworkManager will not make use of that information. + + Master types like bond, bridge and team ignore carrier by default, + while other device types react on carrier changes by default. + This setting overwrites the deprecated main.ignore-carrier setting above. @@ -1096,10 +1146,12 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16 /etc/NetworkManager/system-connections. - The stored connection file may contain passwords and - private keys, so it will be made readable only to root, - and the plugin will ignore files that are readable or - writable by any user or group other than root. + The stored connection file may contain passwords, secrets and + private keys in plain text, so it will be made readable only to + root, and the plugin will ignore files that are readable or + writable by any user or group other than root. See "Secret flag types" + in nm-settings5 + for how to avoid storing passwords in plain text. This plugin is always active, and will automatically be diff --git a/man/nm-online.1 b/man/nm-online.1 index 4b23db44..17ae2a83 100644 --- a/man/nm-online.1 +++ b/man/nm-online.1 @@ -2,12 +2,12 @@ .\" Title: nm-online .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 09/20/2017 +.\" Date: 11/03/2017 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.8.4 +.\" Source: NetworkManager 1.9.90 .\" Language: English .\" -.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.8\&.4" "General Commands Manual" +.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.9\&.90" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-openvswitch.7 b/man/nm-openvswitch.7 new file mode 100644 index 00000000..24dde44f --- /dev/null +++ b/man/nm-openvswitch.7 @@ -0,0 +1,236 @@ +'\" t +.\" Title: nm-openvswitch +.\" Author: +.\" Generator: DocBook XSL Stylesheets vsnapshot +.\" Date: 11/03/2017 +.\" Manual: OpenVSwitch support overview +.\" Source: NetworkManager 1.9.90 +.\" Language: English +.\" +.TH "NM\-OPENVSWITCH" "7" "" "NetworkManager 1\&.9\&.90" "OpenVSwitch support overview" +.\" ----------------------------------------------------------------- +.\" * Define some portability stuff +.\" ----------------------------------------------------------------- +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html +.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) +.ad l +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +nm-openvswitch \- overview of NetworkManager OpenVSwitch support +.SH "OVERVIEW" +.PP +NetworkManager includes basic OpenVSwitch support, good enough to be capable of setting up simple OpenVSwitch configurations\&. It is not extensive and does not expose all functionality of OpenVSwitch provides\&. For large or complicated deployments users are advised to use native tools shipped with OpenVSwitch\&. This document seeks to provide overview of functionality currently provided by NetworkManager, its capabilities and limitations\&. +.PP +First and foremost: NetworkManager applies the configuration by modifying the OVSDB directly\&. Its configuration model follows the OVSDB database model closely and it does not provide the level of abstraction +\fBovs\-vsctl\fR +provides\&. +.PP +In practical terms it means the following: +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +NetworkManager only ever talks to a single OVSDB instance via an UNIX domain socket\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +The configuration is made up of Bridges, Ports and Interfaces\&. Interfaces are always enslaved to Ports, and Ports are always enslaved to Bridges\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +NetworkManager only creates Bridges, Ports and Interfaces you ask it to\&. Unlike +\fBovs\-vsctl\fR, it doesn\*(Aqt create the local interface nor its port automatically\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +You can\*(Aqt enslave Interface directly to a Bridge\&. You always need a Port, even if it has just one interface\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +There are no VLANs\&. The VLAN tagging is enabled by setting a +ovs\-port\&.tag +property on a Port\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +There are no bonds either\&. The bonding is enabled by enslaving multiple Interfaces to a Port and configured by setting properties on a port\&. +.RE +.sp +.SS "Bridges" +.PP +Bridges are represented by connections of ovs\-bridge +type\&. Due to the limitations of OVSDB, "empty" Bridges (with no Ports) can\*(Aqt exist\&. NetworkManager inserts the records for Bridges into OVSDB when a Port is enslaved\&. +.SS "Ports" +.PP +Ports are represented by connections of ovs\-port +type\&. Due to the limitations of OVSDB, "empty" Ports (with no Interfaces) can\*(Aqt exist\&. Ports can also be configured to do VLAN tagging or Bonding\&. NetworkManager inserts the records for Ports into OVSDB when an Interface is enslaved\&. Ports must be enslaved to a Bridge\&. +.SS "Interfaces" +.PP +Interfaces are represented by a connections enslaved to a Port\&. The system interfaces (that have a corresponding Linux link) have a respective +connection\&.type +of the link (e\&.g\&. "wired", "bond", "dummy", etc\&.)\&. Other interfaces ("internal" or "patch" interfaces) are of ovs\-interface type\&. The OVSDB entries are inserted upon enslavement to a Port\&. +.SH "EXAMPLES" +.PP +\fBExample\ \&1.\ \&Creating a Bridge with a single internal Interface\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ \fBnmcli conn add conn\&.type ovs\-bridge conn\&.interface bridge0\fR +Connection \*(Aqovs\-bridge\-bridge0\*(Aq (d10fc64d\-1d48\-4394\-a1b8\-e1aea72f27d5) successfully added\&. +$ \fBnmcli conn add conn\&.type ovs\-port conn\&.interface port0 conn\&.master bridge0\fR +Connection \*(Aqovs\-port\-port0\*(Aq (5ae22bae\-bba4\-4815\-9ade\-7e635633e1f0) successfully added\&. +$ \fBnmcli conn add conn\&.type ovs\-interface conn\&.interface iface0 conn\&.master port0 \e + ipv4\&.method manual ipv4\&.address 192\&.0\&.2\&.1/24\fR +Connection \*(Aqovs\-interface\-iface0\*(Aq (3640d2a1\-a2fd\-4718\-92f1\-cffadb5b6cdc) successfully added\&. +.fi +.if n \{\ +.RE +.\} +.PP +As said above, you need to create a Port even for a single interface\&. Also, before you add the Interface, the Bridge and Port devices appear active, but are not configured in OVSDB yet\&. You can inspect the results with +\fBovs\-vsctl show\fR\&. +.PP +\fBExample\ \&2.\ \&Adding a Linux interface to a Bridge\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ \fBnmcli conn add conn\&.type ovs\-port conn\&.interface port1 conn\&.master bridge0\fR +Connection \*(Aqovs\-port\-port1\*(Aq (67d041eb\-8e7b\-4458\-afee\-a1d07c9c4552) successfully added\&. +$ \fBnmcli conn add conn\&.type ethernet conn\&.interface eth0 conn\&.master port1\fR +Connection \*(Aqovs\-slave\-eth0\*(Aq (d459c45c\-cf78\-4c1c\-b4b7\-505e71379624) successfully added\&. +.fi +.if n \{\ +.RE +.\} +.PP +Again, you need a port\&. +.PP +\fBExample\ \&3.\ \&Creating a VLAN\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ \fBnmcli conn add conn\&.type ovs\-port conn\&.interface port2 conn\&.master bridge0 ovs\-port\&.tag 120\fR +Connection \*(Aqovs\-port\-port2\*(Aq (3994c093\-4ef7\-4549\-a4fd\-627b831c3cb8) successfully added\&. +$ \fBnmcli conn add conn\&.type ethernet conn\&.interface eth1 conn\&.master port2\fR +Connection \*(Aqovs\-slave\-eth1\*(Aq (099be06e\-71ad\-484d\-8d5a\-fcadc5f207f5) successfully added\&. +.fi +.if n \{\ +.RE +.\} +.PP +It\*(Aqs just a port with a tag\&. +.PP +\fBExample\ \&4.\ \&Creating a Bond\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ \fBnmcli conn add conn\&.type ovs\-port conn\&.interface bond0 conn\&.master bridge0\fR +Connection \*(Aqovs\-port\-bond0\*(Aq (d154ebf9\-e999\-4e1b\-a084\-a3de53d25d8a) successfully added\&. +$ \fBnmcli conn add conn\&.type ethernet conn\&.interface eth2 conn\&.master bond0\fR +Connection \*(Aqovs\-slave\-eth2\*(Aq (475ac1bf\-30b2\-4534\-a877\-27f33f58b082) successfully added\&. +$ \fBnmcli conn add conn\&.type ethernet conn\&.interface eth3 conn\&.master bond0\fR +Connection \*(Aqovs\-slave\-eth3\*(Aq (8dedeecb\-ed12\-482b\-b77a\-24a4fb835136) successfully added\&. +.fi +.if n \{\ +.RE +.\} +.PP +It\*(Aqs just a Port with multiple interfaces\&. See nm\-settings manual for Bonding options you can use with "nmcli c add" or "nmcli c modify"\&. You could even set a VLAN tag on the same Port to do VLAN tagging and bonding at the same time\&. +.SH "BUGS" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Not all OpenVSwitch capabilities are supported\&. +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +OpenVSwitch devices don\*(Aqt expose many useful properties on D\-Bus\&. +.RE +.PP +Probably many more\&. +.SH "SEE ALSO" +.PP +\m[blue]\fBRFC 7047: The Open vSwitch Database Management Protocol\fR\m[]\&\s-2\u[1]\d\s+2, +\fBovs-vsctl\fR(8), +\fBovs-vswitchd.conf.db\fR(5), +\fBnm-settings\fR(5), +\fBnmcli\fR(1) +.SH "NOTES" +.IP " 1." 4 +RFC 7047: The Open vSwitch Database Management Protocol +.RS 4 +\%https://www.rfc-editor.org/rfc/rfc7047.txt +.RE diff --git a/man/nm-openvswitch.xml b/man/nm-openvswitch.xml new file mode 100644 index 00000000..5573046c --- /dev/null +++ b/man/nm-openvswitch.xml @@ -0,0 +1,204 @@ + + + +%entities; +]> + + + + + + nm-openvswitch + NetworkManager OpenVSwitch support + + + + nm-openvswitch + 7 + NetworkManager + OpenVSwitch support overview + &NM_VERSION; + + + + nm-openvswitch + overview of NetworkManager OpenVSwitch support + + + + Overview + + NetworkManager includes basic OpenVSwitch support, good enough + to be capable of setting up simple OpenVSwitch configurations. It is not + extensive and does not expose all functionality of OpenVSwitch provides. + For large or complicated deployments users are advised to use native tools + shipped with OpenVSwitch. This document seeks to provide overview of + functionality currently provided by NetworkManager, its capabilities and + limitations. + + First and foremost: NetworkManager applies the configuration by + modifying the OVSDB directly. Its configuration model follows the OVSDB + database model closely and it does not provide the level of abstraction + ovs-vsctl provides. + + In practical terms it means the following: + + + NetworkManager only ever talks to a single OVSDB instance via an + UNIX domain socket. + + + The configuration is made up of Bridges, Ports and + Interfaces. Interfaces are always enslaved to Ports, and Ports are always + enslaved to Bridges. + + + NetworkManager only creates Bridges, Ports and Interfaces + you ask it to. Unlike ovs-vsctl, it doesn't create the + local interface nor its port automatically. + + + You can't enslave Interface directly to a Bridge. You + always need a Port, even if it has just one interface. + + + There are no VLANs. The VLAN tagging is enabled by setting a + ovs-port.tag + property on a Port. + + + There are no bonds either. The bonding is enabled by + enslaving multiple Interfaces to a Port and configured by setting + properties on a port. + + + + + + Bridges + + Bridges are represented by connections of ovs-bridge + type. + Due to the limitations of OVSDB, "empty" Bridges (with no Ports) can't exist. + NetworkManager inserts the records for Bridges into OVSDB when a Port is + enslaved. + + + + + Ports + + Ports are represented by connections of ovs-port + type. + Due to the limitations of OVSDB, "empty" Ports (with no Interfaces) can't + exist. Ports can also be configured to do VLAN tagging or Bonding. + NetworkManager inserts the records for Ports into OVSDB when an Interface is + enslaved. Ports must be enslaved to a Bridge. + + + + Interfaces + + Interfaces are represented by a connections enslaved to a Port. The + system interfaces (that have a corresponding Linux link) have a respective + connection.type + of the link (e.g. "wired", "bond", "dummy", etc.). Other interfaces ("internal" + or "patch" interfaces) are of ovs-interface type. The OVSDB entries are + inserted upon enslavement to a Port. + + + + + + Examples + + Creating a Bridge with a single internal Interface +$ nmcli conn add conn.type ovs-bridge conn.interface bridge0 +Connection 'ovs-bridge-bridge0' (d10fc64d-1d48-4394-a1b8-e1aea72f27d5) successfully added. +$ nmcli conn add conn.type ovs-port conn.interface port0 conn.master bridge0 +Connection 'ovs-port-port0' (5ae22bae-bba4-4815-9ade-7e635633e1f0) successfully added. +$ nmcli conn add conn.type ovs-interface conn.interface iface0 conn.master port0 \ + ipv4.method manual ipv4.address 192.0.2.1/24 +Connection 'ovs-interface-iface0' (3640d2a1-a2fd-4718-92f1-cffadb5b6cdc) successfully added. + + As said above, you need to create a Port even for a single interface. + Also, before you add the Interface, the Bridge and Port devices appear active, + but are not configured in OVSDB yet. You can inspect the results with + ovs-vsctl show. + + + Adding a Linux interface to a Bridge +$ nmcli conn add conn.type ovs-port conn.interface port1 conn.master bridge0 +Connection 'ovs-port-port1' (67d041eb-8e7b-4458-afee-a1d07c9c4552) successfully added. +$ nmcli conn add conn.type ethernet conn.interface eth0 conn.master port1 +Connection 'ovs-slave-eth0' (d459c45c-cf78-4c1c-b4b7-505e71379624) successfully added. + +Again, you need a port. + + + Creating a VLAN +$ nmcli conn add conn.type ovs-port conn.interface port2 conn.master bridge0 ovs-port.tag 120 +Connection 'ovs-port-port2' (3994c093-4ef7-4549-a4fd-627b831c3cb8) successfully added. +$ nmcli conn add conn.type ethernet conn.interface eth1 conn.master port2 +Connection 'ovs-slave-eth1' (099be06e-71ad-484d-8d5a-fcadc5f207f5) successfully added. + + It's just a port with a tag. + + + Creating a Bond +$ nmcli conn add conn.type ovs-port conn.interface bond0 conn.master bridge0 +Connection 'ovs-port-bond0' (d154ebf9-e999-4e1b-a084-a3de53d25d8a) successfully added. +$ nmcli conn add conn.type ethernet conn.interface eth2 conn.master bond0 +Connection 'ovs-slave-eth2' (475ac1bf-30b2-4534-a877-27f33f58b082) successfully added. +$ nmcli conn add conn.type ethernet conn.interface eth3 conn.master bond0 +Connection 'ovs-slave-eth3' (8dedeecb-ed12-482b-b77a-24a4fb835136) successfully added. + + It's just a Port with multiple interfaces. See nm-settings manual for + Bonding options you can use with "nmcli c add" or "nmcli c modify". You could + even set a VLAN tag on the same Port to do VLAN tagging and bonding at the same + time. + + + + + Bugs + + + + Not all OpenVSwitch capabilities are supported. + + + OpenVSwitch devices don't expose many useful properties on D-Bus. + + + Probably many more. + + + + See Also + + RFC 7047: The Open vSwitch Database Management Protocol, + ovs-vsctl8, + ovs-vswitchd.conf.db5, + nm-settings5, + nmcli1 + + + diff --git a/man/nm-settings-ifcfg-rh.5 b/man/nm-settings-ifcfg-rh.5 index 9f35721b..ab29c925 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 vsnapshot -.\" Date: 09/20/2017 +.\" Date: 11/03/2017 .\" Manual: Configuration -.\" Source: NetworkManager 1.8.4 +.\" Source: NetworkManager 1.9.90 .\" Language: English .\" -.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.8\&.4" "Configuration" +.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.9\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -625,11 +625,13 @@ T} T{ password\-raw T}:T{ -(none) +IEEE_8021X_PASSWORD_RAW\fI(+)\fR T}:T{ \ \& T}:T{ -The property is not handled by ifcfg\-rh plugin\&. +password used for EAP, encoded as a hexadecimal string\&. It can also go to "key\-" lookaside file\&.\fB + +Example: \fRIEEE_8021X_PASSWORD_RAW=041c8320083aa4bf T} T{ password\-raw\-flags @@ -970,6 +972,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 @@ -1150,6 +1153,15 @@ Example: \fRLLDP=no\fB Allowed values: \fRboolean value or \*(Aqrx\*(Aq T} +T{ +auth\-retries +T}:T{ +AUTH_RETRIES\fI(+)\fR +T}:T{ +0 +T}:T{ +Number of retries for authentication\&. +T} .TE .sp 1 .sp @@ -1352,29 +1364,7 @@ All DCB related configuration is a NetworkManager extension\&. DCB=yes must be u .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&7.\ \&dummy setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Property -T}:T{ -Ifcfg\-rh Variable -T}:T{ -Default -T}:T{ -Description -T} -.T& -. -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&8.\ \&infiniband setting +.B Table\ \&7.\ \&infiniband setting .TS allbox tab(:); lB lB lB lB. @@ -1451,7 +1441,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&9.\ \&ipv4 setting +.B Table\ \&8.\ \&ipv4 setting .TS allbox tab(:); lB lB lB lB. @@ -1482,6 +1472,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 @@ -1609,6 +1600,15 @@ T}:T{ IPV4_ROUTE_METRIC is the default IPv4 metric for routes on this connection\&. If set to \-1, a default metric based on the device type is used\&. T} T{ +route\-table +T}:T{ +IPV4_ROUTE_TABLE\fI(+)\fR +T}:T{ +0 +T}:T{ +IPV4_ROUTE_TABLE enables policy\-routing and sets the default routing table\&. +T} +T{ dns\-priority T}:T{ IPV4_DNS_PRIORITY\fI(+)\fR @@ -1670,7 +1670,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&10.\ \&ipv6 setting +.B Table\ \&9.\ \&ipv6 setting .TS allbox tab(:); lB lB lB lB. @@ -1699,6 +1699,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 @@ -1813,6 +1814,15 @@ T}:T{ IPV6_ROUTE_METRIC is the default IPv6 metric for routes on this connection\&. If set to \-1, a default metric based on the device type is used\&. T} T{ +route\-table +T}:T{ +IPV6_ROUTE_TABLE\fI(+)\fR +T}:T{ +0 +T}:T{ +IPV6_ROUTE_TABLE enables policy\-routing and sets the default routing table\&. +T} +T{ dns\-priority T}:T{ IPV6_DNS_PRIORITY\fI(+)\fR @@ -1867,7 +1877,29 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&11.\ \&macsec setting +.B Table\ \&10.\ \&ovs\-bridge setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Ifcfg\-rh Variable +T}:T{ +Default +T}:T{ +Description +T} +.T& +. +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&11.\ \&ovs\-interface setting .TS allbox tab(:); lB lB lB lB. @@ -1889,7 +1921,51 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&12.\ \&proxy setting +.B Table\ \&12.\ \&ovs\-patch setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Ifcfg\-rh Variable +T}:T{ +Default +T}:T{ +Description +T} +.T& +. +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&13.\ \&ovs\-port setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Ifcfg\-rh Variable +T}:T{ +Default +T}:T{ +Description +T} +.T& +. +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&14.\ \&proxy setting .TS allbox tab(:); lB lB lB lB. @@ -1956,7 +2032,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&13.\ \&team\-port setting +.B Table\ \&15.\ \&team\-port setting .TS allbox tab(:); lB lB lB lB. @@ -1987,7 +2063,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&14.\ \&team setting +.B Table\ \&16.\ \&team setting .TS allbox tab(:); lB lB lB lB. @@ -2018,7 +2094,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&15.\ \&user setting +.B Table\ \&17.\ \&user setting .TS allbox tab(:); lB lB lB lB. @@ -2032,7 +2108,18 @@ T}:T{ Description T} .T& -. +l l l l. +T{ +data +T}:T{ +NM_USER_* +T}:T{ +\ \& +T}:T{ +each key/value pair is stored as a separate variable with name composed by concatenating NM_USER_ with the encoded key\&. The key is encoded by substituting lowercase letters with uppercase and prepending uppercase letters with an underscore\&. A dot is encoded as a double underscore\&. Remaining characters are encoded as underscore followed by a 3 digit octal representation of the character\&.\fB + +Example: \fRNM_USER_FOO__BAR=something +T} .TE .sp 1 .sp @@ -2040,7 +2127,96 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&16.\ \&802\-3\-ethernet setting +.B Table\ \&18.\ \&vlan setting +.TS +allbox tab(:); +lB lB lB lB. +T{ +Property +T}:T{ +Ifcfg\-rh Variable +T}:T{ +Default +T}:T{ +Description +T} +.T& +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l. +T{ +parent +T}:T{ +DEVICE or PHYSDEV +T}:T{ +\ \& +T}:T{ +Parent interface of the VLAN\&. +T} +T{ +id +T}:T{ +VLAN_ID or DEVICE +T}:T{ +\ \& +T}:T{ +VLAN identifier\&. +T} +T{ +flags +T}:T{ +GVRP, MVRP, VLAN_FLAGS +T}:T{ +\ \& +T}:T{ +VLAN flags\&.\fB + +Allowed values: \fR"yes or "no" for GVRP and MVRP; "LOOSE_BINDING" and "NO_REORDER_HDR" for VLAN_FLAGS +T} +T{ +ingress\-priority\-map +T}:T{ +VLAN_INGRESS_PRIORITY_MAP +T}:T{ +\ \& +T}:T{ +Ingress priority mapping\&.\fB + +Example: \fRVLAN_INGRESS_PRIORITY_MAP=4:2,3:5 +T} +T{ +egress\-priority\-map +T}:T{ +VLAN_EGRESS_PRIORITY_MAP +T}:T{ +\ \& +T}:T{ +Egress priority mapping\&.\fB + +Example: \fRVLAN_EGRESS_PRIORITY_MAP=5:4,4:1,3:7 +T} +T{ +interface\-name +T}:T{ +PHYSDEV and VLAN_ID, or DEVICE +T}:T{ +\ \& +T}:T{ +VLAN interface name\&. If all variables are set, parent device from PHYSDEV takes precedence over DEVICE, but VLAN id from DEVICE takes precedence over VLAN_ID\&.\fB + +Example: \fRPHYSDEV=eth0, VLAN_ID=12; or DEVICE=eth0\&.12 +T} +.TE +.sp 1 +.sp +.it 1 an-trap +.nr an-no-space-flag 1 +.nr an-break-flag 1 +.br +.B Table\ \&19.\ \&802\-3\-ethernet setting .TS allbox tab(:); lB lB lB lB. @@ -2189,7 +2365,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&17.\ \&802\-11\-wireless\-security setting +.B Table\ \&20.\ \&802\-11\-wireless\-security setting .TS allbox tab(:); lB lB lB lB. @@ -2219,6 +2395,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{ key\-mgmt @@ -2287,6 +2465,19 @@ Restrict group/broadcast encryption algorithms, specified as a space separated l Allowed values: \fRCCMP, TKIP, WEP40, WEP104 T} T{ +pmf +T}:T{ +PMF\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Enables or disables PMF (802\&.11w)\fB + +Example: \fRPMF=required\fB + +Allowed values: \fRdefault, disable, optional, required +T} +T{ leap\-username T}:T{ IEEE_8021X_IDENTITY\fI(+)\fR @@ -2389,6 +2580,17 @@ KEY is used for "key" type (10 or 26 hexadecimal characters, or 5 or 13 characte Example: \fRKEY1=s:ahoj, KEY1=0a1c45bc02, KEY_PASSPHRASE1=mysupersecretkey T} +T{ +wps\-method +T}:T{ +WPS_METHOD +T}:T{ +\ \& +T}:T{ +Used to control the WPS methods to be used Valid values are "default", "auto", "disabled", "pin" and "pbc"\&. If omitted, whatver the AP announces is used\&.\fB + +Example: \fRWPS_METHOD=disabled, WPS_METHOD="pin pbc" +T} .TE .sp 1 .sp @@ -2396,7 +2598,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&18.\ \&802\-11\-wireless setting +.B Table\ \&21.\ \&802\-11\-wireless setting .TS allbox tab(:); lB lB lB lB. @@ -2607,7 +2809,7 @@ The following settings are not supported by \fIifcfg\-rh\fR plugin: .PP -adsl, bluetooth, ppp, pppoe, serial, generic, gsm, cdma, 802\-11\-olpc\-mesh, wimax, vpn, macvlan, vxlan, tun, ip\-tunnel +802\-11\-olpc\-mesh, adsl, bluetooth, cdma, dummy, generic, gsm, ip\-tunnel, macsec, macvlan, ppp, pppoe, serial, tun, vpn, vxlan, wimax .SS "Secret flags" .PP Each secret property in a NetworkManager setting has an associated diff --git a/man/nm-settings-ifcfg-rh.xml b/man/nm-settings-ifcfg-rh.xml index d27554d8..2db84cb0 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.8.4nm-settings-ifcfg-rhDescription of ifcfg-rh settings pluginDescription +nm-settings-ifcfg-rhNetworkManager developersnm-settings-ifcfg-rh5NetworkManagerConfiguration1.9.90nm-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 @@ -209,7 +209,9 @@ Allowed values: "EAP-MD5", "EAP-MSCHAPV2", "EAP-GTC", "EAP-OTP" and " Example: IEEE_8021X_PHASE2_SUBJECT_MATCH="Red Hat"phase2-altsubject-matchesIEEE_8021X_PHASE2_ALTSUBJECT_MATCHES(+)phase2-domain-suffix-matchIEEE_8021X_PHASE2_DOMAIN_SUFFIX_MATCH(+)Suffix to match domain of server certificate for phase 2 against.phase2-client-certIEEE_8021X_INNER_CLIENT_CERT(+)Client certificate for inner EAP method. -Example: IEEE_8021X_INNER_CLIENT_CERT=/home/joe/mycert.crtpasswordIEEE_8021X_PASSWORD(+)UTF-8 encoded password used for EAP. It can also go to "key-" lookaside file, or it can be owned by a secret agent.password-flagsIEEE_8021X_PASSWORD_FLAGS(+)Password flags for IEEE_8021X_PASSWORD password. (see for _FLAGS values)password-raw(none)The property is not handled by ifcfg-rh plugin.password-raw-flags(none)The property is not handled by ifcfg-rh plugin.private-keyIEEE_8021X_PRIVATE_KEY(+)Private key for EAP-TLS. +Example: IEEE_8021X_INNER_CLIENT_CERT=/home/joe/mycert.crtpasswordIEEE_8021X_PASSWORD(+)UTF-8 encoded password used for EAP. It can also go to "key-" lookaside file, or it can be owned by a secret agent.password-flagsIEEE_8021X_PASSWORD_FLAGS(+)Password flags for IEEE_8021X_PASSWORD password. (see for _FLAGS values)password-rawIEEE_8021X_PASSWORD_RAW(+)password used for EAP, encoded as a hexadecimal string. It can also go to "key-" lookaside file. + +Example: IEEE_8021X_PASSWORD_RAW=041c8320083aa4bfpassword-raw-flags(none)The property is not handled by ifcfg-rh plugin.private-keyIEEE_8021X_PRIVATE_KEY(+)Private key for EAP-TLS. Example: IEEE_8021X_PRIVATE_KEY=/home/joe/mykey.p12private-key-passwordIEEE_8021X_PRIVATE_KEY_PASSWORD(+)Password for IEEE_8021X_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.private-key-password-flagsIEEE_8021X_PRIVATE_KEY_PASSWORD_FLAGS(+)Password flags for IEEE_8021X_PRIVATE_KEY_PASSWORD password. (see for _FLAGS values)phase2-private-keyIEEE_8021X_INNER_PRIVATE_KEY(+)Private key for inner authentication method for EAP-TLS.phase2-private-key-passwordIEEE_8021X_INNER_PRIVATE_KEY_PASSWORD(+)Password for IEEE_8021X_INNER_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.phase2-private-key-password-flagsIEEE_8021X_INNER_PRIVATE_KEY_PASSWORD_FLAGS(+)Password flags for IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD password. (see for _FLAGS values)pin(none)The property is not handled by ifcfg-rh plugin.pin-flags(none)The property is not handled by ifcfg-rh plugin.system-ca-certs(none)The property is not handled by ifcfg-rh plugin.auth-timeoutIEEE_8021X_AUTH_TIMEOUT(+)0Timeout in seconds for the 802.1X authentication. Zero means the global default or 25.bond settingPropertyIfcfg-rh VariableDefaultDescriptionoptionsBONDING_OPTSBonding options. @@ -255,7 +257,7 @@ Allowed values: yes,no,unknown Example: LLDP=no -Allowed values: boolean value or 'rx'
dcb settingPropertyIfcfg-rh VariableDefaultDescriptionapp-fcoe-flagsDCB_APP_FCOE_ENABLE, DCB_APP_FCOE_ADVERTISE, DCB_APP_FCOE_WILLINGnoFCOE flags. +Allowed values: boolean value or 'rx'auth-retriesAUTH_RETRIES(+)0Number of retries for authentication.
dcb settingPropertyIfcfg-rh VariableDefaultDescriptionapp-fcoe-flagsDCB_APP_FCOE_ENABLE, DCB_APP_FCOE_ADVERTISE, DCB_APP_FCOE_WILLINGnoFCOE flags. Example: DCB_APP_FCOE_ENABLE=yes DCB_APP_FCOE_ADVERTISE=yesapp-fcoe-priorityDCB_APP_FCOE_PRIORITYPriority of FCoE frames. @@ -280,7 +282,7 @@ Example: DCB_PG_STRICT=01101110DCB_PG_UP2TC=01623701
All DCB related configuration is a NetworkManager extension. DCB=yes must be used explicitly to enable DCB so that the rest of the DCB_* variables can apply. - dummy settingPropertyIfcfg-rh VariableDefaultDescription
infiniband settingPropertyIfcfg-rh VariableDefaultDescriptionmac-addressHWADDRIBoIP 20-byte hardware address of the device (in traditional hex-digits-and-colons notation). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device. +
infiniband settingPropertyIfcfg-rh VariableDefaultDescriptionmac-addressHWADDRIBoIP 20-byte hardware address of the device (in traditional hex-digits-and-colons notation). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device. Example: HWADDR=01:02:03:04:05:06:07:08:09:0A:01:02:03:04:05:06:07:08:09:11mtuMTUMTU of the interface.transport-modeCONNECTED_MODECONNECTED_MODE=noCONNECTED_MODE=yes for "connected" mode, CONNECTED_MODE=no for "datagram" modep-keyPKEY_ID (and PKEY=yes)PKEY=noInfiniBand P_Key. The value can be a hex number prefixed with "0x" or a decimal number. When PKEY_ID is specified, PHYSDEV and DEVICE also must be specified. @@ -294,7 +296,7 @@ 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, OPTIONS1, ...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: GATEWAY=10.5.5.1routesADDRESS1, NETMASK1, GATEWAY1, METRIC1, OPTIONS1, ...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.route-tableIPV4_ROUTE_TABLE(+)0IPV4_ROUTE_TABLE enables policy-routing and sets the default routing table.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. A binary value can be specified using hex notation ('aa:bb:cc'). @@ -308,7 +310,7 @@ 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.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_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.route-tableIPV6_ROUTE_TABLE(+)0IPV6_ROUTE_TABLE enables policy-routing and sets the default routing table.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). @@ -320,13 +322,23 @@ Example: IPV6_ADDR_GEN_MODE=stable-privacy Allowed values: IPV6_ADDR_GEN_MODE: eui64, stable-privacytokenIPV6_TOKENThe IPv6 tokenized interface identifier token -Example: IPV6_TOKEN=::53macsec settingPropertyIfcfg-rh VariableDefaultDescription
proxy settingPropertyIfcfg-rh VariableDefaultDescriptionmethodPROXY_METHOD(+)noneMethod for proxy configuration. For "auto", WPAD is used for proxy configuration, or set the PAC file via PAC_URL or PAC_SCRIPT. +Example: IPV6_TOKEN=::53
ovs-bridge settingPropertyIfcfg-rh VariableDefaultDescription
ovs-interface settingPropertyIfcfg-rh VariableDefaultDescription
ovs-patch settingPropertyIfcfg-rh VariableDefaultDescription
ovs-port settingPropertyIfcfg-rh VariableDefaultDescription
proxy settingPropertyIfcfg-rh VariableDefaultDescriptionmethodPROXY_METHOD(+)noneMethod for proxy configuration. For "auto", WPAD is used for proxy configuration, or set the PAC file via PAC_URL or PAC_SCRIPT. Allowed values: none, autobrowser-onlyBROWSER_ONLY(+)noWhether the proxy configuration is for browser only.pac-urlPAC_URL(+)URL for PAC file. Example: PAC_URL=http://wpad.mycompany.com/wpad.datpac-scriptPAC_SCRIPT(+)Path of the PAC script. -Example: PAC_SCRIPT=/home/joe/proxy.pac
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.
user settingPropertyIfcfg-rh VariableDefaultDescription
802-3-ethernet settingPropertyIfcfg-rh VariableDefaultDescriptionport(none)The property is not saved by the plugin.speedETHTOOL_OPTSFixed speed for the ethernet link. It is added as "speed" parameter in the ETHTOOL_OPTS variable.duplexETHTOOL_OPTSFixed duplex mode for the ethernet link. It is added as "duplex" parameter in the ETHOOL_OPTS variable.auto-negotiateETHTOOL_OPTSWhether link speed and duplex autonegotiation is enabled. It is not saved only if disabled and no values are provided for the "speed" and "duplex" parameters (skips link configuration).mac-addressHWADDRHardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device.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_MASK(+)the 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: PAC_SCRIPT=/home/joe/proxy.pac
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.
user settingPropertyIfcfg-rh VariableDefaultDescriptiondataNM_USER_*each key/value pair is stored as a separate variable with name composed by concatenating NM_USER_ with the encoded key. The key is encoded by substituting lowercase letters with uppercase and prepending uppercase letters with an underscore. A dot is encoded as a double underscore. Remaining characters are encoded as underscore followed by a 3 digit octal representation of the character. + +Example: NM_USER_FOO__BAR=something
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. + +Example: VLAN_INGRESS_PRIORITY_MAP=4:2,3:5egress-priority-mapVLAN_EGRESS_PRIORITY_MAPEgress priority mapping. + +Example: VLAN_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
802-3-ethernet settingPropertyIfcfg-rh VariableDefaultDescriptionport(none)The property is not saved by the plugin.speedETHTOOL_OPTSFixed speed for the ethernet link. It is added as "speed" parameter in the ETHTOOL_OPTS variable.duplexETHTOOL_OPTSFixed duplex mode for the ethernet link. It is added as "duplex" parameter in the ETHOOL_OPTS variable.auto-negotiateETHTOOL_OPTSWhether link speed and duplex autonegotiation is enabled. It is not saved only if disabled and no values are provided for the "speed" and "duplex" parameters (skips link configuration).mac-addressHWADDRHardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05). Note that for initscripts this is the current MAC address of the device as found during ifup. For NetworkManager this is the permanent MAC address. Or in case no permanent MAC address exists, the MAC address initially configured on the device.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_MASK(+)the 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. @@ -346,11 +358,17 @@ Allowed values: yes, nopairwis Allowed values: CCMP, TKIPgroupCIPHER_GROUP(+)Restrict group/broadcast encryption algorithms, specified as a space separated list. -Allowed values: CCMP, TKIP, WEP40, WEP104leap-usernameIEEE_8021X_IDENTITY(+)Login name for LEAP.wep-key0KEY1, KEY_PASSPHRASE1(+)The first WEP key (used in most networks). See also DEFAULTKEY for key index.wep-key1KEY2, KEY_PASSPHRASE2(+)WEP key with index 1. See also DEFAULTKEY for key index.wep-key2KEY3, KEY_PASSPHRASE3(+)WEP key with index 2. See also DEFAULTKEY for key index.wep-key3KEY4, KEY_PASSPHRASE4(+)WEP key with index 3. See also DEFAULTKEY for key index.wep-key-flagsWEP_KEY_FLAGS(+)Password flags for KEY<i>, KEY_PASSPHRASE<i> password. (see for _FLAGS values)pskWPA_PSKPre-Shared-Key for WPA networks.psk-flagsWPA_PSK_FLAGS(+)Password flags for WPA_PSK_FLAGS. (see for _FLAGS values) +Allowed values: CCMP, TKIP, WEP40, WEP104pmfPMF(+)Enables or disables PMF (802.11w) + +Example: PMF=required + +Allowed values: default, disable, optional, requiredleap-usernameIEEE_8021X_IDENTITY(+)Login name for LEAP.wep-key0KEY1, KEY_PASSPHRASE1(+)The first WEP key (used in most networks). See also DEFAULTKEY for key index.wep-key1KEY2, KEY_PASSPHRASE2(+)WEP key with index 1. See also DEFAULTKEY for key index.wep-key2KEY3, KEY_PASSPHRASE3(+)WEP key with index 2. See also DEFAULTKEY for key index.wep-key3KEY4, KEY_PASSPHRASE4(+)WEP key with index 3. See also DEFAULTKEY for key index.wep-key-flagsWEP_KEY_FLAGS(+)Password flags for KEY<i>, KEY_PASSPHRASE<i> password. (see for _FLAGS values)pskWPA_PSKPre-Shared-Key for WPA networks.psk-flagsWPA_PSK_FLAGS(+)Password flags for WPA_PSK_FLAGS. (see for _FLAGS values) Example: WPA_PSK_FLAGS=userleap-passwordIEEE_8021X_PASSWORD(+)Password for LEAP. It can also go to "key-" lookaside file, or it can be owned by a secret agent.leap-password-flagsIEEE_8021X_PASSWORD_FLAGS(+)Password flags for IEEE_8021X_PASSWORD_FLAGS. (see for _FLAGS values)wep-key-typeKEY<i> or KEY_PASSPHRASE<i>(+)KEY is used for "key" type (10 or 26 hexadecimal characters, or 5 or 13 character string prefixed with "s:"). KEY_PASSPHRASE is used for WEP passphrases. -Example: KEY1=s:ahoj, KEY1=0a1c45bc02, KEY_PASSPHRASE1=mysupersecretkey
802-11-wireless settingPropertyIfcfg-rh VariableDefaultDescriptionssidESSIDSSID of Wi-Fi network. +Example: KEY1=s:ahoj, KEY1=0a1c45bc02, KEY_PASSPHRASE1=mysupersecretkeywps-methodWPS_METHODUsed to control the WPS methods to be used Valid values are "default", "auto", "disabled", "pin" and "pbc". If omitted, whatver the AP announces is used. + +Example: WPS_METHOD=disabled, WPS_METHOD="pin pbc"
802-11-wireless settingPropertyIfcfg-rh VariableDefaultDescriptionssidESSIDSSID of Wi-Fi network. Example: ESSID="Quick Net"modeMODEWi-Fi network mode. @@ -370,7 +388,7 @@ Allowed values: default, ignore, enable, disableMAC_ADDRESS_RANDOMIZATION=always -Allowed values: default, never, alwayssecurity(none)This property is deprecated and not handled by ifcfg-rh-plugin.
The following settings are not supported by ifcfg-rh plugin:adsl, bluetooth, ppp, pppoe, serial, generic, gsm, cdma, 802-11-olpc-mesh, wimax, vpn, macvlan, vxlan, tun, ip-tunnelSecret flags +Allowed values: default, never, alwayssecurity(none)This property is deprecated and not handled by ifcfg-rh-plugin.The following settings are not supported by ifcfg-rh plugin:802-11-olpc-mesh, adsl, bluetooth, cdma, dummy, generic, gsm, ip-tunnel, macsec, macvlan, ppp, pppoe, serial, tun, vpn, vxlan, wimaxSecret flags Each secret property in a NetworkManager setting has an associated flags property that describes how to handle that secret. In the fcfg-rh plugin variables for secret flags have a diff --git a/man/nm-settings-ifcfg-rh.xsl b/man/nm-settings-ifcfg-rh.xsl index 0dc5394e..aef30fd1 100644 --- a/man/nm-settings-ifcfg-rh.xsl +++ b/man/nm-settings-ifcfg-rh.xsl @@ -17,7 +17,6 @@ /> - nm-settings-ifcfg-rh @@ -328,8 +327,8 @@ DEVICETYPE=TeamPort - - + + <xsl:value-of select="@name"/> setting diff --git a/man/nm-settings-keyfile.5 b/man/nm-settings-keyfile.5 index 8bf64f8d..ed14a777 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 vsnapshot -.\" Date: 09/20/2017 +.\" Date: 11/03/2017 .\" Manual: Configuration -.\" Source: NetworkManager 1.8.4 +.\" Source: NetworkManager 1.9.90 .\" Language: English .\" -.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.8\&.4" "Configuration" +.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.9\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-settings-keyfile.xml b/man/nm-settings-keyfile.xml index f5ebb319..b81fe3c5 100644 --- a/man/nm-settings-keyfile.xml +++ b/man/nm-settings-keyfile.xml @@ -1,6 +1,6 @@ -nm-settings-keyfileNetworkManager developersnm-settings-keyfile5NetworkManagerConfiguration1.8.4nm-settings-keyfileDescription of keyfile settings pluginDescription +nm-settings-keyfileNetworkManager developersnm-settings-keyfile5NetworkManagerConfiguration1.9.90nm-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 @@ -156,7 +156,6 @@ Example: mac-address=00:22:68:12:79:A2 mac-address=0;34;104;18;121;16 Example: mac-address= 80:00:00:6d:fe:80:00:00:00:00:00:00:00:02:55:00:70:33:cf:01
- ipv4 setting (section)PropertyKeyfile VariableFormatDescriptiondnsdnslist of DNS IP addressesList of DNS servers. @@ -191,6 +190,10 @@ Example: route1=2001:4860:4860::/64,2620:52:0:2219:222:68ff:fe11:5403 + + + +
serial setting (section)PropertyKeyfile VariableFormatDescriptionparityparity'e', 'o', or 'n'The connection parity; even, odd, or none. Note that older versions of NetworkManager stored this as an integer: 69 ('E') for even, 111 ('o') for odd, or 110 ('n') for none. diff --git a/man/nm-settings.5 b/man/nm-settings.5 index 24f31ebd..5bf03f10 100644 --- a/man/nm-settings.5 +++ b/man/nm-settings.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 09/20/2017 +.\" Date: 11/03/2017 .\" Manual: Configuration -.\" Source: NetworkManager 1.8.4 +.\" Source: NetworkManager 1.9.90 .\" Language: English .\" -.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.8\&.4" "Configuration" +.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.9\&.90" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -93,8 +93,18 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ +auth\-retries +T}:T{ +int32 +T}:T{ +\-1 +T}:T{ +The number of retries for the authentication\&. Zero means to try indefinitely; \-1 means to use a global default\&. If the global default is not set, the authentication retries for 3 times before failing the connection\&. Currently this only applies to 802\-1x authentication\&. +T} +T{ autoconnect T}:T{ boolean @@ -119,7 +129,7 @@ int32 T}:T{ \-1 T}:T{ -The number of times a connection should be tried when autoctivating before giving up\&. Zero means forever, \-1 means the global default (4 times if not overridden)\&. +The number of times a connection should be tried when autoactivating before giving up\&. Zero means forever, \-1 means the global default (4 times if not overridden)\&. Setting this to 1 means to try activation only once before blocking autoconnect\&. Note that after a timeout, NetworkManager will try to autoconnect again\&. T} T{ autoconnect\-slaves @@ -236,7 +246,7 @@ string T}:T{ \ \& T}:T{ -Token to generate stable IDs for the connection\&. The stable\-id is used for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. Note that also the interface name of the activating connection and a per\-host secret key is included into the address generation so that the same stable\-id on different hosts/devices yields different addresses\&. If the value is unset, an ID unique for the connection is used\&. Specifing a stable\-id allows multiple connections to generate the same addresses\&. Another use is to generate IDs at runtime via dynamic substitutions\&. The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at runtime\&. Currently supported are "${CONNECTION}", "${BOOT}", "${RANDOM}"\&. These effectively create unique IDs per\-connection, per\-boot, or every time\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}/${BOOT}" to create a unique id for this connection that changes with every reboot\&. Note that two connections only use the same effective id if their stable\-id is also identical before performing dynamic substitutions\&. +Token to generate stable IDs for the connection\&. The stable\-id is used for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. Note that also the interface name of the activating connection and a per\-host secret key is included into the address generation so that the same stable\-id on different hosts/devices yields different addresses\&. If the value is unset, an ID unique for the connection is used\&. Specifying a stable\-id allows multiple connections to generate the same addresses\&. Another use is to generate IDs at runtime via dynamic substitutions\&. The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at runtime\&. Currently supported are "${CONNECTION}", "${BOOT}", "${RANDOM}"\&. These effectively create unique IDs per\-connection, per\-boot, or every time\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}/${BOOT}" to create a unique id for this connection that changes with every reboot\&. Note that two connections only use the same effective id if their stable\-id is also identical before performing dynamic substitutions\&. T} T{ timestamp @@ -515,7 +525,7 @@ uint32 T}:T{ 0 T}:T{ -Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options\&. The invidual TLS versions can be explicitly disabled\&. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it\&. The TLS options map to tls_disable_tlsv1_x settings\&. See the wpa_supplicant documentation for more details\&. +Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options\&. The individual TLS versions can be explicitly disabled\&. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it\&. The TLS options map to tls_disable_tlsv1_x settings\&. See the wpa_supplicant documentation for more details\&. T} T{ phase1\-fast\-provisioning @@ -963,6 +973,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ ageing\-time @@ -983,6 +994,15 @@ T}:T{ The Spanning Tree Protocol (STP) forwarding delay, in seconds\&. T} T{ +group\-forward\-mask +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +A mask of group addresses to forward\&. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards\&. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded\&. The mask can\*(Aqt have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP\&. +T} +T{ hello\-time T}:T{ uint32 @@ -1007,7 +1027,7 @@ byte array T}:T{ \ \& T}:T{ -If specified, the MAC address of bridge\&. When creating a new bridge, this MAC address will be set\&. When matching an existing (outside NetworkManager created) bridge, this MAC address must match\&. +If specified, the MAC address of bridge\&. When creating a new bridge, this MAC address will be set\&. If this field is left unspecified, the "ethernet\&.cloned\-mac\-address" is referred instead to generate the initial MAC address\&. Note that setting "ethernet\&.cloned\-mac\-address" anyway overwrites the MAC address of the bridge later while activating the bridge\&. Hence, this property is deprecated\&. T} T{ max\-age @@ -1083,7 +1103,7 @@ boolean T}:T{ FALSE T}:T{ -Enables or disabled "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on\&. +Enables or disables "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on\&. T} T{ name @@ -1303,7 +1323,7 @@ array of uint32 T}:T{ [0, 0, 0, 0, 0, 0, 0, 0] T}:T{ -An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the percentage of bandwidth of the priority\*(Aqs assigned group that the priority may use\&. The sum of all percentages for priorities which belong to the same group must total 100 percent\&. +An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the percentage of bandwidth of the priority\*(Aqs assigned group that the priority may use\&. The sum of all percentages for priorities which belong to the same group must total 100 percents\&. T} T{ priority\-flow\-control @@ -1330,7 +1350,7 @@ array of uint32 T}:T{ [0, 0, 0, 0, 0, 0, 0, 0] T}:T{ -An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 \- 7) and the value indicates the percentage of link bandwidth allocated to that group\&. Allowed values are 0 \- 100, and the sum of all values must total 100 percent\&. +An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 \- 7) and the value indicates the percentage of link bandwidth allocated to that group\&. Allowed values are 0 \- 100, and the sum of all values must total 100 percents\&. T} T{ priority\-group\-flags @@ -1571,7 +1591,7 @@ string T}:T{ \ \& T}:T{ -A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to\&. If given, the connection will apply to any device also allowed by "device\-id" and "sim\-id" which contains a SIM card provisioined by the given operator\&. +A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to\&. If given, the connection will apply to any device also allowed by "device\-id" and "sim\-id" which contains a SIM card provisioned by the given operator\&. T} T{ username @@ -1699,6 +1719,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{ address\-data @@ -1887,7 +1908,16 @@ int64 T}:T{ \-1 T}:T{ -The default metric for routes that don\*(Aqt explicitly specify a metric\&. The default value \-1 means that the metric is choosen automatically based on the device type\&. The metric applies to dynamic routes, manual (static) routes that don\*(Aqt have an explicit metric setting, address prefix routes, and the default route\&. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default)\&. Hence, setting this property to zero effectively mean setting it to 1024\&. For IPv4, zero is a regular value for the metric\&. +The default metric for routes that don\*(Aqt explicitly specify a metric\&. The default value \-1 means that the metric is chosen automatically based on the device type\&. The metric applies to dynamic routes, manual (static) routes that don\*(Aqt have an explicit metric setting, address prefix routes, and the default route\&. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default)\&. Hence, setting this property to zero effectively mean setting it to 1024\&. For IPv4, zero is a regular value for the metric\&. +T} +T{ +route\-table +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Enable policy routing (source routing) and set the routing table used when adding routes\&. This affects all routes, including device\-routes, IPv4LL, DHCP, SLAAC, default\-routes and static routes\&. But note that static routes can individually overwrite the setting by explicitly specifying a non\-zero routing table\&. If the table setting is left at zero, it is eligible to be overwritten via global configuration\&. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection\&. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table)\&. Additionally, NetworkManager will not delete any extraneous routes from tables except the main table\&. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager\&. T} T{ routes @@ -1938,6 +1968,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 @@ -1946,7 +1977,7 @@ int32 T}:T{ 1 T}:T{ -Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration\&. The permitted values are: "eui64", 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\*(Aqs presence when it changes networks\&. The address changes when the interface hardware is replaced\&. The value of "stable\-privacy" enables use of cryptographically secure hash of a secret host\-specific key along with the connection\*(Aqs stable\-id and the network address as specified by RFC7217\&. This makes it impossible to use the address track host\*(Aqs presence, and makes the address stable when the network interface hardware is replaced\&. 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\*(Aqt change on upgrade from older versions\&. Note that this setting is distinct from the Privacy Extensions as configured by "ip6\-privacy" property and it does not affect the temporary addresses configured with this option\&. +Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration\&. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1)\&. If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address\&. This makes the host part of the address to stay constant, making it possible to track host\*(Aqs presence when it changes networks\&. The address changes when the interface hardware is replaced\&. The value of stable\-privacy enables use of cryptographically secure hash of a secret host\-specific key along with the connection\*(Aqs stable\-id and the network address as specified by RFC7217\&. This makes it impossible to use the address track host\*(Aqs presence, and makes the address stable when the network interface hardware is replaced\&. 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\*(Aqt change on upgrade from older versions\&. Note that this setting is distinct from the Privacy Extensions as configured by "ip6\-privacy" property and it does not affect the temporary addresses configured with this option\&. T} T{ address\-data @@ -2126,7 +2157,16 @@ int64 T}:T{ \-1 T}:T{ -The default metric for routes that don\*(Aqt explicitly specify a metric\&. The default value \-1 means that the metric is choosen automatically based on the device type\&. The metric applies to dynamic routes, manual (static) routes that don\*(Aqt have an explicit metric setting, address prefix routes, and the default route\&. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default)\&. Hence, setting this property to zero effectively mean setting it to 1024\&. For IPv4, zero is a regular value for the metric\&. +The default metric for routes that don\*(Aqt explicitly specify a metric\&. The default value \-1 means that the metric is chosen automatically based on the device type\&. The metric applies to dynamic routes, manual (static) routes that don\*(Aqt have an explicit metric setting, address prefix routes, and the default route\&. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default)\&. Hence, setting this property to zero effectively mean setting it to 1024\&. For IPv4, zero is a regular value for the metric\&. +T} +T{ +route\-table +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Enable policy routing (source routing) and set the routing table used when adding routes\&. This affects all routes, including device\-routes, IPv4LL, DHCP, SLAAC, default\-routes and static routes\&. But note that static routes can individually overwrite the setting by explicitly specifying a non\-zero routing table\&. If the table setting is left at zero, it is eligible to be overwritten via global configuration\&. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection\&. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table)\&. Additionally, NetworkManager will not delete any extraneous routes from tables except the main table\&. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager\&. T} T{ routes @@ -2229,7 +2269,7 @@ uint32 T}:T{ 0 T}:T{ -None +If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments\&. T} T{ name @@ -2530,6 +2570,238 @@ SSID of the mesh network to join\&. T} .TE .sp 1 +.SS "ovs\-bridge setting" +.PP +OvsBridge Link Settings\&. +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l +l l l l +l l l l +l l l l +l l l l. +T{ +fail\-mode +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The bridge failure mode\&. One of "secure", "standalone" or empty\&. +T} +T{ +mcast\-snooping\-enable +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +Enable or disable multicast snooping\&. +T} +T{ +name +T}:T{ +string +T}:T{ +ovs\-bridge +T}:T{ +The setting\*(Aqs name, which uniquely identifies the setting within the connection\&. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired"\&. +T} +T{ +rstp\-enable +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +Enable or disable RSTP\&. +T} +T{ +stp\-enable +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +Enable or disable STP\&. +T} +.TE +.sp 1 +.SS "ovs\-interface setting" +.PP +OpenVSwitch Interface Settings\&. +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l +l l l l. +T{ +name +T}:T{ +string +T}:T{ +ovs\-interface +T}:T{ +The setting\*(Aqs name, which uniquely identifies the setting within the connection\&. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired"\&. +T} +T{ +type +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The interface type\&. Either "internal", or empty\&. +T} +.TE +.sp 1 +.SS "ovs\-patch setting" +.PP +OvsPatch Link Settings\&. +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l +l l l l. +T{ +name +T}:T{ +string +T}:T{ +ovs\-patch +T}:T{ +The setting\*(Aqs name, which uniquely identifies the setting within the connection\&. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired"\&. +T} +T{ +peer +T}:T{ +string +T}:T{ +\ \& +T}:T{ +Specifies the unicast destination IP address of a remote OpenVSwitch bridge port to connect to\&. +T} +.TE +.sp 1 +.SS "ovs\-port setting" +.PP +OvsPort Link Settings\&. +.TS +allbox tab(:); +lB lB lB lB. +T{ +Key Name +T}:T{ +Value Type +T}:T{ +Default Value +T}:T{ +Value Description +T} +.T& +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l. +T{ +bond\-downdelay +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +The time port must be inactive in order to be considered down\&. +T} +T{ +bond\-mode +T}:T{ +string +T}:T{ +\ \& +T}:T{ +Bonding mode\&. One of "active\-backup", "balance\-slb", or "balance\-tcp"\&. +T} +T{ +bond\-updelay +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +The time port must be active befor it starts forwarding traffic\&. +T} +T{ +lacp +T}:T{ +string +T}:T{ +\ \& +T}:T{ +LACP mode\&. One of "active", "off", or "passive"\&. +T} +T{ +name +T}:T{ +string +T}:T{ +ovs\-port +T}:T{ +The setting\*(Aqs name, which uniquely identifies the setting within the connection\&. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired"\&. +T} +T{ +tag +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +The VLAN tag in the range 0\-4095\&. +T} +T{ +vlan\-mode +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The VLAN mode\&. One of "access", "native\-tagged", "native\-untagged", "trunk" or unset\&. +T} +.TE +.sp 1 .SS "ppp setting" .PP Point\-to\-Point Protocol Settings\&. @@ -2725,7 +2997,7 @@ boolean T}:T{ FALSE T}:T{ -If 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\&. +If TRUE, MPPE (Microsoft Point\-to\-Point Encryption) will be required for the PPP session\&. If either 64\-bit or 128\-bit MPPE is not available the session will fail\&. Note that MPPE is not used on mobile broadband connections\&. T} T{ require\-mppe\-128 @@ -2734,7 +3006,7 @@ boolean T}:T{ FALSE T}:T{ -If 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\&. +If TRUE, 128\-bit MPPE (Microsoft Point\-to\-Point Encryption) will be required for the PPP session, and the "require\-mppe" property must also be set to TRUE\&. If 128\-bit MPPE is not available the session will fail\&. T} .TE .sp 1 @@ -2758,6 +3030,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{ name @@ -2769,6 +3042,15 @@ T}:T{ The setting\*(Aqs name, which uniquely identifies the setting within the connection\&. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired"\&. T} T{ +parent +T}:T{ +string +T}:T{ +\ \& +T}:T{ +If given, specifies the parent interface name on which this PPPoE connection should be created\&. If this property is not specified, the connection is activated on the interface specified in "interface\-name" of NMSettingConnection\&. +T} +T{ password T}:T{ string @@ -3327,7 +3609,7 @@ uint32 T}:T{ 0 T}:T{ -Timeout for the VPN service to establish the connection\&. Some services may take quite a long time to connect\&. Value of 0 means a default timeout, which is 60 seconds (unless overriden by vpn\&.timeout in configuration file)\&. Values greater than zero mean timeout in seconds\&. +Timeout for the VPN service to establish the connection\&. Some services may take quite a long time to connect\&. Value of 0 means a default timeout, which is 60 seconds (unless overridden by vpn\&.timeout in configuration file)\&. Values greater than zero mean timeout in seconds\&. T} T{ user\-name @@ -3398,7 +3680,7 @@ uint32 T}:T{ 0 T}:T{ -Specifies the VXLAN Network Identifer (or VXLAN Segment Identifier) to use\&. +Specifies the VXLAN Network Identifier (or VXLAN Segment Identifier) to use\&. T} T{ l2\-miss @@ -3651,7 +3933,7 @@ 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\&. +With "cloned\-mac\-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally\-administered, unicast MAC address is created\&. This property allows to specify that certain bits are fixed\&. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address\&. If the property is NULL, it is eligible to be overwritten by a default connection setting\&. If the value is still NULL or an empty string, the default is to create a locally\-administered, unicast MAC address\&. If the value contains one MAC address, this address is used as mask\&. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization\&. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm\&. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized\&. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized\&. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally\-administered, burned\-in MAC address\&. If the value contains more than one additional MAC addresses, one of them is chosen randomly\&. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered\&. T} T{ mac\-address @@ -3696,7 +3978,7 @@ string T}:T{ \ \& T}:T{ -Specific 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\&. +Specific port type to use if the device supports multiple attachment methods\&. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface)\&. If the device supports only one port type, this setting is ignored\&. T} T{ s390\-nettype @@ -3732,7 +4014,7 @@ uint32 T}:T{ 0 T}:T{ -Can be set to a value grater than zero only when "auto\-negotiate" is "off"\&. In that case, statically configures the device to use that specified speed\&. In Mbit/s, ie 100 == 100Mbit/s\&. Must be set together with the "duplex" property when non\-zero\&. Before specifying a speed value be sure your device supports it\&. +Can be set to a value greater than zero only when "auto\-negotiate" is "off"\&. In that case, statically configures the device to use that specified speed\&. In Mbit/s, ie 100 == 100Mbit/s\&. Must be set together with the "duplex" property when non\-zero\&. Before specifying a speed value be sure your device supports it\&. T} T{ wake\-on\-lan @@ -3841,7 +4123,7 @@ 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\&. +With "cloned\-mac\-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally\-administered, unicast MAC address is created\&. This property allows to specify that certain bits are fixed\&. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address\&. If the property is NULL, it is eligible to be overwritten by a default connection setting\&. If the value is still NULL or an empty string, the default is to create a locally\-administered, unicast MAC address\&. If the value contains one MAC address, this address is used as mask\&. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization\&. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm\&. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized\&. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized\&. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally\-administered, burned\-in MAC address\&. If the value contains more than one additional MAC addresses, one of them is chosen randomly\&. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered\&. T} T{ hidden @@ -3995,6 +4277,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{ auth\-alg @@ -4069,6 +4353,15 @@ T}:T{ A list of pairwise encryption algorithms which prevents connections to Wi\-Fi networks that do not utilize one of the algorithms in the list\&. For maximum compatibility leave this property empty\&. Each list element may be one of "tkip" or "ccmp"\&. T} T{ +pmf +T}:T{ +int32 +T}:T{ +0 +T}:T{ +Indicates whether Protected Management Frames (802\&.11w) must be enabled for the connection\&. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported)\&. When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled\&. +T} +T{ proto T}:T{ array of string @@ -4158,11 +4451,20 @@ T}:T{ T}:T{ When static WEP is used (ie, key\-mgmt = "none") and a non\-default WEP key index is used by the AP, put that WEP key index here\&. Valid values are 0 (default key) through 3\&. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 \- 4\&. T} +T{ +wps\-method +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Flags indicating which mode of WPS is to be used if any\&. There\*(Aqs little point in changing the default setting as NetworkManager will automatically determine whether it\*(Aqs feasible to start WPS enrollment from the Access Point capabilities\&. WPS can be disabled by setting this property to a value of 1\&. +T} .TE .sp 1 .SS "Secret flag types:" .PP -Each secret property in a setting has an associated +Each password or secret property in a setting has an associated \fIflags\fR property that describes how to handle that secret\&. The \fIflags\fR @@ -4176,7 +4478,8 @@ property is a bitfield that contains zero or more of the following values logica .sp -1 .IP \(bu 2.3 .\} -0x0 (none) \- the system is responsible for providing and storing this secret\&. +0x0 (none) \- the system is responsible for providing and storing this secret\&. This may be required so that secrets are already available before the user logs in\&. It also commonly means that the secret will be stored in plain text on disk, accessible to root only\&. For example via the keyfile settings plugin as described in the "PLUGINS" section in +\fBNetworkManager.conf\fR(5)\&. .RE .sp .RS 4 diff --git a/man/nm-settings.xml b/man/nm-settings.xml index 72225cb3..3f29ff10 100644 --- a/man/nm-settings.xml +++ b/man/nm-settings.xml @@ -1,6 +1,6 @@ -nm-settingsNetworkManager developersnm-settings5NetworkManagerConfiguration1.8.4nm-settingsDescription of settings and properties of NetworkManager connection profilesDescription +nm-settingsNetworkManager developersnm-settings5NetworkManagerConfiguration1.9.90nm-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,9 +34,10 @@ and properties of this page. connection settingGeneral Connection Profile Settings.Key NameValue TypeDefault ValueValue Description + auth-retriesint32-1The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection. Currently this only applies to 802-1x authentication.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-retriesint32-1The number of times a connection should be tried when autoctivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). + autoconnect-retriesint32-1The number of times a connection should be tried when autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.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". @@ -49,7 +50,7 @@ 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-idstringToken to generate stable IDs for the connection. The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. Note that also the interface name of the activating connection and a per-host secret key is included into the address generation so that the same stable-id on different hosts/devices yields different addresses. If the value is unset, an ID unique for the connection is used. Specifing a stable-id allows multiple connections to generate the same addresses. Another use is to generate IDs at runtime via dynamic substitutions. The '$' character is treated special to perform dynamic substitutions at runtime. Currently supported are "${CONNECTION}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-boot, or every time. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}/${BOOT}" to create a unique id for this connection that changes with every reboot. Note that two connections only use the same effective id if their stable-id is also identical before performing dynamic substitutions. + stable-idstringToken to generate stable IDs for the connection. The stable-id is used for generating IPv6 stable private addresses with ipv6.addr-gen-mode=stable-privacy. It is also used to seed the generated cloned MAC address for ethernet.cloned-mac-address=stable and wifi.cloned-mac-address=stable. Note that also the interface name of the activating connection and a per-host secret key is included into the address generation so that the same stable-id on different hosts/devices yields different addresses. If the value is unset, an ID unique for the connection is used. Specifying a stable-id allows multiple connections to generate the same addresses. Another use is to generate IDs at runtime via dynamic substitutions. The '$' character is treated special to perform dynamic substitutions at runtime. Currently supported are "${CONNECTION}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-boot, or every time. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}/${BOOT}" to create a unique id for this connection that changes with every reboot. Note that two connections only use the same effective id if their stable-id is also identical before performing dynamic substitutions.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 "-"). @@ -75,7 +76,7 @@ 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-auth-flagsuint320Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The invidual TLS versions can be explicitly disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x settings. See the wpa_supplicant documentation for more details. + phase1-auth-flagsuint320Specifies authentication flags to use in "phase 1" outer authentication using NMSetting8021xAuthFlags options. The individual TLS versions can be explicitly disabled. If a certain TLS disable flag is not set, it is up to the supplicant to allow or forbid it. The TLS options map to tls_disable_tlsv1_x settings. See the wpa_supplicant documentation for more details.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. @@ -125,9 +126,10 @@ bridge settingBridging Settings.Key NameValue TypeDefault ValueValue Descriptionageing-timeuint32300The Ethernet MAC address aging time, in seconds.forward-delayuint3215The Spanning Tree Protocol (STP) forwarding delay, in seconds. + group-forward-maskuint320A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.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. + mac-addressbyte arrayIf specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. Hence, this property is deprecated.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". @@ -135,7 +137,7 @@ stpbooleanTRUEControls whether Spanning Tree Protocol (STP) is enabled for this bridge.bridge-port settingBridge Port Settings.Key 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. + hairpin-modebooleanFALSEEnables or disables "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. @@ -157,10 +159,10 @@ 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-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 percents.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-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 percents.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. @@ -185,7 +187,7 @@ 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. + 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 provisioned 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 settingInfiniband Settings.Key NameValue TypeDefault ValueValue Description @@ -217,11 +219,12 @@ 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. + route-metricint64-1The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don'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. + route-tableuint320Enable policy routing (source routing) and set the routing table used when adding routes. This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.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 settingIPv6 Settings.Key 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's stable-id 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. + addr-gen-modeint321Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). 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's stable-id 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. @@ -241,7 +244,8 @@ 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. + route-metricint64-1The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is chosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don'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. + route-tableuint320Enable policy routing (source routing) and set the routing table used when adding routes. This affects all routes, including device-routes, IPv4LL, DHCP, SLAAC, default-routes and static routes. But note that static routes can individually overwrite the setting by explicitly specifying a non-zero routing table. If the table setting is left at zero, it is eligible to be overwritten via global configuration. If the property is zero even after applying the global configuration value, policy routing is disabled for the address family of this connection. Policy routing disabled means that NetworkManager will add all routes to the main table (except static routes that explicitly configure a different table). Additionally, NetworkManager will not delete any extraneous routes from tables except the main table. This is to preserve backward compatibility for users who manage routing tables outside of NetworkManager.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. @@ -251,7 +255,7 @@ 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 + mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple fragments.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. @@ -284,6 +288,30 @@ 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. + ovs-bridge settingOvsBridge Link Settings.Key NameValue TypeDefault ValueValue Description + fail-modestringThe bridge failure mode. One of "secure", "standalone" or empty. + mcast-snooping-enablebooleanFALSEEnable or disable multicast snooping. + namestringovs-bridgeThe 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". + rstp-enablebooleanFALSEEnable or disable RSTP. + stp-enablebooleanFALSEEnable or disable STP. + + ovs-interface settingOpenVSwitch Interface Settings.Key NameValue TypeDefault ValueValue Description + namestringovs-interfaceThe 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". + typestringThe interface type. Either "internal", or empty. + + ovs-patch settingOvsPatch Link Settings.Key NameValue TypeDefault ValueValue Description + namestringovs-patchThe 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". + peerstringSpecifies the unicast destination IP address of a remote OpenVSwitch bridge port to connect to. + + ovs-port settingOvsPort Link Settings.Key NameValue TypeDefault ValueValue Description + bond-downdelayuint320The time port must be inactive in order to be considered down. + bond-modestringBonding mode. One of "active-backup", "balance-slb", or "balance-tcp". + bond-updelayuint320The time port must be active befor it starts forwarding traffic. + lacpstringLACP mode. One of "active", "off", or "passive". + namestringovs-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". + taguint320The VLAN tag in the range 0-4095. + vlan-modestringThe VLAN mode. One of "access", "native-tagged", "native-untagged", "trunk" or unset. + ppp settingPoint-to-Point Protocol Settings.Key NameValue TypeDefault ValueValue Descriptionbauduint320If 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. @@ -302,11 +330,12 @@ 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. + require-mppebooleanFALSEIf TRUE, MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections. + require-mppe-128booleanFALSEIf TRUE, 128-bit MPPE (Microsoft Point-to-Point Encryption) will be required for the PPP session, and the "require-mppe" property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.pppoe settingPPP-over-Ethernet Settings.Key NameValue TypeDefault ValueValue DescriptionnamestringpppoeThe 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 on which this PPPoE connection should be created. If this property is not specified, the connection is activated on the interface specified in "interface-name" of NMSettingConnection.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. @@ -364,13 +393,13 @@ 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. + 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 overridden 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 settingVXLAN Settings.Key NameValue TypeDefault ValueValue Descriptionageinguint32300Specifies 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. + iduint320Specifies the VXLAN Network Identifier (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. @@ -396,16 +425,16 @@ auto-negotiatebooleanFALSEIf TRUE, enforce auto-negotiation of port speed and duplex mode. If FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped.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". For libnm and nmcli, this field is called "cloned-mac-address".duplexstringCan be specified only when "auto-negotiate" is "off". In that case, statically configures the device to use that specified duplex mode, either "half" or "full". Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it. - 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. + 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 than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.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. + portstringSpecific port type to use if the device supports multiple attachment methods. One of "tp" (Twisted Pair), "aui" (Attachment Unit Interface), "bnc" (Thin Ethernet) or "mii" (Media Independent Interface). If the device supports only one port type, this setting is ignored.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. - speeduint320Can be set to a value grater than zero only when "auto-negotiate" is "off". In that case, statically configures the device to use that specified speed. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it. + speeduint320Can be set to a value greater than zero only when "auto-negotiate" is "off". In that case, statically configures the device to use that specified speed. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.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. @@ -415,7 +444,7 @@ 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". For libnm and nmcli, this field is called "cloned-mac-address". - 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. + 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 than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.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"). @@ -439,6 +468,7 @@ 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". + pmfint320Indicates whether Protected Management Frames (802.11w) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_PMF_DISABLE (1) (disable PMF), NM_SETTING_WIRELESS_SECURITY_PMF_OPTIONAL (2) (enable PMF if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_PMF_REQUIRED (3) (enable PMF and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_PMF_DEFAULT (0) and no global default is set, PMF will be optionally enabled.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) @@ -449,12 +479,18 @@ 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. + wps-methoduint320Flags indicating which mode of WPS is to be used if any. There's little point in changing the default setting as NetworkManager will automatically determine whether it's feasible to start WPS enrollment from the Access Point capabilities. WPS can be disabled by setting this property to a value of 1.Secret flag types: - Each secret property in a setting has an associated flags property + Each password or secret property in a setting has an associated flags property that describes how to handle that secret. The flags property is a bitfield that contains zero or more of the following values logically OR-ed together. - 0x0 (none) - the system is responsible for providing and storing this secret.0x1 (agent-owned) - a user-session secret agent is responsible for providing and storing + 0x0 (none) - the system is responsible for providing and storing this secret. This + may be required so that secrets are already available before the user logs in. + It also commonly means that the secret will be stored in plain text on disk, accessible + to root only. For example via the keyfile settings plugin as described in the "PLUGINS" section + in NetworkManager.conf5. + 0x1 (agent-owned) - a user-session secret agent is responsible for providing and storing this secret; when it is required, agents will be asked to provide it.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 diff --git a/man/nm-settings.xsl b/man/nm-settings.xsl index 36fb8288..57d5ce41 100644 --- a/man/nm-settings.xsl +++ b/man/nm-settings.xsl @@ -87,13 +87,18 @@ Secret flag types: - Each secret property in a setting has an associated flags property + Each password or secret property in a setting has an associated flags property that describes how to handle that secret. The flags property is a bitfield that contains zero or more of the following values logically OR-ed together. - 0x0 (none) - the system is responsible for providing and storing this secret. + 0x0 (none) - the system is responsible for providing and storing this secret. This + may be required so that secrets are already available before the user logs in. + It also commonly means that the secret will be stored in plain text on disk, accessible + to root only. For example via the keyfile settings plugin as described in the "PLUGINS" section + in NetworkManager.conf5. + 0x1 (agent-owned) - a user-session secret agent is responsible for providing and storing diff --git a/man/nmcli-examples.7 b/man/nmcli-examples.7 index 4ea6f096..8a5ee51f 100644 --- a/man/nmcli-examples.7 +++ b/man/nmcli-examples.7 @@ -2,12 +2,12 @@ .\" Title: nmcli-examples .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 09/20/2017 +.\" Date: 11/03/2017 .\" Manual: Examples -.\" Source: NetworkManager 1.8.4 +.\" Source: NetworkManager 1.9.90 .\" Language: English .\" -.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.8\&.4" "Examples" +.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.9\&.90" "Examples" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nmcli.1 b/man/nmcli.1 index 14c71c17..b8515cc4 100644 --- a/man/nmcli.1 +++ b/man/nmcli.1 @@ -2,12 +2,12 @@ .\" Title: nmcli .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 09/20/2017 +.\" Date: 11/03/2017 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.8.4 +.\" Source: NetworkManager 1.9.90 .\" Language: English .\" -.TH "NMCLI" "1" "" "NetworkManager 1\&.8\&.4" "General Commands Manual" +.TH "NMCLI" "1" "" "NetworkManager 1\&.9\&.90" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -1336,7 +1336,7 @@ type T}:T{ connection\&.type T}:T{ -This option also accepts values of \fBbond\-slave\fR, +This alias 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\&. @@ -1400,6 +1400,7 @@ T} .T& l l l l +l l l l. T{ username @@ -1416,6 +1417,11 @@ service T}:T{ pppoe\&.service T} +T{ +parent +T}:T{ +pppoe\&.parent +T} .TE .sp 1 .sp @@ -1671,10 +1677,10 @@ 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 +Apart from the usual panu, +nap and dun 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 @@ -1757,7 +1763,7 @@ 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\&. +It\*(Aqs equivalent to the +bond\&.options \*(Aqoption=value\*(Aq syntax\&. T} T{ primary @@ -1861,6 +1867,7 @@ l l l l l l l l +l l l l. T{ stp @@ -1893,6 +1900,11 @@ T}:T{ bridge\&.ageing\-time T} T{ +group\-forward\-mask +T}:T{ +bridge\&.group\-forward\-mask +T} +T{ multicast\-snooping T}:T{ bridge\&.multicast\-snooping @@ -2064,7 +2076,60 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&19.\ \&VxLAN options +.B Table\ \&19.\ \&MACsec 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{ +dev +T}:T{ +macsec\&.parent +T} +T{ +mode +T}:T{ +macsec\&.mode +T} +T{ +encrypt +T}:T{ +macsec\&.encrypt +T} +T{ +cak +T}:T{ +macsec\&.cak +T} +T{ +ckn +T}:T{ +macsec\&.ckn +T} +T{ +port +T}:T{ +macsec\&.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.\ \&VxLAN options .TS allbox tab(:); lB lB. @@ -2123,7 +2188,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&20.\ \&Tun options +.B Table\ \&21.\ \&Tun options .TS allbox tab(:); lB lB. @@ -2176,7 +2241,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&21.\ \&IP tunneling options +.B Table\ \&22.\ \&IP tunneling options .TS allbox tab(:); lB lB. @@ -2217,7 +2282,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&22.\ \&IPv4 options +.B Table\ \&23.\ \&IPv4 options .TS allbox tab(:); lB lB lB. @@ -2234,11 +2299,9 @@ l l l. T{ ip4 T}:T{ -ipv4\&.addresses - ipv4\&.method +ipv4\&.addresses ipv4\&.method T}:T{ -This option can be specified multiple times\&. -It\*(Aqs equivalent of using +ipv4\&.addresses syntax and setting ipv4\&.method to manual\&. +The alias is equivalent to the +ipv4\&.addresses syntax and also sets ipv4\&.method to manual\&. It can be specified multiple times\&. T} T{ gw4 @@ -2254,7 +2317,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&23.\ \&IPv6 options +.B Table\ \&24.\ \&IPv6 options .TS allbox tab(:); lB lB lB. @@ -2271,11 +2334,9 @@ l l l. T{ ip6 T}:T{ -ipv6\&.addresses - ipv6\&.method +ipv6\&.addresses ipv6\&.method T}:T{ -This option can be specified multiple times\&. -It\*(Aqs equivalent of using +ipv6\&.addresses syntax and setting ipv6\&.method to manual\&. +The alias is equivalent to the +ipv6\&.addresses syntax and also sets ipv6\&.method to manual\&. It can be specified multiple times\&. T} T{ gw6 @@ -2291,7 +2352,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&24.\ \&Proxy options +.B Table\ \&25.\ \&Proxy options .TS allbox tab(:); lB lB lB. @@ -2303,13 +2364,37 @@ T}:T{ Note T} .T& +l l l +l l l +l l l l l lt. T{ +method +T}:T{ +proxy\&.method +T}:T{ \ \& +T} +T{ +browser\-only +T}:T{ +proxy\&.browser\-only +T}:T{ +\ \& +T} +T{ +pac\-url +T}:T{ +proxy\&.pac\-url +T}:T{ +\ \& +T} +T{ +pac\-script T}:T{ proxy\&.pac\-script T}:T{ -Read the java script pac\-script from file or pass it directly on the command line\&. Prefix the value with "file://" or "js://" to force one or the other\&. +Read the JavaScript PAC (proxy auto\-config) script from file or pass it directly on the command line\&. Prefix the value with "file://" or "js://" to force one or the other\&. T} .TE .sp 1 diff --git a/man/nmcli.xml b/man/nmcli.xml index 8ee7914b..2619234e 100644 --- a/man/nmcli.xml +++ b/man/nmcli.xml @@ -1684,7 +1684,7 @@ type connection.type - This option also accepts values of , + This alias also accepts values of , and . They create connection profiles. Their use is discouraged in favor of using a specific type with option. @@ -1724,6 +1724,7 @@ property as well. usernamepppoe.username passwordpppoe.password servicepppoe.service + parentpppoe.parent
@@ -1804,10 +1805,10 @@ property as well. 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 + Apart from the usual panu, +nap and dun 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. @@ -1835,7 +1836,7 @@ appropriate gsm.* or cdma.* properties.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. +It's equivalent to the +bond.options 'option=value' syntax. primary miimon @@ -1880,6 +1881,7 @@ It's equivalent of using the +bond.options 'option=value' syn hello-timebridge.hello-time max-agebridge.max-age ageing-timebridge.ageing-time + group-forward-maskbridge.group-forward-mask multicast-snoopingbridge.multicast-snooping macbridge.mac-address prioritybridge-port.priority @@ -1932,6 +1934,20 @@ It's equivalent of using the +bond.options 'option=value' syn + MACsec options + + AliasProperty + + + devmacsec.parent + modemacsec.mode + encryptmacsec.encrypt + cakmacsec.cak + cknmacsec.ckn + portmacsec.port + +
+ VxLAN options AliasProperty @@ -1980,10 +1996,8 @@ It's equivalent of using the +bond.options 'option=value' syn ip4 - ipv4.addresses - ipv4.method - This option can be specified multiple times. -It's equivalent of using +ipv4.addresses syntax and setting ipv4.method to manual. + ipv4.addresses ipv4.method + The alias is equivalent to the +ipv4.addresses syntax and also sets ipv4.method to manual. It can be specified multiple times. gw4ipv4.gateway @@ -1996,10 +2010,8 @@ It's equivalent of using +ipv4.addresses syntax and setting < ip6 - ipv6.addresses - ipv6.method - This option can be specified multiple times. -It's equivalent of using +ipv6.addresses syntax and setting ipv6.method to manual. + ipv6.addresses ipv6.method + The alias is equivalent to the +ipv6.addresses syntax and also sets ipv6.method to manual. It can be specified multiple times. gw6ipv6.gateway @@ -2010,10 +2022,13 @@ It's equivalent of using +ipv6.addresses syntax and setting < AliasPropertyNote + methodproxy.method + browser-onlyproxy.browser-only + pac-urlproxy.pac-url - + pac-script proxy.pac-script - Read the java script pac-script from file or pass it directly on the command line. Prefix the value with "file://" or "js://" to force one or the other. + Read the JavaScript PAC (proxy auto-config) script from file or pass it directly on the command line. Prefix the value with "file://" or "js://" to force one or the other.
diff --git a/man/nmtui.1 b/man/nmtui.1 index cfec6afc..8bca2fda 100644 --- a/man/nmtui.1 +++ b/man/nmtui.1 @@ -2,12 +2,12 @@ .\" Title: nmtui .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot -.\" Date: 09/20/2017 +.\" Date: 11/03/2017 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.8.4 +.\" Source: NetworkManager 1.9.90 .\" Language: English .\" -.TH "NMTUI" "1" "" "NetworkManager 1\&.8\&.4" "General Commands Manual" +.TH "NMTUI" "1" "" "NetworkManager 1\&.9\&.90" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- -- cgit 1.3.0-6-gf8a5