diff options
Diffstat (limited to 'docs/api/html/nm-settings-nmcli.html')
| -rw-r--r-- | docs/api/html/nm-settings-nmcli.html | 132 |
1 files changed, 76 insertions, 56 deletions
diff --git a/docs/api/html/nm-settings-nmcli.html b/docs/api/html/nm-settings-nmcli.html index e59968ad..545ba61f 100644 --- a/docs/api/html/nm-settings-nmcli.html +++ b/docs/api/html/nm-settings-nmcli.html @@ -67,7 +67,7 @@ property. </p> <div class="refsect2"> -<a name="id-1.2.8.4.7"></a><h3>connection setting</h3> +<a name="id-1.2.9.4.7"></a><h3>connection setting</h3> <p>General Connection Profile Settings.</p> <p> Properties: @@ -295,7 +295,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.8"></a><h3>6lowpan setting</h3> +<a name="id-1.2.9.4.8"></a><h3>6lowpan setting</h3> <p>6LoWPAN Settings.</p> <p> Properties: @@ -319,7 +319,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.9"></a><h3>802-1x setting</h3> +<a name="id-1.2.9.4.9"></a><h3>802-1x setting</h3> <p>IEEE 802.1x Authentication Settings.</p> <p> Properties: @@ -729,7 +729,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.10"></a><h3>adsl setting</h3> +<a name="id-1.2.9.4.10"></a><h3>adsl setting</h3> <p>ADSL Settings.</p> <p> Properties: @@ -811,7 +811,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.11"></a><h3>bluetooth setting</h3> +<a name="id-1.2.9.4.11"></a><h3>bluetooth setting</h3> <p>Bluetooth Settings.</p> <p> Properties: @@ -847,7 +847,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.12"></a><h3>bond setting</h3> +<a name="id-1.2.9.4.12"></a><h3>bond setting</h3> <p>Bonding Settings.</p> <p> Properties: @@ -869,7 +869,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.13"></a><h3>bridge setting</h3> +<a name="id-1.2.9.4.13"></a><h3>bridge setting</h3> <p>Bridging Settings.</p> <p> Properties: @@ -1119,7 +1119,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.14"></a><h3>bridge-port setting</h3> +<a name="id-1.2.9.4.14"></a><h3>bridge-port setting</h3> <p>Bridge Port Settings.</p> <p> Properties: @@ -1173,7 +1173,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.15"></a><h3>cdma setting</h3> +<a name="id-1.2.9.4.15"></a><h3>cdma setting</h3> <p>CDMA-based Mobile Broadband Settings.</p> <p> Properties: @@ -1235,7 +1235,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.16"></a><h3>dcb setting</h3> +<a name="id-1.2.9.4.16"></a><h3>dcb setting</h3> <p>Data Center Bridging Settings.</p> <p> Properties: @@ -1371,7 +1371,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.17"></a><h3>ethtool setting</h3> +<a name="id-1.2.9.4.17"></a><h3>ethtool setting</h3> <p>Ethtool Ethernet Settings.</p> <p> Properties: @@ -1703,6 +1703,18 @@ <td><p></p></td> </tr> <tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.pause-autoneg"></a>pause-autoneg</code></span></p></td> +<td><p>Whether to automatically negotiate on pause frame of flow control mechanism defined by IEEE 802.3x standard.</p></td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.pause-rx"></a>pause-rx</code></span></p></td> +<td><p>Whether RX pause should be enabled. Only valid when automatic negotiation is disabled</p></td> +</tr> +<tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.pause-tx"></a>pause-tx</code></span></p></td> +<td><p>Whether TX pause should be enabled. Only valid when automatic negotiation is disabled</p></td> +</tr> +<tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ethtool.ring-rx"></a>ring-rx</code></span></p></td> <td><p></p></td> </tr> @@ -1723,7 +1735,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.18"></a><h3>gsm setting</h3> +<a name="id-1.2.9.4.18"></a><h3>gsm setting</h3> <p>GSM-based Mobile Broadband Settings.</p> <p> Properties: @@ -1861,7 +1873,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.19"></a><h3>infiniband setting</h3> +<a name="id-1.2.9.4.19"></a><h3>infiniband setting</h3> <p>Infiniband Settings.</p> <p> Properties: @@ -1927,7 +1939,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.20"></a><h3>ipv4 setting</h3> +<a name="id-1.2.9.4.20"></a><h3>ipv4 setting</h3> <p>IPv4 Settings.</p> <p> Properties: @@ -1943,9 +1955,9 @@ <td> <p> Alias: ip4</p> -<p>Array of IP addresses.</p> +<p>A list of IPv4 addresses and their prefix length. Multiple addresses can be separated by comma. For example "192.168.1.5/24, 10.1.0.5/24".</p> <p> - Format: array of array of uint32</p> + Format: a comma separated list of addresses</p> </td> </tr> <tr> @@ -2129,9 +2141,9 @@ <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.ipv4.routes"></a>routes</code></span></p></td> <td> -<p>Array of IP routes.</p> +<p>A list of IPv4 destination addresses, prefix length, optional IPv4 next hop addresses, optional route metric, optional attribute. The valid syntax is: "ip[/prefix] [next-hop] [metric] [attribute=val]...[,ip[/prefix]...]". For example "192.0.2.0/24 10.1.1.1 77, 198.51.100.0/24".</p> <p> - Format: array of array of uint32</p> + Format: a comma separated list of routes</p> </td> </tr> <tr> @@ -2143,7 +2155,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.21"></a><h3>ipv6 setting</h3> +<a name="id-1.2.9.4.21"></a><h3>ipv6 setting</h3> <p>IPv6 Settings.</p> <p> Properties: @@ -2359,7 +2371,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.22"></a><h3>ip-tunnel setting</h3> +<a name="id-1.2.9.4.22"></a><h3>ip-tunnel setting</h3> <p>IP Tunneling Settings.</p> <p> Properties: @@ -2487,7 +2499,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.23"></a><h3>macsec setting</h3> +<a name="id-1.2.9.4.23"></a><h3>macsec setting</h3> <p>MACSec Settings.</p> <p> Properties: @@ -2589,7 +2601,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.24"></a><h3>macvlan setting</h3> +<a name="id-1.2.9.4.24"></a><h3>macvlan setting</h3> <p>MAC VLAN Settings.</p> <p> Properties: @@ -2643,7 +2655,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.25"></a><h3>match setting</h3> +<a name="id-1.2.9.4.25"></a><h3>match setting</h3> <p>Match settings.</p> <p> Properties: @@ -2673,7 +2685,7 @@ <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.match.kernel-command-line"></a>kernel-command-line</code></span></p></td> <td> -<p>A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or if prefixed with the exclamation mark unset). The argument must either be a single word, or an assignment (i.e. two words, separated "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\' are used for optional and mandatory matches and inverting the pattern.</p> +<p>A list of kernel command line arguments to match. This may be used to check whether a specific kernel command line option is set (or unset, if prefixed with the exclamation mark). The argument must either be a single word, or an assignment (i.e. two words, joined by "="). In the former case the kernel command line is searched for the word appearing as is, or as left hand side of an assignment. In the latter case, the exact assignment is looked for with right and left hand side matching. Wildcard patterns are not supported. See NMSettingMatch:interface-name for how special characters '|', '&', '!' and '\' are used for optional and mandatory matches and inverting the match.</p> <p> Format: array of string</p> </td> @@ -2691,7 +2703,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.26"></a><h3>802-11-olpc-mesh setting</h3> +<a name="id-1.2.9.4.26"></a><h3>802-11-olpc-mesh setting</h3> <p> Alias: olpc-mesh</p> <p>OLPC Wireless Mesh Settings.</p> @@ -2719,7 +2731,7 @@ <td> <p> Alias: dhcp-anycast</p> -<p>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request.</p> +<p>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. This is currently only implemented by dhclient DHCP plugin.</p> <p> Format: byte array</p> </td> @@ -2739,7 +2751,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.27"></a><h3>ovs-bridge setting</h3> +<a name="id-1.2.9.4.27"></a><h3>ovs-bridge setting</h3> <p>OvsBridge Link Settings.</p> <p> Properties: @@ -2795,7 +2807,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.28"></a><h3>ovs-dpdk setting</h3> +<a name="id-1.2.9.4.28"></a><h3>ovs-dpdk setting</h3> <p>OvsDpdk Link Settings.</p> <p> Properties: @@ -2817,7 +2829,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.29"></a><h3>ovs-interface setting</h3> +<a name="id-1.2.9.4.29"></a><h3>ovs-interface setting</h3> <p>Open vSwitch Interface Settings.</p> <p> Properties: @@ -2839,7 +2851,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.30"></a><h3>ovs-patch setting</h3> +<a name="id-1.2.9.4.30"></a><h3>ovs-patch setting</h3> <p>OvsPatch Link Settings.</p> <p> Properties: @@ -2861,7 +2873,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.31"></a><h3>ovs-port setting</h3> +<a name="id-1.2.9.4.31"></a><h3>ovs-port setting</h3> <p>OvsPort Link Settings.</p> <p> Properties: @@ -2925,7 +2937,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.32"></a><h3>ppp setting</h3> +<a name="id-1.2.9.4.32"></a><h3>ppp setting</h3> <p>Point-to-Point Protocol Settings.</p> <p> Properties: @@ -3085,7 +3097,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.33"></a><h3>pppoe setting</h3> +<a name="id-1.2.9.4.33"></a><h3>pppoe setting</h3> <p>PPP-over-Ethernet Settings.</p> <p> Properties: @@ -3151,7 +3163,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.34"></a><h3>proxy setting</h3> +<a name="id-1.2.9.4.34"></a><h3>proxy setting</h3> <p>WWW Proxy Settings.</p> <p> Properties: @@ -3207,7 +3219,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.35"></a><h3>serial setting</h3> +<a name="id-1.2.9.4.35"></a><h3>serial setting</h3> <p>Serial Link Settings.</p> <p> Properties: @@ -3263,7 +3275,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.36"></a><h3>sriov setting</h3> +<a name="id-1.2.9.4.36"></a><h3>sriov setting</h3> <p>SR-IOV settings.</p> <p> Properties: @@ -3303,7 +3315,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.37"></a><h3>tc setting</h3> +<a name="id-1.2.9.4.37"></a><h3>tc setting</h3> <p>Linux Traffic Control Settings.</p> <p> Properties: @@ -3317,7 +3329,7 @@ <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tc.qdiscs"></a>qdiscs</code></span></p></td> <td> -<p>Array of TC queueing disciplines.</p> +<p>Array of TC queueing disciplines. When the "tc" setting is present, qdiscs from this property are applied upon activation. If the property is empty, all qdiscs are removed and the device will only have the default qdisc assigned by kernel according to the "net.core.default_qdisc" sysctl. If the "tc" setting is not present, NetworkManager doesn't touch the qdiscs present on the interface.</p> <p> Format: array of vardict</p> </td> @@ -3325,7 +3337,7 @@ <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.tc.tfilters"></a>tfilters</code></span></p></td> <td> -<p>Array of TC traffic filters.</p> +<p>Array of TC traffic filters. When the "tc" setting is present, filters from this property are applied upon activation. If the property is empty, NetworkManager removes all the filters. If the "tc" setting is not present, NetworkManager doesn't touch the filters present on the interface.</p> <p> Format: array of vardict</p> </td> @@ -3335,7 +3347,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.38"></a><h3>team setting</h3> +<a name="id-1.2.9.4.38"></a><h3>team setting</h3> <p>Teaming Settings.</p> <p> Properties: @@ -3481,7 +3493,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.39"></a><h3>team-port setting</h3> +<a name="id-1.2.9.4.39"></a><h3>team-port setting</h3> <p>Team Port Settings.</p> <p> Properties: @@ -3555,7 +3567,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.40"></a><h3>tun setting</h3> +<a name="id-1.2.9.4.40"></a><h3>tun setting</h3> <p>Tunnel Settings.</p> <p> Properties: @@ -3631,7 +3643,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.41"></a><h3>vlan setting</h3> +<a name="id-1.2.9.4.41"></a><h3>vlan setting</h3> <p>VLAN Settings.</p> <p> Properties: @@ -3697,7 +3709,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.42"></a><h3>vpn setting</h3> +<a name="id-1.2.9.4.42"></a><h3>vpn setting</h3> <p>VPN Settings.</p> <p> Properties: @@ -3765,7 +3777,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.43"></a><h3>vrf setting</h3> +<a name="id-1.2.9.4.43"></a><h3>vrf setting</h3> <p>VRF settings.</p> <p> Properties: @@ -3789,7 +3801,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.44"></a><h3>vxlan setting</h3> +<a name="id-1.2.9.4.44"></a><h3>vxlan setting</h3> <p>VXLAN Settings.</p> <p> Properties: @@ -3947,7 +3959,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.45"></a><h3>wifi-p2p setting</h3> +<a name="id-1.2.9.4.45"></a><h3>wifi-p2p setting</h3> <p>Wi-Fi P2P Settings.</p> <p> Properties: @@ -3989,7 +4001,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.46"></a><h3>wimax setting</h3> +<a name="id-1.2.9.4.46"></a><h3>wimax setting</h3> <p>WiMax Settings.</p> <p> Properties: @@ -4025,7 +4037,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.47"></a><h3>802-3-ethernet setting</h3> +<a name="id-1.2.9.4.47"></a><h3>802-3-ethernet setting</h3> <p> Alias: ethernet</p> <p>Wired Ethernet Settings.</p> @@ -4039,6 +4051,14 @@ </colgroup> <tbody> <tr> +<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.accept-all-mac-addresses"></a>accept-all-mac-addresses</code></span></p></td> +<td> +<p>When TRUE, setup the interface to accept packets for all MAC addresses. This is enabling the kernel interface flag IFF_PROMISC. When FALSE, the interface will only accept the packets with the interface destination mac address or broadcast.</p> +<p> + Format: NMTernary (int32)</p> +</td> +</tr> +<tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-3-ethernet.auto-negotiate"></a>auto-negotiate</code></span></p></td> <td> <p>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.</p> @@ -4161,7 +4181,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.48"></a><h3>wireguard setting</h3> +<a name="id-1.2.9.4.48"></a><h3>wireguard setting</h3> <p>WireGuard Settings.</p> <p> Properties: @@ -4243,7 +4263,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.49"></a><h3>802-11-wireless setting</h3> +<a name="id-1.2.9.4.49"></a><h3>802-11-wireless setting</h3> <p> Alias: wifi</p> <p>Wi-Fi Settings.</p> @@ -4415,7 +4435,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.50"></a><h3>802-11-wireless-security setting</h3> +<a name="id-1.2.9.4.50"></a><h3>802-11-wireless-security setting</h3> <p> Alias: wifi-sec</p> <p>Wi-Fi Security Settings.</p> @@ -4455,7 +4475,7 @@ <tr> <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.802-11-wireless-security.key-mgmt"></a>key-mgmt</code></span></p></td> <td> -<p>Key management used for the connection. One of "none" (WEP), "ieee8021x" (Dynamic WEP), "wpa-psk" (infrastructure WPA-PSK), "sae" (SAE), "owe" (Opportunistic Wireless Encryption), "wpa-eap" (WPA-Enterprise) or "wpa-eap-suite-b-192" (WPA3-Enterprise Suite B). This property must be set for any Wi-Fi connection that uses security.</p> +<p>Key management used for the connection. One of "none" (WEP or no password protection), "ieee8021x" (Dynamic WEP), "owe" (Opportunistic Wireless Encryption), "wpa-psk" (WPA2 + WPA3 personal), "sae" (WPA3 personal only), "wpa-eap" (WPA2 + WPA3 enterprise) or "wpa-eap-suite-b-192" (WPA3 enterprise only). This property must be set for any Wi-Fi connection that uses security.</p> <p> Format: string</p> </td> @@ -4599,7 +4619,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.51"></a><h3>wpan setting</h3> +<a name="id-1.2.9.4.51"></a><h3>wpan setting</h3> <p>IEEE 802.15.4 (WPAN) MAC Settings.</p> <p> Properties: @@ -4665,7 +4685,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.52"></a><h3>hostname setting</h3> +<a name="id-1.2.9.4.52"></a><h3>hostname setting</h3> <p>Hostname settings.</p> <p> Properties: @@ -4713,7 +4733,7 @@ </div> <hr> <div class="refsect2"> -<a name="id-1.2.8.4.53"></a><h3>veth setting</h3> +<a name="id-1.2.9.4.53"></a><h3>veth setting</h3> <p>Veth Settings.</p> <p> Properties: |