diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/NetworkManager.8 | 20 | ||||
| -rw-r--r-- | man/NetworkManager.conf.5 | 75 | ||||
| -rw-r--r-- | man/NetworkManager.conf.xml | 96 | ||||
| -rw-r--r-- | man/NetworkManager.xml | 13 | ||||
| -rw-r--r-- | man/meson.build | 98 | ||||
| -rw-r--r-- | man/nm-online.1 | 6 | ||||
| -rw-r--r-- | man/nm-openvswitch.7 | 6 | ||||
| -rw-r--r-- | man/nm-settings-ifcfg-rh.5 | 56 | ||||
| -rw-r--r-- | man/nm-settings-ifcfg-rh.xml | 22 | ||||
| -rw-r--r-- | man/nm-settings-keyfile.5 | 6 | ||||
| -rw-r--r-- | man/nm-settings-keyfile.xml | 2 | ||||
| -rw-r--r-- | man/nm-settings.5 | 114 | ||||
| -rw-r--r-- | man/nm-settings.xml | 56 | ||||
| -rw-r--r-- | man/nmcli-examples.7 | 6 | ||||
| -rw-r--r-- | man/nmcli.1 | 213 | ||||
| -rw-r--r-- | man/nmcli.xml | 282 | ||||
| -rw-r--r-- | man/nmtui.1 | 6 |
17 files changed, 928 insertions, 149 deletions
diff --git a/man/NetworkManager.8 b/man/NetworkManager.8 index f53d405a..db19e7be 100644 --- a/man/NetworkManager.8 +++ b/man/NetworkManager.8 @@ -2,12 +2,12 @@ .\" Title: NetworkManager .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 05/11/2018 +.\" Date: 07/25/2018 .\" Manual: Network management daemons -.\" Source: NetworkManager 1.10.8 +.\" Source: NetworkManager 1.12.2 .\" Language: English .\" -.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.10\&.8" "Network management daemons" +.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.12\&.2" "Network management daemons" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -119,6 +119,11 @@ The network connectivity state has changed (no connectivity, went online, etc)\& .PP The environment contains more information about the interface and the connection\&. The following variables are available for the use in the dispatcher scripts: .PP +\fINM_DISPATCHER_ACTION\fR +.RS 4 +The dispatcher action like "up" or "dhcp4\-change", identical to the first command line argument\&. Since NetworkManager 1\&.12\&.0\&. +.RE +.PP \fICONNECTION_UUID\fR .RS 4 The UUID of the connection profile\&. @@ -257,10 +262,11 @@ for more information on configuration file\&. .PP \fB\-\-plugins\fR .RS 4 -List plugins used to manage system\-wide connection settings\&. This list has preference over plugins specified in the configuration file\&. Currently supported plugins are: keyfile, -\fBifcfg\-rh\fR, -\fBifcfg\-suse\fR, -\fBifupdown\fR\&. +List plugins used to manage system\-wide connection settings\&. This list has preference over plugins specified in the configuration file\&. See +main\&.plugins +setting in +\fBNetworkManager.conf\fR(5) +for supported options\&. .RE .PP \fB\-\-log\-level\fR diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5 index 23368723..31af2759 100644 --- a/man/NetworkManager.conf.5 +++ b/man/NetworkManager.conf.5 @@ -2,12 +2,12 @@ .\" Title: NetworkManager.conf .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 05/11/2018 +.\" Date: 07/25/2018 .\" Manual: Configuration -.\" Source: NetworkManager 1.10.8 +.\" Source: NetworkManager 1.12.2 .\" Language: English .\" -.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.10\&.8" "Configuration" +.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.12\&.2" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -109,12 +109,13 @@ plugins\-=remove\-me .PP \fIplugins\fR .RS 4 -Lists system settings plugin names separated by \*(Aq,\*(Aq\&. These plugins are used to read and write system\-wide connections\&. When multiple plugins are specified, the connections are read from all listed plugins\&. When writing connections, the plugins will be asked to save the connection in the order listed here; if the first plugin cannot write out that connection type (or can\*(Aqt write out any connections) the next plugin is tried, etc\&. If none of the plugins can save the connection, an error is returned to the user\&. +Lists system settings plugin names separated by \*(Aq,\*(Aq\&. These plugins are used to read and write system\-wide connection profiles\&. When multiple plugins are specified, the connections are read from all listed plugins\&. When writing connections, the plugins will be asked to save the connection in the order listed here; if the first plugin cannot write out that connection type (or can\*(Aqt write out any connections) the next plugin is tried, etc\&. If none of the plugins can save the connection, an error is returned to the user\&. .sp -If NetworkManager defines a distro\-specific network\-configuration plugin for your system, then that will normally be listed here\&. (See below for the available plugins\&.) Note that the +The default value and the number of available plugins is distro\-specific\&. See +the section called \(lqPLUGINS\(rq +below for the available plugins\&. Note that NetworkManager\*(Aqs native keyfile -plugin is always appended to the end of this list (if it doesn\*(Aqt already appear earlier in the list), so if there is no distro\-specific plugin for your system then you can leave this key unset and NetworkManager will fall back to using -keyfile\&. +plugin is always appended to the end of this list (if it doesn\*(Aqt already appear earlier in the list)\&. .RE .PP \fImonitor\-connection\-files\fR @@ -223,6 +224,7 @@ default is used, unless /etc/resolv\&.conf is a symlink to +/run/systemd/resolve/stub\-resolv\&.conf, /run/systemd/resolve/resolv\&.conf, /lib/systemd/resolv\&.conf or @@ -266,7 +268,7 @@ by replacing it with a symlink\&. .sp file: NetworkManager will write /etc/resolv\&.conf -as file\&. If it finds a symlink, it will follow the symlink and update the target instead\&. +as file\&. If it finds a symlink to an existing target, it will follow the symlink and update the target instead\&. In no case will an existing symlink be replaced by a file\&. Note that older versions of NetworkManager behaved differently and would replace dangling symlinks with a plain file\&. .sp resolvconf: NetworkManager will run resolvconf to update the DNS configuration\&. .sp @@ -549,7 +551,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 "syslog"\&. +The logging backend\&. Supported values are "syslog" and "journal"\&. When NetworkManager is started with "\-\-debug" in addition all messages will be printed to stderr\&. If unspecified, the default is "syslog"\&. .RE .PP \fIaudit\fR @@ -595,6 +597,10 @@ If left unspecified, the default value is 3 tries before failing the connection\ .RS 4 .RE .PP +\fIconnection\&.mdns\fR +.RS 4 +.RE +.PP \fIconnection\&.stable\-id\fR .RS 4 .RE @@ -631,6 +637,10 @@ If configured explicitly to 0, the MTU is not reconfigured during device activat .RS 4 .RE .PP +\fIipv4\&.dhcp\-client\-id\fR +.RS 4 +.RE +.PP \fIipv4\&.dhcp\-timeout\fR .RS 4 If left unspecified, the default value for the interface type is used\&. @@ -645,6 +655,11 @@ If left unspecified, the default value for the interface type is used\&. If left unspecified, routes are only added to the main table\&. Note that this is different from explicitly selecting the main table 254, because of how NetworkManager removes extraneous routes from the tables\&. .RE .PP +\fIipv6\&.dhcp\-duid\fR +.RS 4 +If left unspecified, it defaults to "lease"\&. +.RE +.PP \fIipv6\&.dhcp\-timeout\fR .RS 4 If left unspecified, the default value for the interface type is used\&. @@ -700,6 +715,11 @@ If left unspecified, the default value "ignore" will be used\&. .RS 4 If left unspecified, the default value "optional" will be used\&. .RE +.PP +\fIwifi\-sec\&.fils\fR +.RS 4 +If left unspecified, the default value "optional" will be used\&. +.RE .SS "Sections" .PP You can configure multiple @@ -821,6 +841,15 @@ allows to influence the generated MAC address to use certain vendor OUIs\&. If d wifi\&.cloned\-mac\-address\&. .RE .PP +\fIwifi\&.backend\fR +.RS 4 +Specify the Wi\-Fi backend used for the device\&. Currently supported are +wpa_supplicant +and +iwd +(experimental)\&. +.RE +.PP \fIwifi\&.scan\-generate\-mac\-address\-mask\fR .RS 4 Like the per\-connection settings @@ -851,7 +880,7 @@ This section controls NetworkManager\*(Aqs optional connectivity checking functi .PP \fIuri\fR .RS 4 -The URI of a web page to periodically request when connectivity is being checked\&. This page should return the header "X\-NetworkManager\-Status" with a value of "online"\&. Alternatively, it\*(Aqs body content should be set to "NetworkManager is online"\&. The body content check can be controlled by the +The URI of a web page to periodically request when connectivity is being checked\&. This page should return the header "X\-NetworkManager\-Status" with a value of "online"\&. Alternatively, its body content should be set to "NetworkManager is online"\&. The body content check can be controlled by the response option\&. If this option is blank or missing, connectivity checking is disabled\&. .RE @@ -994,12 +1023,16 @@ enable=nm\-version\-min:1\&.3,nm\-version\-min:1\&.2\&.6,nm\-version\-min:1\&.0\ .RE .SH "PLUGINS" .PP +Settings plugins for reading and writing connection profiles\&. The number of available plugins is distribution specific\&. +.PP \fIkeyfile\fR .RS 4 The keyfile plugin is the generic plugin that supports all the connection types and capabilities that NetworkManager has\&. It writes files out in an \&.ini\-style format in -/etc/NetworkManager/system\-connections\&. +/etc/NetworkManager/system\-connections\&. See +\fBnm-settings-keyfile\fR(5) +for details about the file format\&. .sp The stored connection file may contain passwords, secrets and private keys in plain text, so it will be made readable only to root, and the plugin will ignore files that are readable or writable by any user or group other than root\&. See "Secret flag types" in \fBnm-settings\fR(5) @@ -1017,14 +1050,11 @@ ifcfg\-rh implicitly enables ibft plugin, if it is available\&. This can be disabled by adding -no\-ibft\&. -.RE -.PP -\fIifcfg\-suse\fR -.RS 4 -This plugin is deprecated and its selection has no effect\&. The -keyfile -plugin should be used instead\&. +no\-ibft\&. See +/usr/share/doc/initscripts/sysconfig\&.txt +and +\fBnm-settings-ifcfg-rh\fR(5) +for more information about the ifcfg file format\&. .RE .PP \fIifupdown\fR @@ -1052,6 +1082,13 @@ Note that ibft plugin uses /sbin/iscsiadm and thus requires CAP_SYS_ADMIN capability\&. .RE +.PP +\fIifcfg\-suse\fR, \fIifnet\fR +.RS 4 +These plugins are deprecated and their selection has no effect\&. The +keyfile +plugin should be used instead\&. +.RE .SH "APPENDIX" .SS "Device List Format" .PP diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml index 446540aa..17bc42f3 100644 --- a/man/NetworkManager.conf.xml +++ b/man/NetworkManager.conf.xml @@ -132,7 +132,7 @@ plugins-=remove-me <para> Lists system settings plugin names separated by ','. These plugins are used to read and write system-wide - connections. When multiple plugins are specified, the + connection profiles. When multiple plugins are specified, the connections are read from all listed plugins. When writing connections, the plugins will be asked to save the connection in the order listed here; if the first plugin @@ -142,15 +142,12 @@ plugins-=remove-me to the user. </para> <para> - If NetworkManager defines a distro-specific - network-configuration plugin for your system, then that - will normally be listed here. (See below for the available - plugins.) Note that the <literal>keyfile</literal> plugin - is always appended to the end of this list (if it doesn't - already appear earlier in the list), so if there is no - distro-specific plugin for your system then you can leave - this key unset and NetworkManager will fall back to using - <literal>keyfile</literal>. + The default value and the number of available plugins is + distro-specific. See <xref linkend="settings-plugins"/> + below for the available plugins. + Note that NetworkManager's native <literal>keyfile</literal> + plugin is always appended to the end of this list (if it doesn't + already appear earlier in the list). </para> </listitem> </varlistentry> @@ -312,6 +309,7 @@ no-auto-default=* <listitem><para>Set the DNS (<filename>resolv.conf</filename>) processing mode. If the key is unspecified, <literal>default</literal> is used, unless <filename>/etc/resolv.conf</filename> is a symlink to + <filename>/run/systemd/resolve/stub-resolv.conf</filename>, <filename>/run/systemd/resolve/resolv.conf</filename>, <filename>/lib/systemd/resolv.conf</filename> or <filename>/usr/lib/systemd/resolv.conf</filename>. @@ -365,8 +363,11 @@ no-auto-default=* 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 - instead.</para> + a symlink to an existing target, it will follow the symlink and + update the target instead. In no case will an existing symlink + be replaced by a file. Note that older versions of NetworkManager + behaved differently and would replace dangling symlinks with a + plain file.</para> <para><literal>resolvconf</literal>: NetworkManager will run resolvconf to update the DNS configuration.</para> <para><literal>netconfig</literal>: NetworkManager will run @@ -602,12 +603,10 @@ unmanaged-devices=mac:00:22:68:1c:59:b1;mac:00:1E:65:30:D1:C4;interface-name:eth <varlistentry> <term><varname>backend</varname></term> <listitem><para>The logging backend. Supported values - are "<literal>debug</literal>", "<literal>syslog</literal>", - "<literal>journal</literal>". - "<literal>debug</literal>" uses syslog and logs to standard error. - If NetworkManager is started in debug mode (<literal>--debug</literal>) - this option is ignored and "<literal>debug</literal>" is always used. - Otherwise, the default is "<literal>&NM_CONFIG_DEFAULT_LOGGING_BACKEND_TEXT;</literal>". + are "<literal>syslog</literal>" and "<literal>journal</literal>". + When NetworkManager is started with "<literal>--debug</literal>" + in addition all messages will be printed to stderr. + If unspecified, the default is "<literal>&NM_CONFIG_DEFAULT_LOGGING_BACKEND_TEXT;</literal>". </para></listitem> </varlistentry> <varlistentry> @@ -655,6 +654,9 @@ ipv6.ip6-privacy=0 <term><varname>connection.lldp</varname></term> </varlistentry> <varlistentry> + <term><varname>connection.mdns</varname></term> + </varlistentry> + <varlistentry> <term><varname>connection.stable-id</varname></term> </varlistentry> <varlistentry> @@ -683,6 +685,9 @@ ipv6.ip6-privacy=0 <term><varname>ipv4.dad-timeout</varname></term> </varlistentry> <varlistentry> + <term><varname>ipv4.dhcp-client-id</varname></term> + </varlistentry> + <varlistentry> <term><varname>ipv4.dhcp-timeout</varname></term> <listitem><para>If left unspecified, the default value for the interface type is used.</para></listitem> @@ -698,6 +703,10 @@ ipv6.ip6-privacy=0 </para></listitem> </varlistentry> <varlistentry> + <term><varname>ipv6.dhcp-duid</varname></term> + <listitem><para>If left unspecified, it defaults to "lease".</para></listitem> + </varlistentry> + <varlistentry> <term><varname>ipv6.dhcp-timeout</varname></term> <listitem><para>If left unspecified, the default value for the interface type is used.</para></listitem> @@ -749,6 +758,11 @@ ipv6.ip6-privacy=0 <listitem><para>If left unspecified, the default value "<literal>optional</literal>" will be used.</para></listitem> </varlistentry> + <varlistentry> + <term><varname>wifi-sec.fils</varname></term> + <listitem><para>If left unspecified, the default value + "<literal>optional</literal>" will be used.</para></listitem> + </varlistentry> </variablelist> </para> </refsect2> @@ -927,6 +941,15 @@ managed=1 </para> </listitem> </varlistentry> + <varlistentry id="wifi.backend"> + <term><varname>wifi.backend</varname></term> + <listitem> + <para> + Specify the Wi-Fi backend used for the device. Currently supported + are <literal>wpa_supplicant</literal> and <literal>iwd</literal> (experimental). + </para> + </listitem> + </varlistentry> <varlistentry> <term><varname>wifi.scan-generate-mac-address-mask</varname></term> <listitem> @@ -979,7 +1002,7 @@ managed=1 <listitem><para>The URI of a web page to periodically request when connectivity is being checked. This page should return the header "X-NetworkManager-Status" with a - value of "online". Alternatively, it's body content should + value of "online". Alternatively, its body content should be set to "NetworkManager is online". The body content check can be controlled by the <literal>response</literal> option. If this option is blank or missing, connectivity @@ -1151,9 +1174,14 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16 </para> </refsect1> - <refsect1> + <refsect1 id="settings-plugins"> <title>Plugins</title> + <para> + Settings plugins for reading and writing connection profiles. The number of + available plugins is distribution specific. + </para> + <variablelist> <varlistentry> <term><varname>keyfile</varname></term> @@ -1164,6 +1192,8 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16 capabilities that NetworkManager has. It writes files out in an .ini-style format in <filename>/etc/NetworkManager/system-connections</filename>. + See <link linkend='nm-settings-keyfile'><citerefentry><refentrytitle>nm-settings-keyfile</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> + for details about the file format. </para> <para> The stored connection file may contain passwords, secrets and @@ -1180,6 +1210,7 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16 </para> </listitem> </varlistentry> + <varlistentry> <term><varname>ifcfg-rh</varname></term> <listitem> @@ -1193,17 +1224,9 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16 Enabling <literal>ifcfg-rh</literal> implicitly enables <literal>ibft</literal> plugin, if it is available. This can be disabled by adding <literal>no-ibft</literal>. - </para> - </listitem> - </varlistentry> - - <varlistentry> - <term><varname>ifcfg-suse</varname></term> - <listitem> - <para> - This plugin is deprecated and its selection has no effect. - The <literal>keyfile</literal> plugin should be used - instead. + See <filename>/usr/share/doc/initscripts/sysconfig.txt</filename> + and <link linkend='nm-settings-ifcfg-rh'><citerefentry><refentrytitle>nm-settings-ifcfg-rh</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> + for more information about the ifcfg file format. </para> </listitem> </varlistentry> @@ -1244,6 +1267,17 @@ enable=nm-version-min:1.3,nm-version-min:1.2.6,nm-version-min:1.0.16 </listitem> </varlistentry> + <varlistentry> + <term><varname>ifcfg-suse</varname>, <varname>ifnet</varname></term> + <listitem> + <para> + These plugins are deprecated and their selection has no effect. + The <literal>keyfile</literal> plugin should be used + instead. + </para> + </listitem> + </varlistentry> + </variablelist> </refsect1> diff --git a/man/NetworkManager.xml b/man/NetworkManager.xml index 60dbe7d7..7b0513bb 100644 --- a/man/NetworkManager.xml +++ b/man/NetworkManager.xml @@ -182,6 +182,13 @@ The following variables are available for the use in the dispatcher scripts: <variablelist class="dispatcher-environment"> <varlistentry> + <term><varname>NM_DISPATCHER_ACTION</varname></term> + <listitem><para> + The dispatcher action like "up" or "dhcp4-change", identical to the first + command line argument. Since NetworkManager 1.12.0. + </para></listitem> + </varlistentry> + <varlistentry> <term><varname>CONNECTION_UUID</varname></term> <listitem><para> The UUID of the connection profile. @@ -376,9 +383,9 @@ <term><option>--plugins</option></term> <listitem><para>List plugins used to manage system-wide connection settings. This list has preference over plugins - specified in the configuration file. Currently supported - plugins are: keyfile, <option>ifcfg-rh</option>, - <option>ifcfg-suse</option>, <option>ifupdown</option>. + specified in the configuration file. See <literal>main.plugins</literal> + setting in <link linkend='NetworkManager.conf'><citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></link> + for supported options. </para></listitem> </varlistentry> <varlistentry> diff --git a/man/meson.build b/man/meson.build new file mode 100644 index 00000000..044ddcab --- /dev/null +++ b/man/meson.build @@ -0,0 +1,98 @@ +common_conf = configuration_data() +common_conf.set('NM_VERSION', nm_version) +common_conf.set('sysconfdir', nm_sysconfdir) +common_conf.set('nmrundir', nm_pkgrundir) +common_conf.set('NM_CONFIG_DEFAULT_MAIN_AUTH_POLKIT_TEXT', config_default_main_auth_polkit) +common_conf.set('NM_CONFIG_DEFAULT_LOGGING_BACKEND_TEXT', config_logging_backend_default) +common_conf.set('NM_CONFIG_DEFAULT_LOGGING_AUDIT_TEXT', config_default_logging_audit) +common_conf.set('NM_CONFIG_DEFAULT_MAIN_RC_MANAGER', config_dns_rc_manager_default) +common_conf.set('NM_CONFIG_DEFAULT_MAIN_DHCP', config_dhcp_default) + +common = 'common.ent' + +configure_file( + input: common + '.in', + output: common, + configuration: common_conf +) + +xsltproc_options = [ + xsltproc, + '--output', '@OUTPUT@', + '--path', meson.current_build_dir(), + '--xinclude', + '--nonet', + '--stringparam', 'man.output.quietly', '1', + '--stringparam', 'funcsynopsis.style', 'ansi', + '--stringparam', 'man.th.extra1.suppress', '1', + '--stringparam', 'man.authors.section.enabled', '0', + '--stringparam', 'man.copyright.section.enabled', '0', + '--stringparam', 'man.th.title.max.length', '30' +] + +docbook_xls = 'http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl' + +mans_xmls = [] + +mans = [ + ['NetworkManager', '8'], + ['NetworkManager.conf', '5'], + ['nm-online', '1'], + ['nmcli-examples', '7'], + ['nmcli', '1'], + ['nmtui', '1'] +] + +if enable_ovs + mans += [['nm-openvswitch', '7']] +endif + +foreach man: mans + input = man[0] + '.xml' + content_files += join_paths(meson.current_source_dir(), input) + + output = '@0@.@1@'.format(man[0], man[1]) + + custom_target( + output, + input: input, + output: output, + command: xsltproc_options + [docbook_xls, '@INPUT@'], + install: true, + install_dir: join_paths(nm_mandir, 'man' + man[1]) + ) +endforeach + +if enable_introspection + mans = [ + ['nm-settings-keyfile', '5', nm_settings_keyfile_docs], + ['nm-settings', '5', nm_settings_docs] + ] + + if enable_ifcfg_rh + mans += [['nm-settings-ifcfg-rh', '5', nm_settings_ifcfg_rh_docs]] + endif + + foreach man: mans + output = man[0] + '.xml' + + input = custom_target( + output, + input: man[2], + output: output, + command: xsltproc_options + [join_paths(meson.current_source_dir(), man[0] + '.xsl'), '@INPUT@'] + ) + content_files += input.full_path() + + output = '@0@.@1@'.format(man[0], man[1]) + + custom_target( + output, + input: input, + output: output, + command: xsltproc_options + [docbook_xls, '@INPUT@'], + install: true, + install_dir: join_paths(nm_mandir, 'man' + man[1]) + ) + endforeach +endif diff --git a/man/nm-online.1 b/man/nm-online.1 index b85d94ed..57b277b4 100644 --- a/man/nm-online.1 +++ b/man/nm-online.1 @@ -2,12 +2,12 @@ .\" Title: nm-online .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 05/11/2018 +.\" Date: 07/25/2018 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.10.8 +.\" Source: NetworkManager 1.12.2 .\" Language: English .\" -.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.10\&.8" "General Commands Manual" +.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.12\&.2" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-openvswitch.7 b/man/nm-openvswitch.7 index e9797be2..f5d5ce0f 100644 --- a/man/nm-openvswitch.7 +++ b/man/nm-openvswitch.7 @@ -2,12 +2,12 @@ .\" Title: nm-openvswitch .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 05/11/2018 +.\" Date: 07/25/2018 .\" Manual: OpenVSwitch support overview -.\" Source: NetworkManager 1.10.8 +.\" Source: NetworkManager 1.12.2 .\" Language: English .\" -.TH "NM\-OPENVSWITCH" "7" "" "NetworkManager 1\&.10\&.8" "OpenVSwitch support overview" +.TH "NM\-OPENVSWITCH" "7" "" "NetworkManager 1\&.12\&.2" "OpenVSwitch support overview" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-settings-ifcfg-rh.5 b/man/nm-settings-ifcfg-rh.5 index 93149ba6..e4fb1c1e 100644 --- a/man/nm-settings-ifcfg-rh.5 +++ b/man/nm-settings-ifcfg-rh.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-ifcfg-rh .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 05/11/2018 +.\" Date: 07/25/2018 .\" Manual: Configuration -.\" Source: NetworkManager 1.10.8 +.\" Source: NetworkManager 1.12.2 .\" Language: English .\" -.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.10\&.8" "Configuration" +.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.12\&.2" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -973,6 +973,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ id @@ -1162,6 +1163,19 @@ T}:T{ T}:T{ Number of retries for authentication\&. T} +T{ +mdns +T}:T{ +CONNECTION_MDNS\fI(+)\fR +T}:T{ +missing variable means global default +T}:T{ +Whether or not mDNS is enabled for the connection\fB + +Example: \fRCONNECTION_MDNS=yes\fB + +Allowed values: \fRyes,no,resolve +T} .TE .sp 1 .sp @@ -1640,18 +1654,18 @@ T}:T{ T}:T{ A string sent to the DHCP server to identify the local machine\&. A binary value can be specified using hex notation (\*(Aqaa:bb:cc\*(Aq)\&.\fB -Example: \fRDHCP_CLIENT_ID=ax\-srv\-1; DHCP_CLIENT_ID=01:44:44:44:44:44:44" +Example: \fRDHCP_CLIENT_ID=ax\-srv\-1; DHCP_CLIENT_ID=01:44:44:44:44:44:44 T} T{ dad\-timeout T}:T{ -ARPING_WAIT +ACD_TIMEOUT, ARPING_WAIT T}:T{ -missing variable means global default (config override or 3) +missing variable means global default (config override or zero) T}:T{ -Timeout (in seconds) for performing DAD before configuring IPv4 addresses\&. 0 turns off the DAD completely, \-1 means default value\&.\fB +Timeout (in milliseconds for ACD_TIMEOUT or in seconds for ARPING_WAIT) for address conflict detection before configuring IPv4 addresses\&. 0 turns off the ACD completely, \-1 means default value\&.\fB -Example: \fRARPING_WAIT=2 +Example: \fRACD_TIMEOUT=2000 or ARPING_WAIT=2 T} T{ dhcp\-timeout @@ -1713,6 +1727,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ method @@ -1894,6 +1909,17 @@ The IPv6 tokenized interface identifier token\fB Example: \fRIPV6_TOKEN=::53 T} +T{ +dhcp\-duid +T}:T{ +DHCPV6_DUID\fI(+)\fR +T}:T{ +\ \& +T}:T{ +A string sent to the DHCPv6 server to identify the local machine\&. Apart from the special values "lease", "stable\-llt", "stable\-ll", "stable\-uuid", "llt" and "ll" a binary value in hex format is expected\&. An hex string where each octet is separated by a colon is also accepted\&.\fB + +Example: \fRDHCPV6_DUID=LL; DHCPV6_DUID=0301deadbeef0001; DHCPV6_DUID=03:01:de:ad:be:ef:00:01 +T} .TE .sp 1 .sp @@ -2466,6 +2492,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{ key\-mgmt @@ -2660,6 +2687,19 @@ Used to control the WPS methods to be used Valid values are "default", "auto", " Example: \fRWPS_METHOD=disabled, WPS_METHOD="pin pbc" T} +T{ +fils +T}:T{ +FILS\fI(+)\fR +T}:T{ +\ \& +T}:T{ +Enables or disables FILS (802\&.11ai)\fB + +Example: \fRFILS=required\fB + +Allowed values: \fRdefault, disable, optional, required +T} .TE .sp 1 .sp diff --git a/man/nm-settings-ifcfg-rh.xml b/man/nm-settings-ifcfg-rh.xml index 06dcf4e7..a4578756 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.10.8</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.12.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> 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 @@ -257,7 +257,11 @@ Allowed values: </emphasis>yes,no,unknown</entry></row><row><entry align="left"> Example: </emphasis>LLDP=no<emphasis role="bold"> -Allowed values: </emphasis>boolean value or 'rx'</entry></row><row><entry align="left">auth-retries</entry><entry align="left">AUTH_RETRIES<emphasis>(+)</emphasis></entry><entry align="left">0</entry><entry align="left">Number of retries for authentication.</entry></row></tbody></tgroup></table><table><title>dcb setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">app-fcoe-flags</entry><entry align="left">DCB_APP_FCOE_ENABLE, DCB_APP_FCOE_ADVERTISE, DCB_APP_FCOE_WILLING</entry><entry align="left">no</entry><entry align="left">FCOE flags.<emphasis role="bold"> +Allowed values: </emphasis>boolean value or 'rx'</entry></row><row><entry align="left">auth-retries</entry><entry align="left">AUTH_RETRIES<emphasis>(+)</emphasis></entry><entry align="left">0</entry><entry align="left">Number of retries for authentication.</entry></row><row><entry align="left">mdns</entry><entry align="left">CONNECTION_MDNS<emphasis>(+)</emphasis></entry><entry align="left">missing variable means global default</entry><entry align="left">Whether or not mDNS is enabled for the connection<emphasis role="bold"> + +Example: </emphasis>CONNECTION_MDNS=yes<emphasis role="bold"> + +Allowed values: </emphasis>yes,no,resolve</entry></row></tbody></tgroup></table><table><title>dcb setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">app-fcoe-flags</entry><entry align="left">DCB_APP_FCOE_ENABLE, DCB_APP_FCOE_ADVERTISE, DCB_APP_FCOE_WILLING</entry><entry align="left">no</entry><entry align="left">FCOE flags.<emphasis role="bold"> Example: </emphasis>DCB_APP_FCOE_ENABLE=yes DCB_APP_FCOE_ADVERTISE=yes</entry></row><row><entry align="left">app-fcoe-priority</entry><entry align="left">DCB_APP_FCOE_PRIORITY</entry><entry align="left"/><entry align="left">Priority of FCoE frames.<emphasis role="bold"> @@ -302,9 +306,9 @@ Example: </emphasis>RES_OPTIONS=ndots:2 timeout:3</entry></row><row><entry align 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. A binary value can be specified using hex notation ('aa:bb:cc').<emphasis role="bold"> -Example: </emphasis>DHCP_CLIENT_ID=ax-srv-1; DHCP_CLIENT_ID=01:44:44:44:44:44:44"</entry></row><row><entry align="left">dad-timeout</entry><entry align="left">ARPING_WAIT</entry><entry align="left">missing variable means global default (config override or 3)</entry><entry align="left">Timeout (in seconds) for performing DAD before configuring IPv4 addresses. 0 turns off the DAD completely, -1 means default value.<emphasis role="bold"> +Example: </emphasis>DHCP_CLIENT_ID=ax-srv-1; DHCP_CLIENT_ID=01:44:44:44:44:44:44</entry></row><row><entry align="left">dad-timeout</entry><entry align="left">ACD_TIMEOUT, ARPING_WAIT</entry><entry align="left">missing variable means global default (config override or zero)</entry><entry align="left">Timeout (in milliseconds for ACD_TIMEOUT or in seconds for ARPING_WAIT) for address conflict detection before configuring IPv4 addresses. 0 turns off the ACD completely, -1 means default value.<emphasis role="bold"> -Example: </emphasis>ARPING_WAIT=2</entry></row><row><entry align="left">dhcp-timeout</entry><entry align="left">IPV4_DHCP_TIMEOUT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A timeout after which the DHCP transaction fails in case of no response.<emphasis role="bold"> +Example: </emphasis>ACD_TIMEOUT=2000 or ARPING_WAIT=2</entry></row><row><entry align="left">dhcp-timeout</entry><entry align="left">IPV4_DHCP_TIMEOUT<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A timeout after which the DHCP transaction fails in case of no response.<emphasis role="bold"> Example: </emphasis>IPV4_DHCP_TIMEOUT=10</entry></row><row><entry align="left">dhcp-fqdn</entry><entry align="left">DHCP_FQDN</entry><entry align="left"/><entry align="left">FQDN to send to the DHCP server. When both DHCP_HOSTNAME and DHCP_FQDN are specified only the latter is used.<emphasis role="bold"> @@ -326,7 +330,9 @@ Example: </emphasis>IPV6_ADDR_GEN_MODE=stable-privacy<emphasis role="bold"> Allowed values: </emphasis>IPV6_ADDR_GEN_MODE: eui64, stable-privacy</entry></row><row><entry align="left">token</entry><entry align="left">IPV6_TOKEN</entry><entry align="left"/><entry align="left">The IPv6 tokenized interface identifier token<emphasis role="bold"> -Example: </emphasis>IPV6_TOKEN=::53</entry></row></tbody></tgroup></table><table><title>ovs-bridge 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>ovs-interface 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>ovs-patch 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>ovs-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/></tgroup></table><table><title>proxy setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">method</entry><entry align="left">PROXY_METHOD<emphasis>(+)</emphasis></entry><entry align="left">none</entry><entry align="left">Method for proxy configuration. For "auto", WPAD is used for proxy configuration, or set the PAC file via PAC_URL or PAC_SCRIPT.<emphasis role="bold"> +Example: </emphasis>IPV6_TOKEN=::53</entry></row><row><entry align="left">dhcp-duid</entry><entry align="left">DHCPV6_DUID<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">A string sent to the DHCPv6 server to identify the local machine. Apart from the special values "lease", "stable-llt", "stable-ll", "stable-uuid", "llt" and "ll" a binary value in hex format is expected. An hex string where each octet is separated by a colon is also accepted.<emphasis role="bold"> + +Example: </emphasis>DHCPV6_DUID=LL; DHCPV6_DUID=0301deadbeef0001; DHCPV6_DUID=03:01:de:ad:be:ef:00:01</entry></row></tbody></tgroup></table><table><title>ovs-bridge 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>ovs-interface 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>ovs-patch 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>ovs-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/></tgroup></table><table><title>proxy setting</title><tgroup cols="4"><thead><row><entry>Property</entry><entry>Ifcfg-rh Variable</entry><entry>Default</entry><entry>Description</entry></row></thead><tbody><row><entry align="left">method</entry><entry align="left">PROXY_METHOD<emphasis>(+)</emphasis></entry><entry align="left">none</entry><entry align="left">Method for proxy configuration. For "auto", WPAD is used for proxy configuration, or set the PAC file via PAC_URL or PAC_SCRIPT.<emphasis role="bold"> Allowed values: </emphasis>none, auto</entry></row><row><entry align="left">browser-only</entry><entry align="left">BROWSER_ONLY<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">Whether the proxy configuration is for browser only.</entry></row><row><entry align="left">pac-url</entry><entry align="left">PAC_URL<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">URL for PAC file.<emphasis role="bold"> @@ -376,7 +382,11 @@ Example: </emphasis>WPA_PSK_FLAGS=user</entry></row><row><entry align="left">lea Example: </emphasis>KEY1=s:ahoj, KEY1=0a1c45bc02, KEY_PASSPHRASE1=mysupersecretkey</entry></row><row><entry align="left">wps-method</entry><entry align="left">WPS_METHOD</entry><entry align="left"/><entry align="left">Used to control the WPS methods to be used Valid values are "default", "auto", "disabled", "pin" and "pbc". If omitted, whatver the AP announces is used.<emphasis role="bold"> -Example: </emphasis>WPS_METHOD=disabled, WPS_METHOD="pin pbc"</entry></row></tbody></tgroup></table><table><title>802-11-wireless 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">ssid</entry><entry align="left">ESSID</entry><entry align="left"/><entry align="left">SSID of Wi-Fi network.<emphasis role="bold"> +Example: </emphasis>WPS_METHOD=disabled, WPS_METHOD="pin pbc"</entry></row><row><entry align="left">fils</entry><entry align="left">FILS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">Enables or disables FILS (802.11ai)<emphasis role="bold"> + +Example: </emphasis>FILS=required<emphasis role="bold"> + +Allowed values: </emphasis>default, disable, optional, required</entry></row></tbody></tgroup></table><table><title>802-11-wireless 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">ssid</entry><entry align="left">ESSID</entry><entry align="left"/><entry align="left">SSID of Wi-Fi network.<emphasis role="bold"> Example: </emphasis>ESSID="Quick Net"</entry></row><row><entry align="left">mode</entry><entry align="left">MODE</entry><entry align="left"/><entry align="left">Wi-Fi network mode.<emphasis role="bold"> diff --git a/man/nm-settings-keyfile.5 b/man/nm-settings-keyfile.5 index 2c27d009..f91ba161 100644 --- a/man/nm-settings-keyfile.5 +++ b/man/nm-settings-keyfile.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings-keyfile .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 05/11/2018 +.\" Date: 07/25/2018 .\" Manual: Configuration -.\" Source: NetworkManager 1.10.8 +.\" Source: NetworkManager 1.12.2 .\" Language: English .\" -.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.10\&.8" "Configuration" +.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.12\&.2" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-settings-keyfile.xml b/man/nm-settings-keyfile.xml index 78ef9af8..28303684 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.10.8</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.12.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> 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 diff --git a/man/nm-settings.5 b/man/nm-settings.5 index 9b699db7..ba832ea3 100644 --- a/man/nm-settings.5 +++ b/man/nm-settings.5 @@ -2,12 +2,12 @@ .\" Title: nm-settings .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 05/11/2018 +.\" Date: 07/25/2018 .\" Manual: Configuration -.\" Source: NetworkManager 1.10.8 +.\" Source: NetworkManager 1.12.2 .\" Language: English .\" -.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.10\&.8" "Configuration" +.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.12\&.2" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -94,6 +94,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{ auth\-retries @@ -111,7 +112,7 @@ 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\&. +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\&. Note that autoconnect is not implemented for VPN profiles\&. See "secondaries" as an alternative to automatically connect VPN profiles\&. T} T{ autoconnect\-priority @@ -138,7 +139,7 @@ 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\&. +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 properties "autoconnect", "autoconnect\-priority" and "autoconnect\-retries" are unrelated to this setting\&. 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 @@ -186,6 +187,15 @@ T}:T{ Interface name of the master device or UUID of the master connection\&. T} T{ +mdns +T}:T{ +int32 +T}:T{ +\-1 +T}:T{ +Whether mDNS is enabled for the connection\&. The permitted values are: yes: register hostname and resolving for the connection, no: disable mDNS for the interface, resolve: do not register hostname but allow resolving of mDNS host names\&. When updating this property on a currently activated connection, the change takes effect immediately\&. This feature requires a plugin which supports mDNS\&. One such plugin is dns\-systemd\-resolved\&. +T} +T{ metered T}:T{ NMMetered (int32) @@ -246,7 +256,7 @@ string T}:T{ \ \& T}:T{ -Token to generate stable IDs for the connection\&. The stable\-id is used for generating IPv6 stable private addresses with ipv6\&.addr\-gen\-mode=stable\-privacy\&. It is also used to seed the generated cloned MAC address for ethernet\&.cloned\-mac\-address=stable and wifi\&.cloned\-mac\-address=stable\&. Note that also the interface name of the activating connection and a per\-host secret key is included into the address generation so that the same stable\-id on different hosts/devices yields different addresses\&. If the value is unset, an ID unique for the connection is used\&. Specifying a stable\-id allows multiple connections to generate the same addresses\&. Another use is to generate IDs at runtime via dynamic substitutions\&. The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at runtime\&. Currently supported are "${CONNECTION}", "${BOOT}", "${RANDOM}"\&. These effectively create unique IDs per\-connection, per\-boot, or every time\&. Any unrecognized patterns following \*(Aq$\*(Aq are treated verbatim, however are reserved for future use\&. You are thus advised to avoid \*(Aq$\*(Aq or escape it as "$$"\&. For example, set it to "${CONNECTION}/${BOOT}" to create a unique id for this connection that changes with every reboot\&. Note that two connections only use the same effective id if their stable\-id is also identical before performing dynamic substitutions\&. +This represents the identity of the connection used for various purposes\&. It allows to configure multiple profiles to share the identity\&. Also, the stable\-id can contain placeholders that are substituted dynamically and deterministically depending on the context\&. 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\&. It is also used as DHCP client identifier with ipv4\&.dhcp\-client\-id=stable and to derive the DHCP DUID with ipv6\&.dhcp\-duid=stable\-[llt,ll,uuid]\&. Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm\&. For example, a per\-host key is commonly also included, so that different systems end up generating different IDs\&. Or with ipv6\&.addr\-gen\-mode=stable\-privacy, also the device\*(Aqs name is included, so that different interfaces yield different addresses\&. The \*(Aq$\*(Aq character is treated special to perform dynamic substitutions at runtime\&. Currently supported are "${CONNECTION}", "${DEVICE}", "${BOOT}", "${RANDOM}"\&. These effectively create unique IDs per\-connection, per\-device, per\-boot, or every time\&. Note that "${DEVICE}" corresponds the the interface name of the device\&. 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}\-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates\&. If the value is unset, a global connection default is consulted\&. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection\&. T} T{ timestamp @@ -1027,7 +1037,7 @@ byte array T}:T{ \ \& T}:T{ -If specified, the MAC address of bridge\&. When creating a new bridge, this MAC address will be set\&. If this field is left unspecified, the "ethernet\&.cloned\-mac\-address" is referred instead to generate the initial MAC address\&. Note that setting "ethernet\&.cloned\-mac\-address" anyway overwrites the MAC address of the bridge later while activating the bridge\&. Hence, this property is deprecated\&. +If specified, the MAC address of bridge\&. When creating a new bridge, this MAC address will be set\&. If this field is left unspecified, the "ethernet\&.cloned\-mac\-address" is referred instead to generate the initial MAC address\&. Note that setting "ethernet\&.cloned\-mac\-address" anyway overwrites the MAC address of the bridge later while activating the bridge\&. Hence, this property is deprecated\&. Deprecated: 1 T} T{ max\-age @@ -1321,7 +1331,7 @@ priority\-bandwidth T}:T{ array of uint32 T}:T{ -[0, 0, 0, 0, 0, 0, 0, 0] +[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L] T}:T{ An array of 8 uint values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates the percentage of bandwidth of the priority\*(Aqs assigned group that the priority may use\&. The sum of all percentages for priorities which belong to the same group must total 100 percents\&. T} @@ -1330,7 +1340,7 @@ priority\-flow\-control T}:T{ array of uint32 T}:T{ -[0, 0, 0, 0, 0, 0, 0, 0] +[False, False, False, False, False, False, False, False] T}:T{ An array of 8 boolean values, where the array index corresponds to the User Priority (0 \- 7) and the value indicates whether or not the corresponding priority should transmit priority pause\&. T} @@ -1348,7 +1358,7 @@ priority\-group\-bandwidth T}:T{ array of uint32 T}:T{ -[0, 0, 0, 0, 0, 0, 0, 0] +[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L] T}:T{ An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 \- 7) and the value indicates the percentage of link bandwidth allocated to that group\&. Allowed values are 0 \- 100, and the sum of all values must total 100 percents\&. T} @@ -1366,7 +1376,7 @@ priority\-group\-id T}:T{ array of uint32 T}:T{ -[0, 0, 0, 0, 0, 0, 0, 0] +[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L] T}:T{ 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\&. T} @@ -1375,7 +1385,7 @@ priority\-strict\-bandwidth T}:T{ array of uint32 T}:T{ -[0, 0, 0, 0, 0, 0, 0, 0] +[False, False, False, False, False, False, False, False] T}:T{ 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\&. T} @@ -1384,7 +1394,7 @@ priority\-traffic\-class T}:T{ array of uint32 T}:T{ -[0, 0, 0, 0, 0, 0, 0, 0] +[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L] T}:T{ 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\&. T} @@ -1746,7 +1756,7 @@ int32 T}:T{ \-1 T}:T{ -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\&. +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 zero)\&. A value greater than zero is a timeout in milliseconds\&. The property is currently implemented only for IPv4\&. T} T{ dhcp\-client\-id @@ -1755,7 +1765,7 @@ string T}:T{ \ \& T}:T{ -A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options\&. When the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary client ID, in which case the first byte is assumed to be the \*(Aqtype\*(Aq field as per RFC 2132 section 9\&.14 and the remaining bytes may be an hardware address (e\&.g\&. \*(Aq01:xx:xx:xx:xx:xx:xx\*(Aq where 1 is the Ethernet ARP type and the rest is a MAC address)\&. If the property is not a hex string it is considered as a non\-hardware\-address client ID and the \*(Aqtype\*(Aq field is set to 0\&. +A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options\&. When the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary client ID, in which case the first byte is assumed to be the \*(Aqtype\*(Aq field as per RFC 2132 section 9\&.14 and the remaining bytes may be an hardware address (e\&.g\&. \*(Aq01:xx:xx:xx:xx:xx:xx\*(Aq where 1 is the Ethernet ARP type and the rest is a MAC address)\&. If the property is not a hex string it is considered as a non\-hardware\-address client ID and the \*(Aqtype\*(Aq field is set to 0\&. The special values "mac" and "perm\-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet type (01)\&. Currently, these options only work for ethernet type of links\&. The special value "stable" is supported to generate a type 0 client identifier based on the stable\-id (see connection\&.stable\-id) and a per\-host key\&. If unset, a globally configured default is used\&. If still unset, the client\-id from the last lease is reused\&. T} T{ dhcp\-fqdn @@ -1818,7 +1828,7 @@ int32 T}:T{ 0 T}:T{ -Intra\-connection DNS priority\&. The relative priority to be used when determining the order of DNS servers in resolv\&.conf\&. A lower value means that servers will be on top of the file\&. Zero selects the default value, which is 50 for VPNs and 100 for other connections\&. Note that the priority is to order DNS settings for multiple active connections\&. It does not disambiguate multiple DNS servers within the same connection profile\&. For that, just specify the DNS servers in the desired order\&. When multiple devices have configurations with the same priority, the one with an active default route will be preferred\&. Note that when using dns=dnsmasq the order is meaningless since dnsmasq forwards queries to all known servers at the same time\&. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from connections with the lowest priority value will be used\&. +DNS servers priority\&. The relative priority for DNS servers specified by this setting\&. A lower value is better (higher priority)\&. Zero selects the default value, which is 50 for VPNs and 100 for other connections\&. Note that the priority is to order DNS settings for multiple active connections\&. It does not disambiguate multiple DNS servers within the same connection profile\&. When using dns=default, servers with higher priority will be on top of resolv\&.conf\&. To prioritize a given server over another one within the same connection, just specify them in the desired order\&. When multiple devices have configurations with the same priority, the one with an active default route will be preferred\&. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from connections with the lowest priority value will be used\&. When using a DNS resolver that supports split\-DNS as dns=dnsmasq or dns=systemd\-resolved, each connection is used to query domains in its search list\&. Queries for domains not present in any search list are routed through connections having the \*(Aq~\&.\*(Aq special wildcard domain, which is added automatically to connections with the default route (or can be added manually)\&. When multiple connections specify the same domain, the one with the highest priority (lowest numerical value) wins\&. If a connection specifies a domain which is subdomain of another domain with a negative DNS priority value, the subdomain is ignored\&. T} T{ dns\-search @@ -1827,7 +1837,7 @@ array of string T}:T{ [] T}:T{ -Array of DNS search domains\&. +Array of DNS search domains\&. Domains starting with a tilde (\*(Aq~\*(Aq) are considered \*(Aqrouting\*(Aq domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names\&. T} T{ gateway @@ -1969,6 +1979,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ addr\-gen\-mode @@ -2004,7 +2015,16 @@ int32 T}:T{ \-1 T}:T{ -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\&. +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 zero)\&. A value greater than zero is a timeout in milliseconds\&. The property is currently implemented only for IPv4\&. +T} +T{ +dhcp\-duid +T}:T{ +string +T}:T{ +\ \& +T}:T{ +A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315)\&. The DUID is carried in the Client Identifier option\&. If the property is a hex string (\*(Aqaa:bb:cc\*(Aq) it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option\&. The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection\&. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system\-wide dhclient lease file\&. If still no DUID is found, or another dhcp client is used, a global and permanent DUID\-UUID (RFC 6355) will be generated based on the machine\-id\&. The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device\&. In order to try providing a stable DUID\-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk\&. The special values "stable\-llt", "stable\-ll" and "stable\-uuid" will generate a DUID of the corresponding type, derived from the connection\*(Aqs stable\-id and a per\-host unique key\&. So, the link\-layer address of "stable\-ll" and "stable\-llt" will be a generated address derived from the stable id\&. The DUID\-LLT time value in the "stable\-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt")\&. When the property is unset, the global value provided for "ipv6\&.dhcp\-duid" is used\&. If no global value is provided, the default "lease" value is assumed\&. T} T{ dhcp\-hostname @@ -2058,7 +2078,7 @@ int32 T}:T{ 0 T}:T{ -Intra\-connection DNS priority\&. The relative priority to be used when determining the order of DNS servers in resolv\&.conf\&. A lower value means that servers will be on top of the file\&. Zero selects the default value, which is 50 for VPNs and 100 for other connections\&. Note that the priority is to order DNS settings for multiple active connections\&. It does not disambiguate multiple DNS servers within the same connection profile\&. For that, just specify the DNS servers in the desired order\&. When multiple devices have configurations with the same priority, the one with an active default route will be preferred\&. Note that when using dns=dnsmasq the order is meaningless since dnsmasq forwards queries to all known servers at the same time\&. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from connections with the lowest priority value will be used\&. +DNS servers priority\&. The relative priority for DNS servers specified by this setting\&. A lower value is better (higher priority)\&. Zero selects the default value, which is 50 for VPNs and 100 for other connections\&. Note that the priority is to order DNS settings for multiple active connections\&. It does not disambiguate multiple DNS servers within the same connection profile\&. When using dns=default, servers with higher priority will be on top of resolv\&.conf\&. To prioritize a given server over another one within the same connection, just specify them in the desired order\&. When multiple devices have configurations with the same priority, the one with an active default route will be preferred\&. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from connections with the lowest priority value will be used\&. When using a DNS resolver that supports split\-DNS as dns=dnsmasq or dns=systemd\-resolved, each connection is used to query domains in its search list\&. Queries for domains not present in any search list are routed through connections having the \*(Aq~\&.\*(Aq special wildcard domain, which is added automatically to connections with the default route (or can be added manually)\&. When multiple connections specify the same domain, the one with the highest priority (lowest numerical value) wins\&. If a connection specifies a domain which is subdomain of another domain with a negative DNS priority value, the subdomain is ignored\&. T} T{ dns\-search @@ -2067,7 +2087,7 @@ array of string T}:T{ [] T}:T{ -Array of DNS search domains\&. +Array of DNS search domains\&. Domains starting with a tilde (\*(Aq~\*(Aq) are considered \*(Aqrouting\*(Aq domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names\&. T} T{ gateway @@ -2216,6 +2236,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{ encapsulation\-limit @@ -2227,6 +2248,15 @@ T}:T{ How many additional levels of encapsulation are permitted to be prepended to packets\&. This property applies only to IPv6 tunnels\&. T} T{ +flags +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Tunnel flags\&. Currently the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20)\&. They are valid only for IPv6 tunnels\&. +T} +T{ flow\-label T}:T{ uint32 @@ -2360,6 +2390,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{ encrypt @@ -2434,6 +2465,15 @@ T}:T{ The port component of the SCI (Secure Channel Identifier), between 1 and 65534\&. T} T{ +send\-sci +T}:T{ +boolean +T}:T{ +TRUE +T}:T{ +Specifies whether the SCI (Secure Channel Identifier) is included in every packet\&. +T} +T{ validation T}:T{ int32 @@ -2640,7 +2680,7 @@ T} .sp 1 .SS "ovs\-interface setting" .PP -OpenVSwitch Interface Settings\&. +Open vSwitch Interface Settings\&. .TS allbox tab(:); lB lB lB lB. @@ -2710,7 +2750,7 @@ string T}:T{ \ \& T}:T{ -Specifies the unicast destination IP address of a remote OpenVSwitch bridge port to connect to\&. +Specifies the unicast destination IP address of a remote Open vSwitch bridge port to connect to\&. T} .TE .sp 1 @@ -3395,7 +3435,7 @@ string T}:T{ "roundrobin" T}:T{ -Corresponds to the teamd runner\&.name\&. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp"\&. When setting the runner, all the properties specific to the runner will be reset to the default value; all the properties specific to other runners will be set to an empty value (or if not possible to a default value)\&. +Corresponds to the teamd runner\&.name\&. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random"\&. When setting the runner, all the properties specific to the runner will be reset to the default value; all the properties specific to other runners will be set to an empty value (or if not possible to a default value)\&. T} T{ runner\-active @@ -4164,7 +4204,7 @@ boolean T}:T{ FALSE T}:T{ -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\&. +When TRUE, enforce auto\-negotiation of speed and duplex mode\&. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto\-negotiation process: this works only for BASE\-T 802\&.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory\&. When FALSE, "speed" and "duplex" properties should be both set or link configuration will be skipped\&. T} T{ cloned\-mac\-address @@ -4182,7 +4222,7 @@ string T}:T{ \ \& T}:T{ -Can be specified only when "auto\-negotiate" is "off"\&. In that case, statically configures the device to use that specified duplex mode, either "half" or "full"\&. Must be set together with the "speed" property if specified\&. Before specifying a duplex mode be sure your device supports it\&. +When a value is set, either "half" or "full", configures the device to use the specified duplex mode\&. If "auto\-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE\-T 802\&.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory\&. If the value is unset (the default), the link configuration will be either skipped (if "auto\-negotiate" is "no", the default) or will be auto\-negotiated (if "auto\-negotiate" is "yes") and the local device will advertise all the supported duplex modes\&. Must be set together with the "speed" property if specified\&. Before specifying a duplex mode be sure your device supports it\&. T} T{ generate\-mac\-address\-mask @@ -4272,7 +4312,7 @@ uint32 T}:T{ 0 T}:T{ -Can be set to a value greater than zero only when "auto\-negotiate" is "off"\&. In that case, statically configures the device to use that specified speed\&. In Mbit/s, ie 100 == 100Mbit/s\&. Must be set together with the "duplex" property when non\-zero\&. Before specifying a speed value be sure your device supports it\&. +When a value grater than 0 is set, configures the device to use the specified speed\&. If "auto\-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE\-T 802\&.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory\&. If the value is unset (0, the default), the link configuration will be either skipped (if "auto\-negotiate" is "no", the default) or will be auto\-negotiated (if "auto\-negotiate" is "yes") and the local device will advertise all the supported speeds\&. In Mbit/s, ie 100 == 100Mbit/s\&. Must be set together with the "duplex" property when non\-zero\&. Before specifying a speed value be sure your device supports it\&. T} T{ wake\-on\-lan @@ -4328,6 +4368,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{ assigned\-mac\-address @@ -4390,7 +4431,7 @@ boolean T}:T{ FALSE T}:T{ -If TRUE, indicates this network is a non\-broadcasting network that hides its SSID\&. In this case various workarounds may take place, such as probe\-scanning the SSID for more reliable network discovery\&. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution\&. +If TRUE, indicates this network is a non\-broadcasting network that hides its SSID\&. In this case various workarounds may take place, such as probe\-scanning the SSID for more reliable network discovery\&. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution\&. Note that marking the network as hidden may be a privacy issue for you, as the explicit probe\-scans may be distinctly recognizable on the air\&. T} T{ mac\-address @@ -4500,6 +4541,15 @@ T}:T{ T}:T{ 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\&. T} +T{ +wake\-on\-wlan +T}:T{ +uint32 +T}:T{ +1 +T}:T{ +The NMSettingWirelessWakeOnWLan options to enable\&. Not all devices support all options\&. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake\-on\-LAN in NetworkManager)\&. +T} .TE .sp 1 .SS "802\-11\-wireless\-security setting" @@ -4537,6 +4587,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{ auth\-alg @@ -4548,6 +4599,15 @@ T}:T{ 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\&. T} T{ +fils +T}:T{ +int32 +T}:T{ +0 +T}:T{ +Indicates whether Fast Initial Link Setup (802\&.11ai) must be enabled for the connection\&. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported)\&. When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled\&. +T} +T{ group T}:T{ array of string diff --git a/man/nm-settings.xml b/man/nm-settings.xml index b1fa4631..21135fc9 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.10.8</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.12.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> 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 @@ -35,22 +35,23 @@ </para></variablelist></para> <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.auth-retries">auth-retries</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The number of retries for the authentication. Zero means to try indefinitely; -1 means to use a global default. If the global default is not set, the authentication retries for 3 times before failing the connection. Currently this only applies to 802-1x authentication.</entry></row> - <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">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. Note that autoconnect is not implemented for VPN profiles. See "secondaries" as an alternative to automatically connect VPN profiles.</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 autoactivating before giving up. Zero means forever, -1 means the global default (4 times if not overridden). Setting this to 1 means to try activation only once before blocking autoconnect. Note that after a timeout, NetworkManager will try to autoconnect again.</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.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 properties "autoconnect", "autoconnect-priority" and "autoconnect-retries" are unrelated to this setting. 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.mdns">mdns</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>Whether mDNS is enabled for the connection. The permitted values are: yes: register hostname and resolving for the connection, no: disable mDNS for the interface, resolve: do not register hostname but allow resolving of mDNS host names. When updating this property on a currently activated connection, the change takes effect immediately. This feature requires a plugin which supports mDNS. One such plugin is dns-systemd-resolved.</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 users are allowed if and only if they are in this list. When this is not empty, the connection can be active only when one of the specified users is logged into an active session. 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. Specifying a stable-id allows multiple connections to generate the same addresses. Another use is to generate IDs at runtime via dynamic substitutions. The '$' character is treated special to perform dynamic substitutions at runtime. Currently supported are "${CONNECTION}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-boot, or every time. Any unrecognized patterns following '$' are treated verbatim, however are reserved for future use. You are thus advised to avoid '$' or escape it as "$$". For example, set it to "${CONNECTION}/${BOOT}" to create a unique id for this connection that changes with every reboot. Note that two connections only use the same effective id if their stable-id is also identical before performing dynamic substitutions.</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>This represents the identity of the connection used for various purposes. It allows to configure multiple profiles to share the identity. Also, the stable-id can contain placeholders that are substituted dynamically and deterministically depending on the context. 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. It is also used as DHCP client identifier with ipv4.dhcp-client-id=stable and to derive the DHCP DUID with ipv6.dhcp-duid=stable-[llt,ll,uuid]. Note that depending on the context where it is used, other parameters are also seeded into the generation algorithm. For example, a per-host key is commonly also included, so that different systems end up generating different IDs. Or with ipv6.addr-gen-mode=stable-privacy, also the device's name is included, so that different interfaces yield different addresses. The '$' character is treated special to perform dynamic substitutions at runtime. Currently supported are "${CONNECTION}", "${DEVICE}", "${BOOT}", "${RANDOM}". These effectively create unique IDs per-connection, per-device, per-boot, or every time. Note that "${DEVICE}" corresponds the the interface name of the device. 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}-${DEVICE}" to create a unique id for this connection that changes with every reboot and differs depending on the interface where the profile activates. If the value is unset, a global connection default is consulted. If the value is still unset, the default is similar to "${CONNECTION}" and uses a unique, fixed ID for the connection.</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> @@ -129,7 +130,7 @@ <row><entry align="left" id="nm-settings.property.bridge.group-forward-mask">group-forward-mask</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>A mask of group addresses to forward. Usually, group addresses in the range from 01:80:C2:00:00:00 to 01:80:C2:00:00:0F are not forwarded according to standards. This property is a mask of 16 bits, each corresponding to a group address in that range that must be forwarded. The mask can't have bits 0, 1 or 2 set because they are used for STP, MAC pause frames and LACP.</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> <row><entry align="left" id="nm-settings.property.bridge.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 bridge's interface name.</entry></row> - <row><entry align="left" id="nm-settings.property.bridge.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. Hence, this property is deprecated.</entry></row> + <row><entry align="left" id="nm-settings.property.bridge.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. If this field is left unspecified, the "ethernet.cloned-mac-address" is referred instead to generate the initial MAC address. Note that setting "ethernet.cloned-mac-address" anyway overwrites the MAC address of the bridge later while activating the bridge. Hence, this property is deprecated. Deprecated: 1</entry></row> <row><entry align="left" id="nm-settings.property.bridge.max-age">max-age</entry><entry align="left">uint32</entry><entry align="left">20</entry><entry>The Spanning Tree Protocol (STP) maximum message age, in seconds.</entry></row> <row><entry align="left" id="nm-settings.property.bridge.multicast-snooping">multicast-snooping</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.</entry></row> <row><entry align="left" 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> @@ -159,14 +160,14 @@ <row><entry align="left" id="nm-settings.property.dcb.app-iscsi-flags">app-iscsi-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for the DCB iSCSI application. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row> <row><entry align="left" id="nm-settings.property.dcb.app-iscsi-priority">app-iscsi-priority</entry><entry align="left">int32</entry><entry align="left">-1</entry><entry>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row> <row><entry align="left" id="nm-settings.property.dcb.name">name</entry><entry align="left">string</entry><entry align="left">dcb</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.dcb.priority-bandwidth">priority-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 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.</entry></row> - <row><entry align="left" id="nm-settings.property.dcb.priority-flow-control">priority-flow-control</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 corresponding priority should transmit priority pause.</entry></row> + <row><entry align="left" id="nm-settings.property.dcb.priority-bandwidth">priority-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left">[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L]</entry><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use. The sum of all percentages for priorities which belong to the same group must total 100 percents.</entry></row> + <row><entry align="left" id="nm-settings.property.dcb.priority-flow-control">priority-flow-control</entry><entry align="left">array of uint32</entry><entry align="left">[False, False, False, False, False, False, False, False]</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 corresponding priority should transmit priority pause.</entry></row> <row><entry align="left" id="nm-settings.property.dcb.priority-flow-control-flags">priority-flow-control-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row> - <row><entry align="left" id="nm-settings.property.dcb.priority-group-bandwidth">priority-group-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 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.</entry></row> + <row><entry align="left" id="nm-settings.property.dcb.priority-group-bandwidth">priority-group-bandwidth</entry><entry align="left">array of uint32</entry><entry align="left">[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L]</entry><entry>An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group. Allowed values are 0 - 100, and the sum of all values must total 100 percents.</entry></row> <row><entry align="left" id="nm-settings.property.dcb.priority-group-flags">priority-group-flags</entry><entry align="left">NMSettingDcbFlags (uint32)</entry><entry align="left"/><entry>Specifies the NMSettingDcbFlags for DCB Priority Groups. Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row> - <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> + <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">[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L]</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">[False, False, False, False, False, False, False, False]</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">[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L]</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></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> @@ -201,16 +202,16 @@ <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> - <row><entry align="left" id="nm-settings.property.ipv4.dhcp-client-id">dhcp-client-id</entry><entry align="left">string</entry><entry align="left"/><entry>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0.</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 zero). A value greater than zero is a timeout in milliseconds. The property is currently implemented only for IPv4.</entry></row> + <row><entry align="left" id="nm-settings.property.ipv4.dhcp-client-id">dhcp-client-id</entry><entry align="left">string</entry><entry align="left"/><entry>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. When the property is a hex string ('aa:bb:cc') it is interpreted as a binary client ID, in which case the first byte is assumed to be the 'type' field as per RFC 2132 section 9.14 and the remaining bytes may be an hardware address (e.g. '01:xx:xx:xx:xx:xx:xx' where 1 is the Ethernet ARP type and the rest is a MAC address). If the property is not a hex string it is considered as a non-hardware-address client ID and the 'type' field is set to 0. The special values "mac" and "perm-mac" are supported, which use the current or permanent MAC address of the device to generate a client identifier with type ethernet type (01). Currently, these options only work for ethernet type of links. The special value "stable" is supported to generate a type 0 client identifier based on the stable-id (see connection.stable-id) and a per-host key. If unset, a globally configured default is used. If still unset, the client-id from the last lease is reused.</entry></row> <row><entry align="left" id="nm-settings.property.ipv4.dhcp-fqdn">dhcp-fqdn</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</entry></row> <row><entry align="left" id="nm-settings.property.ipv4.dhcp-hostname">dhcp-hostname</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row> <row><entry align="left" id="nm-settings.property.ipv4.dhcp-send-hostname">dhcp-send-hostname</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</entry></row> <row><entry align="left" id="nm-settings.property.ipv4.dhcp-timeout">dhcp-timeout</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>A timeout for a DHCP transaction in seconds.</entry></row> <row><entry align="left" id="nm-settings.property.ipv4.dns">dns</entry><entry align="left">array of uint32</entry><entry align="left">[]</entry><entry>Array of IP addresses of DNS servers (as network-byte-order integers)</entry></row> <row><entry align="left" id="nm-settings.property.ipv4.dns-options">dns-options</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>Array of DNS options as described in man 5 resolv.conf. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.</entry></row> - <row><entry align="left" id="nm-settings.property.ipv4.dns-priority">dns-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Intra-connection DNS priority. The relative priority to be used when determining the order of DNS servers in resolv.conf. A lower value means that servers will be on top of the file. Zero selects the default value, which is 50 for VPNs and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. For that, just specify the DNS servers in the desired order. When multiple devices have configurations with the same priority, the one with an active default route will be preferred. Note that when using dns=dnsmasq the order is meaningless since dnsmasq forwards queries to all known servers at the same time. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from connections with the lowest priority value will be used.</entry></row> - <row><entry align="left" id="nm-settings.property.ipv4.dns-search">dns-search</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>Array of DNS search domains.</entry></row> + <row><entry align="left" id="nm-settings.property.ipv4.dns-priority">dns-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>DNS servers priority. The relative priority for DNS servers specified by this setting. A lower value is better (higher priority). Zero selects the default value, which is 50 for VPNs and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. When multiple devices have configurations with the same priority, the one with an active default route will be preferred. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from connections with the lowest priority value will be used. When using a DNS resolver that supports split-DNS as dns=dnsmasq or dns=systemd-resolved, each connection is used to query domains in its search list. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the highest priority (lowest numerical value) wins. If a connection specifies a domain which is subdomain of another domain with a negative DNS priority value, the subdomain is ignored.</entry></row> + <row><entry align="left" id="nm-settings.property.ipv4.dns-search">dns-search</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>Array of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.</entry></row> <row><entry align="left" id="nm-settings.property.ipv4.gateway">gateway</entry><entry align="left">string</entry><entry align="left"/><entry>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</entry></row> <row><entry align="left" id="nm-settings.property.ipv4.ignore-auto-dns">ignore-auto-dns</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</entry></row> <row><entry align="left" id="nm-settings.property.ipv4.ignore-auto-routes">ignore-auto-routes</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</entry></row> @@ -227,14 +228,15 @@ <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: NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_EUI64 (0) or NM_SETTING_IP6_CONFIG_ADDR_GEN_MODE_STABLE_PRIVACY (1). If the property is set to EUI64, the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. The value of stable-privacy enables use of cryptographically secure hash of a secret host-specific key along with the connection's stable-id and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. On D-Bus, the absence of an addr-gen-mode setting equals enabling stable-privacy. For keyfile plugin, the absence of the setting on disk means EUI64 so that the property doesn't change on upgrade from older versions. Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</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> - <row><entry align="left" id="nm-settings.property.ipv6.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> + <row><entry align="left" id="nm-settings.property.ipv6.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 zero). A value greater than zero is a timeout in milliseconds. The property is currently implemented only for IPv4.</entry></row> + <row><entry align="left" id="nm-settings.property.ipv6.dhcp-duid">dhcp-duid</entry><entry align="left">string</entry><entry align="left"/><entry>A string containing the DHCPv6 Unique Identifier (DUID) used by the dhcp client to identify itself to DHCPv6 servers (RFC 3315). The DUID is carried in the Client Identifier option. If the property is a hex string ('aa:bb:cc') it is interpreted as a binary DUID and filled as an opaque value in the Client Identifier option. The special value "lease" will retrieve the DUID previously used from the lease file belonging to the connection. If no DUID is found and "dhclient" is the configured dhcp client, the DUID is searched in the system-wide dhclient lease file. If still no DUID is found, or another dhcp client is used, a global and permanent DUID-UUID (RFC 6355) will be generated based on the machine-id. The special values "llt" and "ll" will generate a DUID of type LLT or LL (see RFC 3315) based on the current MAC address of the device. In order to try providing a stable DUID-LLT, the time field will contain a constant timestamp that is used globally (for all profiles) and persisted to disk. The special values "stable-llt", "stable-ll" and "stable-uuid" will generate a DUID of the corresponding type, derived from the connection's stable-id and a per-host unique key. So, the link-layer address of "stable-ll" and "stable-llt" will be a generated address derived from the stable id. The DUID-LLT time value in the "stable-llt" option will be picked among a static timespan of three years (the upper bound of the interval is the same constant timestamp used in "llt"). When the property is unset, the global value provided for "ipv6.dhcp-duid" is used. If no global value is provided, the default "lease" value is assumed.</entry></row> <row><entry align="left" id="nm-settings.property.ipv6.dhcp-hostname">dhcp-hostname</entry><entry align="left">string</entry><entry align="left"/><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row> <row><entry align="left" id="nm-settings.property.ipv6.dhcp-send-hostname">dhcp-send-hostname</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</entry></row> <row><entry align="left" id="nm-settings.property.ipv6.dhcp-timeout">dhcp-timeout</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>A timeout for a DHCP transaction in seconds.</entry></row> <row><entry align="left" id="nm-settings.property.ipv6.dns">dns</entry><entry align="left">array of byte array</entry><entry align="left">[]</entry><entry>Array of IP addresses of DNS servers (in network byte order)</entry></row> <row><entry align="left" id="nm-settings.property.ipv6.dns-options">dns-options</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>Array of DNS options as described in man 5 resolv.conf. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.</entry></row> - <row><entry align="left" id="nm-settings.property.ipv6.dns-priority">dns-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Intra-connection DNS priority. The relative priority to be used when determining the order of DNS servers in resolv.conf. A lower value means that servers will be on top of the file. Zero selects the default value, which is 50 for VPNs and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. For that, just specify the DNS servers in the desired order. When multiple devices have configurations with the same priority, the one with an active default route will be preferred. Note that when using dns=dnsmasq the order is meaningless since dnsmasq forwards queries to all known servers at the same time. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from connections with the lowest priority value will be used.</entry></row> - <row><entry align="left" id="nm-settings.property.ipv6.dns-search">dns-search</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>Array of DNS search domains.</entry></row> + <row><entry align="left" id="nm-settings.property.ipv6.dns-priority">dns-priority</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>DNS servers priority. The relative priority for DNS servers specified by this setting. A lower value is better (higher priority). Zero selects the default value, which is 50 for VPNs and 100 for other connections. Note that the priority is to order DNS settings for multiple active connections. It does not disambiguate multiple DNS servers within the same connection profile. When using dns=default, servers with higher priority will be on top of resolv.conf. To prioritize a given server over another one within the same connection, just specify them in the desired order. When multiple devices have configurations with the same priority, the one with an active default route will be preferred. Negative values have the special effect of excluding other configurations with a greater priority value; so in presence of at least a negative priority, only DNS servers from connections with the lowest priority value will be used. When using a DNS resolver that supports split-DNS as dns=dnsmasq or dns=systemd-resolved, each connection is used to query domains in its search list. Queries for domains not present in any search list are routed through connections having the '~.' special wildcard domain, which is added automatically to connections with the default route (or can be added manually). When multiple connections specify the same domain, the one with the highest priority (lowest numerical value) wins. If a connection specifies a domain which is subdomain of another domain with a negative DNS priority value, the subdomain is ignored.</entry></row> + <row><entry align="left" id="nm-settings.property.ipv6.dns-search">dns-search</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>Array of DNS search domains. Domains starting with a tilde ('~') are considered 'routing' domains and are used only to decide the interface over which a query must be forwarded; they are not used to complete unqualified host names.</entry></row> <row><entry align="left" id="nm-settings.property.ipv6.gateway">gateway</entry><entry align="left">string</entry><entry align="left"/><entry>The gateway associated with this configuration. This is only meaningful if "addresses" is also set.</entry></row> <row><entry align="left" id="nm-settings.property.ipv6.ignore-auto-dns">ignore-auto-dns</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the "dns" and "dns-search" properties, if any, are used.</entry></row> <row><entry align="left" id="nm-settings.property.ipv6.ignore-auto-routes">ignore-auto-routes</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used.</entry></row> @@ -251,6 +253,7 @@ </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.flags">flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Tunnel flags. Currently the following values are supported: NM_IP_TUNNEL_FLAG_IP6_IGN_ENCAP_LIMIT (0x1), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_TCLASS (0x2), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FLOWLABEL (0x4), NM_IP_TUNNEL_FLAG_IP6_MIP6_DEV (0x8), NM_IP_TUNNEL_FLAG_IP6_RCV_DSCP_COPY (0x10), NM_IP_TUNNEL_FLAG_IP6_USE_ORIG_FWMARK (0x20). They are valid only for 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> <row><entry align="left" id="nm-settings.property.ip-tunnel.local">local</entry><entry align="left">string</entry><entry align="left"/><entry>The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.</entry></row> @@ -273,6 +276,7 @@ <row><entry align="left" id="nm-settings.property.macsec.name">name</entry><entry align="left">string</entry><entry align="left">macsec</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.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.send-sci">send-sci</entry><entry align="left">boolean</entry><entry align="left">TRUE</entry><entry>Specifies whether the SCI (Secure Channel Identifier) is included in every packet.</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></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> @@ -295,13 +299,13 @@ <row><entry align="left" id="nm-settings.property.ovs-bridge.rstp-enable">rstp-enable</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Enable or disable RSTP.</entry></row> <row><entry align="left" id="nm-settings.property.ovs-bridge.stp-enable">stp-enable</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Enable or disable STP.</entry></row> </tbody></tgroup></informaltable></refsect2> - <refsect2><title>ovs-interface setting</title><para>OpenVSwitch Interface 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> + <refsect2><title>ovs-interface setting</title><para>Open vSwitch Interface 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.ovs-interface.name">name</entry><entry align="left">string</entry><entry align="left">ovs-interface</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.ovs-interface.type">type</entry><entry align="left">string</entry><entry align="left"/><entry>The interface type. Either "internal", or empty.</entry></row> </tbody></tgroup></informaltable></refsect2> <refsect2><title>ovs-patch setting</title><para>OvsPatch 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.ovs-patch.name">name</entry><entry align="left">string</entry><entry align="left">ovs-patch</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.ovs-patch.peer">peer</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the unicast destination IP address of a remote OpenVSwitch bridge port to connect to.</entry></row> + <row><entry align="left" id="nm-settings.property.ovs-patch.peer">peer</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the unicast destination IP address of a remote Open vSwitch bridge port to connect to.</entry></row> </tbody></tgroup></informaltable></refsect2> <refsect2><title>ovs-port setting</title><para>OvsPort 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.ovs-port.bond-downdelay">bond-downdelay</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>The time port must be inactive in order to be considered down.</entry></row> @@ -370,7 +374,7 @@ <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> <row><entry align="left" id="nm-settings.property.team.notify-peers-count">notify-peers-count</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Corresponds to the teamd notify_peers.count.</entry></row> <row><entry align="left" id="nm-settings.property.team.notify-peers-interval">notify-peers-interval</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Corresponds to the teamd notify_peers.interval.</entry></row> - <row><entry align="left" id="nm-settings.property.team.runner">runner</entry><entry align="left">string</entry><entry align="left">"roundrobin"</entry><entry>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp". When setting the runner, all the properties specific to the runner will be reset to the default value; all the properties specific to other runners will be set to an empty value (or if not possible to a default value).</entry></row> + <row><entry align="left" id="nm-settings.property.team.runner">runner</entry><entry align="left">string</entry><entry align="left">"roundrobin"</entry><entry>Corresponds to the teamd runner.name. Permitted values are: "roundrobin", "broadcast", "activebackup", "loadbalance", "lacp", "random". When setting the runner, all the properties specific to the runner will be reset to the default value; all the properties specific to other runners will be set to an empty value (or if not possible to a default value).</entry></row> <row><entry align="left" id="nm-settings.property.team.runner-active">runner-active</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Corresponds to the teamd runner.active.</entry></row> <row><entry align="left" id="nm-settings.property.team.runner-agg-select-policy">runner-agg-select-policy</entry><entry align="left">string</entry><entry align="left"/><entry>Corresponds to the teamd runner.agg_select_policy.</entry></row> <row><entry align="left" id="nm-settings.property.team.runner-fast-rate">runner-fast-rate</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>Corresponds to the teamd runner.fast_rate.</entry></row> @@ -448,9 +452,9 @@ </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.auto-negotiate">auto-negotiate</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, enforce auto-negotiation of speed and duplex mode. If "speed" and "duplex" properties are both specified, only that single mode will be advertised and accepted during the link auto-negotiation process: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. When 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> - <row><entry align="left" id="nm-settings.property.802-3-ethernet.duplex">duplex</entry><entry align="left">string</entry><entry align="left"/><entry>Can be specified only when "auto-negotiate" is "off". In that case, statically configures the device to use that specified duplex mode, either "half" or "full". Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.</entry></row> + <row><entry align="left" id="nm-settings.property.802-3-ethernet.duplex">duplex</entry><entry align="left">string</entry><entry align="left"/><entry>When a value is set, either "half" or "full", configures the device to use the specified duplex mode. If "auto-negotiate" is "yes" the specified duplex mode will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabits modes, as in these cases link negotiation is mandatory. If the value is unset (the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported duplex modes. Must be set together with the "speed" property if specified. Before specifying a duplex mode be sure your device supports it.</entry></row> <row><entry align="left" id="nm-settings.property.802-3-ethernet.generate-mac-address-mask">generate-mac-address-mask</entry><entry align="left">string</entry><entry align="left"/><entry>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</entry></row> <row><entry align="left" id="nm-settings.property.802-3-ethernet.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the Ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row> <row><entry align="left" id="nm-settings.property.802-3-ethernet.mac-address-blacklist">mac-address-blacklist</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</entry></row> @@ -460,7 +464,7 @@ <row><entry align="left" id="nm-settings.property.802-3-ethernet.s390-nettype">s390-nettype</entry><entry align="left">string</entry><entry align="left"/><entry>s390 network device type; one of "qeth", "lcs", or "ctc", representing the different types of virtual network devices available on s390 systems.</entry></row> <row><entry align="left" id="nm-settings.property.802-3-ethernet.s390-options">s390-options</entry><entry align="left">dict of string to string</entry><entry align="left">{}</entry><entry>Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include "portno", "layer2", "portname", "protocol", among others. Key names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</entry></row> <row><entry align="left" id="nm-settings.property.802-3-ethernet.s390-subchannels">s390-subchannels</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>Identifies specific subchannels that this network device uses for communication with z/VM or s390 host. Like the "mac-address" property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</entry></row> - <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 greater than zero only when "auto-negotiate" is "off". In that case, statically configures the device to use that specified speed. In Mbit/s, ie 100 == 100Mbit/s. Must be set together with the "duplex" property when non-zero. Before specifying a speed value be sure your device supports it.</entry></row> + <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>When a value grater than 0 is set, configures the device to use the specified speed. If "auto-negotiate" is "yes" the specified speed will be the only one advertised during link negotiation: this works only for BASE-T 802.3 specifications and is useful for enforcing gigabit speeds, as in this case link negotiation is mandatory. If the value is unset (0, the default), the link configuration will be either skipped (if "auto-negotiate" is "no", the default) or will be auto-negotiated (if "auto-negotiate" is "yes") and the local device will advertise all the supported speeds. 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></informaltable></refsect2> @@ -471,7 +475,7 @@ <row><entry align="left" id="nm-settings.property.802-11-wireless.channel">channel</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Wireless channel to use for the Wi-Fi connection. The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel. Because channel numbers overlap between bands, this property also requires the "band" property to be set.</entry></row> <row><entry align="left" id="nm-settings.property.802-11-wireless.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> <row><entry align="left" id="nm-settings.property.802-11-wireless.generate-mac-address-mask">generate-mac-address-mask</entry><entry align="left">string</entry><entry align="left"/><entry>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</entry></row> - <row><entry align="left" id="nm-settings.property.802-11-wireless.hidden">hidden</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, indicates this network is a non-broadcasting network that hides its SSID. In this case various workarounds may take place, such as probe-scanning the SSID for more reliable network discovery. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.</entry></row> + <row><entry align="left" id="nm-settings.property.802-11-wireless.hidden">hidden</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>If TRUE, indicates this network is a non-broadcasting network that hides its SSID. In this case various workarounds may take place, such as probe-scanning the SSID for more reliable network discovery. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. Note that marking the network as hidden may be a privacy issue for you, as the explicit probe-scans may be distinctly recognizable on the air.</entry></row> <row><entry align="left" id="nm-settings.property.802-11-wireless.mac-address">mac-address</entry><entry align="left">byte array</entry><entry align="left"/><entry>If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row> <row><entry align="left" id="nm-settings.property.802-11-wireless.mac-address-blacklist">mac-address-blacklist</entry><entry align="left">array of string</entry><entry align="left">[]</entry><entry>A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply. Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</entry></row> <row><entry align="left" id="nm-settings.property.802-11-wireless.mac-address-randomization">mac-address-randomization</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization), NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'. Deprecated: 1</entry></row> @@ -484,9 +488,11 @@ <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> + <row><entry align="left" id="nm-settings.property.802-11-wireless.wake-on-wlan">wake-on-wlan</entry><entry align="left">uint32</entry><entry align="left">1</entry><entry>The NMSettingWirelessWakeOnWLan options to enable. Not all devices support all options. May be any combination of NM_SETTING_WIRELESS_WAKE_ON_WLAN_ANY (0x2), NM_SETTING_WIRELESS_WAKE_ON_WLAN_DISCONNECT (0x4), NM_SETTING_WIRELESS_WAKE_ON_WLAN_MAGIC (0x8), NM_SETTING_WIRELESS_WAKE_ON_WLAN_GTK_REKEY_FAILURE (0x10), NM_SETTING_WIRELESS_WAKE_ON_WLAN_EAP_IDENTITY_REQUEST (0x20), NM_SETTING_WIRELESS_WAKE_ON_WLAN_4WAY_HANDSHAKE (0x40), NM_SETTING_WIRELESS_WAKE_ON_WLAN_RFKILL_RELEASE (0x80), NM_SETTING_WIRELESS_WAKE_ON_WLAN_TCP (0x100) or the special values NM_SETTING_WIRELESS_WAKE_ON_WLAN_DEFAULT (0x1) (to use global settings) and NM_SETTING_WIRELESS_WAKE_ON_WLAN_IGNORE (0x8000) (to disable management of Wake-on-LAN in NetworkManager).</entry></row> </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.fils">fils</entry><entry align="left">int32</entry><entry align="left">0</entry><entry>Indicates whether Fast Initial Link Setup (802.11ai) must be enabled for the connection. One of NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) (use global default value), NM_SETTING_WIRELESS_SECURITY_FILS_DISABLE (1) (disable FILS), NM_SETTING_WIRELESS_SECURITY_FILS_OPTIONAL (2) (enable FILS if the supplicant and the access point support it) or NM_SETTING_WIRELESS_SECURITY_FILS_REQUIRED (3) (enable FILS and fail if not supported). When set to NM_SETTING_WIRELESS_SECURITY_FILS_DEFAULT (0) and no global default is set, FILS will be optionally enabled.</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> <row><entry align="left" id="nm-settings.property.802-11-wireless-security.leap-password">leap-password</entry><entry align="left">string</entry><entry align="left"/><entry>The login password for legacy LEAP connections (ie, key-mgmt = "ieee8021x" and auth-alg = "leap").</entry></row> diff --git a/man/nmcli-examples.7 b/man/nmcli-examples.7 index 272c194d..8e728a74 100644 --- a/man/nmcli-examples.7 +++ b/man/nmcli-examples.7 @@ -2,12 +2,12 @@ .\" Title: nmcli-examples .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 05/11/2018 +.\" Date: 07/25/2018 .\" Manual: Examples -.\" Source: NetworkManager 1.10.8 +.\" Source: NetworkManager 1.12.2 .\" Language: English .\" -.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.10\&.8" "Examples" +.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.12\&.2" "Examples" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nmcli.1 b/man/nmcli.1 index 31bc144d..9a934f0d 100644 --- a/man/nmcli.1 +++ b/man/nmcli.1 @@ -2,12 +2,12 @@ .\" Title: nmcli .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 05/11/2018 +.\" Date: 07/25/2018 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.10.8 +.\" Source: NetworkManager 1.12.2 .\" Language: English .\" -.TH "NMCLI" "1" "" "NetworkManager 1\&.10\&.8" "General Commands Manual" +.TH "NMCLI" "1" "" "NetworkManager 1\&.12\&.2" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -138,6 +138,12 @@ disables them, auto only produces colors when standard output is directed to a terminal\&. The default value is auto\&. +.sp +The actual colors used are configured as described in +\fBterminal-colors.d\fR(5)\&. Please refer to the +COLORS +section for a list of color names supported by +\fBnmcli\fR\&. .RE .PP \fB\-f\fR | \fB\-\-fields\fR {\fIfield1\fR,\fIfield2\fR... | all | common} @@ -1134,13 +1140,19 @@ Monitors all devices in case no interface is specified\&. The monitor terminates command\&. .RE .PP -\fBwifi\fR [\fBlist\fR\ [\fBifname\fR\ \fIifname\fR]\ [\fBbssid\fR\ \fIBSSID\fR]] +\fBwifi\fR [\fBlist\fR\ [\fB\-\-rescan\fR\ |\ \fBauto\fR\ |\ \fBno\fR\ |\ \fByes\fR]\ [\fBifname\fR\ \fIifname\fR]\ [\fBbssid\fR\ \fIBSSID\fR]] .RS 4 List available Wi\-Fi access points\&. The \fBifname\fR and \fBbssid\fR options can be used to list APs for a particular interface or with a specific BSSID, respectively\&. +.sp +By default, +\fBnmcli\fR +ensures that the access point list is no older than 30 seconds and triggers a network scan if necessary\&. The +\fB\-\-rescan\fR +can be used to either force or disable the scan regardless of how fresh the access point list is\&. .RE .PP \fBwifi\fR \fBconnect\fR \fI(B)SSID\fR [\fBpassword\fR\ \fIpassword\fR] [\fBwep\-key\-type\fR\ {key\ |\ phrase}] [\fBifname\fR\ \fIifname\fR] [\fBbssid\fR\ \fIBSSID\fR] [\fBname\fR\ \fIname\fR] [\fBprivate\fR\ {yes\ |\ no}] [\fBhidden\fR\ {yes\ |\ no}] @@ -2398,6 +2410,196 @@ Read the JavaScript PAC (proxy auto\-config) script from file or pass it directl T} .TE .sp 1 +.SH "COLORS" +.PP +Implicit coloring can be disabled by an empty file +/etc/terminal\-colors\&.d/nmcli\&.disable\&. +.PP +See +\fBterminal-colors.d\fR(5) +for more details about colorization configuration\&. The logical color names supported by +\fBnmcli\fR +are: +.PP +\fBconnection\-activated\fR +.RS 4 +A connection that is active\&. +.RE +.PP +\fBconnection\-activating\fR +.RS 4 +Connection that is being activated\&. +.RE +.PP +\fBconnection\-disconnecting\fR +.RS 4 +Connection that is being disconnected\&. +.RE +.PP +\fBconnection\-invisible\fR +.RS 4 +Connection whose details is the user not permitted to see\&. +.RE +.PP +\fBconnectivity\-full\fR +.RS 4 +Conectivity state when Internet is reachable\&. +.RE +.PP +\fBconnectivity\-limited\fR +.RS 4 +Conectivity state when only a local network reachable\&. +.RE +.PP +\fBconnectivity\-none\fR +.RS 4 +Conectivity state when the network is disconnected\&. +.RE +.PP +\fBconnectivity\-portal\fR +.RS 4 +Conectivity state when a captive portal hijacked the connection\&. +.RE +.PP +\fBconnectivity\-unknown\fR +.RS 4 +Conectivity state when a connectivity check didn\*(Aqt run\&. +.RE +.PP +\fBdevice\-activated\fR +.RS 4 +Device that is connected\&. +.RE +.PP +\fBdevice\-activating\fR +.RS 4 +Device that is being configured\&. +.RE +.PP +\fBdevice\-disconnected\fR +.RS 4 +Device that is not connected\&. +.RE +.PP +\fBdevice\-firmware\-missing\fR +.RS 4 +Warning of a missing device firmware\&. +.RE +.PP +\fBdevice\-plugin\-missing\fR +.RS 4 +Warning of a missing device plugin\&. +.RE +.PP +\fBdevice\-unavailable\fR +.RS 4 +Device that is not available for activation\&. +.RE +.PP +\fBmanager\-running\fR +.RS 4 +Notice that the NetworkManager daemon is available\&. +.RE +.PP +\fBmanager\-starting\fR +.RS 4 +Notice that the NetworkManager daemon is being initially connected\&. +.RE +.PP +\fBmanager\-stopped\fR +.RS 4 +Notice that the NetworkManager daemon is not available\&. +.RE +.PP +\fBpermission\-auth\fR +.RS 4 +An action that requires user authentication to get permission\&. +.RE +.PP +\fBpermission\-no\fR +.RS 4 +An action that is not permitted\&. +.RE +.PP +\fBpermission\-yes\fR +.RS 4 +An action that is permitted\&. +.RE +.PP +\fBprompt\fR +.RS 4 +Prompt in interactive mode\&. +.RE +.PP +\fBstate\-asleep\fR +.RS 4 +Indication that NetworkManager in suspended state\&. +.RE +.PP +\fBstate\-connected\-global\fR +.RS 4 +Indication that NetworkManager in connected to Internet\&. +.RE +.PP +\fBstate\-connected\-local\fR +.RS 4 +Indication that NetworkManager in local network\&. +.RE +.PP +\fBstate\-connected\-site\fR +.RS 4 +Indication that NetworkManager in connected to networks other than Internet\&. +.RE +.PP +\fBstate\-connecting\fR +.RS 4 +Indication that NetworkManager is establishing a network connection\&. +.RE +.PP +\fBstate\-disconnected\fR +.RS 4 +Indication that NetworkManager is disconnected from a network\&. +.RE +.PP +\fBstate\-disconnecting\fR +.RS 4 +Indication that NetworkManager is being disconnected from a network\&. +.RE +.PP +\fBwifi\-signal\-excellent\fR +.RS 4 +Wi\-Fi network with an excellent signal level\&. +.RE +.PP +\fBwifi\-signal\-fair\fR +.RS 4 +Wi\-Fi network with a fair signal level\&. +.RE +.PP +\fBwifi\-signal\-good\fR +.RS 4 +Wi\-Fi network with a good signal level\&. +.RE +.PP +\fBwifi\-signal\-poor\fR +.RS 4 +Wi\-Fi network with a poor signal level\&. +.RE +.PP +\fBwifi\-signal\-unknown\fR +.RS 4 +Wi\-Fi network that hasn\*(Aqt been actually seen (a hidden AP)\&. +.RE +.PP +\fBdisabled\fR +.RS 4 +A property that is turned off\&. +.RE +.PP +\fBenabled\fR +.RS 4 +A property that is turned on\&. +.RE .SH "ENVIRONMENT VARIABLES" .PP \fBnmcli\fR\*(Aqs behavior is affected by the following environment variables\&. @@ -2706,4 +2908,5 @@ NetworkManager\&. \fBNetworkManager.conf\fR(5), \fBnm-settings\fR(5), \fBnm-applet\fR(1), -\fBnm-connection-editor\fR(1)\&. +\fBnm-connection-editor\fR(1), +\fBterminal-colors.d\fR(5)\&. diff --git a/man/nmcli.xml b/man/nmcli.xml index 2619234e..9b951c19 100644 --- a/man/nmcli.xml +++ b/man/nmcli.xml @@ -9,7 +9,7 @@ <!-- nmcli(1) manual page - Copyright 2010 - 2016 Red Hat, Inc. + Copyright 2010 - 2018 Red Hat, Inc. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 @@ -183,6 +183,10 @@ <literal>yes</literal> enables colors, <literal>no</literal> disables them, <literal>auto</literal> only produces colors when standard output is directed to a terminal. The default value is <literal>auto</literal>.</para> + <para>The actual colors used are configured as described in + <citerefentry><refentrytitle>terminal-colors.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>. + Please refer to the <link linkend='colors' endterm='colors.title' /> section for a + list of color names supported by <command>nmcli</command>.</para> </listitem> </varlistentry> @@ -1377,6 +1381,12 @@ <command>wifi</command> <arg> <command>list</command> + <group> + <option>--rescan</option> + <arg choice='plain'><option>auto</option></arg> + <arg choice='plain'><option>no</option></arg> + <arg choice='plain'><option>yes</option></arg> + </group> <arg><option>ifname</option> <replaceable>ifname</replaceable></arg> <arg><option>bssid</option> <replaceable>BSSID</replaceable></arg> </arg> @@ -1386,6 +1396,10 @@ <para>List available Wi-Fi access points. The <option>ifname</option> and <option>bssid</option> options can be used to list APs for a particular interface or with a specific BSSID, respectively.</para> + <para>By default, <command>nmcli</command> ensures that the access point list + is no older than 30 seconds and triggers a network scan if necessary. The + <option>--rescan</option> can be used to either force or disable the scan + regardless of how fresh the access point list is.</para> </listitem> </varlistentry> @@ -2035,6 +2049,269 @@ It's equivalent to the <literal>+bond.options 'option=value'</literal> syntax.</ </refsect1> + <refsect1 id='colors'><title id='colors.title'>Colors</title> + <para>Implicit coloring can be disabled by an empty file + <filename>/etc/terminal-colors.d/nmcli.disable</filename>.</para> + + <para>See <citerefentry><refentrytitle>terminal-colors.d</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for more details about colorization configuration. + The logical color names supported by <command>nmcli</command> are:</para> + + <variablelist> + <varlistentry> + <term><option>connection-activated</option></term> + <listitem> + <para>A connection that is active.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>connection-activating</option></term> + <listitem> + <para>Connection that is being activated.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>connection-disconnecting</option></term> + <listitem> + <para>Connection that is being disconnected.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>connection-invisible</option></term> + <listitem> + <para>Connection whose details is the user not permitted to see.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>connectivity-full</option></term> + <listitem> + <para>Conectivity state when Internet is reachable.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>connectivity-limited</option></term> + <listitem> + <para>Conectivity state when only a local network reachable.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>connectivity-none</option></term> + <listitem> + <para>Conectivity state when the network is disconnected.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>connectivity-portal</option></term> + <listitem> + <para>Conectivity state when a captive portal hijacked the connection.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>connectivity-unknown</option></term> + <listitem> + <para>Conectivity state when a connectivity check didn't run.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>device-activated</option></term> + <listitem> + <para>Device that is connected.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>device-activating</option></term> + <listitem> + <para>Device that is being configured.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>device-disconnected</option></term> + <listitem> + <para>Device that is not connected.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>device-firmware-missing</option></term> + <listitem> + <para>Warning of a missing device firmware.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>device-plugin-missing</option></term> + <listitem> + <para>Warning of a missing device plugin.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>device-unavailable</option></term> + <listitem> + <para>Device that is not available for activation.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>manager-running</option></term> + <listitem> + <para>Notice that the NetworkManager daemon is available.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>manager-starting</option></term> + <listitem> + <para>Notice that the NetworkManager daemon is being initially connected.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>manager-stopped</option></term> + <listitem> + <para>Notice that the NetworkManager daemon is not available.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>permission-auth</option></term> + <listitem> + <para>An action that requires user authentication to get permission.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>permission-no</option></term> + <listitem> + <para>An action that is not permitted.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>permission-yes</option></term> + <listitem> + <para>An action that is permitted.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>prompt</option></term> + <listitem> + <para>Prompt in interactive mode.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>state-asleep</option></term> + <listitem> + <para>Indication that NetworkManager in suspended state.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>state-connected-global</option></term> + <listitem> + <para>Indication that NetworkManager in connected to Internet.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>state-connected-local</option></term> + <listitem> + <para>Indication that NetworkManager in local network.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>state-connected-site</option></term> + <listitem> + <para>Indication that NetworkManager in connected to networks other than Internet.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>state-connecting</option></term> + <listitem> + <para>Indication that NetworkManager is establishing a network connection.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>state-disconnected</option></term> + <listitem> + <para>Indication that NetworkManager is disconnected from a network.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>state-disconnecting</option></term> + <listitem> + <para>Indication that NetworkManager is being disconnected from a network.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>wifi-signal-excellent</option></term> + <listitem> + <para>Wi-Fi network with an excellent signal level.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>wifi-signal-fair</option></term> + <listitem> + <para>Wi-Fi network with a fair signal level.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>wifi-signal-good</option></term> + <listitem> + <para>Wi-Fi network with a good signal level.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>wifi-signal-poor</option></term> + <listitem> + <para>Wi-Fi network with a poor signal level.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>wifi-signal-unknown</option></term> + <listitem> + <para>Wi-Fi network that hasn't been actually seen (a hidden AP).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>disabled</option></term> + <listitem> + <para>A property that is turned off.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>enabled</option></term> + <listitem> + <para>A property that is turned on.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + <refsect1 id='environment_variables'><title>Environment Variables</title> <para><command>nmcli</command>'s behavior is affected by the following @@ -2465,7 +2742,8 @@ It's equivalent to the <literal>+bond.options 'option=value'</literal> syntax.</ <link linkend='NetworkManager.conf'><citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <link linkend='nm-settings'><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry></link>, <citerefentry><refentrytitle>nm-applet</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nm-connection-editor</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> + <citerefentry><refentrytitle>nm-connection-editor</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>terminal-colors.d</refentrytitle><manvolnum>5</manvolnum></citerefentry>.</para> </refsect1> </refentry> diff --git a/man/nmtui.1 b/man/nmtui.1 index b7925d75..63652b3f 100644 --- a/man/nmtui.1 +++ b/man/nmtui.1 @@ -2,12 +2,12 @@ .\" Title: nmtui .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 05/11/2018 +.\" Date: 07/25/2018 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.10.8 +.\" Source: NetworkManager 1.12.2 .\" Language: English .\" -.TH "NMTUI" "1" "" "NetworkManager 1\&.10\&.8" "General Commands Manual" +.TH "NMTUI" "1" "" "NetworkManager 1\&.12\&.2" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- |