diff options
Diffstat (limited to 'man/nm-settings-nmcli.xml')
| -rw-r--r-- | man/nm-settings-nmcli.xml | 19 |
1 files changed, 15 insertions, 4 deletions
diff --git a/man/nm-settings-nmcli.xml b/man/nm-settings-nmcli.xml index 1a18a20c..89130b99 100644 --- a/man/nm-settings-nmcli.xml +++ b/man/nm-settings-nmcli.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-nmcli"><refentryinfo><title>nm-settings-nmcli</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.45.91</refmiscinfo></refmeta><refnamediv><refname>nm-settings-nmcli</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles for nmcli</refpurpose></refnamediv><refsect1 id="description"><title>Description</title><para> +<refentry id="nm-settings-nmcli"><refentryinfo><title>nm-settings-nmcli</title><author>NetworkManager developers</author></refentryinfo><refmeta><refentrytitle>nm-settings-nmcli</refentrytitle><manvolnum>5</manvolnum><refmiscinfo class="source">NetworkManager</refmiscinfo><refmiscinfo class="manual">Configuration</refmiscinfo><refmiscinfo class="version">1.46.0</refmiscinfo></refmeta><refnamediv><refname>nm-settings-nmcli</refname><refpurpose>Description of settings and properties of NetworkManager connection profiles for nmcli</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 @@ -503,7 +503,10 @@ Format: integer</para><para> Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.ethtool.ring-tx">ethtool.ring-tx</option></term><listitem><para> Format: integer</para><para> - Valid values: 0 - 4294967295</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>gsm setting</title><para>GSM-based Mobile Broadband Settings.</para><para> + Valid values: 0 - 4294967295</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>generic setting</title><para>Generic Link Settings.</para><para> + Properties: + <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.generic.device-handler">generic.device-handler</option></term><listitem><para>Name of the device handler that will be invoked to add and delete the device for this connection. The name can only contain ASCII alphanumeric characters and '-', '_', '.'. It cannot start with '.'.</para><para>See the NetworkManager-dispatcher(8) man page for more details about how to write the device handler.</para><para>By setting this property the generic connection becomes "virtual", meaning that it can be activated without an existing device; the device will be created at the time the connection is started by invoking the device-handler.</para><para> + Format: string</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>gsm setting</title><para>GSM-based Mobile Broadband Settings.</para><para> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.gsm.apn">gsm.apn</option></term><listitem><para> Alias: apn</para><para>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.</para><para>If the APN is unset (the default) then it may be detected based on "auto-config" setting. The property can be explicitly set to the empty string to prevent that and use no APN.</para><para> @@ -925,7 +928,9 @@ Example: <literal>priority 5 from 1:2:3::5/128 table 45</literal> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.mode">macsec.mode</option></term><listitem><para> Alias: mode</para><para>Specifies how the CAK (Connectivity Association Key) for MKA (MACsec Key Agreement) is obtained.</para><para> Format: choice (NMSettingMacsecMode)</para><para> - Valid values: psk (0), eap (1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.parent">macsec.parent</option></term><listitem><para> + Valid values: psk (0), eap (1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.offload">macsec.offload</option></term><listitem><para>Specifies the MACsec offload mode.</para><para>"off" (0) disables MACsec offload.</para><para>"phy" (1) and "mac" (2) request offload respectively to the PHY or to the MAC; if the selected mode is not available, the connection will fail.</para><para>"default" (-1) uses the global default value specified in NetworkManager configuration; if no global default is defined, the built-in default is "off" (0).</para><para> + Format: choice (NMSettingMacsecOffload)</para><para> + Valid values: default (-1), off (0), phy (1), mac (2)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.parent">macsec.parent</option></term><listitem><para> Alias: dev</para><para>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.</para><para> Format: string</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.macsec.port">macsec.port</option></term><listitem><para> Alias: port</para><para>The port component of the SCI (Secure Channel Identifier), between 1 and 65534.</para><para> @@ -1085,7 +1090,13 @@ Example: <literal>priority 5 from 1:2:3::5/128 table 45</literal> Properties: <variablelist><varlistentry><term><option id="nm-settings-nmcli.property.sriov.autoprobe-drivers">sriov.autoprobe-drivers</option></term><listitem><para>Whether to autoprobe virtual functions by a compatible driver.</para><para>If set to "true" (1), the kernel will try to bind VFs to a compatible driver and if this succeeds a new network interface will be instantiated for each VF.</para><para>If set to "false" (0), VFs will not be claimed and no network interfaces will be created for them.</para><para>When set to "default" (-1), the global default is used; in case the global default is unspecified it is assumed to be "true" (1).</para><para> Format: ternary</para><para> - Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.total-vfs">sriov.total-vfs</option></term><listitem><para>The total number of virtual functions to create.</para><para>Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.</para><para> + Valid values: true/yes/on, false/no/off, default/unknown</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.eswitch-encap-mode">sriov.eswitch-encap-mode</option></term><listitem><para>Select the eswitch encapsulation support.</para><para>Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.</para><para>If set to "preserve" (-1) (default) the eswitch encap-mode won't be modified by NetworkManager.</para><para> + Format: choice (NMSriovEswitchEncapMode)</para><para> + Valid values: preserve (-1), none (0), basic (1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.eswitch-inline-mode">sriov.eswitch-inline-mode</option></term><listitem><para>Select the eswitch inline-mode of the device. Some HWs need the VF driver to put part of the packet headers on the TX descriptor so the e-switch can do proper matching and steering.</para><para>Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.</para><para>If set to "preserve" (-1) (default) the eswitch inline-mode won't be modified by NetworkManager.</para><para> + Format: choice (NMSriovEswitchInlineMode)</para><para> + Valid values: preserve (-1), none (0), link (1), network (2), transport (3)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.eswitch-mode">sriov.eswitch-mode</option></term><listitem><para>Select the eswitch mode of the device. Currently it's only supported for PCI PF devices, and only if the eswitch device is managed from the same PCI address than the PF.</para><para>If set to "preserve" (-1) (default) the eswitch mode won't be modified by NetworkManager.</para><para> + Format: choice (NMSriovEswitchMode)</para><para> + Valid values: preserve (-1), legacy (0), switchdev (1)</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.total-vfs">sriov.total-vfs</option></term><listitem><para>The total number of virtual functions to create.</para><para>Note that when the sriov setting is present NetworkManager enforces the number of virtual functions on the interface (also when it is zero) during activation and resets it upon deactivation. To prevent any changes to SR-IOV parameters don't add a sriov setting to the connection.</para><para> Format: integer</para><para> Valid values: 0 - 4294967295</para></listitem></varlistentry><varlistentry><term><option id="nm-settings-nmcli.property.sriov.vfs">sriov.vfs</option></term><listitem><para>Array of virtual function descriptors.</para><para>Each VF descriptor is a dictionary mapping attribute names to GVariant values. The 'index' entry is mandatory for each VF.</para><para>When represented as string a VF is in the form:</para><para>"INDEX [ATTR=VALUE[ ATTR=VALUE]...]".</para><para>for example:</para><para>"2 mac=00:11:22:33:44:55 spoof-check=true".</para><para>Multiple VFs can be specified using a comma as separator. Currently, the following attributes are supported: mac, spoof-check, trust, min-tx-rate, max-tx-rate, vlans.</para><para>The "vlans" attribute is represented as a semicolon-separated list of VLAN descriptors, where each descriptor has the form</para><para>"ID[.PRIORITY[.PROTO]]".</para><para>PROTO can be either 'q' for 802.1Q (the default) or 'ad' for 802.1ad.</para><para> Format: list of sriov.vfs objects</para></listitem></varlistentry></variablelist></para></refsect2><refsect2><title>tc setting</title><para>Linux Traffic Control Settings.</para><para> |