diff options
Diffstat (limited to 'docs/api/settings-spec.xml')
| -rw-r--r-- | docs/api/settings-spec.xml | 305 |
1 files changed, 256 insertions, 49 deletions
diff --git a/docs/api/settings-spec.xml b/docs/api/settings-spec.xml index c7b88b4e..a0c54945 100644 --- a/docs/api/settings-spec.xml +++ b/docs/api/settings-spec.xml @@ -25,8 +25,8 @@ <row> <entry><screen>eap</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> - <entry>The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: 'leap', 'md5', 'tls', 'peap', 'ttls', and 'fast'. Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.</entry> + <entry><screen></screen></entry> + <entry>The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: 'leap', 'md5', 'tls', 'peap', 'ttls', 'pwd', and 'fast'. Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.</entry> </row> <row> <entry><screen>identity</screen></entry> @@ -67,7 +67,7 @@ <row> <entry><screen>altsubject-matches</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</entry> </row> <row> @@ -127,7 +127,7 @@ <row> <entry><screen>phase2-altsubject-matches</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>List of strings to be matched against 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> @@ -340,7 +340,7 @@ <row> <entry><screen>options</screen></entry> <entry><screen>dict of (string::string)</screen></entry> - <entry><screen>[ ]</screen></entry> + <entry><screen></screen></entry> <entry>Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</entry> </row> </tbody> @@ -371,6 +371,12 @@ <entry>The name of the virtual in-kernel bridging network interface</entry> </row> <row> + <entry><screen>mac-address</screen></entry> + <entry><screen>byte array</screen></entry> + <entry><screen>[]</screen></entry> + <entry>The MAC address of the bridge</entry> + </row> + <row> <entry><screen>stp</screen></entry> <entry><screen>boolean</screen></entry> <entry><screen>TRUE</screen></entry> @@ -404,7 +410,7 @@ <entry><screen>ageing-time</screen></entry> <entry><screen>uint32</screen></entry> <entry><screen>300</screen></entry> - <entry>The ethernet MAC address aging time, in seconds.</entry> + <entry>The Ethernet MAC address aging time, in seconds.</entry> </row> </tbody> </tgroup> @@ -521,7 +527,13 @@ <entry><screen>uuid</screen></entry> <entry><screen>string</screen></entry> <entry><screen></screen></entry> - <entry>Universally unique connection identifier. Must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' (ie, contains only hexadecimal characters and '-'). The UUID should be assigned when the connection is created and never changed as long as the connection still applies to the same network. For example, it should not be changed when the user changes the connection's 'id', but should be recreated when the WiFi SSID, mobile broadband network provider, or the connection type changes.</entry> + <entry>Universally unique connection identifier. Must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' (ie, contains only hexadecimal characters and '-'). The UUID should be assigned when the connection is created and never changed as long as the connection still applies to the same network. For example, it should not be changed when the user changes the connection's 'id', but should be recreated when the Wi-Fi SSID, mobile broadband network provider, or the connection type changes.</entry> + </row> + <row> + <entry><screen>interface-name</screen></entry> + <entry><screen>string</screen></entry> + <entry><screen></screen></entry> + <entry>Interface name this connection is bound to. If not set, then the connection can be attached to any interface of the appropriate type (subject to restrictions imposed by other settings). For connection types where interface names cannot easily be made persistent (e.g. mobile broadband or USB Ethernet), this property should not be used. Setting this property restricts the interfaces a connection can be used with, and if interface names change or are reordered the connection may be applied to the wrong interface.</entry> </row> <row> <entry><screen>type</screen></entry> @@ -532,7 +544,7 @@ <row> <entry><screen>permissions</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection. Otherwise a user is allowed to access this connection if and only if they are in this array. Each entry is of the form "[type]:[id]:[reserved]", for example: "user:dcbw:blah" At this time only the 'user' [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ':' character. Any [reserved] information (if present) must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</entry> </row> <row> @@ -545,7 +557,7 @@ <entry><screen>timestamp</screen></entry> <entry><screen>uint64</screen></entry> <entry><screen>0</screen></entry> - <entry>Timestamp (in seconds since the Unix Epoch) that the connection was last successfully activated. Settings services should update the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp.</entry> + <entry>Timestamp (in seconds since the Unix Epoch) that the connection was last successfully activated. NetworkManager updates the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp. The property is only meant for reading (changes to this property will not be preserved).</entry> </row> <row> <entry><screen>read-only</screen></entry> @@ -574,8 +586,125 @@ <row> <entry><screen>secondaries</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> - <entry>List of connection UUIDs that should be activated when the base connection itself is activated.</entry> + <entry><screen></screen></entry> + <entry>List of connection UUIDs that should be activated when the base connection itself is activated. Currently only VPN connections are supported.</entry> + </row> + <row> + <entry><screen>gateway-ping-timeout</screen></entry> + <entry><screen>uint32</screen></entry> + <entry><screen>0</screen></entry> + <entry>If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping.</entry> + </row> + </tbody> + </tgroup> +</table> +<table> + <title>dcb setting</title> + <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><screen>name</screen></entry> + <entry><screen>string</screen></entry> + <entry><screen>dcb</screen></entry> + <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> + </row> + <row> + <entry><screen>app-fcoe-flags</screen></entry> + <entry><screen>uint32</screen></entry> + <entry><screen>0</screen></entry> + <entry>Specifies the flags for the DCB FCoE application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <xref linkend="secrets-flags"/> for flag values)</entry> + </row> + <row> + <entry><screen>app-fcoe-priority</screen></entry> + <entry><screen>int32</screen></entry> + <entry><screen>-1</screen></entry> + <entry>The highest User Priority (0 - 7) which FCoE frames should use, or -1 for default priority. Only used when the 'app-fcoe-flags' property includes the 'enabled' flag.</entry> + </row> + <row> + <entry><screen>app-fcoe-mode</screen></entry> + <entry><screen>string</screen></entry> + <entry><screen>"fabric"</screen></entry> + <entry>The FCoe controller mode; either 'fabric' (default) or 'vn2vn'.</entry> + </row> + <row> + <entry><screen>app-iscsi-flags</screen></entry> + <entry><screen>uint32</screen></entry> + <entry><screen>0</screen></entry> + <entry>Specifies the flags for the DCB iSCSI application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <xref linkend="secrets-flags"/> for flag values)</entry> + </row> + <row> + <entry><screen>app-iscsi-priority</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 'enabled' flag.</entry> + </row> + <row> + <entry><screen>app-fip-flags</screen></entry> + <entry><screen>uint32</screen></entry> + <entry><screen>0</screen></entry> + <entry>Specifies the flags for the DCB FIP application. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <xref linkend="secrets-flags"/> for flag values)</entry> + </row> + <row> + <entry><screen>app-fip-priority</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 'enabled' flag.</entry> + </row> + <row> + <entry><screen>priority-flow-control-flags</screen></entry> + <entry><screen>uint32</screen></entry> + <entry><screen>0</screen></entry> + <entry>Specifies the flags for DCB Priority Flow Control. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <xref linkend="secrets-flags"/> for flag values)</entry> + </row> + <row> + <entry><screen>priority-flow-control</screen></entry> + <entry><screen>array of uint32</screen></entry> + <entry><screen></screen></entry> + <entry>An array of 8 uint 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. Allowed values are 0 (do not transmit pause) and 1 (transmit pause).</entry> + </row> + <row> + <entry><screen>priority-group-flags</screen></entry> + <entry><screen>uint32</screen></entry> + <entry><screen>0</screen></entry> + <entry>Specifies the flags for DCB Priority Groups. Flags may be any combination of 0x1 (enable), 0x2 (advertise), and 0x4 (willing). (see <xref linkend="secrets-flags"/> for flag values)</entry> + </row> + <row> + <entry><screen>priority-group-id</screen></entry> + <entry><screen>array of uint32</screen></entry> + <entry><screen></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-bandwidth</screen></entry> + <entry><screen>array of uint32</screen></entry> + <entry><screen></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 percent.</entry> + </row> + <row> + <entry><screen>priority-bandwidth</screen></entry> + <entry><screen>array of uint32</screen></entry> + <entry><screen></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 percent.</entry> + </row> + <row> + <entry><screen>priority-strict-bandwidth</screen></entry> + <entry><screen>array of uint32</screen></entry> + <entry><screen></screen></entry> + <entry>An array of 8 uint 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. Allowed values are 0 (the priority may not utilize all bandwidth) or 1 (the priority may utilize all bandwidth).</entry> + </row> + <row> + <entry><screen>priority-traffic-class</screen></entry> + <entry><screen>array of uint32</screen></entry> + <entry><screen></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> @@ -638,7 +767,7 @@ <entry><screen>network-type</screen></entry> <entry><screen>int32</screen></entry> <entry><screen>-1</screen></entry> - <entry>Network preference to force the device to only use specific network technologies. The permitted values are: -1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, 3: prefer 2G, 4: prefer 4G/LTE, 5: 4G/LTE only. Note that not all devices allow network preference control.</entry> + <entry>Network preference to force the device to only use specific network technologies. The permitted values are: -1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, 3: prefer 2G, 4: prefer 4G/LTE, 5: 4G/LTE only. Notes: This property is deprecated and NetworkManager from 0.9.10 onwards doesn't use this property when talking to ModemManager.Also, not all devices allow network preference control.</entry> </row> <row> <entry><screen>pin</screen></entry> @@ -656,7 +785,7 @@ <entry><screen>allowed-bands</screen></entry> <entry><screen>uint32</screen></entry> <entry><screen>1</screen></entry> - <entry>Bitfield of allowed frequency bands. Note that not all devices allow frequency band control.</entry> + <entry>Bitfield of allowed frequency bands.Notes: This property is deprecated and NetworkManager from 0.9.10 onwards doesn't use this property when talking to ModemManager.Also, not all devices allow frequency band control.</entry> </row> <row> <entry><screen>home-only</screen></entry> @@ -703,6 +832,18 @@ <entry><screen></screen></entry> <entry>The IPoIB transport mode. Either 'datagram' or 'connected'.</entry> </row> + <row> + <entry><screen>p-key</screen></entry> + <entry><screen>int32</screen></entry> + <entry><screen>-1</screen></entry> + <entry>The InfiniBand P_Key. Either -1 for the default, or a 16-bit unsigned integer.</entry> + </row> + <row> + <entry><screen>parent</screen></entry> + <entry><screen>string</screen></entry> + <entry><screen></screen></entry> + <entry>The interface name of the parent device, or NULL</entry> + </row> </tbody> </tgroup> </table> @@ -733,25 +874,31 @@ <row> <entry><screen>dns</screen></entry> <entry><screen>array of uint32</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>List of DNS servers (network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</entry> </row> <row> <entry><screen>dns-search</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.</entry> </row> <row> <entry><screen>addresses</screen></entry> <entry><screen>array of array of uint32</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared', 'link-local', or 'disabled' methods as addressing is either automatic or disabled with these methods.</entry> </row> <row> + <entry><screen>address-labels</screen></entry> + <entry><screen>array of string</screen></entry> + <entry><screen></screen></entry> + <entry>Internal use only</entry> + </row> + <row> <entry><screen>routes</screen></entry> <entry><screen>array of array of uint32</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared', 'link-local', or 'disabled', methods as there is no upstream network.</entry> </row> <row> @@ -821,7 +968,7 @@ <entry><screen>method</screen></entry> <entry><screen>string</screen></entry> <entry><screen></screen></entry> - <entry>IPv6 configuration method. If 'auto' is specified then the appropriate automatic method (PPP, router advertisement, etc) is used for the device and most other properties can be left unset. To force the use of DHCP only, specify 'dhcp'; this method is only valid for ethernet-based hardware. If 'link-local' is specified, then an IPv6 link-local address will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'ignore' is specified, IPv6 configuration is not done. This property must be set. NOTE: the 'shared' methodis not yet supported.</entry> + <entry>IPv6 configuration method. If 'auto' is specified then the appropriate automatic method (PPP, router advertisement, etc) is used for the device and most other properties can be left unset. To force the use of DHCP only, specify 'dhcp'; this method is only valid for Ethernet-based hardware. If 'link-local' is specified, then an IPv6 link-local address will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'ignore' is specified, IPv6 configuration is not done. This property must be set. Note: the 'shared' method is not yet supported.</entry> </row> <row> <entry><screen>dhcp-hostname</screen></entry> @@ -832,25 +979,25 @@ <row> <entry><screen>dns</screen></entry> <entry><screen>array of byte array</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>Array of DNS servers, where each member of the array is a byte array containing the IPv6 address of the DNS server (in network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared' or 'link-local' methods as there is no usptream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</entry> </row> <row> <entry><screen>dns-search</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared' or 'link-local' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.</entry> </row> <row> <entry><screen>addresses</screen></entry> <entry><screen>array of (byte array, uint32, byte array)</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>Array of IPv6 address structures. Each IPv6 address structure is composed of 3 members, the first being a byte array containing the IPv6 address (network byte order), the second a 32-bit integer containing the IPv6 address prefix, and the third a byte array containing the IPv6 address (network byte order) of the gateway associated with this address, if any. If no gateway is given, the third element should be given as all zeros. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared' or 'link-local' methods as the interface is automatically assigned an address with these methods.</entry> </row> <row> <entry><screen>routes</screen></entry> <entry><screen>array of (byte array, uint32, byte array, uint32)</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>Array of IPv6 route structures. Each IPv6 route structure is composed of 4 members; the first being the destination IPv6 network or address (network byte order) as a byte array, the second the destination network or address IPv6 prefix, the third being the next-hop IPv6 address (network byte order) if any, and the fourth being the route metric. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared' or 'link-local' methods because there is no upstream network.</entry> </row> <row> @@ -1076,7 +1223,7 @@ <entry><screen>service</screen></entry> <entry><screen>string</screen></entry> <entry><screen></screen></entry> - <entry>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified serivce. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</entry> + <entry>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified service. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</entry> </row> <row> <entry><screen>username</screen></entry> @@ -1151,6 +1298,66 @@ </tgroup> </table> <table> + <title>team setting</title> + <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><screen>name</screen></entry> + <entry><screen>string</screen></entry> + <entry><screen>team</screen></entry> + <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> + </row> + <row> + <entry><screen>interface-name</screen></entry> + <entry><screen>string</screen></entry> + <entry><screen></screen></entry> + <entry>The name of the virtual in-kernel team network interface</entry> + </row> + <row> + <entry><screen>config</screen></entry> + <entry><screen>string</screen></entry> + <entry><screen></screen></entry> + <entry>JSON configuration for the team network interface. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the default configuration is used. See man teamd.conf for the format details.</entry> + </row> + </tbody> + </tgroup> +</table> +<table> + <title>team-port setting</title> + <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><screen>name</screen></entry> + <entry><screen>string</screen></entry> + <entry><screen>team-port</screen></entry> + <entry>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</entry> + </row> + <row> + <entry><screen>config</screen></entry> + <entry><screen>string</screen></entry> + <entry><screen></screen></entry> + <entry>JSON configuration for the team port. The property should contain raw JSON configuration data suitable for teamd, because the value is passed directly to teamd. If not specified, the dafault configuration is used. See man teamd.conf for the format details.</entry> + </row> + </tbody> + </tgroup> +</table> +<table> <title>vlan setting</title> <tgroup cols="4"> <thead> @@ -1172,13 +1379,13 @@ <entry><screen>interface-name</screen></entry> <entry><screen>string</screen></entry> <entry><screen></screen></entry> - <entry>If given, specifies the kernel name of the VLAN interface. If not given, a default name will be constructed from the interface described by the parent interface and the 'id' property, ex 'eth2.1'. The parent interface may be given by the 'parent' property or by a hardware address property, eg the 'wired' settings' 'mac-address' property.</entry> + <entry>If given, specifies the kernel name of the VLAN interface. If not given, a default name will be constructed from the interface described by the parent interface and the 'id' property, ex 'eth2.1'. The parent interface may be given by the 'parent' property or by the 'mac-address' property of a 'wired' setting.</entry> </row> <row> <entry><screen>parent</screen></entry> <entry><screen>string</screen></entry> <entry><screen></screen></entry> - <entry>If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain a hardware address in a hardware-specific setting, like the 'wired' settings' 'mac-address' property.</entry> + <entry>If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain a 'wired' setting with a 'mac-address' property.</entry> </row> <row> <entry><screen>id</screen></entry> @@ -1195,13 +1402,13 @@ <row> <entry><screen>ingress-priority-map</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format 'from:to' where both 'from' and 'to' are unsigned integers, ie '7:3'.</entry> </row> <row> <entry><screen>egress-priority-map</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format 'from:to' where both 'from' and 'to' are unsigned integers, ie '7:3'.</entry> </row> </tbody> @@ -1240,13 +1447,13 @@ <row> <entry><screen>data</screen></entry> <entry><screen>dict of (string::string)</screen></entry> - <entry><screen>[ ]</screen></entry> + <entry><screen></screen></entry> <entry>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</entry> </row> <row> <entry><screen>secrets</screen></entry> <entry><screen>dict of (string::string)</screen></entry> - <entry><screen>[ ]</screen></entry> + <entry><screen></screen></entry> <entry>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</entry> </row> </tbody> @@ -1331,7 +1538,7 @@ <entry><screen>mac-address</screen></entry> <entry><screen>byte array</screen></entry> <entry><screen>[]</screen></entry> - <entry>If specified, this connection will only apply to the ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry> + <entry>If specified, this connection will only apply to the Ethernet 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>cloned-mac-address</screen></entry> @@ -1342,8 +1549,8 @@ <row> <entry><screen>mac-address-blacklist</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> - <entry>If specified, this connection will never apply to the ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</entry> + <entry><screen></screen></entry> + <entry>If specified, this connection will never apply to the Ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</entry> </row> <row> <entry><screen>mtu</screen></entry> @@ -1354,7 +1561,7 @@ <row> <entry><screen>s390-subchannels</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>Identifies specific subchannels that this network device uses for communcation with z/VM or s390 host. Like the 'mac-address' property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</entry> </row> <row> @@ -1366,7 +1573,7 @@ <row> <entry><screen>s390-options</screen></entry> <entry><screen>dict of (string::string)</screen></entry> - <entry><screen>[ ]</screen></entry> + <entry><screen></screen></entry> <entry>Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include 'portno', 'layer2', 'portname', 'protocol', among others.</entry> </row> </tbody> @@ -1394,25 +1601,25 @@ <entry><screen>ssid</screen></entry> <entry><screen>byte array</screen></entry> <entry><screen>[]</screen></entry> - <entry>SSID of the WiFi network. Must be specified.</entry> + <entry>SSID of the Wi-Fi network. Must be specified.</entry> </row> <row> <entry><screen>mode</screen></entry> <entry><screen>string</screen></entry> <entry><screen></screen></entry> - <entry>WiFi network mode; one of 'infrastructure', 'adhoc' or 'ap'. If blank, infrastructure is assumed.</entry> + <entry>Wi-Fi network mode; one of 'infrastructure', 'adhoc' or 'ap'. If blank, infrastructure is assumed.</entry> </row> <row> <entry><screen>band</screen></entry> <entry><screen>string</screen></entry> <entry><screen></screen></entry> - <entry>802.11 frequency band of the network. One of 'a' for 5GHz 802.11a or 'bg' for 2.4GHz 802.11. This will lock associations to the WiFi network to the specific band, i.e. if 'a' is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</entry> + <entry>802.11 frequency band of the network. One of 'a' for 5GHz 802.11a or 'bg' for 2.4GHz 802.11. This will lock associations to the Wi-Fi network to the specific band, i.e. if 'a' is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</entry> </row> <row> <entry><screen>channel</screen></entry> <entry><screen>uint32</screen></entry> <entry><screen>0</screen></entry> - <entry>Wireless channel to use for the WiFi connection. The device will only join (or create for Ad-Hoc networks) a WiFi network on the specified channel. Because channel numbers overlap between bands, this property also requires the 'band' property to be set.</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>bssid</screen></entry> @@ -1436,18 +1643,18 @@ <entry><screen>mac-address</screen></entry> <entry><screen>byte array</screen></entry> <entry><screen>[]</screen></entry> - <entry>If specified, this connection will only apply to the WiFi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</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>cloned-mac-address</screen></entry> <entry><screen>byte array</screen></entry> <entry><screen>[]</screen></entry> - <entry>If specified, request that the WiFi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</entry> + <entry>If specified, request that the Wi-Fi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</entry> </row> <row> <entry><screen>mac-address-blacklist</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</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> @@ -1459,8 +1666,8 @@ <row> <entry><screen>seen-bssids</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> - <entry>A list of BSSIDs (each BSSID formatted as a MAC address like 00:11:22:33:44:55') that have been detected as part of the WiFI network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BBSID list of NetworkManager. The changes you make to this property will not be preserved.</entry> + <entry><screen></screen></entry> + <entry>A list of BSSIDs (each BSSID formatted as a MAC address like 00:11:22:33:44:55') that have been detected as part of the Wi-Fi network. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BSSID list of NetworkManager. The changes you make to this property will not be preserved.</entry> </row> <row> <entry><screen>security</screen></entry> @@ -1499,7 +1706,7 @@ <entry><screen>key-mgmt</screen></entry> <entry><screen>string</screen></entry> <entry><screen></screen></entry> - <entry>Key management used for the connection. One of 'none' (WEP), 'ieee8021x' (Dynamic WEP), 'wpa-none' (WPA-PSK Ad-Hoc), 'wpa-psk' (infrastructure WPA-PSK), or 'wpa-eap' (WPA-Enterprise). This property must be set for any WiFi connection that uses security.</entry> + <entry>Key management used for the connection. One of 'none' (WEP), 'ieee8021x' (Dynamic WEP), 'wpa-none' (WPA-PSK Ad-Hoc), 'wpa-psk' (infrastructure WPA-PSK), or 'wpa-eap' (WPA-Enterprise). This property must be set for any Wi-Fi connection that uses security.</entry> </row> <row> <entry><screen>wep-tx-keyidx</screen></entry> @@ -1516,19 +1723,19 @@ <row> <entry><screen>proto</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <entry>List of strings specifying the allowed WPA protocol versions to use. Each element may be one 'wpa' (allow WPA) or 'rsn' (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.</entry> </row> <row> <entry><screen>pairwise</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> - <entry>A list of pairwise 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> + <entry><screen></screen></entry> + <entry>A list of pairwise 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 'tkip' or 'ccmp'.</entry> </row> <row> <entry><screen>group</screen></entry> <entry><screen>array of string</screen></entry> - <entry><screen>[]</screen></entry> + <entry><screen></screen></entry> <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> @@ -1577,7 +1784,7 @@ <entry><screen>psk</screen></entry> <entry><screen>string</screen></entry> <entry><screen></screen></entry> - <entry>Pre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the WiFi network.</entry> + <entry>Pre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the Wi-Fi network.</entry> </row> <row> <entry><screen>psk-flags</screen></entry> |