diff options
| author | Michael Biebl <biebl@debian.org> | 2019-12-18 18:29:24 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2019-12-18 18:29:24 +0100 |
| commit | 28028b26b3371756811e95d894f709f4b1207c00 (patch) | |
| tree | 6fe7316fd743b51042db47601a8ef8814b3134ac /man | |
| parent | e22609983008e1a669196ad64ba3a59ae8c76e0d (diff) | |
New upstream version 1.22.0 upstream/1.22.0
Diffstat (limited to 'man')
| -rw-r--r-- | man/NetworkManager.8 | 6 | ||||
| -rw-r--r-- | man/NetworkManager.conf.5 | 32 | ||||
| -rw-r--r-- | man/NetworkManager.conf.xml | 23 | ||||
| -rw-r--r-- | man/meson.build | 19 | ||||
| -rw-r--r-- | man/nm-initrd-generator.8 | 6 | ||||
| -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 | 10 | ||||
| -rw-r--r-- | man/nm-settings-ifcfg-rh.xml | 6 | ||||
| -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 | 62 | ||||
| -rw-r--r-- | man/nm-settings.xml | 13 | ||||
| -rw-r--r-- | man/nmcli-examples.7 | 46 | ||||
| -rw-r--r-- | man/nmcli-examples.xml | 22 | ||||
| -rw-r--r-- | man/nmcli.1 | 36 | ||||
| -rw-r--r-- | man/nmcli.xml | 45 | ||||
| -rw-r--r-- | man/nmtui.1 | 6 |
18 files changed, 271 insertions, 81 deletions
diff --git a/man/NetworkManager.8 b/man/NetworkManager.8 index a159ef74..b91257b4 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: 11/25/2019 +.\" Date: 12/17/2019 .\" Manual: Network management daemons -.\" Source: NetworkManager 1.20.8 +.\" Source: NetworkManager 1.22.0 .\" Language: English .\" -.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.20\&.8" "Network management daemons" +.TH "NETWORKMANAGER" "8" "" "NetworkManager 1\&.22\&.0" "Network management daemons" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/NetworkManager.conf.5 b/man/NetworkManager.conf.5 index 7e5a91dd..6b1a3081 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: 11/25/2019 +.\" Date: 12/17/2019 .\" Manual: Configuration -.\" Source: NetworkManager 1.20.8 +.\" Source: NetworkManager 1.22.0 .\" Language: English .\" -.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.20\&.8" "Configuration" +.TH "NETWORKMANAGER\&.CONF" "5" "" "NetworkManager 1\&.22\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -126,8 +126,10 @@ This setting is deprecated and has no effect\&. \fIauth\-polkit\fR .RS 4 Whether the system uses PolicyKit for authorization\&. If -false, all requests will be allowed\&. If -true, non\-root requests are authorized using PolicyKit\&. The default value is +true, non\-root requests are authorized using PolicyKit\&. Requests from root (user ID zero) are always granted without asking PolicyKit\&. If +false, all requests will be allowed and PolicyKit is not used\&. If set to +root\-only +PolicyKit is not used and all requests except root are denied\&. The default value is true\&. .RE .PP @@ -696,6 +698,16 @@ If configured explicitly to 0, the MTU is not reconfigured during device activat .RS 4 .RE .PP +\fIipv4\&.dhcp\-iaid\fR +.RS 4 +If left unspecified, it defaults to "ifname"\&. +.RE +.PP +\fIipv4\&.dhcp\-hostname\-flags\fR +.RS 4 +If left unspecified, the value 3 (fqdn\-encoded,fqdn\-serv\-update) is used\&. +.RE +.PP \fIipv4\&.dhcp\-timeout\fR .RS 4 If left unspecified, the default value for the interface type is used\&. @@ -720,6 +732,16 @@ If left unspecified, routes are only added to the main table\&. Note that this i If left unspecified, it defaults to "lease"\&. .RE .PP +\fIipv6\&.dhcp\-iaid\fR +.RS 4 +If left unspecified, it defaults to "ifname"\&. +.RE +.PP +\fIipv6\&.dhcp\-hostname\-flags\fR +.RS 4 +If left unspecified, the value 1 (fqdn\-serv\-update) is used\&. +.RE +.PP \fIipv6\&.dhcp\-timeout\fR .RS 4 If left unspecified, the default value for the interface type is used\&. diff --git a/man/NetworkManager.conf.xml b/man/NetworkManager.conf.xml index e56de210..c0c05147 100644 --- a/man/NetworkManager.conf.xml +++ b/man/NetworkManager.conf.xml @@ -158,8 +158,11 @@ plugins-=remove-me <varlistentry> <term><varname>auth-polkit</varname></term> <listitem><para>Whether the system uses PolicyKit for authorization. - If <literal>false</literal>, all requests will be allowed. If - <literal>true</literal>, non-root requests are authorized using PolicyKit. + If <literal>true</literal>, non-root requests are authorized using PolicyKit. + Requests from root (user ID zero) are always granted without asking PolicyKit. + If <literal>false</literal>, all requests will be allowed and PolicyKit is + not used. If set to <literal>root-only</literal> PolicyKit is not used and + all requests except root are denied. The default value is <literal>&NM_CONFIG_DEFAULT_MAIN_AUTH_POLKIT_TEXT;</literal>. </para></listitem> </varlistentry> @@ -713,6 +716,14 @@ ipv6.ip6-privacy=0 <term><varname>ipv4.dhcp-client-id</varname></term> </varlistentry> <varlistentry> + <term><varname>ipv4.dhcp-iaid</varname></term> + <listitem><para>If left unspecified, it defaults to "ifname".</para></listitem> + </varlistentry> + <varlistentry> + <term><varname>ipv4.dhcp-hostname-flags</varname></term> + <listitem><para>If left unspecified, the value 3 (fqdn-encoded,fqdn-serv-update) is used.</para></listitem> + </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> @@ -737,6 +748,14 @@ ipv6.ip6-privacy=0 <listitem><para>If left unspecified, it defaults to "lease".</para></listitem> </varlistentry> <varlistentry> + <term><varname>ipv6.dhcp-iaid</varname></term> + <listitem><para>If left unspecified, it defaults to "ifname".</para></listitem> + </varlistentry> + <varlistentry> + <term><varname>ipv6.dhcp-hostname-flags</varname></term> + <listitem><para>If left unspecified, the value 1 (fqdn-serv-update) is used.</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> diff --git a/man/meson.build b/man/meson.build index a4ef3d9e..f9130535 100644 --- a/man/meson.build +++ b/man/meson.build @@ -1,20 +1,7 @@ -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('nmstatedir', nm_pkgstatedir) -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' - common_ent_file = configure_file( - input: common + '.in', - output: common, - configuration: common_conf, + input: 'common.ent.in', + output: '@BASENAME@', + configuration: data_conf, ) xsltproc_options = [ diff --git a/man/nm-initrd-generator.8 b/man/nm-initrd-generator.8 index 2728693a..c3d7076a 100644 --- a/man/nm-initrd-generator.8 +++ b/man/nm-initrd-generator.8 @@ -2,12 +2,12 @@ .\" Title: nm-initrd-generator .\" Author: .\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> -.\" Date: 11/25/2019 +.\" Date: 12/17/2019 .\" Manual: System Administration -.\" Source: NetworkManager 1.20.8 +.\" Source: NetworkManager 1.22.0 .\" Language: English .\" -.TH "NM\-INITRD\-GENERATOR" "8" "" "NetworkManager 1\&.20\&.8" "System Administration" +.TH "NM\-INITRD\-GENERATOR" "8" "" "NetworkManager 1\&.22\&.0" "System Administration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-online.1 b/man/nm-online.1 index 55bca017..24ae0b81 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: 11/25/2019 +.\" Date: 12/17/2019 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.20.8 +.\" Source: NetworkManager 1.22.0 .\" Language: English .\" -.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.20\&.8" "General Commands Manual" +.TH "NM\-ONLINE" "1" "" "NetworkManager 1\&.22\&.0" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-openvswitch.7 b/man/nm-openvswitch.7 index 152d559f..1444bfe1 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: 11/25/2019 +.\" Date: 12/17/2019 .\" Manual: Open vSwitch support overview -.\" Source: NetworkManager 1.20.8 +.\" Source: NetworkManager 1.22.0 .\" Language: English .\" -.TH "NM\-OPENVSWITCH" "7" "" "NetworkManager 1\&.20\&.8" "Open vSwitch support overview" +.TH "NM\-OPENVSWITCH" "7" "" "NetworkManager 1\&.22\&.0" "Open vSwitch support overview" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-settings-ifcfg-rh.5 b/man/nm-settings-ifcfg-rh.5 index a582095c..6371e37b 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: 11/25/2019 +.\" Date: 12/17/2019 .\" Manual: Configuration -.\" Source: NetworkManager 1.20.8 +.\" Source: NetworkManager 1.22.0 .\" Language: English .\" -.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.20\&.8" "Configuration" +.TH "NM\-SETTINGS\-IFCFG\-RH" "5" "" "NetworkManager 1\&.22\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -1963,7 +1963,9 @@ IPV6_DEFROUTE\fI(+)\fR, (and IPV6_DEFAULTGW, IPV6_DEFAULTDEV in /etc/sysconfig/n T}:T{ IPV6_DEFROUTE=yes (when no variable specified) T}:T{ -IPV6_DEFROUTE=no tells NetworkManager that this connection should not be assigned the default IPv6 route\&. IPV6_DEFROUTE has the opposite meaning as \*(Aqnever\-default\*(Aq property\&. +IPV6_DEFROUTE=no tells NetworkManager that this connection should not be assigned the default IPv6 route\&. IPV6_DEFROUTE has the opposite meaning as \*(Aqnever\-default\*(Aq property\&.\fB + +Example: \fRDHCPV6_HOSTNAME_FLAGS=5 */ T} T{ may\-fail diff --git a/man/nm-settings-ifcfg-rh.xml b/man/nm-settings-ifcfg-rh.xml index f1535039..384d410f 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.20.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.22.0</refmiscinfo></refmeta><refnamediv><refname>nm-settings-ifcfg-rh</refname><refpurpose>Description of <emphasis>ifcfg-rh</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on the concept of connection profiles that contain network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing @@ -334,7 +334,9 @@ Example: </emphasis>DHCP_FQDN=foo.bar.com</entry></row></tbody></tgroup></table> Example: </emphasis>IPV6ADDR=ab12:9876::1 IPV6ADDR_SECONDARIES="ab12:9876::2 ab12:9876::3"</entry></row><row><entry align="left">gateway</entry><entry align="left">IPV6_DEFAULTGW</entry><entry align="left"/><entry align="left">Gateway IP address.<emphasis role="bold"> -Example: </emphasis>IPV6_DEFAULTGW=abbe::1</entry></row><row><entry align="left">routes</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">List of static routes. They are not stored in ifcfg-* file, but in route6-* file instead in the form of command line for 'ip route add'.</entry></row><row><entry align="left">ignore-auto-routes</entry><entry align="left">IPV6_PEERROUTES<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">IPV6_PEERROUTES has the opposite meaning as 'ignore-auto-routes' property.</entry></row><row><entry align="left">ignore-auto-dns</entry><entry align="left">IPV6_PEERDNS<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">IPV6_PEERDNS has the opposite meaning as 'ignore-auto-dns' property.</entry></row><row><entry align="left">dhcp-hostname</entry><entry align="left">DHCPV6_HOSTNAME</entry><entry align="left"/><entry align="left">Hostname to send the DHCP server.</entry></row><row><entry align="left">never-default</entry><entry align="left">IPV6_DEFROUTE<emphasis>(+)</emphasis>, (and IPV6_DEFAULTGW, IPV6_DEFAULTDEV in /etc/sysconfig/network)</entry><entry align="left">IPV6_DEFROUTE=yes (when no variable specified)</entry><entry align="left">IPV6_DEFROUTE=no tells NetworkManager that this connection should not be assigned the default IPv6 route. IPV6_DEFROUTE has the opposite meaning as 'never-default' property.</entry></row><row><entry align="left">may-fail</entry><entry align="left">IPV6_FAILURE_FATAL<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">IPV6_FAILURE_FATAL has the opposite meaning as 'may-fail' property.</entry></row><row><entry align="left">route-metric</entry><entry align="left">IPV6_ROUTE_METRIC<emphasis>(+)</emphasis></entry><entry align="left">-1</entry><entry align="left">IPV6_ROUTE_METRIC is the default IPv6 metric for routes on this connection. If set to -1, a default metric based on the device type is used.</entry></row><row><entry align="left">route-table</entry><entry align="left">IPV6_ROUTE_TABLE<emphasis>(+)</emphasis></entry><entry align="left">0</entry><entry align="left">IPV6_ROUTE_TABLE enables policy-routing and sets the default routing table.</entry></row><row><entry align="left">dns-priority</entry><entry align="left">IPV6_DNS_PRIORITY<emphasis>(+)</emphasis></entry><entry align="left">0</entry><entry align="left">The priority for DNS servers of this connection. Lower values have higher priority. If zero, the default value will be used (50 for VPNs, 100 for other connections). A negative value prevents DNS from other connections with greater values to be used.<emphasis role="bold"> +Example: </emphasis>IPV6_DEFAULTGW=abbe::1</entry></row><row><entry align="left">routes</entry><entry align="left">(none)</entry><entry align="left"/><entry align="left">List of static routes. They are not stored in ifcfg-* file, but in route6-* file instead in the form of command line for 'ip route add'.</entry></row><row><entry align="left">ignore-auto-routes</entry><entry align="left">IPV6_PEERROUTES<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">IPV6_PEERROUTES has the opposite meaning as 'ignore-auto-routes' property.</entry></row><row><entry align="left">ignore-auto-dns</entry><entry align="left">IPV6_PEERDNS<emphasis>(+)</emphasis></entry><entry align="left">yes</entry><entry align="left">IPV6_PEERDNS has the opposite meaning as 'ignore-auto-dns' property.</entry></row><row><entry align="left">dhcp-hostname</entry><entry align="left">DHCPV6_HOSTNAME</entry><entry align="left"/><entry align="left">Hostname to send the DHCP server.</entry></row><row><entry align="left">never-default</entry><entry align="left">IPV6_DEFROUTE<emphasis>(+)</emphasis>, (and IPV6_DEFAULTGW, IPV6_DEFAULTDEV in /etc/sysconfig/network)</entry><entry align="left">IPV6_DEFROUTE=yes (when no variable specified)</entry><entry align="left">IPV6_DEFROUTE=no tells NetworkManager that this connection should not be assigned the default IPv6 route. IPV6_DEFROUTE has the opposite meaning as 'never-default' property.<emphasis role="bold"> + +Example: </emphasis>DHCPV6_HOSTNAME_FLAGS=5 */ </entry></row><row><entry align="left">may-fail</entry><entry align="left">IPV6_FAILURE_FATAL<emphasis>(+)</emphasis></entry><entry align="left">no</entry><entry align="left">IPV6_FAILURE_FATAL has the opposite meaning as 'may-fail' property.</entry></row><row><entry align="left">route-metric</entry><entry align="left">IPV6_ROUTE_METRIC<emphasis>(+)</emphasis></entry><entry align="left">-1</entry><entry align="left">IPV6_ROUTE_METRIC is the default IPv6 metric for routes on this connection. If set to -1, a default metric based on the device type is used.</entry></row><row><entry align="left">route-table</entry><entry align="left">IPV6_ROUTE_TABLE<emphasis>(+)</emphasis></entry><entry align="left">0</entry><entry align="left">IPV6_ROUTE_TABLE enables policy-routing and sets the default routing table.</entry></row><row><entry align="left">dns-priority</entry><entry align="left">IPV6_DNS_PRIORITY<emphasis>(+)</emphasis></entry><entry align="left">0</entry><entry align="left">The priority for DNS servers of this connection. Lower values have higher priority. If zero, the default value will be used (50 for VPNs, 100 for other connections). A negative value prevents DNS from other connections with greater values to be used.<emphasis role="bold"> Example: </emphasis>IPV6_DNS_PRIORITY=20</entry></row><row><entry align="left">dns-options</entry><entry align="left">IPV6_RES_OPTIONS<emphasis>(+)</emphasis></entry><entry align="left"/><entry align="left">List of DNS options to be added to /etc/resolv.conf<emphasis role="bold"> diff --git a/man/nm-settings-keyfile.5 b/man/nm-settings-keyfile.5 index 68b09024..be46aaea 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: 11/25/2019 +.\" Date: 12/17/2019 .\" Manual: Configuration -.\" Source: NetworkManager 1.20.8 +.\" Source: NetworkManager 1.22.0 .\" Language: English .\" -.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.20\&.8" "Configuration" +.TH "NM\-SETTINGS\-KEYFILE" "5" "" "NetworkManager 1\&.22\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- diff --git a/man/nm-settings-keyfile.xml b/man/nm-settings-keyfile.xml index 56685f4f..66ed6c23 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.20.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.22.0</refmiscinfo></refmeta><refnamediv><refname>nm-settings-keyfile</refname><refpurpose>Description of <emphasis>keyfile</emphasis> settings plugin</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on the concept of connection profiles that contain network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry> for details). The profiles can be stored in various formats. NetworkManager uses plugins for reading and writing diff --git a/man/nm-settings.5 b/man/nm-settings.5 index 60f23a82..e05a5a11 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: 11/25/2019 +.\" Date: 12/17/2019 .\" Manual: Configuration -.\" Source: NetworkManager 1.20.8 +.\" Source: NetworkManager 1.22.0 .\" Language: English .\" -.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.20\&.8" "Configuration" +.TH "NM\-SETTINGS" "5" "" "NetworkManager 1\&.22\&.0" "Configuration" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -628,7 +628,7 @@ string T}:T{ \ \& T}:T{ -Specifies the allowed "phase 2" inner non\-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property\&. Recognized non\-EAP "phase 2" methods are "pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls"\&. Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details\&. +Specifies the allowed "phase 2" inner non\-EAP authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property\&. Recognized non\-EAP "phase 2" methods are "pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls"\&. Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details\&. T} T{ phase2\-autheap @@ -637,7 +637,7 @@ string T}:T{ \ \& T}:T{ -Specifies the allowed "phase 2" inner EAP\-based authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property\&. Recognized EAP\-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls"\&. Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details\&. +Specifies the allowed "phase 2" inner EAP\-based authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property\&. Recognized EAP\-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls"\&. Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details\&. T} T{ phase2\-ca\-cert @@ -1503,6 +1503,7 @@ l l l l l l l l l l l l l l l l +l l l l l l l l. T{ apn @@ -1514,6 +1515,15 @@ T}:T{ The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM\-based network\&. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider\-specific walled\-garden, so it is important to use the correct APN for the user\*(Aqs mobile broadband plan\&. The APN may only be composed of the characters a\-z, 0\-9, \&., and \- per GSM 03\&.60 Section 14\&.9\&. T} T{ +auto\-config +T}:T{ +boolean +T}:T{ +FALSE +T}:T{ +When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database\&. +T} +T{ device\-id T}:T{ string @@ -1728,6 +1738,8 @@ l l l l l l l l l l l l l l l l +l l l l +l l l l l l l l. T{ address\-data @@ -1784,6 +1796,24 @@ T}:T{ 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\&. T} T{ +dhcp\-hostname\-flags +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Flags for the DHCP hostname and FQDN\&. Currently this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4)\&. When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6\&. When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration\&. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests\&. +T} +T{ +dhcp\-iaid +T}:T{ +string +T}:T{ +\ \& +T}:T{ +A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The property is a 32\-bit decimal value or a special value among "mac", "perm\-mac", "ifname" and "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address\&. +T} +T{ dhcp\-send\-hostname T}:T{ boolean @@ -1968,6 +1998,8 @@ l l l l l l l l l l l l l l l l +l l l l +l l l l l l l l. T{ addr\-gen\-mode @@ -2024,6 +2056,24 @@ T}:T{ 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\&. T} T{ +dhcp\-hostname\-flags +T}:T{ +uint32 +T}:T{ +0 +T}:T{ +Flags for the DHCP hostname and FQDN\&. Currently this property only includes flags to control the FQDN flags set in the DHCP FQDN option\&. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4)\&. When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag\&. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6\&. When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration\&. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests\&. +T} +T{ +dhcp\-iaid +T}:T{ +string +T}:T{ +\ \& +T}:T{ +A string containing the "Identity Association Identifier" (IAID) used by the DHCP client\&. The property is a 32\-bit decimal value or a special value among "mac", "perm\-mac", "ifname" and "stable"\&. When set to "mac" (or "perm\-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID\&. When set to "ifname", the IAID is computed by hashing the interface name\&. The special value "stable" can be used to generate an IAID based on the stable\-id (see connection\&.stable\-id), a per\-host key and the interface name\&. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname"\&. Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address\&. +T} +T{ dhcp\-send\-hostname T}:T{ boolean @@ -4641,7 +4691,7 @@ string T}:T{ \ \& T}:T{ -Key management used for the connection\&. One of "none" (WEP), "ieee8021x" (Dynamic WEP), "wpa\-none" (Ad\-Hoc WPA\-PSK), "wpa\-psk" (infrastructure WPA\-PSK), "sae" (SAE) or "wpa\-eap" (WPA\-Enterprise)\&. This property must be set for any Wi\-Fi connection that uses security\&. +Key management used for the connection\&. One of "none" (WEP), "ieee8021x" (Dynamic WEP), "wpa\-psk" (infrastructure WPA\-PSK), "sae" (SAE) or "wpa\-eap" (WPA\-Enterprise)\&. This property must be set for any Wi\-Fi connection that uses security\&. T} T{ leap\-password diff --git a/man/nm-settings.xml b/man/nm-settings.xml index 5f77b821..c4c3bfc2 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.20.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.22.0</refmiscinfo></refmeta><refnamediv><refname>nm-settings</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> NetworkManager is based on a concept of connection profiles, sometimes referred to as connections only. These connection profiles contain a network configuration. When NetworkManager activates a connection profile on a network device the configuration will @@ -87,8 +87,8 @@ <row><entry align="left" id="nm-settings.property.802-1x.phase1-peaplabel">phase1-peaplabel</entry><entry align="left">string</entry><entry align="left"/><entry>Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to "1" to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase1-peapver">phase1-peapver</entry><entry align="left">string</entry><entry align="left"/><entry>Forces which PEAP version is used when PEAP is set as the EAP method in the "eap" property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to "0" or "1" to force that specific PEAP version.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase2-altsubject-matches">phase2-altsubject-matches</entry><entry align="left">array of string</entry><entry align="left"/><entry>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner "phase 2" authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</entry></row> - <row><entry align="left" id="nm-settings.property.802-1x.phase2-auth">phase2-auth</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the allowed "phase 2" inner non-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. Recognized non-EAP "phase 2" methods are "pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</entry></row> - <row><entry align="left" id="nm-settings.property.802-1x.phase2-autheap">phase2-autheap</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the allowed "phase 2" inner EAP-based authentication methods when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</entry></row> + <row><entry align="left" id="nm-settings.property.802-1x.phase2-auth">phase2-auth</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the allowed "phase 2" inner non-EAP authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. Recognized non-EAP "phase 2" methods are "pap", "chap", "mschap", "mschapv2", "gtc", "otp", "md5", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</entry></row> + <row><entry align="left" id="nm-settings.property.802-1x.phase2-autheap">phase2-autheap</entry><entry align="left">string</entry><entry align="left"/><entry>Specifies the allowed "phase 2" inner EAP-based authentication method when an EAP method that uses an inner TLS tunnel is specified in the "eap" property. Recognized EAP-based "phase 2" methods are "md5", "mschapv2", "otp", "gtc", and "tls". Each "phase 2" inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase2-ca-cert">phase2-ca-cert</entry><entry align="left">byte array</entry><entry align="left"/><entry>Contains the "phase 2" CA certificate if used by the EAP method specified in the "phase2-auth" or "phase2-autheap" properties. Certificate data is specified using a "scheme"; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string "file://" and ending with a terminating NUL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase2-ca-cert-password">phase2-ca-cert-password</entry><entry align="left">string</entry><entry align="left"/><entry>The password used to access the "phase2" CA certificate stored in "phase2-ca-cert" property. Only makes sense if the certificate is stored on a PKCS#11 token that requires a login.</entry></row> <row><entry align="left" id="nm-settings.property.802-1x.phase2-ca-cert-password-flags">phase2-ca-cert-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "phase2-ca-cert-password" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> @@ -179,6 +179,7 @@ </tbody></tgroup></informaltable></refsect2> <refsect2><title>gsm setting</title><para>GSM-based Mobile Broadband Settings.</para><informaltable><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody> <row><entry align="left" id="nm-settings.property.gsm.apn">apn</entry><entry align="left">string</entry><entry align="left"/><entry>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</entry></row> + <row><entry align="left" id="nm-settings.property.gsm.auto-config">auto-config</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, the settings such as APN, username, or password will default to values that match the network the modem will register to in the Mobile Broadband Provider database.</entry></row> <row><entry align="left" id="nm-settings.property.gsm.device-id">device-id</entry><entry align="left">string</entry><entry align="left"/><entry>The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.</entry></row> <row><entry align="left" id="nm-settings.property.gsm.home-only">home-only</entry><entry align="left">boolean</entry><entry align="left">FALSE</entry><entry>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</entry></row> <row><entry align="left" id="nm-settings.property.gsm.mtu">mtu</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry></row> @@ -206,6 +207,8 @@ <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 (01). Currently, these options only work for ethernet type of links. The special value "duid" generates a RFC4361-compliant client identifier based on a hash of the interface name as IAID and /etc/machine-id. 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 you set the stable-id, you may want to include the "${DEVICE}" or "${MAC}" specifier to get a per-device key. If unset, a globally configured default is used. If still unset, the default depends on the DHCP plugin.</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-hostname-flags">dhcp-hostname-flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Flags for the DHCP hostname and FQDN. Currently this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</entry></row> + <row><entry align="left" id="nm-settings.property.ipv4.dhcp-iaid">dhcp-iaid</entry><entry align="left">string</entry><entry align="left"/><entry>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.</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>Array of IP addresses of DNS servers (as network-byte-order integers)</entry></row> @@ -230,6 +233,8 @@ <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. You may want to include the "${DEVICE}" or "${MAC}" specifier in the stable-id, in case this profile gets activated on multiple devices. 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-hostname-flags">dhcp-hostname-flags</entry><entry align="left">uint32</entry><entry align="left">0</entry><entry>Flags for the DHCP hostname and FQDN. Currently this property only includes flags to control the FQDN flags set in the DHCP FQDN option. Supported FQDN flags are NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) and NM_DHCP_HOSTNAME_FLAG_FQDN_NO_UPDATE (0x4). When no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is set, the DHCP FQDN option will contain no flag. Otherwise, if no FQDN flag is set and NM_DHCP_HOSTNAME_FLAG_FQDN_CLEAR_FLAGS (0x8) is not set, the standard FQDN flags are set in the request: NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1), NM_DHCP_HOSTNAME_FLAG_FQDN_ENCODED (0x2) for IPv4 and NM_DHCP_HOSTNAME_FLAG_FQDN_SERV_UPDATE (0x1) for IPv6. When this property is set to the default value NM_DHCP_HOSTNAME_FLAG_NONE (0x0), a global default is looked up in NetworkManager configuration. If that value is unset or also NM_DHCP_HOSTNAME_FLAG_NONE (0x0), then the standard FQDN flags described above are sent in the DHCP requests.</entry></row> + <row><entry align="left" id="nm-settings.property.ipv6.dhcp-iaid">dhcp-iaid</entry><entry align="left">string</entry><entry align="left"/><entry>A string containing the "Identity Association Identifier" (IAID) used by the DHCP client. The property is a 32-bit decimal value or a special value among "mac", "perm-mac", "ifname" and "stable". When set to "mac" (or "perm-mac"), the last 4 bytes of the current (or permanent) MAC address are used as IAID. When set to "ifname", the IAID is computed by hashing the interface name. The special value "stable" can be used to generate an IAID based on the stable-id (see connection.stable-id), a per-host key and the interface name. When the property is unset, the value from global configuration is used; if no global default is set then the IAID is assumed to be "ifname". Note that at the moment this property is ignored for IPv6 by dhclient, which always derives the IAID from the MAC address.</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>Array of IP addresses of DNS servers (in network byte order)</entry></row> @@ -497,7 +502,7 @@ <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>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), "sae" (SAE) 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.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-psk" (infrastructure WPA-PSK), "sae" (SAE) 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> <row><entry align="left" id="nm-settings.property.802-11-wireless-security.leap-password-flags">leap-password-flags</entry><entry align="left">NMSettingSecretFlags (uint32)</entry><entry align="left"/><entry>Flags indicating how to handle the "leap-password" property. (see <xref linkend="secrets-flags"/> for flag values)</entry></row> <row><entry align="left" id="nm-settings.property.802-11-wireless-security.leap-username">leap-username</entry><entry align="left">string</entry><entry align="left"/><entry>The login username 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 1bcfc3bb..b97cd8e9 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: 11/25/2019 +.\" Date: 12/17/2019 .\" Manual: Examples -.\" Source: NetworkManager 1.20.8 +.\" Source: NetworkManager 1.22.0 .\" Language: English .\" -.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.20\&.8" "Examples" +.TH "NMCLI\-EXAMPLES" "7" "" "NetworkManager 1\&.22\&.0" "Examples" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -689,6 +689,46 @@ nmcli> \fBquit\fR .\} .PP Example session in the nmcli interactive connection editor\&. The scenario creates an Ethernet connection profile with static addressing (IPs and DNS)\&. +.PP +\fBExample\ \&16.\ \&Bluetooth connection profiles\fR +.PP +NetworkManger supports both connecting to NAP and DUN devices as a client\&. It also supports sharing the network via a NAP server\&. +.PP +For NAP client connections, NetworkManager automatically creates a suitable in\-memory profile for paired devices if none is available\&. You may use that generated profile directly, but you may also modify and persist it, which will prevent to automatically re\-create it\&. You may also create a profile from scratch\&. For example, the following uses DHCP and IPv6 autoconf for address configuration: +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ \fBnmcli connection add type bluetooth con\-name "Profile for My Bluetooth Device (NAP)" autoconnect no bluetooth\&.type panu bluetooth\&.bdaddr "$BDADDR"\fR +.fi +.if n \{\ +.RE +.\} +.PP +For DUN connections, the user needs to configure modem settings and hence no profile gets created automatically\&. The modem settings depend on your device and you either need a "gsm" or a "csma" section\&. For example, +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ \fBnmcli connection add type bluetooth con\-name "Profile for My Bluetooth Device (DUN)" autoconnect no bluetooth\&.type dun bluetooth\&.bdaddr "$BDADDR" gsm\&.apn apn\&.com\fR +.fi +.if n \{\ +.RE +.\} +.PP +Finally, you can create a bluetooth hotspot\&. BlueZ implements those as a bridge device, so such profiles also have a bridge section\&. Also, you probably want to set IP methods as "shared", so that clients get automatic IP addressing\&. Note that the "shared" IPv4 method requires dnsmasq to be available\&. +.sp +.if n \{\ +.RS 4 +.\} +.nf +$ \fBnmcli connection add type bluetooth con\-name "My Bluetooth Hotspot" autoconnect no ifname btnap0 bluetooth\&.type nap ipv4\&.method shared ipv6\&.method shared\fR +.fi +.if n \{\ +.RE +.\} .SH "SEE ALSO" .PP \fBnmcli\fR(1), diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml index e777c326..53e003fb 100644 --- a/man/nmcli-examples.xml +++ b/man/nmcli-examples.xml @@ -587,6 +587,28 @@ Connection 'ethernet-4' (de89cdeb-a3e1-4d53-8fa0-c22546c775f4) successfully </para> </example> + <example><title>Bluetooth connection profiles</title> + <para>NetworkManger supports both connecting to NAP and DUN devices as a client. It also + supports sharing the network via a NAP server. + </para> + <para>For NAP client connections, NetworkManager automatically creates a suitable in-memory profile + for paired devices if none is available. You may use that generated profile directly, but you may also modify + and persist it, which will prevent to automatically re-create it. You may also create a profile from scratch. + For example, the following uses DHCP and IPv6 autoconf for address configuration: + </para> +<screen><prompt>$ </prompt><userinput>nmcli connection add type bluetooth con-name "Profile for My Bluetooth Device (NAP)" autoconnect no bluetooth.type panu bluetooth.bdaddr "$BDADDR"</userinput></screen> + <para>For DUN connections, the user needs to configure modem settings and hence no profile + gets created automatically. The modem settings depend on your device and you either need + a "gsm" or a "csma" section. For example, + </para> +<screen><prompt>$ </prompt><userinput>nmcli connection add type bluetooth con-name "Profile for My Bluetooth Device (DUN)" autoconnect no bluetooth.type dun bluetooth.bdaddr "$BDADDR" gsm.apn apn.com</userinput></screen> + <para>Finally, you can create a bluetooth hotspot. BlueZ implements those as a bridge device, + so such profiles also have a bridge section. Also, you probably want to set IP methods as "shared", + so that clients get automatic IP addressing. Note that the "shared" IPv4 method requires dnsmasq to be available. + </para> +<screen><prompt>$ </prompt><userinput>nmcli connection add type bluetooth con-name "My Bluetooth Hotspot" autoconnect no ifname btnap0 bluetooth.type nap ipv4.method shared ipv6.method shared</userinput></screen> + </example> + </refsect1> <refsect1> diff --git a/man/nmcli.1 b/man/nmcli.1 index 2dfb294d..a2309a5e 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: 11/25/2019 +.\" Date: 12/17/2019 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.20.8 +.\" Source: NetworkManager 1.22.0 .\" Language: English .\" -.TH "NMCLI" "1" "" "NetworkManager 1\&.20\&.8" "General Commands Manual" +.TH "NMCLI" "1" "" "NetworkManager 1\&.22\&.0" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- @@ -99,6 +99,10 @@ The actual colors used are configured as described in COLORS section for a list of color names supported by \fBnmcli\fR\&. +.sp +If the environment variable +NO_COLOR +is set (to any value), then coloring is disabled with mode "auto"\&. Explicitly enabling coloring overrides the environment variable\&. .RE .PP \fB\-\-complete\-args\fR @@ -590,25 +594,27 @@ option is not specified, the default timeout will be 10 seconds\&. .RS 4 Add, modify or remove properties in the connection profile\&. .sp -To set the property just specify the property name followed by the value\&. An empty value ("") removes the property value\&. +To set the property just specify the property name followed by the value\&. An empty value ("") resets the property value to the default\&. .sp In addition to the properties, you can also use short names for some of the properties\&. Consult the PROPERTY ALIASES section for details\&. .sp -If you want to append an item to the existing value, use +If you want to append an item or a flag to the existing value, use + -prefix for the property name\&. If you want to remove just one item from container\-type property, use +prefix for the property name or alias\&. If you want to remove items from a container\-type or flag property, use \- -prefix for the property name and specify a value or an zero\-based index of the item to remove (or option name for properties with named options) as -\fIvalue\fR\&. The +prefix\&. For certain properties you can also remove elements by specifying the zero\-based index(es)\&. The + and \- -modifies only have a real effect for multi\-value (container) properties like +modifiers only have a real effect for properties that support them\&. These are for example multi\-value (container) properties or flags like ipv4\&.dns, +ip4, ipv4\&.addresses, -bond\&.options, etc\&. +bond\&.options, +802\-1x\&.phase1\-auth\-flags +etc\&. .sp See \fBnm-settings\fR(5) @@ -1275,6 +1281,11 @@ This command does not show the APs, use for that\&. .RE .PP +\fBwifi\fR \fBshow\-password\fR [\fBifname\fR\ \fIifname\fR] +.RS 4 +Show the details of the active Wi\-Fi networks, including the secrets\&. +.RE +.PP \fBlldp\fR [\fBlist\fR\ [\fBifname\fR\ \fIifname\fR]] .RS 4 Display information about neighboring devices learned through the Link Layer Discovery Protocol (LLDP)\&. The @@ -2561,6 +2572,11 @@ Warning of a missing device plugin\&. Device that is not available for activation\&. .RE .PP +\fBdevice\-disabled\fR +.RS 4 +Device is disabled by software or hardware kill switch\&. +.RE +.PP \fBmanager\-running\fR .RS 4 Notice that the NetworkManager daemon is available\&. diff --git a/man/nmcli.xml b/man/nmcli.xml index 43d469c4..e0e8b3ff 100644 --- a/man/nmcli.xml +++ b/man/nmcli.xml @@ -129,6 +129,9 @@ <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> + <para>If the environment variable <literal>NO_COLOR</literal> is set (to any value), + then coloring is disabled with mode "auto". Explicitly enabling coloring overrides + the environment variable.</para> </listitem> </varlistentry> @@ -876,21 +879,23 @@ <para>Add, modify or remove properties in the connection profile.</para> <para>To set the property just specify the property name followed by the - value. An empty value (<literal>""</literal>) removes the property value.</para> + value. An empty value (<literal>""</literal>) resets the property value to + the default.</para> <para>In addition to the properties, you can also use short names for some of the properties. Consult the <link linkend='property_aliases' endterm='property_aliases.title' /> section for details.</para> - <para>If you want to append an item to the existing value, use - <literal>+</literal> prefix for the property name. If you want to remove just - one item from container-type property, use <literal>-</literal> prefix for - the property name and specify a value or an zero-based index of the item to - remove (or option name for properties with named options) as - <replaceable>value</replaceable>. The <literal>+</literal> and <literal>-</literal> - modifies only have a real effect for multi-value (container) - properties like <literal>ipv4.dns</literal>, <literal>ipv4.addresses</literal>, - <literal>bond.options</literal>, etc.</para> + <para>If you want to append an item or a flag to the existing value, use + <literal>+</literal> prefix for the property name or alias. If you want to + remove items from a container-type or flag property, use <literal>-</literal> prefix. + For certain properties you can also remove elements by specifying the zero-based + index(es). + The <literal>+</literal> and <literal>-</literal> modifiers + only have a real effect for properties that support them. + These are for example multi-value (container) properties or flags like <literal>ipv4.dns</literal>, + <literal>ip4</literal>, <literal>ipv4.addresses</literal>, <literal>bond.options</literal>, + <literal>802-1x.phase1-auth-flags</literal> etc.</para> <para>See <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum> </citerefentry> for complete reference of setting and property names, their descriptions @@ -1611,6 +1616,19 @@ <varlistentry> <term> + <command>wifi</command> + <command>show-password</command> + <arg><option>ifname</option> <replaceable>ifname</replaceable></arg> + </term> + + <listitem> + <para>Show the details of the active Wi-Fi networks, including the + secrets.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> <command>lldp</command> <arg> <command>list</command> @@ -2191,6 +2209,13 @@ It's equivalent to the <literal>+bond.options 'option=value'</literal> syntax.</ </varlistentry> <varlistentry> + <term><option>device-disabled</option></term> + <listitem> + <para>Device is disabled by software or hardware kill switch.</para> + </listitem> + </varlistentry> + + <varlistentry> <term><option>manager-running</option></term> <listitem> <para>Notice that the NetworkManager daemon is available.</para> diff --git a/man/nmtui.1 b/man/nmtui.1 index 10b1e30e..380e0358 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: 11/25/2019 +.\" Date: 12/17/2019 .\" Manual: General Commands Manual -.\" Source: NetworkManager 1.20.8 +.\" Source: NetworkManager 1.22.0 .\" Language: English .\" -.TH "NMTUI" "1" "" "NetworkManager 1\&.20\&.8" "General Commands Manual" +.TH "NMTUI" "1" "" "NetworkManager 1\&.22\&.0" "General Commands Manual" .\" ----------------------------------------------------------------- .\" * Define some portability stuff .\" ----------------------------------------------------------------- |