about summary refs log tree commit diff
path: root/docs/api/settings-spec.xml
diff options
context:
space:
mode:
authorMichael Biebl <biebl@debian.org>2018-10-20 01:31:18 +0200
committerMichael Biebl <biebl@debian.org>2018-10-20 01:31:18 +0200
commitb4885f208ba690090952c0ae0452dd5bc2ba0601 (patch)
tree5c8af02da4543f7132b9bad45711a3a65e620d0d /docs/api/settings-spec.xml
parent142485af41b7cf7b0060cc682a56d3ff38cabbb6 (diff)
parent6518e361171f64bcaaa4bf868139362ed95cc2e0 (diff)
Update upstream source from tag 'upstream/1.14.2'
Update to upstream version '1.14.2'
with Debian dir c118292f450ace1133a5dba2777cbeb54977dbe8
Diffstat (limited to 'docs/api/settings-spec.xml')
-rw-r--r--docs/api/settings-spec.xml10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/api/settings-spec.xml b/docs/api/settings-spec.xml
index 67c9bebb..e967773a 100644
--- a/docs/api/settings-spec.xml
+++ b/docs/api/settings-spec.xml
@@ -144,14 +144,14 @@
     <row><entry><screen>app-fip-priority<indexterm zone="settings-dcb"><primary sortas="app-fip-priority">app-fip-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The highest User Priority (0 - 7) which FIP frames should use, or -1 for default priority.  Only used when the "app-fip-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row>
     <row><entry><screen>app-iscsi-flags<indexterm zone="settings-dcb"><primary sortas="app-iscsi-flags">app-iscsi-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for the DCB iSCSI application.  Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row>
     <row><entry><screen>app-iscsi-priority<indexterm zone="settings-dcb"><primary sortas="app-iscsi-priority">app-iscsi-priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>The highest User Priority (0 - 7) which iSCSI frames should use, or -1 for default priority. Only used when the "app-iscsi-flags" property includes the NM_SETTING_DCB_FLAG_ENABLE (0x1) flag.</entry></row>
-    <row><entry><screen>priority-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-bandwidth">priority-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen>[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L]</screen></entry><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use.  The sum of all percentages for priorities which belong to the same group must total 100 percents.</entry></row>
+    <row><entry><screen>priority-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-bandwidth">priority-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen>[0, 0, 0, 0, 0, 0, 0, 0]</screen></entry><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the percentage of bandwidth of the priority's assigned group that the priority may use.  The sum of all percentages for priorities which belong to the same group must total 100 percents.</entry></row>
     <row><entry><screen>priority-flow-control<indexterm zone="settings-dcb"><primary sortas="priority-flow-control">priority-flow-control</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen>[False, False, False, False, False, False, False, False]</screen></entry><entry>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the corresponding priority should transmit priority pause.</entry></row>
     <row><entry><screen>priority-flow-control-flags<indexterm zone="settings-dcb"><primary sortas="priority-flow-control-flags">priority-flow-control-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for DCB Priority Flow Control (PFC). Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row>
-    <row><entry><screen>priority-group-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-group-bandwidth">priority-group-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen>[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L]</screen></entry><entry>An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group.  Allowed values are 0 - 100, and the sum of all values must total 100 percents.</entry></row>
+    <row><entry><screen>priority-group-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-group-bandwidth">priority-group-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen>[0, 0, 0, 0, 0, 0, 0, 0]</screen></entry><entry>An array of 8 uint values, where the array index corresponds to the Priority Group ID (0 - 7) and the value indicates the percentage of link bandwidth allocated to that group.  Allowed values are 0 - 100, and the sum of all values must total 100 percents.</entry></row>
     <row><entry><screen>priority-group-flags<indexterm zone="settings-dcb"><primary sortas="priority-group-flags">priority-group-flags</primary></indexterm></screen></entry><entry><screen>NMSettingDcbFlags (uint32)</screen></entry><entry><screen/></entry><entry>Specifies the NMSettingDcbFlags for DCB Priority Groups.  Flags may be any combination of NM_SETTING_DCB_FLAG_ENABLE (0x1), NM_SETTING_DCB_FLAG_ADVERTISE (0x2), and NM_SETTING_DCB_FLAG_WILLING (0x4).</entry></row>
-    <row><entry><screen>priority-group-id<indexterm zone="settings-dcb"><primary sortas="priority-group-id">priority-group-id</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen>[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L]</screen></entry><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID.  Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.</entry></row>
+    <row><entry><screen>priority-group-id<indexterm zone="settings-dcb"><primary sortas="priority-group-id">priority-group-id</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen>[0, 0, 0, 0, 0, 0, 0, 0]</screen></entry><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the Priority Group ID.  Allowed Priority Group ID values are 0 - 7 or 15 for the unrestricted group.</entry></row>
     <row><entry><screen>priority-strict-bandwidth<indexterm zone="settings-dcb"><primary sortas="priority-strict-bandwidth">priority-strict-bandwidth</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen>[False, False, False, False, False, False, False, False]</screen></entry><entry>An array of 8 boolean values, where the array index corresponds to the User Priority (0 - 7) and the value indicates whether or not the priority may use all of the bandwidth allocated to its assigned group.</entry></row>
-    <row><entry><screen>priority-traffic-class<indexterm zone="settings-dcb"><primary sortas="priority-traffic-class">priority-traffic-class</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen>[0L, 0L, 0L, 0L, 0L, 0L, 0L, 0L]</screen></entry><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.</entry></row>
+    <row><entry><screen>priority-traffic-class<indexterm zone="settings-dcb"><primary sortas="priority-traffic-class">priority-traffic-class</primary></indexterm></screen></entry><entry><screen>array of uint32</screen></entry><entry><screen>[0, 0, 0, 0, 0, 0, 0, 0]</screen></entry><entry>An array of 8 uint values, where the array index corresponds to the User Priority (0 - 7) and the value indicates the traffic class (0 - 7) to which the priority is mapped.</entry></row>
   </tbody></tgroup></table></para></refsect1></refentry>
   <refentry id="settings-dummy"><refnamediv><refname>dummy</refname><refpurpose>Dummy Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-dummy.properties">
             Properties
@@ -505,7 +505,7 @@
     <row><entry><screen>channel<indexterm zone="settings-802-11-wireless"><primary sortas="channel">channel</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Wireless channel to use for the Wi-Fi connection.  The device will only join (or create for Ad-Hoc networks) a Wi-Fi network on the specified channel.  Because channel numbers overlap between bands, this property also requires the "band" property to be set.</entry></row>
     <row><entry><screen>cloned-mac-address<indexterm zone="settings-802-11-wireless"><primary sortas="cloned-mac-address">cloned-mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>This D-Bus field is deprecated in favor of "assigned-mac-address" which is more flexible and allows specifying special variants like "random". For libnm and nmcli, this field is called "cloned-mac-address".</entry></row>
     <row><entry><screen>generate-mac-address-mask<indexterm zone="settings-802-11-wireless"><primary sortas="generate-mac-address-mask">generate-mac-address-mask</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>With "cloned-mac-address" setting "random" or "stable", by default all bits of the MAC address are scrambled and a locally-administered, unicast MAC address is created. This property allows to specify that certain bits are fixed. Note that the least significant bit of the first MAC address will always be unset to create a unicast MAC address. If the property is NULL, it is eligible to be overwritten by a default connection setting. If the value is still NULL or an empty string, the default is to create a locally-administered, unicast MAC address. If the value contains one MAC address, this address is used as mask. The set bits of the mask are to be filled with the current MAC address of the device, while the unset bits are subject to randomization. Setting "FE:FF:FF:00:00:00" means to preserve the OUI of the current MAC address and only randomize the lower 3 bytes using the "random" or "stable" algorithm. If the value contains one additional MAC address after the mask, this address is used instead of the current MAC address to fill the bits that shall not be randomized. For example, a value of "FE:FF:FF:00:00:00 68:F7:28:00:00:00" will set the OUI of the MAC address to 68:F7:28, while the lower bits are randomized. A value of "02:00:00:00:00:00 00:00:00:00:00:00" will create a fully scrambled globally-administered, burned-in MAC address. If the value contains more than one additional MAC addresses, one of them is chosen randomly. For example, "02:00:00:00:00:00 00:00:00:00:00:00 02:00:00:00:00:00" will create a fully scrambled MAC address, randomly locally or globally administered.</entry></row>
-    <row><entry><screen>hidden<indexterm zone="settings-802-11-wireless"><primary sortas="hidden">hidden</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, indicates this network is a non-broadcasting network that hides its SSID.  In this case various workarounds may take place, such as probe-scanning the SSID for more reliable network discovery.  However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. Note that marking the network as hidden may be a privacy issue for you, as the explicit probe-scans may be distinctly recognizable on the air.</entry></row>
+    <row><entry><screen>hidden<indexterm zone="settings-802-11-wireless"><primary sortas="hidden">hidden</primary></indexterm></screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>If TRUE, indicates that the network is a non-broadcasting network that hides its SSID. This works both in infrastructure and AP mode. In infrastructure mode, various workarounds are used for a more reliable discovery of hidden networks, such as probe-scanning the SSID.  However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution. In AP mode, the created network does not broadcast its SSID. Note that marking the network as hidden may be a privacy issue for you (in infrastructure mode) or client stations (in AP mode), as the explicit probe-scans are distinctly recognizable on the air.</entry></row>
     <row><entry><screen>mac-address<indexterm zone="settings-802-11-wireless"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>byte array</screen></entry><entry><screen/></entry><entry>If specified, this connection will only apply to the Wi-Fi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry></row>
     <row><entry><screen>mac-address-blacklist<indexterm zone="settings-802-11-wireless"><primary sortas="mac-address-blacklist">mac-address-blacklist</primary></indexterm></screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>A list of permanent MAC addresses of Wi-Fi devices to which this connection should never apply.  Each MAC address should be given in the standard hex-digits-and-colons notation (eg "00:11:22:33:44:55").</entry></row>
     <row><entry><screen>mac-address-randomization<indexterm zone="settings-802-11-wireless"><primary sortas="mac-address-randomization">mac-address-randomization</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>One of NM_SETTING_MAC_RANDOMIZATION_DEFAULT (0) (never randomize unless the user has set a global default to randomize and the supplicant supports randomization),  NM_SETTING_MAC_RANDOMIZATION_NEVER (1) (never randomize the MAC address), or NM_SETTING_MAC_RANDOMIZATION_ALWAYS (2) (always randomize the MAC address). This property is deprecated for 'cloned-mac-address'. Deprecated: 1</entry></row>