Version 1.0.10 +

Version 1.1.90

diff --git a/docs/api/html/ref-migrating.html b/docs/api/html/ref-migrating.html index 34f90ebb..6527f738 100644 --- a/docs/api/html/ref-migrating.html +++ b/docs/api/html/ref-migrating.html @@ -256,7 +256,7 @@ are now string-based permissions. The mapping is as follows:

Table 27.

Table 31.

@@ -424,7 +424,7 @@ following values:

Table 28.

Table 32.

@@ -496,7 +496,7 @@ their replacements:

Table 29.

Table 33.

diff --git a/docs/api/html/ref-settings.html b/docs/api/html/ref-settings.html index 24add750..e3b8a8de 100644 --- a/docs/api/html/ref-settings.html +++ b/docs/api/html/ref-settings.html @@ -30,7 +30,7 @@ This part documents the properties and value types of each "Setting" object that composes the basic unit of NetworkManager configuration, the "Connection". Each Connection object is simply a dictionary mapping - setting names (like "wimax" or "bluetooth") to a dictionary of + setting names (like "802-3-ethernet" or "bluetooth") to a dictionary of key/value pairs that represents each itself.

@@ -451,6 +451,12 @@

+ + + + + + @@ -619,6 +625,12 @@ + + + + + + @@ -628,7 +640,7 @@ - + @@ -682,7 +694,7 @@ - +

The Spanning Tree Protocol (STP) maximum message age, in seconds.
multicast-snooping	boolean	TRUE	Controls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved.
name	string	bridge	The name of the network interface 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 software devices this specifies the name of the created device. 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.
lldp	int32	-1	Whether LLDP is enabled for the connection.
master	string		metered	NMMetered (int32)		Whether the connection is metered.	Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately.
name	zone	string		The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.	The trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. When updating this property on a currently activated connection, the change takes effect immediately.

@@ -851,6 +863,12 @@ The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9. +

device-id

string

+The device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device. + +

home-only

boolean

FALSE

@@ -899,6 +917,18 @@ Flags indicating how to handle the "pin" property. +

sim-id

string

+The SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier. + + +

sim-operator-id

string

+A MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioined by the given operator. + +

username

string

@@ -999,10 +1029,16 @@ 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. +

dhcp-fqdn

string

+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. + +

dhcp-hostname

string

-If the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. +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.

dhcp-send-hostname

@@ -1011,12 +1047,24 @@ 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. +

dhcp-timeout

uint32

+A timeout for a DHCP transaction in seconds. + +

dns

array of uint32

[]

Array of IP addresses of DNS servers (as network-byte-order integers) +

dns-options

array of string

[]

+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. + +

dns-search

array of string

[]

@@ -1103,6 +1151,12 @@ +

addr-gen-mode

int32

+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. + +

address-data

array of vardict

@@ -1118,7 +1172,7 @@

dhcp-hostname

string

dhcp-send-hostname

@@ -1133,6 +1187,12 @@ Array of IP addresses of DNS servers (in network byte order) +

dns-options

array of string

[]

+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. + +

dns-search

array of string

[]

@@ -1160,7 +1220,7 @@

ip6-privacy

NMSettingIP6ConfigPrivacy (int32)

-Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". +Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.

may-fail

@@ -1209,7 +1269,155 @@

Table 15. 802-11-olpc-mesh setting

Table 15. ip-tunnel setting

++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key Name	Value Type	Default Value	Value Description
encapsulation-limit	uint32	0	How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels.
flow-label	uint32	0	The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels.
input-key	string		The key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.
local	string		The local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address.
mode	uint32	0	The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2).
mtu	uint32	0	None
name	string	ip-tunnel	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".
output-key	string		The key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used.
parent	string		If given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface.
path-mtu-discovery	boolean	TRUE	Whether to enable Path MTU Discovery on this tunnel.
remote	string		The remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address.
tos	uint32	0	The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets.
ttl	uint32	0	The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value.

Table 16. macvlan setting

++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key Name	Value Type	Default Value	Value Description
mode	uint32	0	The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device.
name	string	macvlan	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".
parent	string		If given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property.
promiscuous	boolean	TRUE	Whether the interface should be put in promiscuous mode.
tap	boolean	FALSE	Whether the interface should be a MACVTAP.

Table 17. 802-11-olpc-mesh setting

@@ -1253,7 +1461,7 @@

Table 16. ppp setting

Table 18. ppp setting

@@ -1387,7 +1595,7 @@

Table 17. pppoe setting

Table 19. pppoe setting

@@ -1437,7 +1645,7 @@

Table 18. serial setting

Table 20. serial setting

@@ -1493,7 +1701,7 @@

Table 19. team setting

Table 21. team setting

@@ -1531,7 +1739,7 @@

Table 20. team-port setting

Table 22. team-port setting

@@ -1563,7 +1771,69 @@

Table 21. vlan setting

Table 23. tun setting

++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key Name	Value Type	Default Value	Value Description
group	string		The group ID which will own the device. If set to NULL everyone will be able to use the device.
mode	uint32	1	The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one.
multi-queue	boolean	FALSE	If the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue.
name	string	tun	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".
owner	string		The user ID which will own the device. If set to NULL everyone will be able to use the device.
pi	boolean	FALSE	If TRUE the interface will prepend a 4 byte header describing the physical interface to the packets.
vnet-hdr	boolean	FALSE	If TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header.

Table 24. vlan setting

@@ -1588,7 +1858,7 @@ - + @@ -1625,7 +1895,7 @@

Table 22. vpn setting

Table 25. vpn setting

flags	NMVlanFlags (uint32)		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).	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.
id

@@ -1671,6 +1941,12 @@ + + + + + + @@ -1681,7 +1957,129 @@

Table 23. wimax setting

Table 26. vxlan setting

D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.
timeout	uint32	0	Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overriden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.
user-name	string

++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Key Name	Value Type	Default Value	Value Description
ageing	uint32	0	Specifies the lifetime in seconds of FDB entries learnt by the kernel.
destination-port	uint32	8472	Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint.
id	uint32	0	Specifies the VXLAN Network Identifer (or VXLAN Segment Identifier) to use.
l2-miss	boolean	FALSE	Specifies whether netlink LL ADDR miss notifications are generated.
l3-miss	boolean	FALSE	Specifies whether netlink IP ADDR miss notifications are generated.
learning	boolean	TRUE	Specifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database.
limit	uint32	0	Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries.
local	string		If given, specifies the source IP address to use in outgoing packets.
name	string	vxlan	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".
parent	string		If given, specifies the parent interface name or parent connection UUID.
proxy	boolean	FALSE	Specifies whether ARP proxy is turned on.
remote	string		Specifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join.
rsc	boolean	FALSE	Specifies whether route short circuit is turned on.
source-port-max	uint32	0	Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.
source-port-min	uint32	0	Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.
tos	uint32	0	Specifies the TOS value to use in outgoing packets.
ttl	uint32	0	Specifies the time-to-live value to use in outgoing packets.

Table 27. wimax setting

@@ -1700,7 +2098,7 @@ - + @@ -1712,14 +2110,14 @@ - +

mac-address	byte array		If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing).	If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). Deprecated: 1
name	network-name	string		Network Service Provider (NSP) name of the WiMAX network this connection should use.	Network Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1

Table 24. 802-3-ethernet setting

Table 28. 802-3-ethernet setting

@@ -1823,7 +2221,7 @@

Table 25. 802-11-wireless setting

Table 29. 802-11-wireless setting

@@ -1881,6 +2279,12 @@ + + + + + + @@ -1899,6 +2303,12 @@ + + + + + + @@ -1933,7 +2343,7 @@

Table 26. 802-11-wireless-security setting

Table 30. 802-11-wireless-security setting

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").
mac-address-randomization	uint32	0	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).
mode	string		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".
powersave	uint32	0	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.
rate	uint32	0

diff --git a/docs/api/html/spec.html b/docs/api/html/spec.html index 870e837f..dd4be9bf 100644 --- a/docs/api/html/spec.html +++ b/docs/api/html/spec.html @@ -1,4 +1,4 @@ -NetworkManager D-Bus Interface Specification version 1.0.10

NetworkManager D-Bus Interface Specification

Version 1.0.10

NetworkManager D-Bus Interface Specification

Version 1.1.90

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or @@ -116,10 +116,22 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

- Get the list of network devices. + Get the list of realized network devices.

Returns

devices - ao: - List of object paths of network devices known to the system. + List of object paths of network devices known to the system. This + list does not include device placeholders (see GetAllDevices()). +

GetAllDevices ( + + ) → + ao

+ Get the list of all network devices. +

Returns

devices - + ao: + List of object paths of network devices and device placeholders + (eg, devices that do not yet exist but which can be automatically + created by NetworkManager if one of their AvailableConnections + was activated).

GetDeviceByIpIface ( s: iface ) → @@ -246,7 +258,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Parameters
`level` - `s`
- One of [ERR, WARN, INFO, DEBUG, TRACE]. + One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. + This level is applied to the domains as specified in the domains + argument. Except for the special level "KEEP", all unmentioned + domains are disabled entirely. "KEEP" is special and allows + not to change the current setting except for the specified + domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only + touch the platform domain.
`domains` - `s`
A combination of logging domains separated by commas (','), or "NONE" @@ -332,7 +350,16 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Properties:

Devices - ao - (read): - The list of network devices/interfaces NetworkManager knows about. + The list of realized network devices. Realized devices are those which + have backing resources (eg from the kernel or a management daemon like + ModemManager, teamd, etc). +
AllDevices - + ao - + (read): + The list of both realized and un-realized network devices. Un-realized + devices are software devices which do not yet have backing resources, + but for which backing resources can be created if the device is + activated.
NetworkingEnabled - b - (read): @@ -386,8 +413,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.(read) (NM_METERED); - Wheter the connectivity is metered. This is equivalent to the - metered property of the device associated with the primary + Indicates whether the connectivity is metered. This is equivalent + to the metered property of the device associated with the primary connection.
ActivatingConnection - o - @@ -417,6 +444,18 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.NM_CONNECTIVITY): The network connectivity state. +
GlobalDnsConfiguration - + a{sv} - + (readwrite): + Dictionary of global DNS settings where the key is one of + "searches", "options" and "domains". The values for the + "searches" and "options" keys are string arrays describing the + list of search domains and resolver options, respectively. + The value of the "domains" key is a second-level dictionary, + where each key is a domain name, and each key's value is a + third-level dictionary with the keys "servers" and + "options". "servers" is a string array of DNS servers, + "options" is a string array of domain-specific options.

Enumerated types:

NM_STATE

Describes the overall state of the daemon.

NM_STATE_UNKNOWN = 0: @@ -498,7 +537,23 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
NM_802_11_AP_SEC_NONE = 0x0: Null flag.
NM_802_11_AP_SEC_PAIR_WEP40 = 0x1: Access point supports pairwise 40-bit WEP encryption.
NM_802_11_AP_SEC_PAIR_WEP104 = 0x2: Access point supports pairwise 104-bit WEP encryption.
NM_802_11_AP_SEC_PAIR_TKIP = 0x4: Access point supports pairwise TKIP encryption.
NM_802_11_AP_SEC_PAIR_CCMP = 0x8: Access point supports pairwise CCMP encryption.
NM_802_11_AP_SEC_GROUP_WEP40 = 0x10: Access point supports a group 40-bit WEP cipher.
NM_802_11_AP_SEC_GROUP_WEP104 = 0x20: Access point supports a group 104-bit WEP cipher.
NM_802_11_AP_SEC_GROUP_TKIP = 0x40: Access point supports a group TKIP cipher.
NM_802_11_AP_SEC_GROUP_CCMP = 0x80: Access point supports a group CCMP cipher.
NM_802_11_AP_SEC_KEY_MGMT_PSK = 0x100: Access point supports PSK key management.
NM_802_11_AP_SEC_KEY_MGMT_802_1X = 0x200: Access point supports 802.1x key management.

org.freedesktop.NetworkManager.Device

Methods:

Disconnect ( +

org.freedesktop.NetworkManager.Device

Methods:

Reapply ( + a{sa{sv}}: connection, u: flags + ) → + nothing

+ Attempts to update the configuration of a device without deactivating it. + You can either modify the configuration by passing the desired setup via "connection" + argument or just omit the argument to bring it in sync with the connection that + has been activated but could have been modified since. +

Parameters

connection - + a{sa{sv}}: + The effective connection settings and properties to use. If empty, the connection + settings from the connection that is active on the device will be used. +
flags - + u: + Flags which would modify the behavior of the Reapply call. + There are no flags defined currently and the users should use the value of 0. +

Disconnect ( ) → nothing

@@ -613,8 +668,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Managed - b - - (read)

- Whether or not this device is managed by NetworkManager. + (readwrite)

+ Whether or not this device is managed by NetworkManager. Setting this + property has a similar effect to configuring the device as unmanaged + via the keyfile.unmanaged-devices setting in NetworkManager.conf. + Changes to this value are not persistent and lost after NetworkManager + restart.

Autoconnect - b - (readwrite)

@@ -628,6 +687,11 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.(read)

If TRUE, indicates the device is likely missing firmware necessary for its operation. +

NmPluginMissing - + b - + (read)

+ If TRUE, indicates the NetworkManager plugin for the device is likely + missing or misconfigured.

DeviceType - u - (read) @@ -656,6 +720,17 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Whether the amount of traffic flowing through the device is subject to limitations, for example set by service providers. +

LldpNeighbors - + aa{sv} - + (read)

+ Array of LLDP neighbors; each element is a dictionary mapping + LLDP TLV names to variant boxed values. +

Real - + b - + (read)

+ True if the device exists, or False for placeholder devices that + do not yet exist but could be automatically created by NetworkManager + if one of their AvailableConnections was activated.

Enumerated types:

NM_DEVICE_STATE

NM_DEVICE_STATE_UNKNOWN = 0: The device is in an unknown state.
NM_DEVICE_STATE_UNMANAGED = 10: @@ -883,6 +958,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.u - (read); Design speed of the device, in megabits/second (Mb/s). +
S390Subchannels - + as - + (read): + Array of S/390 subchannels for S/390 or z/Architecture devices.
Carrier - b - (read): @@ -1351,7 +1430,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.as - (read); A list of domains this address belongs to.
Searches - as - - (read): A list of dns searches.
WinsServers - + (read): A list of dns searches.
DnsOptions - + as - + (read): + A list of DNS options that modify the behavior of the DNS + resolver. See resolv.conf(5) manual page for the list of + supported options. +
WinsServers - au - (read): The Windows Internet Name Service servers associated with the connection. Each address is in network byte order.

@@ -1395,7 +1480,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.as - (read)

A list of domains this address belongs to.

Searches - as - - (read)

A list of dns searches.

+ (read)

A list of dns searches.

DnsOptions - + as - + (read)

+ A list of DNS options that modify the behavior of the DNS + resolver. See resolv.conf(5) manual page for the list of + supported options. +

org.freedesktop.NetworkManager.DHCP4Config

Options and configuration returned by the IPv4 DHCP server. diff --git a/docs/api/network-manager-docs.xml b/docs/api/network-manager-docs.xml index 0f9c7dbb..e8c99460 100644 --- a/docs/api/network-manager-docs.xml +++ b/docs/api/network-manager-docs.xml @@ -51,7 +51,7 @@ This part documents the properties and value types of each "Setting" object that composes the basic unit of NetworkManager configuration, the "Connection". Each Connection object is simply a dictionary mapping - setting names (like "wimax" or "bluetooth") to a dictionary of + setting names (like "802-3-ethernet" or "bluetooth") to a dictionary of key/value pairs that represents each itself. diff --git a/docs/api/settings-spec.xml b/docs/api/settings-spec.xml index 5247d409..70b885b4 100644 --- a/docs/api/settings-spec.xml +++ b/docs/api/settings-spec.xml @@ -63,6 +63,7 @@ interface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the bridge's interface name. mac-addressbyte arrayIf specified, the MAC address of bridge. When creating a new bridge, this MAC address will be set. When matching an existing (outside NetworkManager created) bridge, this MAC address must match. max-ageuint3220The Spanning Tree Protocol (STP) maximum message age, in seconds. + multicast-snoopingbooleanTRUEControls whether IGMP snooping is enabled for this bridge. Note that if snooping was automatically disabled due to hash collisions, the system may refuse to enable the feature until the collisions are resolved. namestringbridgeThe 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". priorityuint3232768Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are "better"; the lowest priority bridge will be elected the root bridge. stpbooleanTRUEControls whether Spanning Tree Protocol (STP) is enabled for this bridge. @@ -87,8 +88,9 @@ gateway-ping-timeoutuint320If greater than zero, delay success of IP addressing until either the timeout is reached, or an IP gateway replies to a ping. idstringA human readable unique identifier for the connection, like "Work Wi-Fi" or "T-Mobile 3G". interface-namestringThe name of the network interface 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 software devices this specifies the name of the created device. 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. + lldpint32-1Whether LLDP is enabled for the connection. masterstringInterface name of the master device or UUID of the master connection. - meteredNMMetered (int32)Whether the connection is metered. + meteredNMMetered (int32)Whether the connection is metered. When updating this property on a currently activated connection, the change takes effect immediately. namestringconnectionThe 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". permissionsarray of string[]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 list. 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 present must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8. read-onlybooleanFALSEFALSE if the connection can be modified using the provided settings service's D-Bus interface with the right privileges, or TRUE if the connection is read-only and cannot be modified. @@ -97,7 +99,7 @@ timestampuint640The time, in seconds since the Unix Epoch, that the connection was last _successfully_ fully 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). typestringBase type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, "802-3-ethernet" or "802-11-wireless" or "bluetooth", etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, "vpn" or "bridge", etc). uuidstringA universally unique identifier for the connection, for example generated with libuuid. It 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 "id" property or NMSettingIP4Config changes, but might need to be re-created when the Wi-Fi SSID, mobile broadband network provider, or "type" property changes. The UUID must be in the format "2815492f-7e56-435e-b2e9-246bd7cdc664" (ie, contains only hexadecimal characters and "-"). - zonestringThe trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. + zonestringThe trust level of a the connection. Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall. When updating this property on a currently activated connection, the change takes effect immediately.

dcb settingKey NameValue TypeDefault ValueValue Descriptionapp-fcoe-flagsNMSettingDcbFlags (uint32)Specifies the NMSettingDcbFlags for the DCB FCoE 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). @@ -122,6 +124,7 @@

gsm settingKey NameValue TypeDefault ValueValue DescriptionapnstringThe GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9. + device-idstringThe device unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will only apply to the specified device.home-onlybooleanFALSEWhen TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.namestringgsmThe 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".network-idstringThe Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible. @@ -130,6 +133,8 @@ password-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "password" property.pinstringIf the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.pin-flagsNMSettingSecretFlags (uint32)Flags indicating how to handle the "pin" property. + sim-idstringThe SIM card unique identifier (as given by the WWAN management service) which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" which contains a SIM card matching the given identifier. + sim-operator-idstringA MCC/MNC string like "310260" or "21601" identifying the specific mobile network operator which this connection applies to. If given, the connection will apply to any device also allowed by "device-id" and "sim-id" which contains a SIM card provisioined by the given operator.usernamestringThe username used to authenticate with the network, if required. Many providers do not require a username, or accept any username. But if a username is required, it is specified here.

infiniband settingKey NameValue TypeDefault ValueValue Description @@ -144,9 +149,12 @@ address-dataarray of vardictArray 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.addressesarray of array of uint32[]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.dhcp-client-idstringA string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options. - dhcp-hostnamestringIf the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. + dhcp-fqdnstringIf 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. + dhcp-hostnamestringIf 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.dhcp-send-hostnamebooleanTRUEIf 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. + dhcp-timeoutuint320A timeout for a DHCP transaction in seconds.dnsarray of uint32[]Array of IP addresses of DNS servers (as network-byte-order integers) + dns-optionsarray of string[]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.dns-searcharray of string[]Array of DNS search domains.gatewaystringThe gateway associated with this configuration. This is only meaningful if "addresses" is also set.ignore-auto-dnsbooleanFALSEWhen "method" is set to "auto" and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the "dns" and "dns-search" properties, if any, are used. @@ -160,16 +168,18 @@ routesarray of array of uint32[]Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. 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. If the metric is 0, NM will choose an appropriate default metric for the device. (There is no way to explicitly specify an actual metric of 0 with this property.)

ipv6 settingKey NameValue TypeDefault ValueValue Description + addr-gen-modeint321Configure 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.address-dataarray of vardictArray 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.addressesarray of legacy IPv6 address struct (a(ayuay))[]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. - dhcp-hostnamestringIf the "dhcp-send-hostname" property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease. + dhcp-hostnamestringIf 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.dhcp-send-hostnamebooleanTRUEIf 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.dnsarray of byte array[]Array of IP addresses of DNS servers (in network byte order) + dns-optionsarray of string[]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.dns-searcharray of string[]Array of DNS search domains.gatewaystringThe gateway associated with this configuration. This is only meaningful if "addresses" is also set.ignore-auto-dnsbooleanFALSEWhen "method" is set to "auto" and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the "dns" and "dns-search" properties, if any, are used.ignore-auto-routesbooleanFALSEWhen "method" is set to "auto" and this property to TRUE, automatically configured routes are ignored and only routes specified in the "routes" property, if any, are used. - ip6-privacyNMSettingIP6ConfigPrivacy (int32)Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". + ip6-privacyNMSettingIP6ConfigPrivacy (int32)Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: -1: unknown, 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses). Having a per-connection setting set to "-1" (unknown) means fallback to global configuration "ipv6.ip6-privacy". If also global configuration is unspecified or set to "-1", fallback to read "/proc/sys/net/ipv6/conf/default/use_tempaddr". Note that this setting is distinct from the Stable Privacy addresses that can be enabled with the "addr-gen-mode" property's "stable-privacy" setting as another way of avoiding host tracking with IPv6 addresses.may-failbooleanTRUEIf TRUE, allow overall network configuration to proceed even if the configuration specified by this property times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE on the NMSettingIP4Config allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.methodstringIP configuration method. NMSettingIP4Config and NMSettingIP6Config both support "auto", "manual", and "link-local". See the subclass-specific documentation for other values. In general, for the "auto" method, properties such as "dns" and "routes" specify information that is added on to the information returned from automatic configuration. The "ignore-auto-routes" and "ignore-auto-dns" properties modify this behavior. For methods that imply no upstream network, such as "shared" or "link-local", these properties must be empty.namestringipv6The 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". @@ -178,6 +188,28 @@ route-metricint64-1The default metric for routes that don't explicitly specify a metric. The default value -1 means that the metric is choosen automatically based on the device type. The metric applies to dynamic routes, manual (static) routes that don't have an explicit metric setting, address prefix routes, and the default route. Note that for IPv6, the kernel accepts zero (0) but coerces it to 1024 (user default). Hence, setting this property to zero effectively mean setting it to 1024. For IPv4, zero is a regular value for the metric.routesarray of legacy IPv6 route struct (a(ayuayu))[]Deprecated in favor of the 'route-data' property, but this can be used for backward-compatibility with older daemons. Note that if you send this property the daemon will ignore 'route-data'. Array of IPv6 route structures. Each IPv6 route structure is composed of an IPv6 address, a prefix length (1 - 128), an IPv6 next hop address (which may be zeroed out if there is no next hop), and a metric. If the metric is 0, NM will choose an appropriate default metric for the device.

+ ip-tunnel settingKey NameValue TypeDefault ValueValue Description + encapsulation-limituint320How many additional levels of encapsulation are permitted to be prepended to packets. This property applies only to IPv6 tunnels. + flow-labeluint320The flow label to assign to tunnel packets. This property applies only to IPv6 tunnels. + input-keystringThe key used for tunnel input packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used. + localstringThe local endpoint of the tunnel; the value can be empty, otherwise it must contain an IPv4 or IPv6 address. + modeuint320The tunneling mode, for example NM_IP_TUNNEL_MODE_IPIP (1) or NM_IP_TUNNEL_MODE_GRE (2). + mtuuint320None + namestringip-tunnelThe 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". + output-keystringThe key used for tunnel output packets; the property is valid only for certain tunnel modes (GRE, IP6GRE). If empty, no key is used. + parentstringIf given, specifies the parent interface name or parent connection UUID the new device will be bound to so that tunneled packets will only be routed via that interface. + path-mtu-discoverybooleanTRUEWhether to enable Path MTU Discovery on this tunnel. + remotestringThe remote endpoint of the tunnel; the value must contain an IPv4 or IPv6 address. + tosuint320The type of service (IPv4) or traffic class (IPv6) field to be set on tunneled packets. + ttluint320The TTL to assign to tunneled packets. 0 is a special value meaning that packets inherit the TTL value. +

+ macvlan settingKey NameValue TypeDefault ValueValue Description + modeuint320The macvlan mode, which specifies the communication mechanism between multiple macvlans on the same lower device. + namestringmacvlanThe 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". + parentstringIf given, specifies the parent interface name or parent connection UUID from which this MAC-VLAN interface should be created. If this property is not specified, the connection must contain an "802-3-ethernet" setting with a "mac-address" property. + promiscuousbooleanTRUEWhether the interface should be put in promiscuous mode. + tapbooleanFALSEWhether the interface should be a MACVTAP. +

802-11-olpc-mesh settingKey NameValue TypeDefault ValueValue Descriptionchanneluint320Channel on which the mesh network to join is located.dhcp-anycast-addressbyte arrayAnycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the request. @@ -229,9 +261,18 @@ configstringThe 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 default configuration is used. See man teamd.conf for the format details.namestringteam-portThe 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".

+ tun settingKey NameValue TypeDefault ValueValue Description + groupstringThe group ID which will own the device. If set to NULL everyone will be able to use the device. + modeuint321The operating mode of the virtual device. Allowed values are NM_SETTING_TUN_MODE_TUN (1) to create a layer 3 device and NM_SETTING_TUN_MODE_TAP (2) to create an Ethernet-like layer 2 one. + multi-queuebooleanFALSEIf the property is set to TRUE, the interface will support multiple file descriptors (queues) to parallelize packet sending or receiving. Otherwise, the interface will only support a single queue. + namestringtunThe 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". + ownerstringThe user ID which will own the device. If set to NULL everyone will be able to use the device. + pibooleanFALSEIf TRUE the interface will prepend a 4 byte header describing the physical interface to the packets. + vnet-hdrbooleanFALSEIf TRUE the IFF_VNET_HDR the tunnel packets will include a virtio network header. +

vlan settingKey NameValue TypeDefault ValueValue Descriptionegress-priority-maparray of string[]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". - flagsNMVlanFlags (uint32)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). + flagsNMVlanFlags (uint32)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.iduint320The VLAN identifier that the interface created by this connection should be assigned.ingress-priority-maparray of string[]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".interface-namestringDeprecated in favor of connection.interface-name, but can be used for backward-compatibility with older daemons, to set the vlan's interface name. @@ -244,12 +285,32 @@ persistentbooleanFALSEIf the VPN service supports persistence, and this property is TRUE, the VPN will attempt to stay connected across link changes and outages, until explicitly disconnected.secretsdict of string to string{}Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.service-typestringD-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin. + timeoutuint320Timeout for the VPN service to establish the connection. Some services may take quite a long time to connect. Value of 0 means a default timeout, which is 60 seconds (unless overriden by vpn.timeout in configuration file). Values greater than zero mean timeout in seconds.user-namestringIf 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.

+ vxlan settingKey NameValue TypeDefault ValueValue Description + ageinguint320Specifies the lifetime in seconds of FDB entries learnt by the kernel. + destination-portuint328472Specifies the UDP destination port to communicate to the remote VXLAN tunnel endpoint. + iduint320Specifies the VXLAN Network Identifer (or VXLAN Segment Identifier) to use. + l2-missbooleanFALSESpecifies whether netlink LL ADDR miss notifications are generated. + l3-missbooleanFALSESpecifies whether netlink IP ADDR miss notifications are generated. + learningbooleanTRUESpecifies whether unknown source link layer addresses and IP addresses are entered into the VXLAN device forwarding database. + limituint320Specifies the maximum number of FDB entries. A value of zero means that the kernel will store unlimited entries. + localstringIf given, specifies the source IP address to use in outgoing packets. + namestringvxlanThe 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". + parentstringIf given, specifies the parent interface name or parent connection UUID. + proxybooleanFALSESpecifies whether ARP proxy is turned on. + remotestringSpecifies the unicast destination IP address to use in outgoing packets when the destination link layer address is not known in the VXLAN device forwarding database, or the multicast IP address to join. + rscbooleanFALSESpecifies whether route short circuit is turned on. + source-port-maxuint320Specifies the maximum UDP source port to communicate to the remote VXLAN tunnel endpoint. + source-port-minuint320Specifies the minimum UDP source port to communicate to the remote VXLAN tunnel endpoint. + tosuint320Specifies the TOS value to use in outgoing packets. + ttluint320Specifies the time-to-live value to use in outgoing packets. +

wimax settingKey NameValue TypeDefault ValueValue Description - mac-addressbyte arrayIf specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). + mac-addressbyte arrayIf specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing). Deprecated: 1namestringwimaxThe 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". - network-namestringNetwork Service Provider (NSP) name of the WiMAX network this connection should use. + network-namestringNetwork Service Provider (NSP) name of the WiMAX network this connection should use. Deprecated: 1

802-3-ethernet settingKey NameValue TypeDefault ValueValue Descriptionauto-negotiatebooleanTRUEIf TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, do not allow auto-negotiation, in which case the "speed" and "duplex" properties should be set. @@ -275,9 +336,11 @@ hiddenbooleanFALSEIf 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.mac-addressbyte arrayIf 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).mac-address-blacklistarray of string[]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"). + mac-address-randomizationuint320One 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).modestringWi-Fi network mode; one of "infrastructure", "adhoc" or "ap". If blank, infrastructure is assumed.mtuuint320If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.namestring802-11-wirelessThe 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". + powersaveuint320If 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.rateuint320If 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.securityNoneThis 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.seen-bssidsarray of string[]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. diff --git a/docs/api/spec.html b/docs/api/spec.html index 870e837f..dd4be9bf 100644 --- a/docs/api/spec.html +++ b/docs/api/spec.html @@ -1,4 +1,4 @@ -NetworkManager D-Bus Interface Specification version 1.0.10

NetworkManager D-Bus Interface Specification

Version 1.0.10

NetworkManager D-Bus Interface Specification

Version 1.1.90

- Get the list of network devices. + Get the list of realized network devices.

Returns

devices - ao: - List of object paths of network devices known to the system. + List of object paths of network devices known to the system. This + list does not include device placeholders (see GetAllDevices()). +

GetAllDevices ( + + ) → + ao

+ Get the list of all network devices. +

Returns

devices - + ao: + List of object paths of network devices and device placeholders + (eg, devices that do not yet exist but which can be automatically + created by NetworkManager if one of their AvailableConnections + was activated).

GetDeviceByIpIface ( s: iface ) → @@ -246,7 +258,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
Parameters
`level` - `s`
- One of [ERR, WARN, INFO, DEBUG, TRACE]. + One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. + This level is applied to the domains as specified in the domains + argument. Except for the special level "KEEP", all unmentioned + domains are disabled entirely. "KEEP" is special and allows + not to change the current setting except for the specified + domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only + touch the platform domain.
`domains` - `s`
A combination of logging domains separated by commas (','), or "NONE" @@ -332,7 +350,16 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Properties:

Devices - ao - (read): - The list of network devices/interfaces NetworkManager knows about. + The list of realized network devices. Realized devices are those which + have backing resources (eg from the kernel or a management daemon like + ModemManager, teamd, etc). +
AllDevices - + ao - + (read): + The list of both realized and un-realized network devices. Un-realized + devices are software devices which do not yet have backing resources, + but for which backing resources can be created if the device is + activated.
NetworkingEnabled - b - (read): @@ -386,8 +413,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.(read) (NM_METERED); - Wheter the connectivity is metered. This is equivalent to the - metered property of the device associated with the primary + Indicates whether the connectivity is metered. This is equivalent + to the metered property of the device associated with the primary connection.
ActivatingConnection - o - @@ -417,6 +444,18 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.NM_CONNECTIVITY): The network connectivity state. +
GlobalDnsConfiguration - + a{sv} - + (readwrite): + Dictionary of global DNS settings where the key is one of + "searches", "options" and "domains". The values for the + "searches" and "options" keys are string arrays describing the + list of search domains and resolver options, respectively. + The value of the "domains" key is a second-level dictionary, + where each key is a domain name, and each key's value is a + third-level dictionary with the keys "servers" and + "options". "servers" is a string array of DNS servers, + "options" is a string array of domain-specific options.

Enumerated types:

NM_STATE

Describes the overall state of the daemon.

NM_STATE_UNKNOWN = 0: @@ -498,7 +537,23 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
NM_802_11_AP_SEC_NONE = 0x0: Null flag.
NM_802_11_AP_SEC_PAIR_WEP40 = 0x1: Access point supports pairwise 40-bit WEP encryption.
NM_802_11_AP_SEC_PAIR_WEP104 = 0x2: Access point supports pairwise 104-bit WEP encryption.
NM_802_11_AP_SEC_PAIR_TKIP = 0x4: Access point supports pairwise TKIP encryption.
NM_802_11_AP_SEC_PAIR_CCMP = 0x8: Access point supports pairwise CCMP encryption.
NM_802_11_AP_SEC_GROUP_WEP40 = 0x10: Access point supports a group 40-bit WEP cipher.
NM_802_11_AP_SEC_GROUP_WEP104 = 0x20: Access point supports a group 104-bit WEP cipher.
NM_802_11_AP_SEC_GROUP_TKIP = 0x40: Access point supports a group TKIP cipher.
NM_802_11_AP_SEC_GROUP_CCMP = 0x80: Access point supports a group CCMP cipher.
NM_802_11_AP_SEC_KEY_MGMT_PSK = 0x100: Access point supports PSK key management.
NM_802_11_AP_SEC_KEY_MGMT_802_1X = 0x200: Access point supports 802.1x key management.

org.freedesktop.NetworkManager.Device

Methods:

Disconnect ( +

org.freedesktop.NetworkManager.Device

Methods:

Reapply ( + a{sa{sv}}: connection, u: flags + ) → + nothing

Parameters

connection - + a{sa{sv}}: + The effective connection settings and properties to use. If empty, the connection + settings from the connection that is active on the device will be used. +
flags - + u: + Flags which would modify the behavior of the Reapply call. + There are no flags defined currently and the users should use the value of 0. +

Disconnect ( ) → nothing

@@ -613,8 +668,12 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Managed - b - - (read)

- Whether or not this device is managed by NetworkManager. + (readwrite)

Autoconnect - b - (readwrite)

@@ -628,6 +687,11 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.(read)

If TRUE, indicates the device is likely missing firmware necessary for its operation. +

NmPluginMissing - + b - + (read)

+ If TRUE, indicates the NetworkManager plugin for the device is likely + missing or misconfigured.

DeviceType - u - (read) @@ -656,6 +720,17 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

Whether the amount of traffic flowing through the device is subject to limitations, for example set by service providers. +

LldpNeighbors - + aa{sv} - + (read)

+ Array of LLDP neighbors; each element is a dictionary mapping + LLDP TLV names to variant boxed values. +

Real - + b - + (read)

+ True if the device exists, or False for placeholder devices that + do not yet exist but could be automatically created by NetworkManager + if one of their AvailableConnections was activated.

Enumerated types:

NM_DEVICE_STATE

NM_DEVICE_STATE_UNKNOWN = 0: The device is in an unknown state.
NM_DEVICE_STATE_UNMANAGED = 10: @@ -883,6 +958,10 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.u - (read); Design speed of the device, in megabits/second (Mb/s). +
S390Subchannels - + as - + (read): + Array of S/390 subchannels for S/390 or z/Architecture devices.
Carrier - b - (read): @@ -1351,7 +1430,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.as - (read); A list of domains this address belongs to.
Searches - as - - (read): A list of dns searches.
WinsServers - + (read): A list of dns searches.
DnsOptions - + as - + (read): + A list of DNS options that modify the behavior of the DNS + resolver. See resolv.conf(5) manual page for the list of + supported options. +
WinsServers - au - (read): The Windows Internet Name Service servers associated with the connection. Each address is in network byte order.

@@ -1395,7 +1480,13 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.as - (read)

A list of domains this address belongs to.

Searches - as - - (read)

A list of dns searches.

+ (read)

A list of dns searches.

DnsOptions - + as - + (read)

+ A list of DNS options that modify the behavior of the DNS + resolver. See resolv.conf(5) manual page for the list of + supported options. +

org.freedesktop.NetworkManager.DHCP4Config

Options and configuration returned by the IPv4 DHCP server. diff --git a/docs/api/version.xml b/docs/api/version.xml index 7ee7020b..69658cdd 100644 --- a/docs/api/version.xml +++ b/docs/api/version.xml @@ -1 +1 @@ -1.0.10 +1.1.90 -- cgit 1.3.0-6-gf8a5