diff options
Diffstat (limited to 'docs/api/settings-spec.xml')
| -rw-r--r-- | docs/api/settings-spec.xml | 11 |
1 files changed, 7 insertions, 4 deletions
diff --git a/docs/api/settings-spec.xml b/docs/api/settings-spec.xml index 70b885b4..31fb3102 100644 --- a/docs/api/settings-spec.xml +++ b/docs/api/settings-spec.xml @@ -148,11 +148,12 @@ <para><table><title>ipv4 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>address-data</screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>Array of IPv4 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.</entry></row> <row><entry><screen>addresses</screen></entry><entry><screen>array of array of uint32</screen></entry><entry><screen>[]</screen></entry><entry>Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. 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.</entry></row> + <row><entry><screen>dad-timeout</screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or 3 seconds). A value greater than zero is a timeout in milliseconds.</entry></row> <row><entry><screen>dhcp-client-id</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options.</entry></row> <row><entry><screen>dhcp-fqdn</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If the "dhcp-send-hostname" property is TRUE, then the specified FQDN will be sent to the DHCP server when acquiring a lease. This property and "dhcp-hostname" are mutually exclusive and cannot be set at the same time.</entry></row> <row><entry><screen>dhcp-hostname</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row> <row><entry><screen>dhcp-send-hostname</screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</entry></row> - <row><entry><screen>dhcp-timeout</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>A timeout for a DHCP transaction in seconds.</entry></row> + <row><entry><screen>dhcp-timeout</screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>A timeout for a DHCP transaction in seconds.</entry></row> <row><entry><screen>dns</screen></entry><entry><screen>array of uint32</screen></entry><entry><screen>[]</screen></entry><entry>Array of IP addresses of DNS servers (as network-byte-order integers)</entry></row> <row><entry><screen>dns-options</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>Array of DNS options. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.</entry></row> <row><entry><screen>dns-search</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>Array of DNS search domains.</entry></row> @@ -171,8 +172,10 @@ <row><entry><screen>addr-gen-mode</screen></entry><entry><screen>int32</screen></entry><entry><screen>1</screen></entry><entry>Configure method for creating the address for use with RFC4862 IPv6 Stateless Address Autoconfiguration. The permitted values are: "eui64", "stable-privacy" or unset. If the property is set to "eui64", the addresses will be generated using the interface tokens derived from hardware address. This makes the host part of the address to stay constant, making it possible to track host's presence when it changes networks. The address changes when the interface hardware is replaced. The value of "stable-privacy" enables use of cryptographically secure hash of a secret host-specific key along with the connection identification and the network address as specified by RFC7217. This makes it impossible to use the address track host's presence, and makes the address stable when the network interface hardware is replaced. Leaving this unset causes a default that could be subject to change in future versions to be used. Note that this setting is distinct from the Privacy Extensions as configured by "ip6-privacy" property and it does not affect the temporary addresses configured with this option.</entry></row> <row><entry><screen>address-data</screen></entry><entry><screen>array of vardict</screen></entry><entry><screen/></entry><entry>Array of IPv6 addresses. Each address dictionary contains at least 'address' and 'prefix' entries, containing the IP address as a string, and the prefix length as a uint32. Additional attributes may also exist on some addresses.</entry></row> <row><entry><screen>addresses</screen></entry><entry><screen>array of legacy IPv6 address struct (a(ayuay))</screen></entry><entry><screen>[]</screen></entry><entry>Deprecated in favor of the 'address-data' and 'gateway' properties, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'address-data' and 'gateway'. Array of IPv6 address structures. Each IPv6 address structure is composed of an IPv6 address, a prefix length (1 - 128), and an IPv6 gateway address. The gateway may be zeroed out if no gateway exists for that subnet.</entry></row> + <row><entry><screen>dad-timeout</screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry>Timeout in milliseconds used to check for the presence of duplicate IP addresses on the network. If an address conflict is detected, the activation will fail. A zero value means that no duplicate address detection is performed, -1 means the default value (either configuration ipvx.dad-timeout override or 3 seconds). A value greater than zero is a timeout in milliseconds.</entry></row> <row><entry><screen>dhcp-hostname</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. This property and "dhcp-fqdn" are mutually exclusive and cannot be set at the same time.</entry></row> <row><entry><screen>dhcp-send-hostname</screen></entry><entry><screen>boolean</screen></entry><entry><screen>TRUE</screen></entry><entry>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the "dhcp-hostname" property is NULL and this property is TRUE, the current persistent hostname of the computer is sent.</entry></row> + <row><entry><screen>dhcp-timeout</screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry>A timeout for a DHCP transaction in seconds.</entry></row> <row><entry><screen>dns</screen></entry><entry><screen>array of byte array</screen></entry><entry><screen>[]</screen></entry><entry>Array of IP addresses of DNS servers (in network byte order)</entry></row> <row><entry><screen>dns-options</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>Array of DNS options. NULL means that the options are unset and left at the default. In this case NetworkManager will use default options. This is distinct from an empty list of properties.</entry></row> <row><entry><screen>dns-search</screen></entry><entry><screen>array of string</screen></entry><entry><screen>[]</screen></entry><entry>Array of DNS search domains.</entry></row> @@ -273,7 +276,7 @@ <para><table><title>vlan 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>egress-priority-map</screen></entry><entry><screen>array of string</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> <row><entry><screen>flags</screen></entry><entry><screen>NMVlanFlags (uint32)</screen></entry><entry><screen/></entry><entry>One or more flags which control the behavior and features of the VLAN interface. Flags include NM_VLAN_FLAG_REORDER_HEADERS (0x1) (reordering of output packet headers), NM_VLAN_FLAG_GVRP (0x2) (use of the GVRP protocol), and NM_VLAN_FLAG_LOOSE_BINDING (0x4) (loose binding of the interface to its master device's operating state). NM_VLAN_FLAG_MVRP (0x8) (use of the MVRP protocol). The default value of this property is NM_VLAN_FLAG_REORDER_HEADERS, but it used to be 0. To preserve backward compatibility, the default-value in the D-Bus API continues to be 0 and a missing property on D-Bus is still considered as 0.</entry></row> - <row><entry><screen>id</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The VLAN identifier that the interface created by this connection should be assigned.</entry></row> + <row><entry><screen>id</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>The VLAN identifier that the interface created by this connection should be assigned. The valid range is from 0 to 4094, without the reserved id 4095.</entry></row> <row><entry><screen>ingress-priority-map</screen></entry><entry><screen>array of string</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>interface-name</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Deprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name.</entry></row> <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>vlan</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> @@ -289,7 +292,7 @@ <row><entry><screen>user-name</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.</entry></row> </tbody></tgroup></table></para> <para><table><title>vxlan 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>ageing</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Specifies the lifetime in seconds of FDB entries learnt by the kernel.</entry></row> + <row><entry><screen>ageing</screen></entry><entry><screen>uint32</screen></entry><entry><screen>300</screen></entry><entry>Specifies the lifetime in seconds of FDB entries learnt by the kernel.</entry></row> <row><entry><screen>destination-port</screen></entry><entry><screen>uint32</screen></entry><entry><screen>8472</screen></entry><entry>Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.</entry></row> <row><entry><screen>id</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>Specifies the VXLAN Network Identifer (or VXLAN Segment Identifier) to use.</entry></row> <row><entry><screen>l2-miss</screen></entry><entry><screen>boolean</screen></entry><entry><screen>FALSE</screen></entry><entry>Specifies whether netlink LL ADDR miss notifications are generated.</entry></row> @@ -340,7 +343,7 @@ <row><entry><screen>mode</screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry>Wi-Fi network mode; one of "infrastructure", "adhoc" or "ap". If blank, infrastructure is assumed.</entry></row> <row><entry><screen>mtu</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry></row> <row><entry><screen>name</screen></entry><entry><screen>string</screen></entry><entry><screen>802-11-wireless</screen></entry><entry>The setting's name, which uniquely identifies the setting within the connection. Each setting type has a name unique to that type, for example "ppp" or "wireless" or "wired".</entry></row> - <row><entry><screen>powersave</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If set to FALSE, Wi-Fi power saving behavior is disabled. If set to TRUE, Wi-Fi power saving behavior is enabled. All other values are reserved. Note that even though only boolean values are allowed, the property type is an unsigned integer to allow for future expansion.</entry></row> + <row><entry><screen>powersave</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>One of NM_SETTING_WIRELESS_POWERSAVE_DISABLE (2) (disable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_ENABLE (3) (enable Wi-Fi power saving), NM_SETTING_WIRELESS_POWERSAVE_IGNORE (1) (don't touch currently configure setting) or NM_SETTING_WIRELESS_POWERSAVE_DEFAULT (0) (use the globally configured value). All other values are reserved.</entry></row> <row><entry><screen>rate</screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry>If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</entry></row> <row><entry><screen>security</screen></entry><entry><screen>None</screen></entry><entry><screen/></entry><entry>This property is deprecated, but can be set to the value '802-11-wireless-security' when a wireless security setting is also present in the connection dictionary, for compatibility with very old NetworkManager daemons.</entry></row> <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 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> |