diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/NetworkManager.8 | 6 | ||||
| -rw-r--r-- | man/NetworkManager.conf.5 | 49 | ||||
| -rw-r--r-- | man/NetworkManager.conf.xml | 67 | ||||
| -rw-r--r-- | man/common.ent.in | 1 | ||||
| -rw-r--r-- | man/nm-online.1 | 6 | ||||
| -rw-r--r-- | man/nm-settings-ifcfg-rh.5 | 96 | ||||
| -rw-r--r-- | man/nm-settings-ifcfg-rh.xml | 16 | ||||
| -rw-r--r-- | man/nm-settings-keyfile.5 | 6 | ||||
| -rw-r--r-- | man/nm-settings-keyfile.xml | 4 | ||||
| -rw-r--r-- | man/nm-settings.5 | 914 | ||||
| -rw-r--r-- | man/nm-settings.xml | 193 | ||||
| -rw-r--r-- | man/nm-settings.xsl | 33 | ||||
| -rw-r--r-- | man/nmcli-examples.7 | 52 | ||||
| -rw-r--r-- | man/nmcli-examples.xml | 19 | ||||
| -rw-r--r-- | man/nmcli.1 | 34 | ||||
| -rw-r--r-- | man/nmcli.xml | 29 | ||||
| -rw-r--r-- | man/nmtui.1 | 6 |
17 files changed, 941 insertions, 590 deletions
diff --git a/man/NetworkManager.8 b/man/NetworkManager.8 index d18ba497..029dadce 100644 --- a/man/NetworkManager.8 +++ b/man/NetworkManager.8 @@ -2,12 +2,12 @@ .\" Title: NetworkManager .\" Author: .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 02/15/2017 +.\" Date: 05/10/2017 .\" Manual: Network management daemons -.\" Source: NetworkManager 1.6.2 +.\" Source: NetworkManager 1.8.0 .\" Language: English .\" -.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.6\&.2" "Network management daemons" +.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.8\&.0" "Network management daemons" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5 index 6ef2bc5d..339a106d 100644 --- a/man/NetworkManager.conf.5 +++ b/man/NetworkManager.conf.5 @@ -2,12 +2,12 @@ .\" Title: NetworkManager.conf .\" Author: .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 02/15/2017 +.\" Date: 05/10/2017 .\" Manual: Configuration -.\" Source: NetworkManager 1.6.2 +.\" Source: NetworkManager 1.8.0 .\" Language: English .\" -.TH "NETWORKMANAGER\&.CON" "5" "" "NetworkManager 1\&.6\&.2" "Configuration" +.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.8\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -144,7 +144,7 @@ internal option uses a built\-in DHCP client which is not currently as featureful as the external clients\&. .sp If this key is missing, it defaults to -dhclient\&. It the chosen plugin is not available, clients are looked for in this order: +internal\&. It the chosen plugin is not available, clients are looked for in this order: dhclient, dhcpcd, internal\&. @@ -205,6 +205,17 @@ When set to \*(Aqtrue\*(Aq, NetworkManager quits after performing initial networ true, network configuration for WiFi, WWAN, Bluetooth, ADSL, and PPPoE interfaces cannot be preserved due to their use of external services, and these devices will be deconfigured when NetworkManager quits even though other interface\*(Aqs configuration may be preserved\&. Also, to preserve DHCP addresses the \*(Aqdhcp\*(Aq option must be set to \*(Aqinternal\*(Aq\&. The default value of the \*(Aqconfigure\-and\-quit\*(Aq option is \*(Aqfalse\*(Aq, meaning that NetworkManager will continue running after initial network configuration and continue responding to system and hardware events, D\-Bus requests, and user commands\&. .RE .PP +\fIhostname\-mode\fR +.RS 4 +Set the management mode of the hostname\&. This parameter will affect only the transient hostname\&. If a valid static hostname is set, NetworkManager will skip the update of the hostname despite the value of this option\&. An hostname empty or equal to \*(Aqlocalhost\*(Aq, \*(Aqlocalhost6\*(Aq, \*(Aqlocalhost\&.localdomain\*(Aq or \*(Aqlocalhost6\&.localdomain\*(Aq is considered invalid\&. +.sp +default: NetworkManager will update the hostname with the one provided via DHCP on the main connection (the one with a default route)\&. If not present, the hostname will be updated to the last one set outside NetworkManager\&. If it is not valid, NetworkManager will try to recover the hostname from the reverse lookup of the IP address of the main connection\&. If this fails too, the hostname will be set to \*(Aqlocalhost\&.localdomain\*(Aq\&. +.sp +dhcp: NetworkManager will update the transient hostname only with information coming from DHCP\&. No fallback nor reverse lookup will be performed, but when the dhcp connection providing the hostname is deactivated, the hostname is reset to the last hostname set outside NetworkManager or \*(Aqlocalhost\*(Aq if none valid is there\&. +.sp +none: NetworkManager will not manage the transient hostname and will never set it\&. +.RE +.PP \fIdns\fR .RS 4 Set the DNS (resolv\&.conf) processing mode\&. If the key is unspecified, @@ -225,7 +236,7 @@ to reflect the nameservers provided by currently active connections\&. .sp dnsmasq: NetworkManager will run dnsmasq as a local caching nameserver, using a "split DNS" configuration if you are connected to a VPN, and then update resolv\&.conf -to point to the local nameserver\&. It is possible to pass custom options to the dnsmasq instance by adding them to files in the "${prefix}/etc/NetworkManager/dnsmasq\&.d/" directory\&. Note that when multiple upstream servers are available, dnsmasq will initially contact them in parallel and then use the fastest to respond, probing again other servers after some time\&. This behavior can be modified passing the \*(Aqall\-servers\*(Aq or \*(Aqstrict\-order\*(Aq options to dnsmasq (see the manual page for more details)\&. +to point to the local nameserver\&. It is possible to pass custom options to the dnsmasq instance by adding them to files in the "/etc/NetworkManager/dnsmasq\&.d/" directory\&. Note that when multiple upstream servers are available, dnsmasq will initially contact them in parallel and then use the fastest to respond, probing again other servers after some time\&. This behavior can be modified passing the \*(Aqall\-servers\*(Aq or \*(Aqstrict\-order\*(Aq options to dnsmasq (see the manual page for more details)\&. .sp unbound: NetworkManager will talk to unbound and dnssec\-triggerd, providing a "split DNS" configuration with DNSSEC support\&. /etc/resolv\&.conf @@ -241,15 +252,17 @@ rc\-manager\ \&unmanaged .RS 4 Set the resolv\&.conf -management mode\&. The default value depends on NetworkManager build options, and this version of NetworkManager was build with a default of "symlink"\&. Regardless of this setting, NetworkManager will always write resolv\&.conf to its runtime state directory\&. +management mode\&. The default value depends on NetworkManager build options, and this version of NetworkManager was build with a default of "symlink"\&. Regardless of this setting, NetworkManager will always write resolv\&.conf to its runtime state directory +/var/run/NetworkManager/resolv\&.conf\&. .sp -symlink: NetworkManager will symlink +symlink: If /etc/resolv\&.conf -to its private resolv\&.conf file in the runtime state directory\&. If +is a regular file, NetworkManager will replace the file on update\&. If /etc/resolv\&.conf -already is a symlink pointing to a different location, the file will not be modified\&. This allows the user to disable managing by pointing the link +is instead a symlink, NetworkManager will leave it alone\&. Unless the symlink points to the internal file +/var/run/NetworkManager/resolv\&.conf, in which case the symlink will be updated to emit an inotify notification\&. This allows the user to conveniently instruct NetworkManager not to manage /etc/resolv\&.conf -to somewhere else\&. +by replacing it with a symlink\&. .sp file: NetworkManager will write /etc/resolv\&.conf @@ -296,7 +309,7 @@ or other system configuration files according to build options\&. .PP \fIpath\fR .RS 4 -The location where keyfiles are read and stored\&. This defaults to "${prefix}/etc/NetworkManager/conf\&.d"\&. +The location where keyfiles are read and stored\&. This defaults to "/etc/NetworkManager/system\-connections"\&. .RE .PP \fIunmanaged\-devices\fR @@ -524,7 +537,7 @@ INFO\&. .PP \fIbackend\fR .RS 4 -The logging backend\&. Supported values are "debug", "syslog", "journal"\&. "debug" uses syslog and logs to standard error\&. If NetworkManager is started in debug mode (\-\-debug) this option is ignored and "debug" is always used\&. Otherwise, the default is "journal"\&. +The logging backend\&. Supported values are "debug", "syslog", "journal"\&. "debug" uses syslog and logs to standard error\&. If NetworkManager is started in debug mode (\-\-debug) this option is ignored and "debug" is always used\&. Otherwise, the default is "syslog"\&. .RE .PP \fIaudit\fR @@ -532,7 +545,7 @@ The logging backend\&. Supported values are "debug", "syslog", "journal"\&. "deb Whether the audit records are delivered to auditd, the audit daemon\&. If false, audit records will be sent only to the NetworkManager logging system\&. If set to true, they will be also sent to auditd\&. The default value is -true\&. +false\&. .RE .SH "CONNECTION SECTION" .PP @@ -768,6 +781,11 @@ wifi\&.generate\-mac\-address\-mask, this allows to configure the generated MAC \fBnm-settings\fR(5) for details\&. .RE +.PP +\fIsriov\-num\-vfs\fR +.RS 4 +Specify the number of virtual functions (VF) to enable for a PCI physical device that supports single\-root I/O virtualization (SR\-IOV)\&. +.RE .SS "Sections" .PP The @@ -1041,6 +1059,11 @@ type:TYPE Match the device type\&. Valid type names are as reported by "nmcli \-f GENERAL\&.TYPE device show"\&. Globbing is not supported\&. .RE .PP +driver:DRIVER +.RS 4 +Match the device driver as reported by "nmcli \-f GENERAL\&.DRIVER,GENERAL\&.DRIVER\-VERSION device show"\&. "DRIVER" must match the driver name exactly and does not support globbing\&. Optionally, a driver version may be specified separated by \*(Aq/\*(Aq\&. Globbing is supported for the version\&. +.RE +.PP except:SPEC .RS 4 Negative match of a device\&. diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml index 8c93ac4c..658fd7c2 100644 --- a/man/NetworkManager.conf.xml +++ b/man/NetworkManager.conf.xml @@ -277,6 +277,34 @@ no-auto-default=* </varlistentry> <varlistentry> + <term><varname>hostname-mode</varname></term> + <listitem> + <para> + Set the management mode of the hostname. This parameter will + affect only the transient hostname. If a valid static hostname is set, + NetworkManager will skip the update of the hostname despite the value of + this option. An hostname empty or equal to 'localhost', 'localhost6', + 'localhost.localdomain' or 'localhost6.localdomain' is considered invalid. + </para> + <para><literal>default</literal>: NetworkManager will update the hostname + with the one provided via DHCP on the main connection (the one with a default + route). If not present, the hostname will be updated to the last one set + outside NetworkManager. If it is not valid, NetworkManager will try to recover + the hostname from the reverse lookup of the IP address of the main connection. + If this fails too, the hostname will be set to 'localhost.localdomain'. + </para> + <para><literal>dhcp</literal>: NetworkManager will update the transient hostname + only with information coming from DHCP. No fallback nor reverse lookup will be + performed, but when the dhcp connection providing the hostname is deactivated, + the hostname is reset to the last hostname set outside NetworkManager or + 'localhost' if none valid is there. + </para> + <para><literal>none</literal>: NetworkManager will not manage the transient + hostname and will never set it. + </para> + </listitem> + </varlistentry> + <varlistentry> <term><varname>dns</varname></term> <listitem><para>Set the DNS (<filename>resolv.conf</filename>) processing mode. If the key is unspecified, <literal>default</literal> is used, @@ -321,15 +349,17 @@ no-auto-default=* options, and this version of NetworkManager was build with a default of "<literal>&NM_CONFIG_DEFAULT_MAIN_RC_MANAGER;</literal>". Regardless of this setting, NetworkManager will - always write resolv.conf to its runtime state directory.</para> - <para><literal>symlink</literal>: NetworkManager will symlink - <filename>/etc/resolv.conf</filename> to its private - resolv.conf file in the runtime state directory. If - <filename>/etc/resolv.conf</filename> - already is a symlink pointing to a different location, the file - will not be modified. This allows the user to disable managing - by pointing the link <filename>/etc/resolv.conf</filename> to - somewhere else.</para> + always write resolv.conf to its runtime state directory + <filename>&nmrundir;/resolv.conf</filename>.</para> + <para><literal>symlink</literal>: If <filename>/etc/resolv.conf</filename> is + a regular file, NetworkManager will replace the file on update. If + <filename>/etc/resolv.conf</filename> is instead a symlink, NetworkManager + will leave it alone. Unless the symlink points to the internal file + <filename>&nmrundir;/resolv.conf</filename>, + in which case the symlink will be updated to emit an inotify notification. + This allows the user to conveniently instruct NetworkManager not + to manage <filename>/etc/resolv.conf</filename> by replacing it with + a symlink.</para> <para><literal>file</literal>: NetworkManager will write <filename>/etc/resolv.conf</filename> as file. If it finds a symlink, it will follow the symlink and update the target @@ -401,7 +431,7 @@ no-auto-default=* <term><varname>path</varname></term> <listitem> <para>The location where keyfiles are read and stored. - This defaults to "<filename>&sysconfdir;/NetworkManager/conf.d</filename>". + This defaults to "<filename>&sysconfdir;/NetworkManager/system-connections</filename>". </para> </listitem> </varlistentry> @@ -825,6 +855,16 @@ unmanaged=1 </para> </listitem> </varlistentry> + <varlistentry id="sriov-num-vfs"> + <term><varname>sriov-num-vfs</varname></term> + <listitem> + <para> + Specify the number of virtual functions (VF) to enable + for a PCI physical device that supports single-root I/O + virtualization (SR-IOV). + </para> + </listitem> + </varlistentry> </variablelist> </para> </refsect2> @@ -1171,6 +1211,13 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16 Globbing is not supported.</para></listitem> </varlistentry> <varlistentry> + <term>driver:DRIVER</term> + <listitem><para>Match the device driver as reported by "<literal>nmcli -f GENERAL.DRIVER,GENERAL.DRIVER-VERSION device show</literal>". + "<literal>DRIVER</literal>" must match the driver name exactly and does not support globbing. + Optionally, a driver version may be specified separated by '/'. Globbing is supported for the version. + </para></listitem> + </varlistentry> + <varlistentry> <term>except:SPEC</term> <listitem><para>Negative match of a device. <literal>SPEC</literal> must be explicitly qualified with a prefix such as <literal>interface-name:</literal>. A negative match has higher priority then the positive diff --git a/man/common.ent.in b/man/common.ent.in index 4c3310c4..ddfbb69a 100644 --- a/man/common.ent.in +++ b/man/common.ent.in @@ -1,6 +1,7 @@ <?xml version="1.0" encoding="utf-8" ?> <!ENTITY NM_VERSION "@NM_VERSION@"> <!ENTITY sysconfdir "@sysconfdir@"> +<!ENTITY nmrundir "@nmrundir@"> <!ENTITY NM_CONFIG_DEFAULT_MAIN_AUTH_POLKIT_TEXT "@NM_CONFIG_DEFAULT_MAIN_AUTH_POLKIT_TEXT@"> <!ENTITY NM_CONFIG_DEFAULT_LOGGING_BACKEND_TEXT "@NM_CONFIG_DEFAULT_LOGGING_BACKEND_TEXT@"> <!ENTITY NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT "@NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT@"> diff --git a/man/nm-online.1 b/man/nm-online.1 index d79310f9..6de8ea32 100644 --- a/man/nm-online.1 +++ b/man/nm-online.1 @@ -2,12 +2,12 @@ .\" Title: nm-online .\" Author: .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 02/15/2017 +.\" Date: 05/10/2017 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.6.2 +.\" Source: NetworkManager 1.8.0 .\" Language: English .\" -.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.6\&.2" "General Commands Manual" +.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.8\&.0" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-settings-ifcfg-rh.5 b/man/nm-settings-ifcfg-rh.5 index fed899a2..69879b38 100644 --- a/man/nm-settings-ifcfg-rh.5 +++ b/man/nm-settings-ifcfg-rh.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-ifcfg-rh .\" Author: .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 02/15/2017 +.\" Date: 05/10/2017 .\" Manual: Configuration -.\" Source: NetworkManager 1.6.2 +.\" Source: NetworkManager 1.8.0 .\" Language: English .\" -.TH "NM\-SETTINGS\-IFCFG\" "5" "" "NetworkManager 1\&.6\&.2" "Configuration" +.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.8\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -381,6 +381,8 @@ l l l l l l l l l l l l l l l l +l l l l +l l l l l l l l. T{ eap @@ -524,6 +526,19 @@ Example: \fRIEEE_8021X_FAST_PROVISIONING="allow\-auth allow\-unauth"\fB Allowed values: \fRspace\-separated list of these values [allow\-auth, allow\-unauth] T} T{ +phase1\-auth\-flags +T}:T{ +IEEE_8021X_PHASE1_AUTH_FLAGS\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Authentication flags for the supplicant\fB + +Example: \fRIEEE_8021X_PHASE1_AUTH_FLAGS="tls\-1\-0\-disable tls\-1\-1\-disable"\fB + +Allowed values: \fRspace\-separated list of authentication flags names +T} +T{ phase2\-auth T}:T{ IEEE_8021X_INNER_AUTH_METHODS\fI(+)\fR @@ -708,6 +723,15 @@ T}:T{ T}:T{ The property is not handled by ifcfg\-rh plugin\&. T} +T{ +auth\-timeout +T}:T{ +IEEE_8021X_AUTH_TIMEOUT\fI(+)\fR +T}:T{ +0 +T}:T{ +Timeout in seconds for the 802\&.1X authentication\&. Zero means the global default or 25\&. +T} .TE .sp 1 .sp @@ -1328,7 +1352,29 @@ 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.\ \&infiniband setting +.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 .TS allbox tab(:); lB lB lB lB. @@ -1405,7 +1451,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&8.\ \&ipv4 setting +.B Table\ \&9.\ \&ipv4 setting .TS allbox tab(:); lB lB lB lB. @@ -1493,7 +1539,7 @@ T} T{ routes T}:T{ -ADDRESS1, NETMASK1, GATEWAY1, METRIC1, \&.\&.\&. +ADDRESS1, NETMASK1, GATEWAY1, METRIC1, OPTIONS1, \&.\&.\&. T}:T{ \ \& T}:T{ @@ -1624,7 +1670,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&9.\ \&ipv6 setting +.B Table\ \&10.\ \&ipv6 setting .TS allbox tab(:); lB lB lB lB. @@ -1821,7 +1867,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&10.\ \&macsec setting +.B Table\ \&11.\ \&macsec setting .TS allbox tab(:); lB lB lB lB. @@ -1843,7 +1889,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&11.\ \&proxy setting +.B Table\ \&12.\ \&proxy setting .TS allbox tab(:); lB lB lB lB. @@ -1910,7 +1956,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&12.\ \&team\-port setting +.B Table\ \&13.\ \&team\-port setting .TS allbox tab(:); lB lB lB lB. @@ -1941,7 +1987,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&13.\ \&team setting +.B Table\ \&14.\ \&team setting .TS allbox tab(:); lB lB lB lB. @@ -1972,7 +2018,29 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&14.\ \&802\-3\-ethernet setting +.B Table\ \&15.\ \&user 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\ \&16.\ \&802\-3\-ethernet setting .TS allbox tab(:); lB lB lB lB. @@ -2121,7 +2189,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&15.\ \&802\-11\-wireless\-security setting +.B Table\ \&17.\ \&802\-11\-wireless\-security setting .TS allbox tab(:); lB lB lB lB. @@ -2328,7 +2396,7 @@ T} .nr an-no-space-flag 1 .nr an-break-flag 1 .br -.B Table\ \&16.\ \&802\-11\-wireless setting +.B Table\ \&18.\ \&802\-11\-wireless setting .TS allbox tab(:); lB lB lB lB. diff --git a/man/nm-settings-ifcfg-rh.xml b/man/nm-settings-ifcfg-rh.xml index 7b5f56cb..a476608f 100644 --- a/man/nm-settings-ifcfg-rh.xml +++ b/man/nm-settings-ifcfg-rh.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-ifcfg-rh"><refentryinfo><title>nm-settings-ifcfg-rh</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-ifcfg-rh</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.6.2</refmiscinfo></refmeta><refnamediv><refname>nm-settings-ifcfg-rh</refname><refpurpose>Description of <emphasis>ifcfg-rh</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> +<refentry id="nm-settings-ifcfg-rh"><refentryinfo><title>nm-settings-ifcfg-rh</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-ifcfg-rh</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.8.0</refmiscinfo></refmeta><refnamediv><refname>nm-settings-ifcfg-rh</refname><refpurpose>Description of <emphasis>ifcfg-rh</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on the concept of connection profiles that contain network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing @@ -193,7 +193,11 @@ Allowed values: </emphasis>yes, no</entry></row><row><entry align="left">phase1- Example: </emphasis>IEEE_8021X_FAST_PROVISIONING="allow-auth allow-unauth"<emphasis role="bold"> -Allowed values: </emphasis>space-separated list of these values [allow-auth, allow-unauth]</entry></row><row><entry align="left">phase2-auth</entry><entry align="left">IEEE_8021X_INNER_AUTH_METHODS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Inner non-EAP authentication methods. IEEE_8021X_INNER_AUTH_METHODS can contain values both for 'phase2-auth' and 'phase2-autheap' properties.<emphasis role="bold"> +Allowed values: </emphasis>space-separated list of these values [allow-auth, allow-unauth]</entry></row><row><entry align="left">phase1-auth-flags</entry><entry align="left">IEEE_8021X_PHASE1_AUTH_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Authentication flags for the supplicant<emphasis role="bold"> + +Example: </emphasis>IEEE_8021X_PHASE1_AUTH_FLAGS="tls-1-0-disable tls-1-1-disable"<emphasis role="bold"> + +Allowed values: </emphasis>space-separated list of authentication flags names</entry></row><row><entry align="left">phase2-auth</entry><entry align="left">IEEE_8021X_INNER_AUTH_METHODS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Inner non-EAP authentication methods. IEEE_8021X_INNER_AUTH_METHODS can contain values both for 'phase2-auth' and 'phase2-autheap' properties.<emphasis role="bold"> Example: </emphasis>IEEE_8021X_INNER_AUTH_METHODS=PAP<emphasis role="bold"> @@ -207,7 +211,7 @@ Example: </emphasis>IEEE_8021X_PHASE2_SUBJECT_MATCH="Red Hat"</entry></row><row> Example: </emphasis>IEEE_8021X_INNER_CLIENT_CERT=/home/joe/mycert.crt</entry></row><row><entry align="left">password</entry><entry align="left">IEEE_8021X_PASSWORD<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">UTF-8 encoded password used for EAP. It can also go to "key-" lookaside file, or it can be owned by a secret agent.</entry></row><row><entry align="left">password-flags</entry><entry align="left">IEEE_8021X_PASSWORD_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for IEEE_8021X_PASSWORD password. (see <xref linkend="secrets-flags"/> for _FLAGS values)</entry></row><row><entry align="left">password-raw</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">password-raw-flags</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">private-key</entry><entry align="left">IEEE_8021X_PRIVATE_KEY<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Private key for EAP-TLS.<emphasis role="bold"> -Example: </emphasis>IEEE_8021X_PRIVATE_KEY=/home/joe/mykey.p12</entry></row><row><entry align="left">private-key-password</entry><entry align="left">IEEE_8021X_PRIVATE_KEY_PASSWORD<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password for IEEE_8021X_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.</entry></row><row><entry align="left">private-key-password-flags</entry><entry align="left">IEEE_8021X_PRIVATE_KEY_PASSWORD_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for IEEE_8021X_PRIVATE_KEY_PASSWORD password. (see <xref linkend="secrets-flags"/> for _FLAGS values)</entry></row><row><entry align="left">phase2-private-key</entry><entry align="left">IEEE_8021X_INNER_PRIVATE_KEY<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Private key for inner authentication method for EAP-TLS.</entry></row><row><entry align="left">phase2-private-key-password</entry><entry align="left">IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password for IEEE_8021X_INNER_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.</entry></row><row><entry align="left">phase2-private-key-password-flags</entry><entry align="left">IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD password. (see <xref linkend="secrets-flags"/> for _FLAGS values)</entry></row><row><entry align="left">pin</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">pin-flags</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">system-ca-certs</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not handled by ifcfg-rh plugin.</entry></row></tbody></tgroup></table><table><title>bond setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">options</entry><entry align="left">BONDING_OPTS</entry><entry align="left"/><entry align="left">Bonding options.<emphasis role="bold"> +Example: </emphasis>IEEE_8021X_PRIVATE_KEY=/home/joe/mykey.p12</entry></row><row><entry align="left">private-key-password</entry><entry align="left">IEEE_8021X_PRIVATE_KEY_PASSWORD<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password for IEEE_8021X_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.</entry></row><row><entry align="left">private-key-password-flags</entry><entry align="left">IEEE_8021X_PRIVATE_KEY_PASSWORD_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for IEEE_8021X_PRIVATE_KEY_PASSWORD password. (see <xref linkend="secrets-flags"/> for _FLAGS values)</entry></row><row><entry align="left">phase2-private-key</entry><entry align="left">IEEE_8021X_INNER_PRIVATE_KEY<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Private key for inner authentication method for EAP-TLS.</entry></row><row><entry align="left">phase2-private-key-password</entry><entry align="left">IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password for IEEE_8021X_INNER_PRIVATE_KEY. It can also go to "key-" lookaside file, or it can be owned by a secret agent.</entry></row><row><entry align="left">phase2-private-key-password-flags</entry><entry align="left">IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD_FLAGS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Password flags for IEEE_8021X_INNER_PRIVATE_KEY_PASSWORD password. (see <xref linkend="secrets-flags"/> for _FLAGS values)</entry></row><row><entry align="left">pin</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">pin-flags</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">system-ca-certs</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not handled by ifcfg-rh plugin.</entry></row><row><entry align="left">auth-timeout</entry><entry align="left">IEEE_8021X_AUTH_TIMEOUT<emphasis>(+)</emphasis></entry><entry align="left">0</entry><entry align="left">Timeout in seconds for the 802.1X authentication. Zero means the global default or 25.</entry></row></tbody></tgroup></table><table><title>bond setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">options</entry><entry align="left">BONDING_OPTS</entry><entry align="left"/><entry align="left">Bonding options.<emphasis role="bold"> Example: </emphasis>BONDING_OPTS="miimon=100 mode=broadcast"</entry></row></tbody></tgroup></table><table><title>bridge-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">priority</entry><entry align="left">BRIDGING_OPTS: priority=</entry><entry align="left">32</entry><entry align="left">STP priority.<emphasis role="bold"> @@ -276,7 +280,7 @@ Example: </emphasis>DCB_PG_STRICT=01101110</entry></row><row><entry align="left" Example: </emphasis>DCB_PG_UP2TC=01623701</entry></row></tbody></tgroup></table><para> All DCB related configuration is a NetworkManager extension. DCB=yes must be used explicitly to enable DCB so that the rest of the DCB_* variables can apply. - </para><table><title>infiniband setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">IBoIP 20-byte hardware address of the device (in traditional hex-digits-and-colons notation). 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.<emphasis role="bold"> + </para><table><title>dummy setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>infiniband setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">IBoIP 20-byte hardware address of the device (in traditional hex-digits-and-colons notation). 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.<emphasis role="bold"> Example: </emphasis>HWADDR=01:02:03:04:05:06:07:08:09:0A:01:02:03:04:05:06:07:08:09:11</entry></row><row><entry align="left">mtu</entry><entry align="left">MTU</entry><entry align="left"/><entry align="left">MTU of the interface.</entry></row><row><entry align="left">transport-mode</entry><entry align="left">CONNECTED_MODE</entry><entry align="left">CONNECTED_MODE=no</entry><entry align="left">CONNECTED_MODE=yes for "connected" mode, CONNECTED_MODE=no for "datagram" mode</entry></row><row><entry align="left">p-key</entry><entry align="left">PKEY_ID (and PKEY=yes)</entry><entry align="left">PKEY=no</entry><entry align="left">InfiniBand 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.<emphasis role="bold"> @@ -290,7 +294,7 @@ Example: </emphasis>DNS1=1.2.3.4 DNS2=10.0.0.254 DNS3=8.8.8.8</entry></row><row> Example: </emphasis>IPADDR=10.5.5.23 PREFIX=24 IPADDR1=1.1.1.2 PREFIX1=16</entry></row><row><entry align="left">gateway</entry><entry align="left">GATEWAY</entry><entry align="left"/><entry align="left">Gateway IP address.<emphasis role="bold"> -Example: </emphasis>GATEWAY=10.5.5.1</entry></row><row><entry align="left">routes</entry><entry align="left">ADDRESS1, NETMASK1, GATEWAY1, METRIC1, ...</entry><entry align="left"/><entry align="left">List of static routes. They are not stored in ifcfg-* file, but in route-* file instead.</entry></row><row><entry align="left">ignore-auto-routes</entry><entry align="left">PEERROUTES<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">PEERROUTES has the opposite meaning as 'ignore-auto-routes' property.</entry></row><row><entry align="left">ignore-auto-dns</entry><entry align="left">PEERDNS</entry><entry align="left">yes</entry><entry align="left">PEERDNS has the opposite meaning as 'ignore-auto-dns' property.</entry></row><row><entry align="left">dhcp-send-hostname</entry><entry align="left">DHCP_SEND_HOSTNAME<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">Whether DHCP_HOSTNAME should be sent to the DHCP server.</entry></row><row><entry align="left">dhcp-hostname</entry><entry align="left">DHCP_HOSTNAME</entry><entry align="left"/><entry align="left">Hostname to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used.</entry></row><row><entry align="left">never-default</entry><entry align="left">DEFROUTE (GATEWAYDEV in /etc/sysconfig/network)</entry><entry align="left">yes</entry><entry align="left">DEFROUTE=no tells NetworkManager that this connection should not be assigned the default route. DEFROUTE has the opposite meaning as 'never-default' property.</entry></row><row><entry align="left">may-fail</entry><entry align="left">IPV4_FAILURE_FATAL<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">IPV4_FAILURE_FATAL has the opposite meaning as 'may-fail' property.</entry></row><row><entry align="left">route-metric</entry><entry align="left">IPV4_ROUTE_METRIC<emphasis>(+)</emphasis></entry><entry align="left">-1</entry><entry align="left">IPV4_ROUTE_METRIC is the default IPv4 metric for routes on this connection. If set to -1, a default metric based on the device type is used.</entry></row><row><entry align="left">dns-priority</entry><entry align="left">IPV4_DNS_PRIORITY<emphasis>(+)</emphasis></entry><entry align="left">0</entry><entry align="left">The priority for DNS servers of this connection. Lower values have higher priority. If zero, the default value will be used (50 for VPNs, 100 for other connections). A negative value prevents DNS from other connections with greater values to be used.<emphasis role="bold"> +Example: </emphasis>GATEWAY=10.5.5.1</entry></row><row><entry align="left">routes</entry><entry align="left">ADDRESS1, NETMASK1, GATEWAY1, METRIC1, OPTIONS1, ...</entry><entry align="left"/><entry align="left">List of static routes. They are not stored in ifcfg-* file, but in route-* file instead.</entry></row><row><entry align="left">ignore-auto-routes</entry><entry align="left">PEERROUTES<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">PEERROUTES has the opposite meaning as 'ignore-auto-routes' property.</entry></row><row><entry align="left">ignore-auto-dns</entry><entry align="left">PEERDNS</entry><entry align="left">yes</entry><entry align="left">PEERDNS has the opposite meaning as 'ignore-auto-dns' property.</entry></row><row><entry align="left">dhcp-send-hostname</entry><entry align="left">DHCP_SEND_HOSTNAME<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">Whether DHCP_HOSTNAME should be sent to the DHCP server.</entry></row><row><entry align="left">dhcp-hostname</entry><entry align="left">DHCP_HOSTNAME</entry><entry align="left"/><entry align="left">Hostname to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used.</entry></row><row><entry align="left">never-default</entry><entry align="left">DEFROUTE (GATEWAYDEV in /etc/sysconfig/network)</entry><entry align="left">yes</entry><entry align="left">DEFROUTE=no tells NetworkManager that this connection should not be assigned the default route. DEFROUTE has the opposite meaning as 'never-default' property.</entry></row><row><entry align="left">may-fail</entry><entry align="left">IPV4_FAILURE_FATAL<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">IPV4_FAILURE_FATAL has the opposite meaning as 'may-fail' property.</entry></row><row><entry align="left">route-metric</entry><entry align="left">IPV4_ROUTE_METRIC<emphasis>(+)</emphasis></entry><entry align="left">-1</entry><entry align="left">IPV4_ROUTE_METRIC is the default IPv4 metric for routes on this connection. If set to -1, a default metric based on the device type is used.</entry></row><row><entry align="left">dns-priority</entry><entry align="left">IPV4_DNS_PRIORITY<emphasis>(+)</emphasis></entry><entry align="left">0</entry><entry align="left">The priority for DNS servers of this connection. Lower values have higher priority. If zero, the default value will be used (50 for VPNs, 100 for other connections). A negative value prevents DNS from other connections with greater values to be used.<emphasis role="bold"> Example: </emphasis>IPV4_DNS_PRIORITY=20</entry></row><row><entry align="left">dhcp-client-id</entry><entry align="left">DHCP_CLIENT_ID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A string sent to the DHCP server to identify the local machine.<emphasis role="bold"> @@ -322,7 +326,7 @@ Allowed values: </emphasis>none, auto</entry></row><row><entry align="left">brow Example: </emphasis>PAC_URL=http://wpad.mycompany.com/wpad.dat</entry></row><row><entry align="left">pac-script</entry><entry align="left">PAC_SCRIPT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Path of the PAC script.<emphasis role="bold"> -Example: </emphasis>PAC_SCRIPT=/home/joe/proxy.pac</entry></row></tbody></tgroup></table><table><title>team-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">config</entry><entry align="left">TEAM_PORT_CONFIG</entry><entry align="left"/><entry align="left">Team port configuration in JSON. See man teamd.conf for details.</entry></row></tbody></tgroup></table><table><title>team setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">config</entry><entry align="left">TEAM_CONFIG</entry><entry align="left"/><entry align="left">Team configuration in JSON. See man teamd.conf for details.</entry></row></tbody></tgroup></table><table><title>802-3-ethernet setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">port</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not saved by the plugin.</entry></row><row><entry align="left">speed</entry><entry align="left">ETHTOOL_OPTS</entry><entry align="left"/><entry align="left">Fixed speed for the ethernet link. It is added as "speed" parameter in the ETHTOOL_OPTS variable.</entry></row><row><entry align="left">duplex</entry><entry align="left">ETHTOOL_OPTS</entry><entry align="left"/><entry align="left">Fixed duplex mode for the ethernet link. It is added as "duplex" parameter in the ETHOOL_OPTS variable.</entry></row><row><entry align="left">auto-negotiate</entry><entry align="left">ETHTOOL_OPTS</entry><entry align="left"/><entry align="left">Whether 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).</entry></row><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05). 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.</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left">MACADDR</entry><entry align="left"/><entry align="left">Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).</entry></row><row><entry align="left">generate-mac-address-mask</entry><entry align="left">GENERATE_MAC_ADDRESS_MASK<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">the MAC address mask for generating randomized and stable cloned-mac-address.</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left">HWADDR_BLACKLIST<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">It denies usage of the connection for any device whose address is listed.<emphasis role="bold"> +Example: </emphasis>PAC_SCRIPT=/home/joe/proxy.pac</entry></row></tbody></tgroup></table><table><title>team-port setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">config</entry><entry align="left">TEAM_PORT_CONFIG</entry><entry align="left"/><entry align="left">Team port configuration in JSON. See man teamd.conf for details.</entry></row></tbody></tgroup></table><table><title>team setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">config</entry><entry align="left">TEAM_CONFIG</entry><entry align="left"/><entry align="left">Team configuration in JSON. See man teamd.conf for details.</entry></row></tbody></tgroup></table><table><title>user setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody/></tgroup></table><table><title>802-3-ethernet setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">port</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">The property is not saved by the plugin.</entry></row><row><entry align="left">speed</entry><entry align="left">ETHTOOL_OPTS</entry><entry align="left"/><entry align="left">Fixed speed for the ethernet link. It is added as "speed" parameter in the ETHTOOL_OPTS variable.</entry></row><row><entry align="left">duplex</entry><entry align="left">ETHTOOL_OPTS</entry><entry align="left"/><entry align="left">Fixed duplex mode for the ethernet link. It is added as "duplex" parameter in the ETHOOL_OPTS variable.</entry></row><row><entry align="left">auto-negotiate</entry><entry align="left">ETHTOOL_OPTS</entry><entry align="left"/><entry align="left">Whether 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).</entry></row><row><entry align="left">mac-address</entry><entry align="left">HWADDR</entry><entry align="left"/><entry align="left">Hardware address of the device in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:05). 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.</entry></row><row><entry align="left">cloned-mac-address</entry><entry align="left">MACADDR</entry><entry align="left"/><entry align="left">Cloned (spoofed) MAC address in traditional hex-digits-and-colons notation (e.g. 00:22:68:14:5A:99).</entry></row><row><entry align="left">generate-mac-address-mask</entry><entry align="left">GENERATE_MAC_ADDRESS_MASK<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">the MAC address mask for generating randomized and stable cloned-mac-address.</entry></row><row><entry align="left">mac-address-blacklist</entry><entry align="left">HWADDR_BLACKLIST<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">It denies usage of the connection for any device whose address is listed.<emphasis role="bold"> Example: </emphasis>HWADDR_BLACKLIST="00:22:68:11:69:08 00:11:22:11:44:55"</entry></row><row><entry align="left">mtu</entry><entry align="left">MTU</entry><entry align="left"/><entry align="left">MTU of the interface.</entry></row><row><entry align="left">s390-subchannels</entry><entry align="left">SUBCHANNELS</entry><entry align="left"/><entry align="left">Subchannels for IBM S390 hosts.<emphasis role="bold"> diff --git a/man/nm-settings-keyfile.5 b/man/nm-settings-keyfile.5 index c10eaf7a..b729b6c2 100644 --- a/man/nm-settings-keyfile.5 +++ b/man/nm-settings-keyfile.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-keyfile .\" Author: .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 02/15/2017 +.\" Date: 05/10/2017 .\" Manual: Configuration -.\" Source: NetworkManager 1.6.2 +.\" Source: NetworkManager 1.8.0 .\" Language: English .\" -.TH "NM\-SETTINGS\-KEYFIL" "5" "" "NetworkManager 1\&.6\&.2" "Configuration" +.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.8\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-settings-keyfile.xml b/man/nm-settings-keyfile.xml index 27586b55..05cb94fd 100644 --- a/man/nm-settings-keyfile.xml +++ b/man/nm-settings-keyfile.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings-keyfile"><refentryinfo><title>nm-settings-keyfile</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-keyfile</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.6.2</refmiscinfo></refmeta><refnamediv><refname>nm-settings-keyfile</refname><refpurpose>Description of <emphasis>keyfile</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> +<refentry id="nm-settings-keyfile"><refentryinfo><title>nm-settings-keyfile</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-keyfile</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.8.0</refmiscinfo></refmeta><refnamediv><refname>nm-settings-keyfile</refname><refpurpose>Description of <emphasis>keyfile</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on the concept of connection profiles that contain network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing @@ -149,6 +149,7 @@ Example: </emphasis>mac-address=00:22:68:12:79:A2 mac-address=0;34;104;18;121;16 + <table><title>infiniband setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> <row><entry align="left">mac-address</entry><entry align="left">mac-address</entry><entry align="left">usual hex-digits-and-colons notation</entry><entry align="left">MAC address in traditional hex-digits-and-colons notation, or or semicolon separated list of 20 decimal bytes (obsolete)<emphasis role="bold"> @@ -199,6 +200,7 @@ Example: </emphasis>parity=n</entry></row> + <table><title>vpn setting (section)</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Keyfile Variable</entry><entry>Format</entry><entry>Description</entry></row></thead><tbody> <row><entry align="left">data</entry><entry align="left">separate variables named after keys of the dictionary</entry><entry align="left"/><entry align="left">The keys of the data dictionary are used as variable names directly under [vpn] section.<emphasis role="bold"> diff --git a/man/nm-settings.5 b/man/nm-settings.5 index 0d91c79d..543179c1 100644 --- a/man/nm-settings.5 +++ b/man/nm-settings.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings .\" Author: .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 02/15/2017 +.\" Date: 05/10/2017 .\" Manual: Configuration -.\" Source: NetworkManager 1.6.2 +.\" Source: NetworkManager 1.8.0 .\" Language: English .\" -.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.6\&.2" "Configuration" +.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.8\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -58,12 +58,9 @@ that allows direct configuration of the settings and properties according to a c connection editor has also a built\-in \fIdescribe\fR command that can display description of particular settings and properties of this page\&. -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&1.\ \&802\-1x setting +.SS "connection setting" +.PP +General Connection Profile Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -96,6 +93,234 @@ l l l l l l l l l l l l l l l l +l l l l. +T{ +autoconnect +T}:T{ +boolean +T}:T{ +TRUE +T}:T{ +Whether 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\&. +T} +T{ +autoconnect\-priority +T}:T{ +int32 +T}:T{ +0 +T}:T{ +The 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\&. +T} +T{ +autoconnect\-retries +T}:T{ +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)\&. +T} +T{ +autoconnect\-slaves +T}:T{ +NMSettingConnectionAutoconnectSlaves (int32) +T}:T{ +\ \& +T}:T{ +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\&. +T} +T{ +gateway\-ping\-timeout +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping\&. +T} +T{ +id +T}:T{ +string +T}:T{ +\ \& +T}:T{ +A human readable unique identifier for the connection, like "Work Wi\-Fi" or "T\-Mobile 3G"\&. +T} +T{ +interface\-name +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The name of the network interface this connection is bound to\&. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings)\&. For software devices this specifies the name of the created device\&. For connection types where interface names cannot easily be made persistent (e\&.g\&. mobile broadband or USB Ethernet), this property should not be used\&. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface\&. +T} +T{ +lldp +T}:T{ +int32 +T}:T{ +\-1 +T}:T{ +Whether LLDP is enabled for the connection\&. +T} +T{ +master +T}:T{ +string +T}:T{ +\ \& +T}:T{ +Interface name of the master device or UUID of the master connection\&. +T} +T{ +metered +T}:T{ +NMMetered (int32) +T}:T{ +\ \& +T}:T{ +Whether the connection is metered\&. When updating this property on a currently activated connection, the change takes effect immediately\&. +T} +T{ +name +T}:T{ +string +T}:T{ +connection +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{ +permissions +T}:T{ +array of string +T}:T{ +[] +T}:T{ +An array of strings defining what access a given user has to this connection\&. If this is NULL or empty, all users are allowed to access this connection\&. Otherwise a user is allowed to access this connection if and only if they are in this list\&. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah"\&. At this time only the "user" [type] is allowed\&. Any other values are ignored and reserved for future use\&. [id] is the username that this permission refers to, which may not contain the ":" character\&. Any [reserved] information present must be ignored and is reserved for future use\&. All of [type], [id], and [reserved] must be valid UTF\-8\&. +T} +T{ +read\-only +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +FALSE if the connection can be modified using the provided settings service\*(Aqs D\-Bus interface with the right privileges, or TRUE if the connection is read\-only and cannot be modified\&. +T} +T{ +secondaries +T}:T{ +array of string +T}:T{ +[] +T}:T{ +List of connection UUIDs that should be activated when the base connection itself is activated\&. Currently only VPN connections are supported\&. +T} +T{ +slave\-type +T}:T{ +string +T}:T{ +\ \& +T}:T{ +Setting name of the device type of this slave\*(Aqs master connection (eg, "bond"), or NULL if this connection is not a slave\&. +T} +T{ +stable\-id +T}:T{ +string +T}:T{ +\ \& +T}:T{ +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\&. +T} +T{ +timestamp +T}:T{ +uint64 +T}:T{ +0 +T}:T{ +The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated\&. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp\&. The property is only meant for reading (changes to this property will not be preserved)\&. +T} +T{ +type +T}:T{ +string +T}:T{ +\ \& +T}:T{ +Base type of the connection\&. For hardware\-dependent connections, should contain the setting name of the hardware\-type specific setting (ie, "802\-3\-ethernet" or "802\-11\-wireless" or "bluetooth", etc), and for non\-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc)\&. +T} +T{ +uuid +T}:T{ +string +T}:T{ +\ \& +T}:T{ +A universally unique identifier for the connection, for example generated with libuuid\&. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network\&. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re\-created when the Wi\-Fi SSID, mobile broadband network provider, or "type" property changes\&. The UUID must be in the format "2815492f\-7e56\-435e\-b2e9\-246bd7cdc664" (ie, contains only hexadecimal characters and "\-")\&. +T} +T{ +zone +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The trust level of a the connection\&. Free form case\-insensitive string (for example "Home", "Work", "Public")\&. NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall\&. When updating this property on a currently activated connection, the change takes effect immediately\&. +T} +.TE +.sp 1 +.SS "802\-1x setting" +.PP +AIEEE 802\&.1x Authentication 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 +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l +l l l l l l l l l l l l l l l l @@ -131,6 +356,15 @@ T}:T{ Anonymous identity string for EAP authentication methods\&. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP\-TTLS\&. T} T{ +auth\-timeout +T}:T{ +int32 +T}:T{ +0 +T}:T{ +A timeout for the authentication\&. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds\&. +T} +T{ ca\-cert T}:T{ byte array @@ -140,6 +374,24 @@ T}:T{ Contains the CA certificate if used by the EAP method specified in the "eap" property\&. Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. T} T{ +ca\-cert\-password +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The password used to access the CA certificate stored in "ca\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. +T} +T{ +ca\-cert\-password\-flags +T}:T{ +NMSettingSecretFlags (uint32) +T}:T{ +\ \& +T}:T{ +Flags indicating how to handle the "ca\-cert\-password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) +T} +T{ ca\-path T}:T{ string @@ -158,6 +410,24 @@ T}:T{ Contains the client certificate if used by the EAP method specified in the "eap" property\&. Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. T} T{ +client\-cert\-password +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The password used to access the client certificate stored in "client\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. +T} +T{ +client\-cert\-password\-flags +T}:T{ +NMSettingSecretFlags (uint32) +T}:T{ +\ \& +T}:T{ +Flags indicating how to handle the "client\-cert\-password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) +T} +T{ domain\-suffix\-match T}:T{ string @@ -239,6 +509,15 @@ T}:T{ Flags indicating how to handle the "password\-raw" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) T} T{ +phase1\-auth\-flags +T}:T{ +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\&. +T} +T{ phase1\-fast\-provisioning T}:T{ string @@ -302,6 +581,24 @@ T}:T{ Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2\-auth" or "phase2\-autheap" properties\&. Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. T} T{ +phase2\-ca\-cert\-password +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The password used to access the "phase2" CA certificate stored in "phase2\-ca\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. +T} +T{ +phase2\-ca\-cert\-password\-flags +T}:T{ +NMSettingSecretFlags (uint32) +T}:T{ +\ \& +T}:T{ +Flags indicating how to handle the "phase2\-ca\-cert\-password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) +T} +T{ phase2\-ca\-path T}:T{ string @@ -320,6 +617,24 @@ T}:T{ Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2\-auth" or "phase2\-autheap" properties\&. Certificate data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme (which is backwards compatible with NM 0\&.7\&.x) this property should be set to the certificate\*(Aqs DER encoded data\&. When using the path scheme, this property should be set to the full UTF\-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte\&. This property can be unset even if the EAP method supports CA certificates, but this allows man\-in\-the\-middle attacks and is NOT recommended\&. T} T{ +phase2\-client\-cert\-password +T}:T{ +string +T}:T{ +\ \& +T}:T{ +The password used to access the "phase2" client certificate stored in "phase2\-client\-cert" property\&. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login\&. +T} +T{ +phase2\-client\-cert\-password\-flags +T}:T{ +NMSettingSecretFlags (uint32) +T}:T{ +\ \& +T}:T{ +Flags indicating how to handle the "phase2\-client\-cert\-password" property\&. (see the section called \(lqSecret flag types:\(rq for flag values) +T} +T{ phase2\-domain\-suffix\-match T}:T{ string @@ -335,7 +650,7 @@ byte array T}:T{ \ \& T}:T{ -Contains the "phase 2" inner private key when the "phase2\-auth" or "phase2\-autheap" property is set to "tls"\&. Key data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme and private keys, this property should be set to the key\*(Aqs encrypted PEM encoded data\&. When using private keys with the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2\-private\-key\-password" property must be set to password used to decrypt the PKCS#12 certificate and key\&. When using PKCS#12 files and the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "phase2\-private\-key\-password" property must be set to the password used to decode the PKCS#12 private key and certificate\&. +Contains the "phase 2" inner private key when the "phase2\-auth" or "phase2\-autheap" property is set to "tls"\&. Key data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme and private keys, this property should be set to the key\*(Aqs encrypted PEM encoded data\&. When using private keys with the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2\-private\-key\-password" property must be set to password used to decrypt the PKCS#12 certificate and key\&. When using PKCS#12 files and the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2\-private\-key\-password" property must be set to the password used to decode the PKCS#12 private key and certificate\&. T} T{ phase2\-private\-key\-password @@ -389,7 +704,7 @@ byte array T}:T{ \ \& T}:T{ -Contains the private key when the "eap" property is set to "tls"\&. Key data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme and private keys, this property should be set to the key\*(Aqs encrypted PEM encoded data\&. When using private keys with the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private\-key\-password" property must be set to password used to decrypt the PKCS#12 certificate and key\&. When using PKCS#12 files and the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "private\-key\-password" property must be set to the password used to decode the PKCS#12 private key and certificate\&. WARNING: "private\-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users\&. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data\&. +Contains the private key when the "eap" property is set to "tls"\&. Key data is specified using a "scheme"; two are currently supported: blob and path\&. When using the blob scheme and private keys, this property should be set to the key\*(Aqs encrypted PEM encoded data\&. When using private keys with the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte\&. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private\-key\-password" property must be set to password used to decrypt the PKCS#12 certificate and key\&. When using PKCS#12 files and the path scheme, this property should be set to the full UTF\-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private\-key\-password" property must be set to the password used to decode the PKCS#12 private key and certificate\&. WARNING: "private\-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users\&. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data\&. T} T{ private\-key\-password @@ -429,12 +744,9 @@ When TRUE, overrides the "ca\-path" and "phase2\-ca\-path" properties using the T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&2.\ \&adsl setting +.SS "adsl setting" +.PP +ADSL Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -530,12 +842,9 @@ VPI of ADSL connection T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&3.\ \&bluetooth setting +.SS "bluetooth setting" +.PP +Bluetooth Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -581,12 +890,9 @@ Either "dun" for Dial\-Up Networking connections or "panu" for Personal Area Net T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&4.\ \&bond setting +.SS "bond setting" +.PP +Bonding Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -632,12 +938,9 @@ Dictionary of key/value pairs of bonding options\&. Both keys and values must b T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&5.\ \&bridge setting +.SS "bridge setting" +.PP +Bridging Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -753,12 +1056,9 @@ Controls whether Spanning Tree Protocol (STP) is enabled for this bridge\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&6.\ \&bridge\-port setting +.SS "bridge\-port setting" +.PP +Bridge Port Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -814,12 +1114,9 @@ The Spanning Tree Protocol (STP) priority of this bridge port\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&7.\ \&cdma setting +.SS "cdma setting" +.PP +CDMA\-based Mobile Broadband Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -837,8 +1134,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{ +mtu +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. +T} +T{ name T}:T{ string @@ -885,233 +1192,9 @@ The username used to authenticate with the network, if required\&. Many provide T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&8.\ \&connection setting -.TS -allbox tab(:); -lB lB lB lB. -T{ -Key Name -T}:T{ -Value Type -T}:T{ -Default Value -T}:T{ -Value Description -T} -.T& -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l -l l l l. -T{ -autoconnect -T}:T{ -boolean -T}:T{ -TRUE -T}:T{ -Whether 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\&. -T} -T{ -autoconnect\-priority -T}:T{ -int32 -T}:T{ -0 -T}:T{ -The 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\&. -T} -T{ -autoconnect\-retries -T}:T{ -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)\&. -T} -T{ -autoconnect\-slaves -T}:T{ -NMSettingConnectionAutoconnectSlaves (int32) -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -gateway\-ping\-timeout -T}:T{ -uint32 -T}:T{ -0 -T}:T{ -If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping\&. -T} -T{ -id -T}:T{ -string -T}:T{ -\ \& -T}:T{ -A human readable unique identifier for the connection, like "Work Wi\-Fi" or "T\-Mobile 3G"\&. -T} -T{ -interface\-name -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The name of the network interface this connection is bound to\&. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings)\&. For software devices this specifies the name of the created device\&. For connection types where interface names cannot easily be made persistent (e\&.g\&. mobile broadband or USB Ethernet), this property should not be used\&. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface\&. -T} -T{ -lldp -T}:T{ -int32 -T}:T{ -\-1 -T}:T{ -Whether LLDP is enabled for the connection\&. -T} -T{ -master -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Interface name of the master device or UUID of the master connection\&. -T} -T{ -metered -T}:T{ -NMMetered (int32) -T}:T{ -\ \& -T}:T{ -Whether the connection is metered\&. When updating this property on a currently activated connection, the change takes effect immediately\&. -T} -T{ -name -T}:T{ -string -T}:T{ -connection -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{ -permissions -T}:T{ -array of string -T}:T{ -[] -T}:T{ -An array of strings defining what access a given user has to this connection\&. If this is NULL or empty, all users are allowed to access this connection\&. Otherwise a user is allowed to access this connection if and only if they are in this list\&. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah"\&. At this time only the "user" [type] is allowed\&. Any other values are ignored and reserved for future use\&. [id] is the username that this permission refers to, which may not contain the ":" character\&. Any [reserved] information present must be ignored and is reserved for future use\&. All of [type], [id], and [reserved] must be valid UTF\-8\&. -T} -T{ -read\-only -T}:T{ -boolean -T}:T{ -FALSE -T}:T{ -FALSE if the connection can be modified using the provided settings service\*(Aqs D\-Bus interface with the right privileges, or TRUE if the connection is read\-only and cannot be modified\&. -T} -T{ -secondaries -T}:T{ -array of string -T}:T{ -[] -T}:T{ -List of connection UUIDs that should be activated when the base connection itself is activated\&. Currently only VPN connections are supported\&. -T} -T{ -slave\-type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Setting name of the device type of this slave\*(Aqs master connection (eg, "bond"), or NULL if this connection is not a slave\&. -T} -T{ -stable\-id -T}:T{ -string -T}:T{ -\ \& -T}:T{ -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\&. -T} -T{ -timestamp -T}:T{ -uint64 -T}:T{ -0 -T}:T{ -The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated\&. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp\&. The property is only meant for reading (changes to this property will not be preserved)\&. -T} -T{ -type -T}:T{ -string -T}:T{ -\ \& -T}:T{ -Base type of the connection\&. For hardware\-dependent connections, should contain the setting name of the hardware\-type specific setting (ie, "802\-3\-ethernet" or "802\-11\-wireless" or "bluetooth", etc), and for non\-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc)\&. -T} -T{ -uuid -T}:T{ -string -T}:T{ -\ \& -T}:T{ -A universally unique identifier for the connection, for example generated with libuuid\&. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network\&. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re\-created when the Wi\-Fi SSID, mobile broadband network provider, or "type" property changes\&. The UUID must be in the format "2815492f\-7e56\-435e\-b2e9\-246bd7cdc664" (ie, contains only hexadecimal characters and "\-")\&. -T} -T{ -zone -T}:T{ -string -T}:T{ -\ \& -T}:T{ -The trust level of a the connection\&. Free form case\-insensitive string (for example "Home", "Work", "Public")\&. NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall\&. When updating this property on a currently activated connection, the change takes effect immediately\&. -T} -.TE -.sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&9.\ \&dcb setting +.SS "dcb setting" +.PP +Data Center Bridging Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -1287,12 +1370,37 @@ An array of 8 uint values, where the array index corresponds to the User Priorit T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&10.\ \&generic setting +.SS "dummy setting" +.PP +Dummy 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. +T{ +name +T}:T{ +string +T}:T{ +dummy +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} +.TE +.sp 1 +.SS "generic setting" +.PP +Generic Link Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -1318,12 +1426,9 @@ The setting\*(Aqs name, which uniquely identifies the setting within the connect T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&11.\ \&gsm setting +.SS "gsm setting" +.PP +GSM\-based Mobile Broadband Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -1349,6 +1454,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{ apn @@ -1378,6 +1484,15 @@ T}:T{ When TRUE, only connections to the home network will be allowed\&. Connections to roaming networks will not be made\&. T} T{ +mtu +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +If non\-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames\&. +T} +T{ name T}:T{ string @@ -1469,12 +1584,9 @@ The username used to authenticate with the network, if required\&. Many provide T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&12.\ \&infiniband setting +.SS "infiniband setting" +.PP +Infiniband Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -1550,12 +1662,9 @@ The IP\-over\-InfiniBand transport mode\&. Either "datagram" or "connected"\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&13.\ \&ipv4 setting +.SS "ipv4 setting" +.PP +IPv4 Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -1791,12 +1900,9 @@ Deprecated in favor of the \*(Aqroute\-data\*(Aq property, but this can be used T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&14.\ \&ipv6 setting +.SS "ipv6 setting" +.PP +IPv6 Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2042,12 +2148,9 @@ Configure the token for draft\-chown\-6man\-tokenised\-ipv6\-identifiers\-02 IPv T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&15.\ \&ip\-tunnel setting +.SS "ip\-tunnel setting" +.PP +IP Tunneling Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2193,12 +2296,9 @@ The TTL to assign to tunneled packets\&. 0 is a special value meaning that packe T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&16.\ \&macsec setting +.SS "macsec setting" +.PP +MACSec Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2304,12 +2404,9 @@ Specifies the validation mode for incoming frames\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&17.\ \&macvlan setting +.SS "macvlan setting" +.PP +MAC VLAN Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2375,12 +2472,9 @@ Whether the interface should be a MACVTAP\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&18.\ \&802\-11\-olpc\-mesh setting +.SS "802\-11\-olpc\-mesh setting" +.PP +OLPC Wireless Mesh Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2436,12 +2530,9 @@ SSID of the mesh network to join\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&19.\ \&ppp setting +.SS "ppp setting" +.PP +Point\-to\-Point Protocol Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2647,12 +2738,9 @@ If TRUE, 128\-bit MPPE (Microsoft Point\-to\-Point Encrpytion) will be required T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&20.\ \&pppoe setting +.SS "pppoe setting" +.PP +PPP\-over\-Ethernet Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2718,12 +2806,9 @@ Username used to authenticate with the PPPoE service\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&21.\ \&proxy setting +.SS "proxy setting" +.PP +WWW Proxy Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2789,12 +2874,9 @@ PAC URL for obtaining PAC file\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&22.\ \&serial setting +.SS "serial setting" +.PP +Serial Link Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2870,12 +2952,9 @@ Number of stop bits for communication on the serial port\&. Either 1 or 2\&. Th T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&23.\ \&team setting +.SS "team setting" +.PP +Teaming Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2921,12 +3000,9 @@ The setting\*(Aqs name, which uniquely identifies the setting within the connect T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&24.\ \&team\-port setting +.SS "team\-port setting" +.PP +Team Port Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2962,12 +3038,9 @@ The setting\*(Aqs name, which uniquely identifies the setting within the connect T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&25.\ \&tun setting +.SS "tun setting" +.PP +Tunnel Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -3053,12 +3126,47 @@ If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&26.\ \&vlan setting +.SS "user setting" +.PP +General User Profile 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{ +data +T}:T{ +dict of string to string +T}:T{ +{} +T}:T{ +A dictionary of key/value pairs with user data\&. This data is ignored by NetworkManager and can be used at the users discretion\&. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length\&. +T} +T{ +name +T}:T{ +string +T}:T{ +user +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} +.TE +.sp 1 +.SS "vlan setting" +.PP +VLAN Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -3144,12 +3252,9 @@ If given, specifies the parent interface name or parent connection UUID from whi T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&27.\ \&vpn setting +.SS "vpn setting" +.PP +VPN Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -3235,12 +3340,9 @@ If the VPN connection requires a user name for authentication, that name should T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&28.\ \&vxlan setting +.SS "vxlan setting" +.PP +VXLAN Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -3426,12 +3528,9 @@ Specifies the time\-to\-live value to use in outgoing packets\&. T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&29.\ \&wimax setting +.SS "wimax setting" +.PP +WiMax Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -3477,12 +3576,9 @@ Network Service Provider (NSP) name of the WiMAX network this connection should T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&30.\ \&802\-3\-ethernet setting +.SS "802\-3\-ethernet setting" +.PP +Wired Ethernet Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -3658,12 +3754,9 @@ If specified, the password used with magic\-packet\-based Wake\-on\-LAN, represe T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&31.\ \&802\-11\-wireless setting +.SS "802\-11\-wireless setting" +.PP +Wi\-Fi Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -3869,12 +3962,9 @@ If non\-zero, directs the device to use the specified transmit power\&. Units ar T} .TE .sp 1 -.sp -.it 1 an-trap -.nr an-no-space-flag 1 -.nr an-break-flag 1 -.br -.B Table\ \&32.\ \&802\-11\-wireless\-security setting +.SS "802\-11\-wireless\-security setting" +.PP +Wi\-Fi Security Settings\&. .TS allbox tab(:); lB lB lB lB. diff --git a/man/nm-settings.xml b/man/nm-settings.xml index f3a594e8..1ceee6f4 100644 --- a/man/nm-settings.xml +++ b/man/nm-settings.xml @@ -1,6 +1,6 @@ <?xml version="1.0"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> -<refentry id="nm-settings"><refentryinfo><title>nm-settings</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.6.2</refmiscinfo></refmeta><refnamediv><refname>nm-settings</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> +<refentry id="nm-settings"><refentryinfo><title>nm-settings</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.8.0</refmiscinfo></refmeta><refnamediv><refname>nm-settings</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on a concept of connection profiles, sometimes referred to as connections only. These connection profiles contain a network configuration. When NetworkManager activates a connection profile on a network device the configuration will @@ -33,12 +33,39 @@ <emphasis>describe</emphasis> command that can display description of particular settings and properties of this page. </para></variablelist></para> - <table><title>802-1x setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <refsect2><title>connection setting</title><para>General Connection Profile Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry align="left" id="nm-settings.property.connection.autoconnect">autoconnect</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether 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.</entry></row> + <row><entry align="left" id="nm-settings.property.connection.autoconnect-priority">autoconnect-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>The 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.</entry></row> + <row><entry align="left" id="nm-settings.property.connection.autoconnect-retries">autoconnect-retries</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>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).</entry></row> + <row><entry align="left" id="nm-settings.property.connection.autoconnect-slaves">autoconnect-slaves</entry><entry align="left">NMSettingConnectionAutoconnectSlaves (int32)</entry><entry align="left"/><entry>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.</entry></row> + <row><entry align="left" id="nm-settings.property.connection.gateway-ping-timeout">gateway-ping-timeout</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</entry></row> + <row><entry align="left" id="nm-settings.property.connection.id">id</entry><entry align="left">string</entry><entry align="left"/><entry>A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</entry></row> + <row><entry align="left" id="nm-settings.property.connection.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). For software devices this specifies the name of the created device. For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.</entry></row> + <row><entry align="left" id="nm-settings.property.connection.lldp">lldp</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Whether LLDP is enabled for the connection.</entry></row> + <row><entry align="left" id="nm-settings.property.connection.master">master</entry><entry align="left">string</entry><entry align="left"/><entry>Interface name of the master device or UUID of the master connection.</entry></row> + <row><entry align="left" id="nm-settings.property.connection.metered">metered</entry><entry align="left">NMMetered (int32)</entry><entry align="left"/><entry>Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.</entry></row> + <row><entry align="left" id="nm-settings.property.connection.name">name</entry><entry align="left">string</entry><entry align="left">connection</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + <row><entry align="left" id="nm-settings.property.connection.permissions">permissions</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection. Otherwise a user is allowed to access this connection if and only if they are in this list. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</entry></row> + <row><entry align="left" id="nm-settings.property.connection.read-only">read-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>FALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.</entry></row> + <row><entry align="left" id="nm-settings.property.connection.secondaries">secondaries</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported.</entry></row> + <row><entry align="left" id="nm-settings.property.connection.slave-type">slave-type</entry><entry align="left">string</entry><entry align="left"/><entry>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</entry></row> + <row><entry align="left" id="nm-settings.property.connection.stable-id">stable-id</entry><entry align="left">string</entry><entry align="left"/><entry>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 '$' 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.</entry></row> + <row><entry align="left" id="nm-settings.property.connection.timestamp">timestamp</entry><entry align="left">uint64</entry><entry align="left">0</entry><entry>The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).</entry></row> + <row><entry align="left" id="nm-settings.property.connection.type">type</entry><entry align="left">string</entry><entry align="left"/><entry>Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).</entry></row> + <row><entry align="left" id="nm-settings.property.connection.uuid">uuid</entry><entry align="left">string</entry><entry align="left"/><entry>A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").</entry></row> + <row><entry align="left" id="nm-settings.property.connection.zone">zone</entry><entry align="left">string</entry><entry align="left"/><entry>The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. When updating this property on a currently activated connection, the change takes effect immediately.</entry></row> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>802-1x setting</title><para>AIEEE 802.1x Authentication Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.802-1x.altsubject-matches">altsubject-matches</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.anonymous-identity">anonymous-identity</entry><entry align="left">string</entry><entry align="left"/><entry>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</entry></row> + <row><entry align="left" id="nm-settings.property.802-1x.auth-timeout">auth-timeout</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>A timeout for the authentication. Zero means the global default; if the global default is not set, the authentication timeout is 25 seconds.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.ca-cert">ca-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry>Contains the CA certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</entry></row> + <row><entry align="left" id="nm-settings.property.802-1x.ca-cert-password">ca-cert-password</entry><entry align="left">string</entry><entry align="left"/><entry>The password used to access the CA certificate stored in "ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</entry></row> + <row><entry align="left" id="nm-settings.property.802-1x.ca-cert-password-flags">ca-cert-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "ca-cert-password" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.ca-path">ca-path</entry><entry align="left">string</entry><entry align="left"/><entry>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "ca-cert" property.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.client-cert">client-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry>Contains the client certificate if used by the EAP method specified in the "eap" property. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte.</entry></row> + <row><entry align="left" id="nm-settings.property.802-1x.client-cert-password">client-cert-password</entry><entry align="left">string</entry><entry align="left"/><entry>The password used to access the client certificate stored in "client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</entry></row> + <row><entry align="left" id="nm-settings.property.802-1x.client-cert-password-flags">client-cert-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "client-cert-password" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.domain-suffix-match">domain-suffix-match</entry><entry align="left">string</entry><entry align="left"/><entry>Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.eap">eap</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: "leap", "md5", "tls", "peap", "ttls", "pwd", and "fast". Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.identity">identity</entry><entry align="left">string</entry><entry align="left"/><entry>Identity string for EAP authentication methods. Often the user's user or login name.</entry></row> @@ -48,6 +75,7 @@ <row><entry align="left" id="nm-settings.property.802-1x.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.password-raw">password-raw</entry><entry align="left">byte array</entry><entry align="left"/><entry>Password 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.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.password-raw-flags">password-raw-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password-raw" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> + <row><entry align="left" id="nm-settings.property.802-1x.phase1-auth-flags">phase1-auth-flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>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.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase1-fast-provisioning">phase1-fast-provisioning</entry><entry align="left">string</entry><entry align="left"/><entry>Enables 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.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase1-peaplabel">phase1-peaplabel</entry><entry align="left">string</entry><entry align="left"/><entry>Forces 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.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase1-peapver">phase1-peapver</entry><entry align="left">string</entry><entry align="left"/><entry>Forces 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.</entry></row> @@ -55,22 +83,26 @@ <row><entry align="left" id="nm-settings.property.802-1x.phase2-auth">phase2-auth</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the allowed "phase 2" inner non-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. Recognized non-EAP "phase 2" methods are "pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase2-autheap">phase2-autheap</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the allowed "phase 2" inner EAP-based authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase2-ca-cert">phase2-ca-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry>Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</entry></row> + <row><entry align="left" id="nm-settings.property.802-1x.phase2-ca-cert-password">phase2-ca-cert-password</entry><entry align="left">string</entry><entry align="left"/><entry>The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</entry></row> + <row><entry align="left" id="nm-settings.property.802-1x.phase2-ca-cert-password-flags">phase2-ca-cert-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "phase2-ca-cert-password" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase2-ca-path">phase2-ca-path</entry><entry align="left">string</entry><entry align="left"/><entry>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the "phase2-ca-cert" property.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase2-client-cert">phase2-client-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry>Contains the "phase 2" client certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</entry></row> + <row><entry align="left" id="nm-settings.property.802-1x.phase2-client-cert-password">phase2-client-cert-password</entry><entry align="left">string</entry><entry align="left"/><entry>The password used to access the "phase2" client certificate stored in "phase2-client-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</entry></row> + <row><entry align="left" id="nm-settings.property.802-1x.phase2-client-cert-password-flags">phase2-client-cert-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "phase2-client-cert-password" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase2-domain-suffix-match">phase2-domain-suffix-match</entry><entry align="left">string</entry><entry align="left"/><entry>Constraint for server domain name. If set, this FQDN is used as a suffix match requirement for dNSName element(s) of the certificate presented by the authentication server during the inner "phase 2" authentication. If a matching dNSName is found, this constraint is met. If no dNSName values are present, this constraint is matched against SubjectName CN using same suffix match comparison.</entry></row> - <row><entry align="left" id="nm-settings.property.802-1x.phase2-private-key">phase2-private-key</entry><entry align="left">byte array</entry><entry align="left"/><entry>Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</entry></row> + <row><entry align="left" id="nm-settings.property.802-1x.phase2-private-key">phase2-private-key</entry><entry align="left">byte array</entry><entry align="left"/><entry>Contains the "phase 2" inner private key when the "phase2-auth" or "phase2-autheap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "phase2-private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "phase2-private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase2-private-key-password">phase2-private-key-password</entry><entry align="left">string</entry><entry align="left"/><entry>The password used to decrypt the "phase 2" private key specified in the "phase2-private-key" property when the private key either uses the path scheme, or is a PKCS#12 format key.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase2-private-key-password-flags">phase2-private-key-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "phase2-private-key-password" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase2-subject-match">phase2-subject-match</entry><entry align="left">string</entry><entry align="left"/><entry>Substring to be matched against the subject of the certificate presented by the authentication server during the inner "phase 2" authentication. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:phase2-domain-suffix-match.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.pin">pin</entry><entry align="left">string</entry><entry align="left"/><entry>PIN used for EAP authentication methods.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.pin-flags">pin-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "pin" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> - <row><entry align="left" id="nm-settings.property.802-1x.private-key">private-key</entry><entry align="left">byte array</entry><entry align="left"/><entry>Contains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.</entry></row> + <row><entry align="left" id="nm-settings.property.802-1x.private-key">private-key</entry><entry align="left">byte array</entry><entry align="left"/><entry>Contains the private key when the "eap" property is set to "tls". Key data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme and private keys, this property should be set to the key's encrypted PEM encoded data. When using private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data and the "private-key-password" property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string "file://" and ending with a terminating NUL byte, and as with the blob scheme the "private-key-password" property must be set to the password used to decode the PKCS#12 private key and certificate. WARNING: "private-key" is not a "secret" property, and thus unencrypted private key data using the BLOB scheme may be readable by unprivileged users. Private keys should always be encrypted with a private key password to prevent unauthorized access to unencrypted private key data.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.private-key-password">private-key-password</entry><entry align="left">string</entry><entry align="left"/><entry>The password used to decrypt the private key specified in the "private-key" property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.private-key-password-flags">private-key-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "private-key-password" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.subject-match">subject-match</entry><entry align="left">string</entry><entry align="left"/><entry>Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed. This property provides little security, if any, and its use is deprecated in favor of NMSetting8021x:domain-suffix-match.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.system-ca-certs">system-ca-certs</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, overrides the "ca-path" and "phase2-ca-path" properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the "ca-cert" and "phase2-ca-cert" properties. If the path provided with --system-ca-path is rather a file name (bundle of trusted CA certificates), it overrides "ca-cert" and "phase2-ca-cert" properties instead (sets ca_cert/ca_cert2 options for wpa_supplicant).</entry></row> - </tbody></tgroup></table> - <table><title>adsl setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>adsl setting</title><para>ADSL Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.adsl.encapsulation">encapsulation</entry><entry align="left">string</entry><entry align="left"/><entry>Encapsulation of ADSL connection. Can be "vcmux" or "llc".</entry></row> <row><entry align="left" id="nm-settings.property.adsl.name">name</entry><entry align="left">string</entry><entry align="left">adsl</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.adsl.password">password</entry><entry align="left">string</entry><entry align="left"/><entry>Password used to authenticate with the ADSL service.</entry></row> @@ -79,18 +111,18 @@ <row><entry align="left" id="nm-settings.property.adsl.username">username</entry><entry align="left">string</entry><entry align="left"/><entry>Username used to authenticate with the ADSL service.</entry></row> <row><entry align="left" id="nm-settings.property.adsl.vci">vci</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>VCI of ADSL connection</entry></row> <row><entry align="left" id="nm-settings.property.adsl.vpi">vpi</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>VPI of ADSL connection</entry></row> - </tbody></tgroup></table> - <table><title>bluetooth setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>bluetooth setting</title><para>Bluetooth Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.bluetooth.bdaddr">bdaddr</entry><entry align="left">byte array</entry><entry align="left"/><entry>The Bluetooth address of the device.</entry></row> <row><entry align="left" id="nm-settings.property.bluetooth.name">name</entry><entry align="left">string</entry><entry align="left">bluetooth</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.bluetooth.type">type</entry><entry align="left">string</entry><entry align="left"/><entry>Either "dun" for Dial-Up Networking connections or "panu" for Personal Area Networking connections to devices supporting the NAP profile.</entry></row> - </tbody></tgroup></table> - <table><title>bond setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>bond setting</title><para>Bonding Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.bond.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bond's interface name.</entry></row> <row><entry align="left" id="nm-settings.property.bond.name">name</entry><entry align="left">string</entry><entry align="left">bond</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.bond.options">options</entry><entry align="left">dict of string to string</entry><entry align="left">{'mode': 'balance-rr'}</entry><entry>Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</entry></row> - </tbody></tgroup></table> - <table><title>bridge setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>bridge setting</title><para>Bridging Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.bridge.ageing-time">ageing-time</entry><entry align="left">uint32</entry><entry align="left">300</entry><entry>The Ethernet MAC address aging time, in seconds.</entry></row> <row><entry align="left" id="nm-settings.property.bridge.forward-delay">forward-delay</entry><entry align="left">uint32</entry><entry align="left">15</entry><entry>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</entry></row> <row><entry align="left" id="nm-settings.property.bridge.hello-time">hello-time</entry><entry align="left">uint32</entry><entry align="left">2</entry><entry>The Spanning Tree Protocol (STP) hello time, in seconds.</entry></row> @@ -101,43 +133,22 @@ <row><entry align="left" id="nm-settings.property.bridge.name">name</entry><entry align="left">string</entry><entry align="left">bridge</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.bridge.priority">priority</entry><entry align="left">uint32</entry><entry align="left">32768</entry><entry>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge.</entry></row> <row><entry align="left" id="nm-settings.property.bridge.stp">stp</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</entry></row> - </tbody></tgroup></table> - <table><title>bridge-port setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>bridge-port setting</title><para>Bridge Port Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.bridge-port.hairpin-mode">hairpin-mode</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Enables or disabled "hairpin mode" for the port, which allows frames to be sent back out through the port the frame was received on.</entry></row> <row><entry align="left" id="nm-settings.property.bridge-port.name">name</entry><entry align="left">string</entry><entry align="left">bridge-port</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.bridge-port.path-cost">path-cost</entry><entry align="left">uint32</entry><entry align="left">100</entry><entry>The Spanning Tree Protocol (STP) port cost for destinations via this port.</entry></row> <row><entry align="left" id="nm-settings.property.bridge-port.priority">priority</entry><entry align="left">uint32</entry><entry align="left">32</entry><entry>The Spanning Tree Protocol (STP) priority of this bridge port.</entry></row> - </tbody></tgroup></table> - <table><title>cdma setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>cdma setting</title><para>CDMA-based Mobile Broadband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry align="left" id="nm-settings.property.cdma.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row> <row><entry align="left" id="nm-settings.property.cdma.name">name</entry><entry align="left">string</entry><entry align="left">cdma</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.cdma.number">number</entry><entry align="left">string</entry><entry align="left"/><entry>The number to dial to establish the connection to the CDMA-based mobile broadband network, if any. If not specified, the default number (#777) is used when required.</entry></row> <row><entry align="left" id="nm-settings.property.cdma.password">password</entry><entry align="left">string</entry><entry align="left"/><entry>The password used to authenticate with the network, if required. Many providers do not require a password, or accept any password. But if a password is required, it is specified here.</entry></row> <row><entry align="left" id="nm-settings.property.cdma.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> <row><entry align="left" id="nm-settings.property.cdma.username">username</entry><entry align="left">string</entry><entry align="left"/><entry>The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.</entry></row> - </tbody></tgroup></table> - <table><title>connection setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> - <row><entry align="left" id="nm-settings.property.connection.autoconnect">autoconnect</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether 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.</entry></row> - <row><entry align="left" id="nm-settings.property.connection.autoconnect-priority">autoconnect-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>The 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.</entry></row> - <row><entry align="left" id="nm-settings.property.connection.autoconnect-retries">autoconnect-retries</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>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).</entry></row> - <row><entry align="left" id="nm-settings.property.connection.autoconnect-slaves">autoconnect-slaves</entry><entry align="left">NMSettingConnectionAutoconnectSlaves (int32)</entry><entry align="left"/><entry>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.</entry></row> - <row><entry align="left" id="nm-settings.property.connection.gateway-ping-timeout">gateway-ping-timeout</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</entry></row> - <row><entry align="left" id="nm-settings.property.connection.id">id</entry><entry align="left">string</entry><entry align="left"/><entry>A human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G".</entry></row> - <row><entry align="left" id="nm-settings.property.connection.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>The name of the network interface this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). For software devices this specifies the name of the created device. For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.</entry></row> - <row><entry align="left" id="nm-settings.property.connection.lldp">lldp</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Whether LLDP is enabled for the connection.</entry></row> - <row><entry align="left" id="nm-settings.property.connection.master">master</entry><entry align="left">string</entry><entry align="left"/><entry>Interface name of the master device or UUID of the master connection.</entry></row> - <row><entry align="left" id="nm-settings.property.connection.metered">metered</entry><entry align="left">NMMetered (int32)</entry><entry align="left"/><entry>Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.</entry></row> - <row><entry align="left" id="nm-settings.property.connection.name">name</entry><entry align="left">string</entry><entry align="left">connection</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> - <row><entry align="left" id="nm-settings.property.connection.permissions">permissions</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection. Otherwise a user is allowed to access this connection if and only if they are in this list. Each entry is of the form "[type]:[id]:[reserved]"; for example, "user:dcbw:blah". At this time only the "user" [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ":" character. Any [reserved] information present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</entry></row> - <row><entry align="left" id="nm-settings.property.connection.read-only">read-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>FALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified.</entry></row> - <row><entry align="left" id="nm-settings.property.connection.secondaries">secondaries</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported.</entry></row> - <row><entry align="left" id="nm-settings.property.connection.slave-type">slave-type</entry><entry align="left">string</entry><entry align="left"/><entry>Setting name of the device type of this slave's master connection (eg, "bond"), or NULL if this connection is not a slave.</entry></row> - <row><entry align="left" id="nm-settings.property.connection.stable-id">stable-id</entry><entry align="left">string</entry><entry align="left"/><entry>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 '$' 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.</entry></row> - <row><entry align="left" id="nm-settings.property.connection.timestamp">timestamp</entry><entry align="left">uint64</entry><entry align="left">0</entry><entry>The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully activated. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).</entry></row> - <row><entry align="left" id="nm-settings.property.connection.type">type</entry><entry align="left">string</entry><entry align="left"/><entry>Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc).</entry></row> - <row><entry align="left" id="nm-settings.property.connection.uuid">uuid</entry><entry align="left">string</entry><entry align="left"/><entry>A universally unique identifier for the connection, for example generated with libuuid. It should be assigned when the connection is created, and never changed as long as the connection still applies to the same network. For example, it should not be changed when the "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-").</entry></row> - <row><entry align="left" id="nm-settings.property.connection.zone">zone</entry><entry align="left">string</entry><entry align="left"/><entry>The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. When updating this property on a currently activated connection, the change takes effect immediately.</entry></row> - </tbody></tgroup></table> - <table><title>dcb setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>dcb setting</title><para>Data Center Bridging Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.dcb.app-fcoe-flags">app-fcoe-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for the DCB FCoE application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row> <row><entry align="left" id="nm-settings.property.dcb.app-fcoe-mode">app-fcoe-mode</entry><entry align="left">string</entry><entry align="left">"fabric"</entry><entry>The FCoE controller mode; either "fabric" (default) or "vn2vn".</entry></row> <row><entry align="left" id="nm-settings.property.dcb.app-fcoe-priority">app-fcoe-priority</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the "app-fcoe-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row> @@ -154,14 +165,18 @@ <row><entry align="left" id="nm-settings.property.dcb.priority-group-id">priority-group-id</entry><entry align="left">array of uint32</entry><entry align="left">[0, 0, 0, 0, 0, 0, 0, 0]</entry><entry>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.</entry></row> <row><entry align="left" id="nm-settings.property.dcb.priority-strict-bandwidth">priority-strict-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left">[0, 0, 0, 0, 0, 0, 0, 0]</entry><entry>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.</entry></row> <row><entry align="left" id="nm-settings.property.dcb.priority-traffic-class">priority-traffic-class</entry><entry align="left">array of uint32</entry><entry align="left">[0, 0, 0, 0, 0, 0, 0, 0]</entry><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.</entry></row> - </tbody></tgroup></table> - <table><title>generic setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>dummy setting</title><para>Dummy Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry align="left" id="nm-settings.property.dummy.name">name</entry><entry align="left">string</entry><entry align="left">dummy</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>generic setting</title><para>Generic Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.generic.name">name</entry><entry align="left">string</entry><entry align="left">generic</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> - </tbody></tgroup></table> - <table><title>gsm setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>gsm setting</title><para>GSM-based Mobile Broadband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.gsm.apn">apn</entry><entry align="left">string</entry><entry align="left"/><entry>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</entry></row> <row><entry align="left" id="nm-settings.property.gsm.device-id">device-id</entry><entry align="left">string</entry><entry align="left"/><entry>The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</entry></row> <row><entry align="left" id="nm-settings.property.gsm.home-only">home-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</entry></row> + <row><entry align="left" id="nm-settings.property.gsm.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row> <row><entry align="left" id="nm-settings.property.gsm.name">name</entry><entry align="left">string</entry><entry align="left">gsm</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.gsm.network-id">network-id</entry><entry align="left">string</entry><entry align="left"/><entry>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</entry></row> <row><entry align="left" id="nm-settings.property.gsm.number">number</entry><entry align="left">string</entry><entry align="left"/><entry>Number to dial when establishing a PPP data session with the GSM-based mobile broadband network. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which allows NetworkManager to select the appropriate settings automatically.</entry></row> @@ -172,16 +187,16 @@ <row><entry align="left" id="nm-settings.property.gsm.sim-id">sim-id</entry><entry align="left">string</entry><entry align="left"/><entry>The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier.</entry></row> <row><entry align="left" id="nm-settings.property.gsm.sim-operator-id">sim-operator-id</entry><entry align="left">string</entry><entry align="left"/><entry>A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioined by the given operator.</entry></row> <row><entry align="left" id="nm-settings.property.gsm.username">username</entry><entry align="left">string</entry><entry align="left"/><entry>The username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.</entry></row> - </tbody></tgroup></table> - <table><title>infiniband setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>infiniband setting</title><para>Infiniband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.infiniband.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row> <row><entry align="left" id="nm-settings.property.infiniband.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row> <row><entry align="left" id="nm-settings.property.infiniband.name">name</entry><entry align="left">string</entry><entry align="left">infiniband</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.infiniband.p-key">p-key</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.</entry></row> <row><entry align="left" id="nm-settings.property.infiniband.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>The interface name of the parent device of this device. Normally NULL, but if the "p_key" property is set, then you must specify the base device by setting either this property or "mac-address".</entry></row> <row><entry align="left" id="nm-settings.property.infiniband.transport-mode">transport-mode</entry><entry align="left">string</entry><entry align="left"/><entry>The IP-over-InfiniBand transport mode. Either "datagram" or "connected".</entry></row> - </tbody></tgroup></table> - <table><title>ipv4 setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>ipv4 setting</title><para>IPv4 Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.ipv4.address-data">address-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv4 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.</entry></row> <row><entry align="left" id="nm-settings.property.ipv4.addresses">addresses</entry><entry align="left">array of array of uint32</entry><entry align="left">[]</entry><entry>Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet.</entry></row> <row><entry align="left" id="nm-settings.property.ipv4.dad-timeout">dad-timeout</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Timeout 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.</entry></row> @@ -204,8 +219,8 @@ <row><entry align="left" id="nm-settings.property.ipv4.route-data">route-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv4 routes. Each route dictionary contains at least 'dest' and 'prefix' entries, containing the destination IP address as a string, and the prefix length as a uint32. Most routes will also have a 'gateway' entry, containing the gateway IP address as a string. If the route has a 'metric' entry (containing a uint32), that will be used as the metric for the route (otherwise NM will pick a default value appropriate to the device). Additional attributes may also exist on some routes.</entry></row> <row><entry align="left" id="nm-settings.property.ipv4.route-metric">route-metric</entry><entry align="left">int64</entry><entry align="left">-1</entry><entry>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is choosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</entry></row> <row><entry align="left" id="nm-settings.property.ipv4.routes">routes</entry><entry align="left">array of array of uint32</entry><entry align="left">[]</entry><entry>Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. If the metric is 0, NM will choose an appropriate default metric for the device. (There is no way to explicitly specify an actual metric of 0 with this property.)</entry></row> - </tbody></tgroup></table> - <table><title>ipv6 setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>ipv6 setting</title><para>IPv6 Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.ipv6.addr-gen-mode">addr-gen-mode</entry><entry align="left">int32</entry><entry align="left">1</entry><entry>Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: "eui64", 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.</entry></row> <row><entry align="left" id="nm-settings.property.ipv6.address-data">address-data</entry><entry align="left">array of vardict</entry><entry align="left"/><entry>Array of IPv6 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.</entry></row> <row><entry align="left" id="nm-settings.property.ipv6.addresses">addresses</entry><entry align="left">array of legacy IPv6 address struct (a(ayuay))</entry><entry align="left">[]</entry><entry>Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv6 address structures. Each IPv6 address structure is composed of an IPv6 address, a prefix length (1 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.</entry></row> @@ -229,8 +244,8 @@ <row><entry align="left" id="nm-settings.property.ipv6.route-metric">route-metric</entry><entry align="left">int64</entry><entry align="left">-1</entry><entry>The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is choosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.</entry></row> <row><entry align="left" id="nm-settings.property.ipv6.routes">routes</entry><entry align="left">array of legacy IPv6 route struct (a(ayuayu))</entry><entry align="left">[]</entry><entry>Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv6 route structures. Each IPv6 route structure is composed of an IPv6 address, a prefix length (1 - 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric. If the metric is 0, NM will choose an appropriate default metric for the device.</entry></row> <row><entry align="left" id="nm-settings.property.ipv6.token">token</entry><entry align="left">string</entry><entry align="left"/><entry>Configure the token for draft-chown-6man-tokenised-ipv6-identifiers-02 IPv6 tokenized interface identifiers. Useful with eui64 addr-gen-mode.</entry></row> - </tbody></tgroup></table> - <table><title>ip-tunnel setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>ip-tunnel setting</title><para>IP Tunneling Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.ip-tunnel.encapsulation-limit">encapsulation-limit</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.</entry></row> <row><entry align="left" id="nm-settings.property.ip-tunnel.flow-label">flow-label</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.</entry></row> <row><entry align="left" id="nm-settings.property.ip-tunnel.input-key">input-key</entry><entry align="left">string</entry><entry align="left"/><entry>The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.</entry></row> @@ -244,8 +259,8 @@ <row><entry align="left" id="nm-settings.property.ip-tunnel.remote">remote</entry><entry align="left">string</entry><entry align="left"/><entry>The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.</entry></row> <row><entry align="left" id="nm-settings.property.ip-tunnel.tos">tos</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.</entry></row> <row><entry align="left" id="nm-settings.property.ip-tunnel.ttl">ttl</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.</entry></row> - </tbody></tgroup></table> - <table><title>macsec setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>macsec setting</title><para>MACSec Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.macsec.encrypt">encrypt</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether the transmitted traffic must be encrypted.</entry></row> <row><entry align="left" id="nm-settings.property.macsec.mka-cak">mka-cak</entry><entry align="left">string</entry><entry align="left"/><entry>The pre-shared CAK (Connectivity Association Key) for MACsec Key Agreement.</entry></row> <row><entry align="left" id="nm-settings.property.macsec.mka-cak-flags">mka-cak-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "mka-cak" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> @@ -255,21 +270,21 @@ <row><entry align="left" id="nm-settings.property.macsec.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this MACSEC interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row> <row><entry align="left" id="nm-settings.property.macsec.port">port</entry><entry align="left">int32</entry><entry align="left">1</entry><entry>The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</entry></row> <row><entry align="left" id="nm-settings.property.macsec.validation">validation</entry><entry align="left">int32</entry><entry align="left">2</entry><entry>Specifies the validation mode for incoming frames.</entry></row> - </tbody></tgroup></table> - <table><title>macvlan setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>macvlan setting</title><para>MAC VLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.macvlan.mode">mode</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.</entry></row> <row><entry align="left" id="nm-settings.property.macvlan.name">name</entry><entry align="left">string</entry><entry align="left">macvlan</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.macvlan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row> <row><entry align="left" id="nm-settings.property.macvlan.promiscuous">promiscuous</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Whether the interface should be put in promiscuous mode.</entry></row> <row><entry align="left" id="nm-settings.property.macvlan.tap">tap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Whether the interface should be a MACVTAP.</entry></row> - </tbody></tgroup></table> - <table><title>802-11-olpc-mesh setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>802-11-olpc-mesh setting</title><para>OLPC Wireless Mesh Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.802-11-olpc-mesh.channel">channel</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Channel on which the mesh network to join is located.</entry></row> <row><entry align="left" id="nm-settings.property.802-11-olpc-mesh.dhcp-anycast-address">dhcp-anycast-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.</entry></row> <row><entry align="left" id="nm-settings.property.802-11-olpc-mesh.name">name</entry><entry align="left">string</entry><entry align="left">802-11-olpc-mesh</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.802-11-olpc-mesh.ssid">ssid</entry><entry align="left">byte array</entry><entry align="left"/><entry>SSID of the mesh network to join.</entry></row> - </tbody></tgroup></table> - <table><title>ppp setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>ppp setting</title><para>Point-to-Point Protocol Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.ppp.baud">baud</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If 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.</entry></row> <row><entry align="left" id="nm-settings.property.ppp.crtscts">crtscts</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If 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.</entry></row> <row><entry align="left" id="nm-settings.property.ppp.lcp-echo-failure">lcp-echo-failure</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The "lcp-echo-interval" property must also be set to a non-zero value if this property is used.</entry></row> @@ -289,39 +304,39 @@ <row><entry align="left" id="nm-settings.property.ppp.refuse-pap">refuse-pap</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, the PAP authentication method will not be used.</entry></row> <row><entry align="left" id="nm-settings.property.ppp.require-mppe">require-mppe</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>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.</entry></row> <row><entry align="left" id="nm-settings.property.ppp.require-mppe-128">require-mppe-128</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>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.</entry></row> - </tbody></tgroup></table> - <table><title>pppoe setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>pppoe setting</title><para>PPP-over-Ethernet Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.pppoe.name">name</entry><entry align="left">string</entry><entry align="left">pppoe</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.pppoe.password">password</entry><entry align="left">string</entry><entry align="left"/><entry>Password used to authenticate with the PPPoE service.</entry></row> <row><entry align="left" id="nm-settings.property.pppoe.password-flags">password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "password" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> <row><entry align="left" id="nm-settings.property.pppoe.service">service</entry><entry align="left">string</entry><entry align="left"/><entry>If 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.</entry></row> <row><entry align="left" id="nm-settings.property.pppoe.username">username</entry><entry align="left">string</entry><entry align="left"/><entry>Username used to authenticate with the PPPoE service.</entry></row> - </tbody></tgroup></table> - <table><title>proxy setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>proxy setting</title><para>WWW Proxy Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.proxy.browser-only">browser-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Whether the proxy configuration is for browser only.</entry></row> <row><entry align="left" id="nm-settings.property.proxy.method">method</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Method for proxy configuration, Default is NM_SETTING_PROXY_METHOD_NONE (0)</entry></row> <row><entry align="left" id="nm-settings.property.proxy.name">name</entry><entry align="left">string</entry><entry align="left">proxy</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.proxy.pac-script">pac-script</entry><entry align="left">string</entry><entry align="left"/><entry>PAC script for the connection.</entry></row> <row><entry align="left" id="nm-settings.property.proxy.pac-url">pac-url</entry><entry align="left">string</entry><entry align="left"/><entry>PAC URL for obtaining PAC file.</entry></row> - </tbody></tgroup></table> - <table><title>serial setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>serial setting</title><para>Serial Link Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.serial.baud">baud</entry><entry align="left">uint32</entry><entry align="left">57600</entry><entry>Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</entry></row> <row><entry align="left" id="nm-settings.property.serial.bits">bits</entry><entry align="left">uint32</entry><entry align="left">8</entry><entry>Byte-width of the serial communication. The 8 in "8n1" for example.</entry></row> <row><entry align="left" id="nm-settings.property.serial.name">name</entry><entry align="left">string</entry><entry align="left">serial</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.serial.parity">parity</entry><entry align="left">byte</entry><entry align="left"/><entry>The connection parity: 69 (ASCII 'E') for even parity, 111 (ASCII 'o') for odd, 110 (ASCII 'n') for none.</entry></row> <row><entry align="left" id="nm-settings.property.serial.send-delay">send-delay</entry><entry align="left">uint64</entry><entry align="left">0</entry><entry>Time to delay between each byte sent to the modem, in microseconds.</entry></row> <row><entry align="left" id="nm-settings.property.serial.stopbits">stopbits</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in "8n1" for example.</entry></row> - </tbody></tgroup></table> - <table><title>team setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>team setting</title><para>Teaming Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.team.config">config</entry><entry align="left">string</entry><entry align="left"/><entry>The JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</entry></row> <row><entry align="left" id="nm-settings.property.team.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the team's interface name.</entry></row> <row><entry align="left" id="nm-settings.property.team.name">name</entry><entry align="left">string</entry><entry align="left">team</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> - </tbody></tgroup></table> - <table><title>team-port setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>team-port setting</title><para>Team Port Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.team-port.config">config</entry><entry align="left">string</entry><entry align="left"/><entry>The JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</entry></row> <row><entry align="left" id="nm-settings.property.team-port.name">name</entry><entry align="left">string</entry><entry align="left">team-port</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> - </tbody></tgroup></table> - <table><title>tun setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>tun setting</title><para>Tunnel Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.tun.group">group</entry><entry align="left">string</entry><entry align="left"/><entry>The group ID which will own the device. If set to NULL everyone will be able to use the device.</entry></row> <row><entry align="left" id="nm-settings.property.tun.mode">mode</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.</entry></row> <row><entry align="left" id="nm-settings.property.tun.multi-queue">multi-queue</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.</entry></row> @@ -329,8 +344,12 @@ <row><entry align="left" id="nm-settings.property.tun.owner">owner</entry><entry align="left">string</entry><entry align="left"/><entry>The user ID which will own the device. If set to NULL everyone will be able to use the device.</entry></row> <row><entry align="left" id="nm-settings.property.tun.pi">pi</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.</entry></row> <row><entry align="left" id="nm-settings.property.tun.vnet-hdr">vnet-hdr</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.</entry></row> - </tbody></tgroup></table> - <table><title>vlan setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>user setting</title><para>General User Profile Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + <row><entry align="left" id="nm-settings.property.user.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>A dictionary of key/value pairs with user data. This data is ignored by NetworkManager and can be used at the users discretion. The keys only support a strict ascii format, but the values can be arbitrary UTF8 strings up to a certain length.</entry></row> + <row><entry align="left" id="nm-settings.property.user.name">name</entry><entry align="left">string</entry><entry align="left">user</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>vlan setting</title><para>VLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.vlan.egress-priority-map">egress-priority-map</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format "from:to" where both "from" and "to" are unsigned integers, ie "7:3".</entry></row> <row><entry align="left" id="nm-settings.property.vlan.flags">flags</entry><entry align="left">NMVlanFlags (uint32)</entry><entry align="left"/><entry>One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.</entry></row> <row><entry align="left" id="nm-settings.property.vlan.id">id</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.</entry></row> @@ -338,8 +357,8 @@ <row><entry align="left" id="nm-settings.property.vlan.interface-name">interface-name</entry><entry align="left">string</entry><entry align="left"/><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.</entry></row> <row><entry align="left" id="nm-settings.property.vlan.name">name</entry><entry align="left">string</entry><entry align="left">vlan</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.vlan.parent">parent</entry><entry align="left">string</entry><entry align="left"/><entry>If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.</entry></row> - </tbody></tgroup></table> - <table><title>vpn setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>vpn setting</title><para>VPN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.vpn.data">data</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</entry></row> <row><entry align="left" id="nm-settings.property.vpn.name">name</entry><entry align="left">string</entry><entry align="left">vpn</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.vpn.persistent">persistent</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.</entry></row> @@ -347,8 +366,8 @@ <row><entry align="left" id="nm-settings.property.vpn.service-type">service-type</entry><entry align="left">string</entry><entry align="left"/><entry>D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</entry></row> <row><entry align="left" id="nm-settings.property.vpn.timeout">timeout</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overriden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.</entry></row> <row><entry align="left" id="nm-settings.property.vpn.user-name">user-name</entry><entry align="left">string</entry><entry align="left"/><entry>If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.</entry></row> - </tbody></tgroup></table> - <table><title>vxlan setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>vxlan setting</title><para>VXLAN Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.vxlan.ageing">ageing</entry><entry align="left">uint32</entry><entry align="left">300</entry><entry>Specifies the lifetime in seconds of FDB entries learnt by the kernel.</entry></row> <row><entry align="left" id="nm-settings.property.vxlan.destination-port">destination-port</entry><entry align="left">uint32</entry><entry align="left">8472</entry><entry>Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</entry></row> <row><entry align="left" id="nm-settings.property.vxlan.id">id</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the VXLAN Network Identifer (or VXLAN Segment Identifier) to use.</entry></row> @@ -366,13 +385,13 @@ <row><entry align="left" id="nm-settings.property.vxlan.source-port-min">source-port-min</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</entry></row> <row><entry align="left" id="nm-settings.property.vxlan.tos">tos</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the TOS value to use in outgoing packets.</entry></row> <row><entry align="left" id="nm-settings.property.vxlan.ttl">ttl</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Specifies the time-to-live value to use in outgoing packets.</entry></row> - </tbody></tgroup></table> - <table><title>wimax setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>wimax setting</title><para>WiMax Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.wimax.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). Deprecated: 1</entry></row> <row><entry align="left" id="nm-settings.property.wimax.name">name</entry><entry align="left">string</entry><entry align="left">wimax</entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> <row><entry align="left" id="nm-settings.property.wimax.network-name">network-name</entry><entry align="left">string</entry><entry align="left"/><entry>Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1</entry></row> - </tbody></tgroup></table> - <table><title>802-3-ethernet setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>802-3-ethernet setting</title><para>Wired Ethernet Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.802-3-ethernet.assigned-mac-address">assigned-mac-address</entry><entry align="left">string</entry><entry align="left"/><entry>The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explict hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".</entry></row> <row><entry align="left" id="nm-settings.property.802-3-ethernet.auto-negotiate">auto-negotiate</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If 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.</entry></row> <row><entry align="left" id="nm-settings.property.802-3-ethernet.cloned-mac-address">cloned-mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>This 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".</entry></row> @@ -389,8 +408,8 @@ <row><entry align="left" id="nm-settings.property.802-3-ethernet.speed">speed</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>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.</entry></row> <row><entry align="left" id="nm-settings.property.802-3-ethernet.wake-on-lan">wake-on-lan</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>The 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).</entry></row> <row><entry align="left" id="nm-settings.property.802-3-ethernet.wake-on-lan-password">wake-on-lan-password</entry><entry align="left">string</entry><entry align="left"/><entry>If specified, the password used with magic-packet-based Wake-on-LAN, represented as an Ethernet MAC address. If NULL, no password will be required.</entry></row> - </tbody></tgroup></table> - <table><title>802-11-wireless setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>802-11-wireless setting</title><para>Wi-Fi Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.802-11-wireless.assigned-mac-address">assigned-mac-address</entry><entry align="left">string</entry><entry align="left"/><entry>The new field for the cloned MAC address. It can be either a hardware address in ASCII representation, or one of the special values "preserve", "permanent", "random" or "stable". This field replaces the deprecated "cloned-mac-address" on D-Bus, which can only contain explict hardware addresses. Note that this property only exists in D-Bus API. libnm and nmcli continue to call this property "cloned-mac-address".</entry></row> <row><entry align="left" id="nm-settings.property.802-11-wireless.band">band</entry><entry align="left">string</entry><entry align="left"/><entry>802.11 frequency band of the network. One of "a" for 5GHz 802.11a or "bg" for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if "a" is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</entry></row> <row><entry align="left" id="nm-settings.property.802-11-wireless.bssid">bssid</entry><entry align="left">byte array</entry><entry align="left"/><entry>If 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.</entry></row> @@ -410,8 +429,8 @@ <row><entry align="left" id="nm-settings.property.802-11-wireless.seen-bssids">seen-bssids</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>A list of BSSIDs (each BSSID formatted as a MAC address like "00:11:22:33:44:55") that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</entry></row> <row><entry align="left" id="nm-settings.property.802-11-wireless.ssid">ssid</entry><entry align="left">byte array</entry><entry align="left"/><entry>SSID of the Wi-Fi network. Must be specified.</entry></row> <row><entry align="left" id="nm-settings.property.802-11-wireless.tx-power">tx-power</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</entry></row> - </tbody></tgroup></table> - <table><title>802-11-wireless-security setting</title><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> + </tbody></tgroup></informaltable></refsect2> + <refsect2><title>802-11-wireless-security setting</title><para>Wi-Fi Security Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.802-11-wireless-security.auth-alg">auth-alg</entry><entry align="left">string</entry><entry align="left"/><entry>When WEP is used (ie, key-mgmt = "none" or "ieee8021x") indicate the 802.11 authentication algorithm required by the AP here. One of "open" for Open System, "shared" for Shared Key, or "leap" for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = "ieee8021x" and auth-alg = "leap") the "leap-username" and "leap-password" properties must be specified.</entry></row> <row><entry align="left" id="nm-settings.property.802-11-wireless-security.group">group</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>A list of group/broadcast encryption algorithms which prevents connections to Wi-Fi networks that do not utilize one of the algorithms in the list. For maximum compatibility leave this property empty. Each list element may be one of "wep40", "wep104", "tkip", or "ccmp".</entry></row> <row><entry align="left" id="nm-settings.property.802-11-wireless-security.key-mgmt">key-mgmt</entry><entry align="left">string</entry><entry align="left"/><entry>Key management used for the connection. One of "none" (WEP), "ieee8021x" (Dynamic WEP), "wpa-none" (Ad-Hoc WPA-PSK), "wpa-psk" (infrastructure WPA-PSK), or "wpa-eap" (WPA-Enterprise). This property must be set for any Wi-Fi connection that uses security.</entry></row> @@ -430,7 +449,7 @@ <row><entry align="left" id="nm-settings.property.802-11-wireless-security.wep-key2">wep-key2</entry><entry align="left">string</entry><entry align="left"/><entry>Index 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.</entry></row> <row><entry align="left" id="nm-settings.property.802-11-wireless-security.wep-key3">wep-key3</entry><entry align="left">string</entry><entry align="left"/><entry>Index 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.</entry></row> <row><entry align="left" id="nm-settings.property.802-11-wireless-security.wep-tx-keyidx">wep-tx-keyidx</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>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.</entry></row> - </tbody></tgroup></table> + </tbody></tgroup></informaltable></refsect2> <refsect2 id="secrets-flags"><title>Secret flag types:</title><para> Each secret property in a setting has an associated <emphasis>flags</emphasis> property that describes how to handle that secret. The <emphasis>flags</emphasis> property is a bitfield diff --git a/man/nm-settings.xsl b/man/nm-settings.xsl index 733d08aa..36fb8288 100644 --- a/man/nm-settings.xsl +++ b/man/nm-settings.xsl @@ -126,22 +126,25 @@ </xsl:template> <xsl:template match="setting"> - <table> + <refsect2> <title><xsl:value-of select="@name"/> setting</title> - <tgroup cols="4"> - <thead> - <row> - <entry>Key Name</entry> - <entry>Value Type</entry> - <entry>Default Value</entry> - <entry>Value Description</entry> - </row> - </thead> - <tbody> - <xsl:apply-templates/> - </tbody> - </tgroup> - </table> + <para><xsl:value-of select="@description"/>.</para> + <informaltable> + <tgroup cols="4"> + <thead> + <row> + <entry>Key Name</entry> + <entry>Value Type</entry> + <entry>Default Value</entry> + <entry>Value Description</entry> + </row> + </thead> + <tbody> + <xsl:apply-templates/> + </tbody> + </tgroup> + </informaltable> + </refsect2> </xsl:template> <xsl:template match="property"> diff --git a/man/nmcli-examples.7 b/man/nmcli-examples.7 index ab02a564..3291c072 100644 --- a/man/nmcli-examples.7 +++ b/man/nmcli-examples.7 @@ -2,12 +2,12 @@ .\" Title: nmcli-examples .\" Author: .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 02/15/2017 +.\" Date: 05/10/2017 .\" Manual: Examples -.\" Source: NetworkManager 1.6.2 +.\" Source: NetworkManager 1.8.0 .\" Language: English .\" -.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.6\&.2" "Examples" +.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.8\&.0" "Examples" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -312,7 +312,47 @@ that is bound to interface name \fIcon show\fR command displays the profile so that all parameters can be reviewed\&. .PP -\fBExample\ \&10.\ \&Escaping colon characters in tabular mode\fR +\fBExample\ \&10.\ \&Convenient field values retrieval for scripting\fR +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ \fBnmcli \-g ip4\&.address connection show my\-con\-eth0\fR +192\&.168\&.1\&.12/24 +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ \fBnmcli \-g ip4\&.address,ip4\&.dns connection show my\-con\-eth0\fR +192\&.168\&.1\&.12/24 +192\&.168\&.1\&.1 +.fi +.if n \{\ +.RE +.\} +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ \fBnmcli \-g ip4 connection show my\-con\-eth0\fR +IP4:192\&.168\&.1\&.12/24:192\&.168\&.1\&.1::192\&.168\&.1\&.1:: +.fi +.if n \{\ +.RE +.\} +.PP +This example shows retrieval of ip4 connection field values via the \-\-get\-values option\&. Multiple comma separated fields can be provided: they will be printed one per line\&. If a whole section is provided instead of a single field, the name of the section will be printed followed by all the related field values on the same line\&. See also \-\-terse, \-\-mode, \-\-fields and \-\-escape options in +\fBnmcli\fR(1) +manual page for more customized output\&. +.PP +\fBExample\ \&11.\ \&Escaping colon characters in tabular mode\fR .sp .if n \{\ .RS 4 @@ -331,7 +371,7 @@ nager/ActiveConnection/9 .PP This example shows escaping colon characters in tabular mode\&. It may be useful for script processing, because \*(Aq:\*(Aq is used as a field separator\&. .PP -\fBExample\ \&11.\ \&nmcli usage in a NetworkManager dispatcher script to make Ethernet and Wi\-Fi mutually exclusive\fR +\fBExample\ \&12.\ \&nmcli usage in a NetworkManager dispatcher script to make Ethernet and Wi\-Fi mutually exclusive\fR .sp .if n \{\ .RS 4 @@ -369,7 +409,7 @@ manual page for more information about NetworkManager dispatcher scripts\&. .PP \fBExample sessions of interactive connection editor\fR .PP -\fBExample\ \&12.\ \&Adding an ethernet connection profile in interactive editor (a)\fR +\fBExample\ \&13.\ \&Adding an ethernet connection profile in interactive editor (a)\fR .sp .if n \{\ .RS 4 diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml index 864e6504..0b15f112 100644 --- a/man/nmcli-examples.xml +++ b/man/nmcli-examples.xml @@ -254,6 +254,25 @@ B,DISPATCH</screen> </para> </example> + <example><title>Convenient field values retrieval for scripting</title> +<screen><prompt>$ </prompt><userinput>nmcli -g ip4.address connection show my-con-eth0</userinput> +192.168.1.12/24</screen> +<screen><prompt>$ </prompt><userinput>nmcli -g ip4.address,ip4.dns connection show my-con-eth0</userinput> +192.168.1.12/24 +192.168.1.1</screen> +<screen><prompt>$ </prompt><userinput>nmcli -g ip4 connection show my-con-eth0</userinput> +IP4:192.168.1.12/24:192.168.1.1::192.168.1.1::</screen> + <para> + This example shows retrieval of ip4 connection field values via the --get-values + option. Multiple comma separated fields can be provided: they will be printed one + per line. If a whole section is provided instead of a single field, the name of the + section will be printed followed by all the related field values on the same line. + See also --terse, --mode, --fields and --escape options in <link linkend='nmcli'><citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry></link> + manual page for more customized output. + </para> + </example> + + <example><title>Escaping colon characters in tabular mode</title> <screen><prompt>$ </prompt><userinput>nmcli -t -f general -e yes -m tab dev show eth0</userinput> GENERAL:eth0:ethernet:Intel Corporation:82567LM Gigabit Network Connection: diff --git a/man/nmcli.1 b/man/nmcli.1 index 571f9ed3..349c3331 100644 --- a/man/nmcli.1 +++ b/man/nmcli.1 @@ -2,12 +2,12 @@ .\" Title: nmcli .\" Author: .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 02/15/2017 +.\" Date: 05/10/2017 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.6.2 +.\" Source: NetworkManager 1.8.0 .\" Language: English .\" -.TH "NMCLI" "1" "" "NetworkManager 1\&.6\&.2" "General Commands Manual" +.TH "NMCLI" "1" "" "NetworkManager 1\&.8\&.0" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -151,13 +151,16 @@ common is used to print common field values of the command\&. .sp If omitted, default is -common\&. The option is mandatory when -\fB\-\-terse\fR -is used\&. In this case, generic values -all -and -common -cannot be used\&. This is to maintain compatibility when new fields are added in the future\&. +common\&. +.RE +.PP +\fB\-g\fR | \fB\-\-get\-values\fR {\fIfield1\fR,\fIfield2\fR... | all | common} +.RS 4 +This option is used to print values from specific fields\&. It is basically a shortcut for +\-\-mode tabular \-\-terse \-\-fields +and is a convenient way to retrieve values for particular fields\&. The values are printed one per line without headers\&. +.sp +If a section is specified instead of a field, the section name will be printed followed by colon separated values of the fields belonging to that section, all on the same line\&. .RE .PP \fB\-e\fR | \fB\-\-escape\fR {yes | no} @@ -877,6 +880,17 @@ macvlan vxlan .RE .sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +dummy +.RE +.sp The most typical uses are described in the EXAMPLES section\&. diff --git a/man/nmcli.xml b/man/nmcli.xml index d7610c8c..8ee7914b 100644 --- a/man/nmcli.xml +++ b/man/nmcli.xml @@ -205,10 +205,30 @@ command. <literal>common</literal> is used to print common field values of the command.</para> - <para>If omitted, default is <literal>common</literal>. The option is - mandatory when <option>--terse</option> is used. In this case, generic values - <literal>all</literal> and <literal>common</literal> cannot be used. This - is to maintain compatibility when new fields are added in the future.</para> + <para>If omitted, default is <literal>common</literal>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-g</option></arg> + <arg choice='plain'><option>--get-values</option></arg> + <group choice='req'> + <arg choice='plain' rep='repeat'><replaceable>field1</replaceable>,<replaceable>field2</replaceable></arg> + <arg choice='plain'>all</arg> + <arg choice='plain'>common</arg> + </group> + </group></term> + + <listitem> + <para>This option is used to print values from specific fields. It is basically + a shortcut for <literal>--mode tabular --terse --fields</literal> and is a convenient + way to retrieve values for particular fields. The values are printed one per line + without headers.</para> + + <para>If a section is specified instead of a field, the section name will be printed + followed by colon separated values of the fields belonging to that section, all on + the same line.</para> </listitem> </varlistentry> @@ -925,6 +945,7 @@ <listitem><para><literal>ip-tunnel</literal></para></listitem> <listitem><para><literal>macvlan</literal></para></listitem> <listitem><para><literal>vxlan</literal></para></listitem> + <listitem><para><literal>dummy</literal></para></listitem> </itemizedlist> <para>The most typical uses are described in the <link linkend='examples' endterm='examples.title' /> section.</para> diff --git a/man/nmtui.1 b/man/nmtui.1 index cecd1b98..95ab4506 100644 --- a/man/nmtui.1 +++ b/man/nmtui.1 @@ -2,12 +2,12 @@ .\" Title: nmtui .\" Author: .\" Generator: DocBook XSL Stylesheets v1.79.1 <http://docbook.sf.net/> -.\" Date: 02/15/2017 +.\" Date: 05/10/2017 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.6.2 +.\" Source: NetworkManager 1.8.0 .\" Language: English .\" -.TH "NMTUI" "1" "" "NetworkManager 1\&.6\&.2" "General Commands Manual" +.TH "NMTUI" "1" "" "NetworkManager 1\&.8\&.0" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- |