diff options
| author | Michael Biebl <biebl@debian.org> | 2022-02-14 19:23:28 +0100 |
|---|---|---|
| committer | Michael Biebl <biebl@debian.org> | 2022-02-14 19:23:28 +0100 |
| commit | 2f94dba7385fd0e0ef19a06eb4a2fcf6c43d7946 (patch) | |
| tree | e2222f5577115985dd52044d2991253403cdd952 /src/libnm-client-impl/nm-property-infos-nmcli.xml | |
| parent | 88c227d90a6b7b388c5c85d72802a0ca8f05ed5c (diff) | |
New upstream version 1.35.91 upstream/1.35.91
Diffstat (limited to 'src/libnm-client-impl/nm-property-infos-nmcli.xml')
| -rw-r--r-- | src/libnm-client-impl/nm-property-infos-nmcli.xml | 438 |
1 files changed, 226 insertions, 212 deletions
diff --git a/src/libnm-client-impl/nm-property-infos-nmcli.xml b/src/libnm-client-impl/nm-property-infos-nmcli.xml index a234f3ce..3d067745 100644 --- a/src/libnm-client-impl/nm-property-infos-nmcli.xml +++ b/src/libnm-client-impl/nm-property-infos-nmcli.xml @@ -1,80 +1,180 @@ -<nm-setting-docs> -<setting name="6lowpan"> -</setting> -<setting name="802-1x"> -</setting> -<setting name="adsl"> -</setting> -<setting name="bluetooth"> -</setting> -<setting name="bond-port"> -</setting> -<setting name="bond"> -</setting> -<setting name="bridge-port"> -</setting> -<setting name="bridge"> -</setting> -<setting name="cdma"> -</setting> -<setting name="connection"> -</setting> -<setting name="dcb"> -</setting> -<setting name="dummy"> -</setting> -<setting name="ethtool"> -</setting> -<setting name="generic"> -</setting> -<setting name="gsm"> -</setting> -<setting name="hostname"> -</setting> -<setting name="infiniband"> -</setting> -<setting name="ip-tunnel"> -</setting> -<setting name="ipv4"> -<property name="addresses" variable="addresses" format="a comma separated list of addresses" values="" default="" example="" description="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". The addresses are listed in decreasing priority, meaning the first address will be the primary address." /> -<property name="routes" variable="routes" format="a comma separated list of routes" values="" default="" example="" description="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"." /> -</setting> -<setting name="ipv6"> -<property name="addresses" variable="addresses" format="a comma separated list of addresses" values="" default="" example="" description="A list of IPv6 addresses and their prefix length. Multiple addresses can be separated by comma. For example "2001:db8:85a3::8a2e:370:7334/64, 2001:db8:85a3::5/64". The addresses are listed in increasing priority, meaning the last address will be the primary address." /> -</setting> -<setting name="macsec"> -</setting> -<setting name="macvlan"> -</setting> -<setting name="match"> -</setting> -<setting name="802-11-olpc-mesh"> -</setting> -<setting name="ovs-bridge"> -</setting> -<setting name="ovs-dpdk"> -</setting> -<setting name="ovs-external-ids"> -</setting> -<setting name="ovs-interface"> -</setting> -<setting name="ovs-patch"> -</setting> -<setting name="ovs-port"> -</setting> -<setting name="ppp"> -</setting> -<setting name="pppoe"> -</setting> -<setting name="proxy"> -</setting> -<setting name="serial"> -</setting> -<setting name="sriov"> -</setting> -<setting name="tc"> -<property name="qdiscs" variable="qdiscs" format="GPtrArray(NMTCQdisc)" values="" default="" example="" description=""> -<description-docbook> +<nm-setting-docs><setting name="6lowpan"> +</setting><setting name="802-1x"> +</setting><setting name="adsl"> +</setting><setting name="bluetooth"> +</setting><setting name="bond-port"> +</setting><setting name="bond"> +</setting><setting name="bridge-port"> +</setting><setting name="bridge"> +</setting><setting name="cdma"> +</setting><setting name="connection"> +</setting><setting name="dcb"> +</setting><setting name="dummy"> +</setting><setting name="ethtool"> +</setting><setting name="generic"> +</setting><setting name="gsm"> +</setting><setting name="hostname"> +</setting><setting name="infiniband"> +</setting><setting name="ip-tunnel"> +</setting><setting name="ipv4"> +<property name="addresses" variable="addresses" format="a comma separated list of addresses" values="" default="" example="" description="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". The addresses are listed in decreasing priority, meaning the first address will be the primary address." /><property name="routes" variable="routes" format="a comma separated list of routes" values="" default="" example="" description="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"."><description-docbook> +<para> +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". +</para> +<para> +Various attributes are supported: +<itemizedlist> +<listitem> +<para><literal>"cwnd"</literal> - an unsigned 32 bit integer.</para> +</listitem> +<listitem> +<para><literal>"initcwnd"</literal> - an unsigned 32 bit integer.</para> +</listitem> +<listitem> +<para><literal>"initrwnd"</literal> - an unsigned 32 bit integer.</para> +</listitem> +<listitem> +<para><literal>"lock-cwnd"</literal> - a boolean value.</para> +</listitem> +<listitem> +<para><literal>"lock-initcwnd"</literal> - a boolean value.</para> +</listitem> +<listitem> +<para><literal>"lock-initrwnd"</literal> - a boolean value.</para> +</listitem> +<listitem> +<para><literal>"lock-mtu"</literal> - a boolean value.</para> +</listitem> +<listitem> +<para><literal>"lock-window"</literal> - a boolean value.</para> +</listitem> +<listitem> +<para><literal>"mtu"</literal> - an unsigned 32 bit integer.</para> +</listitem> +<listitem> +<para><literal>"onlink"</literal> - a boolean value.</para> +</listitem> +<listitem> +<para><literal>"scope"</literal> - an unsigned 8 bit integer. IPv4 only.</para> +</listitem> +<listitem> +<para><literal>"src"</literal> - an IPv4 address.</para> +</listitem> +<listitem> +<para><literal>"table"</literal> - an unsigned 32 bit integer. The default depends on ipv4.route-table.</para> +</listitem> +<listitem> +<para><literal>"tos"</literal> - an unsigned 8 bit integer. IPv4 only.</para> +</listitem> +<listitem> +<para><literal>"type"</literal> - one of <literal>unicast</literal>, <literal>local</literal>, <literal>blackhole</literal>, +<literal>unavailable</literal>, <literal>prohibit</literal>. The default is <literal>unicast</literal>.</para> +</listitem> +<listitem> +<para><literal>"window"</literal> - an unsigned 32 bit integer.</para> +</listitem> +</itemizedlist> +</para> +<para> +For details see also `man ip-route`. +</para></description-docbook></property><property name="routing-rules" variable="routing-rules" format="a comma separated list of routing rules" values="" default="" example="" description="A comma separated list of routing rules for policy routing."><description-docbook> +<para> +A comma separated list of routing rules for policy routing. The format +is based on <command>ip rule add</command> syntax and mostly compatible. +One difference is that routing rules in NetworkManager always need a +fixed priority. +</para> +<para> +Example: <literal>priority 5 from 192.167.4.0/24 table 45</literal> +</para></description-docbook></property></setting><setting name="ipv6"> +<property name="addresses" variable="addresses" format="a comma separated list of addresses" values="" default="" example="" description="A list of IPv6 addresses and their prefix length. Multiple addresses can be separated by comma. For example "2001:db8:85a3::8a2e:370:7334/64, 2001:db8:85a3::5/64". The addresses are listed in increasing priority, meaning the last address will be the primary address." /><property name="routes" variable="routes" format="a comma separated list of routes" values="" default="" example="" description=""><description-docbook> +<para> +A list of IPv6 destination addresses, prefix length, optional IPv6 +next hop addresses, optional route metric, optional attribute. The valid syntax is: +"ip[/prefix] [next-hop] [metric] [attribute=val]...[,ip[/prefix]...]". +</para> +<para> +Various attributes are supported: +<itemizedlist> +<listitem> +<para><literal>"cwnd"</literal> - an unsigned 32 bit integer.</para> +</listitem> +<listitem> +<para><literal>"from"</literal> - an IPv6 address with optional prefix. IPv6 only.</para> +</listitem> +<listitem> +<para><literal>"initcwnd"</literal> - an unsigned 32 bit integer.</para> +</listitem> +<listitem> +<para><literal>"initrwnd"</literal> - an unsigned 32 bit integer.</para> +</listitem> +<listitem> +<para><literal>"lock-cwnd"</literal> - a boolean value.</para> +</listitem> +<listitem> +<para><literal>"lock-initcwnd"</literal> - a boolean value.</para> +</listitem> +<listitem> +<para><literal>"lock-initrwnd"</literal> - a boolean value.</para> +</listitem> +<listitem> +<para><literal>"lock-mtu"</literal> - a boolean value.</para> +</listitem> +<listitem> +<para><literal>"lock-window"</literal> - a boolean value.</para> +</listitem> +<listitem> +<para><literal>"mtu"</literal> - an unsigned 32 bit integer.</para> +</listitem> +<listitem> +<para><literal>"onlink"</literal> - a boolean value.</para> +</listitem> +<listitem> +<para><literal>"src"</literal> - an IPv6 address.</para> +</listitem> +<listitem> +<para><literal>"table"</literal> - an unsigned 32 bit integer. The default depends on ipv6.route-table.</para> +</listitem> +<listitem> +<para><literal>"type"</literal> - one of <literal>unicast</literal>, <literal>local</literal>, <literal>blackhole</literal>, +<literal>unavailable</literal>, <literal>prohibit</literal>. The default is <literal>unicast</literal>.</para> +</listitem> +<listitem> +<para><literal>"window"</literal> - an unsigned 32 bit integer.</para> +</listitem> +</itemizedlist> +</para> +<para> +For details see also `man ip-route`. +</para></description-docbook></property><property name="routing-rules" variable="routing-rules" format="a comma separated list of routing rules" values="" default="" example="" description="A comma separated list of routing rules for policy routing."><description-docbook> +<para> +A comma separated list of routing rules for policy routing. The format +is based on <command>ip rule add</command> syntax and mostly compatible. +One difference is that routing rules in NetworkManager always need a +fixed priority. +</para> +<para> +Example: <literal>priority 5 from 1:2:3::5/128 table 45</literal> +</para></description-docbook></property></setting><setting name="macsec"> +</setting><setting name="macvlan"> +</setting><setting name="match"> +</setting><setting name="802-11-olpc-mesh"> +</setting><setting name="ovs-bridge"> +</setting><setting name="ovs-dpdk"> +</setting><setting name="ovs-external-ids"> +</setting><setting name="ovs-interface"> +</setting><setting name="ovs-patch"> +</setting><setting name="ovs-port"> +</setting><setting name="ppp"> +</setting><setting name="pppoe"> +</setting><setting name="proxy"> +</setting><setting name="serial"> +</setting><setting name="sriov"> +</setting><setting name="tc"> +<property name="qdiscs" variable="qdiscs" format="GPtrArray(NMTCQdisc)" values="" default="" example="" description=""><description-docbook> <para> Array of TC queueing disciplines. qdisc is a basic block in the Linux traffic control subsystem @@ -84,9 +184,7 @@ Each qdisc can be specified by the following attributes: </para> <variablelist> <varlistentry> -<term> -<varname>handle HANDLE</varname> -</term> +<term><varname>handle HANDLE</varname></term> <listitem> <para> specifies the qdisc handle. A qdisc, which potentially can have children, gets @@ -97,9 +195,7 @@ explicitly assign a handle to qdiscs expected to have children. </listitem> </varlistentry> <varlistentry> -<term> -<varname>parent HANDLE</varname> -</term> +<term><varname>parent HANDLE</varname></term> <listitem> <para> specifies the handle of the parent qdisc the current qdisc must be @@ -108,9 +204,7 @@ attached to. </listitem> </varlistentry> <varlistentry> -<term> -<varname>root</varname> -</term> +<term><varname>root</varname></term> <listitem> <para> specifies that the qdisc is attached to the root of device. @@ -118,9 +212,7 @@ specifies that the qdisc is attached to the root of device. </listitem> </varlistentry> <varlistentry> -<term> -<varname>KIND</varname> -</term> +<term><varname>KIND</varname></term> <listitem> <para> this is the qdisc kind. NetworkManager currently supports the @@ -137,9 +229,7 @@ Parameters for 'fq_codel': </para> <variablelist> <varlistentry> -<term> -<varname>limit U32</varname> -</term> +<term><varname>limit U32</varname></term> <listitem> <para> the hard limit on the real queue size. When this limit is @@ -148,9 +238,7 @@ reached, incoming packets are dropped. Default is 10240 packets. </listitem> </varlistentry> <varlistentry> -<term> -<varname>memory_limit U32</varname> -</term> +<term><varname>memory_limit U32</varname></term> <listitem> <para> sets a limit on the total number of bytes that can be queued in @@ -161,9 +249,7 @@ limit parameter and the memory limit will be enforced. Default is </listitem> </varlistentry> <varlistentry> -<term> -<varname>flows U32</varname> -</term> +<term><varname>flows U32</varname></term> <listitem> <para> the number of flows into which the incoming packets are @@ -176,9 +262,7 @@ Default value is 1024. </listitem> </varlistentry> <varlistentry> -<term> -<varname>target U32</varname> -</term> +<term><varname>target U32</varname></term> <listitem> <para> the acceptable minimum standing/persistent queue delay. This minimum @@ -188,9 +272,7 @@ experience. The unit of measurement is microsecond(us). Default value is 5ms. </listitem> </varlistentry> <varlistentry> -<term> -<varname>interval U32</varname> -</term> +<term><varname>interval U32</varname></term> <listitem> <para> used to ensure that the measured minimum delay does not become too stale. @@ -202,9 +284,7 @@ react. Default value is 100ms. </listitem> </varlistentry> <varlistentry> -<term> -<varname>quantum U32</varname> -</term> +<term><varname>quantum U32</varname></term> <listitem> <para> the number of bytes used as 'deficit' in the fair queuing @@ -214,9 +294,7 @@ Ethernet MTU plus the hardware header length of 14 bytes. </listitem> </varlistentry> <varlistentry> -<term> -<varname>ecn BOOL</varname> -</term> +<term><varname>ecn BOOL</varname></term> <listitem> <para> can be used to mark packets instead of dropping them. ecn is turned @@ -225,9 +303,7 @@ on by default. </listitem> </varlistentry> <varlistentry> -<term> -<varname>ce_threshold U32</varname> -</term> +<term><varname>ce_threshold U32</varname></term> <listitem> <para> sets a threshold above which all packets are marked with ECN @@ -243,9 +319,7 @@ Parameters for 'sfq': </para> <variablelist> <varlistentry> -<term> -<varname>divisor U32</varname> -</term> +<term><varname>divisor U32</varname></term> <listitem> <para> can be used to set a different hash table size, available @@ -256,9 +330,7 @@ value: 1024. </listitem> </varlistentry> <varlistentry> -<term> -<varname>limit U32</varname> -</term> +<term><varname>limit U32</varname></term> <listitem> <para> Upper limit of the SFQ. Can be used to reduce the default @@ -267,9 +339,7 @@ length of 127 packets. </listitem> </varlistentry> <varlistentry> -<term> -<varname>depth U32</varname> -</term> +<term><varname>depth U32</varname></term> <listitem> <para> Limit of packets per flow. Default to @@ -278,9 +348,7 @@ Limit of packets per flow. Default to </listitem> </varlistentry> <varlistentry> -<term> -<varname>perturb_period U32</varname> -</term> +<term><varname>perturb_period U32</varname></term> <listitem> <para> Interval in seconds for queue algorithm perturbation. @@ -294,9 +362,7 @@ collisions. </listitem> </varlistentry> <varlistentry> -<term> -<varname>quantum U32</varname> -</term> +<term><varname>quantum U32</varname></term> <listitem> <para> Amount of bytes a flow is allowed to dequeue during a @@ -307,9 +373,7 @@ minimum value. </listitem> </varlistentry> <varlistentry> -<term> -<varname>flows U32</varname> -</term> +<term><varname>flows U32</varname></term> <listitem> <para> Default value is 127. @@ -322,9 +386,7 @@ Parameters for 'tbf': </para> <variablelist> <varlistentry> -<term> -<varname>rate U64</varname> -</term> +<term><varname>rate U64</varname></term> <listitem> <para> Bandwidth or rate. These parameters accept a floating @@ -336,9 +398,7 @@ device's speed. </listitem> </varlistentry> <varlistentry> -<term> -<varname>burst U32</varname> -</term> +<term><varname>burst U32</varname></term> <listitem> <para> Also known as buffer or maxburst. Size of the bucket, in @@ -365,9 +425,7 @@ have to set this. Must be an integral power of 2. </listitem> </varlistentry> <varlistentry> -<term> -<varname>limit U32</varname> -</term> +<term><varname>limit U32</varname></term> <listitem> <para> Limit is the number of bytes that can be queued waiting @@ -376,9 +434,7 @@ for tokens to become available. </listitem> </varlistentry> <varlistentry> -<term> -<varname>latency U32</varname> -</term> +<term><varname>latency U32</varname></term> <listitem> <para> specifies the maximum amount of time a packet can @@ -388,11 +444,7 @@ the size of the bucket, the rate and possibly the peakrate </para> </listitem> </varlistentry> -</variablelist> -</description-docbook> -</property> -<property name="tfilters" variable="tfilters" format="GPtrArray(NMTCTfilter)" values="" default="" example="" description=""> -<description-docbook> +</variablelist></description-docbook></property><property name="tfilters" variable="tfilters" format="GPtrArray(NMTCTfilter)" values="" default="" example="" description=""><description-docbook> <para> Array of TC traffic filters. Traffic control can manage the packet content during classification by using filters. @@ -402,9 +454,7 @@ Each tfilters can be specified by the following attributes: </para> <variablelist> <varlistentry> -<term> -<varname>handle HANDLE</varname> -</term> +<term><varname>handle HANDLE</varname></term> <listitem> <para> specifies the tfilters handle. A filter is used by a classful qdisc to determine in which class @@ -414,9 +464,7 @@ see qdiscs handle for detailed information. </listitem> </varlistentry> <varlistentry> -<term> -<varname>parent HANDLE</varname> -</term> +<term><varname>parent HANDLE</varname></term> <listitem> <para> specifies the handle of the parent qdisc the current qdisc must be @@ -425,9 +473,7 @@ attached to. </listitem> </varlistentry> <varlistentry> -<term> -<varname>root</varname> -</term> +<term><varname>root</varname></term> <listitem> <para> specifies that the qdisc is attached to the root of device. @@ -435,9 +481,7 @@ specifies that the qdisc is attached to the root of device. </listitem> </varlistentry> <varlistentry> -<term> -<varname>KIND</varname> -</term> +<term><varname>KIND</varname></term> <listitem> <para> this is the tfilters kind. NetworkManager currently supports @@ -453,9 +497,7 @@ Actions for 'mirred': </para> <variablelist> <varlistentry> -<term> -<varname>egress bool</varname> -</term> +<term><varname>egress bool</varname></term> <listitem> <para> Define whether the packet should exit from the interface. @@ -463,9 +505,7 @@ Define whether the packet should exit from the interface. </listitem> </varlistentry> <varlistentry> -<term> -<varname>ingress bool</varname> -</term> +<term><varname>ingress bool</varname></term> <listitem> <para> Define whether the packet should come into the interface. @@ -473,9 +513,7 @@ Define whether the packet should come into the interface. </listitem> </varlistentry> <varlistentry> -<term> -<varname>mirror bool</varname> -</term> +<term><varname>mirror bool</varname></term> <listitem> <para> Define whether the packet should be copied to the destination space. @@ -483,9 +521,7 @@ Define whether the packet should be copied to the destination space. </listitem> </varlistentry> <varlistentry> -<term> -<varname>redirect bool</varname> -</term> +<term><varname>redirect bool</varname></term> <listitem> <para> Define whether the packet should be moved to the destination space. @@ -498,49 +534,27 @@ Action for 'simple': </para> <variablelist> <varlistentry> -<term> -<varname>sdata char[32]</varname> -</term> +<term><varname>sdata char[32]</varname></term> <listitem> <para> The actual string to print. </para> </listitem> </varlistentry> -</variablelist> -</description-docbook> -</property> -</setting> -<setting name="team-port"> -</setting> -<setting name="team"> -</setting> -<setting name="tun"> -</setting> -<setting name="user"> -</setting> -<setting name="veth"> -</setting> -<setting name="vlan"> -</setting> -<setting name="vpn"> -</setting> -<setting name="vrf"> -</setting> -<setting name="vxlan"> -</setting> -<setting name="wifi-p2p"> -</setting> -<setting name="wimax"> -</setting> -<setting name="802-3-ethernet"> -</setting> -<setting name="wireguard"> -</setting> -<setting name="802-11-wireless-security"> -</setting> -<setting name="802-11-wireless"> -</setting> -<setting name="wpan"> -</setting> -</nm-setting-docs> \ No newline at end of file +</variablelist></description-docbook></property></setting><setting name="team-port"> +</setting><setting name="team"> +</setting><setting name="tun"> +</setting><setting name="user"> +</setting><setting name="veth"> +</setting><setting name="vlan"> +</setting><setting name="vpn"> +</setting><setting name="vrf"> +</setting><setting name="vxlan"> +</setting><setting name="wifi-p2p"> +</setting><setting name="wimax"> +</setting><setting name="802-3-ethernet"> +</setting><setting name="wireguard"> +</setting><setting name="802-11-wireless-security"> +</setting><setting name="802-11-wireless"> +</setting><setting name="wpan"> +</setting></nm-setting-docs> \ No newline at end of file |