From c2de0d98ba39e0a1a970d066fd19be786092f376 Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Tue, 1 Mar 2016 16:55:22 +0100 Subject: Imported Upstream version 1.1.91 --- docs/api/spec.html | 763 ++++++++++++++++++++++++++++++++++++----------------- 1 file changed, 521 insertions(+), 242 deletions(-) (limited to 'docs/api/spec.html') diff --git a/docs/api/spec.html b/docs/api/spec.html index dd4be9bf..990fd2ba 100644 --- a/docs/api/spec.html +++ b/docs/api/spec.html @@ -1,4 +1,4 @@ -NetworkManager D-Bus Interface Specification version 1.1.90

NetworkManager D-Bus Interface Specification

Version 1.1.90

Copyright (C) 2008 - 2011 Red Hat, Inc.
Copyright (C) 2008 - 2009 Novell, Inc.
+

NetworkManager D-Bus Interface Specification

Version 1.1.91

Copyright (C) 2008 - 2016 Red Hat, Inc.
Copyright (C) 2008 - 2009 Novell, Inc.

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 @@ -111,7 +111,7 @@ General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

-

Interfaces

+

Interfaces

org.freedesktop.NetworkManager

Methods:

GetDevices ( ) → @@ -538,21 +538,66 @@ 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:

Reapply ( - a{sa{sv}}: connection, u: flags + a{sa{sv}}: connection, t: version_id, 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. + Attempts to update the configuration of a device without deactivating it. NetworkManager + has the concept of connections, which are profiles that contain the configuration for + a networking device. Those connections are exposed via D-Bus as individual objects + that can be created, modified and deleted. When activating such a settings-connection + on a device, the settings-connection is cloned to become an applied-connection and used to + configure the device (see GetAppliedConnection). Subsequent modification of the + settings-connection don't propagate automatically to the device's applied-connection + (with exception of the firewall-zone and the metered property). For the changes to take + effect, you can either re-activate the settings-connection, or call Reapply. + The Reapply call allows you to directly update the applied-connection and reconfigure + the device. + Reapply can also be useful if the currently applied-connection is equal to the connection + that is about to be reapplied. This allows to reconfigure the device and revert external + changes like removing or adding an IP address (which NetworkManager doesn't revert + automatically because it is assumed that the user made these changes intentionally outside + of NetworkManager). + Reapply can make the applied-connection different from the settings-connection, + just like updating the settings-connection can make them different.

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. + The optional connection settings that will be reapplied on the device. If empty, the + currently active settings-connection will be used. The connection cannot arbitrarly + differ from the current applied-connection otherwise the call will fail. + Only certain changes are supported, like adding or removing IP addresses. +
version_id - + t
+ If non-zero, the current version id of the applied-connection must match. + The current version id can be retrieved via GetAppliedConnection. + This optional argument allows to catch concurrent modifications between + the GetAppliedConnection call and Reapply.
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. +

GetAppliedConnection ( + u: flags + ) → + a{sa{sv}}, t

+ Get the currently applied connection on the device. This is a snapshot of the last activated + connection on the device, that is the configuration that is currently applied on the device. + Usually this is the same as GetSettings of the referenced settings connection. However, it + can differ if the settings connection was subsequently modified or the applied connection was + modified by Reapply. The applied connection is set when activating a device or when calling + Reapply. +

Parameters

flags - + u
+ Flags which would modify the behavior of the GetAppliedConnection call. + There are no flags defined currently and the users should use the value of 0. +

Returns

connection - + a{sa{sv}}
+ The effective connection settings that the connection has currently applied. +
version_id - + t
+ The version-id of the currently applied connection. This can be specified during + Reapply to avoid races where you first fetch the applied connection, modify it + and try to reapply it. If the applied connection is modified in the meantime, the + version_id gets incremented and Reapply will fail.

Disconnect ( ) → @@ -939,6 +984,88 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

+

org.freedesktop.NetworkManager.Device.Adsl

Interface has no methods.

Signals:

PropertiesChanged ( + a{sv}: properties + )

Parameters

properties - + a{sv} + (String_Variant_Map) +
+ A dictionary mapping property names to variant boxed values +

Properties:

Carrier - + b - + (read)
+ Indicates whether the physical carrier is found. +
+ +

org.freedesktop.NetworkManager.Device.Bond

Interface has no methods.

Signals:

PropertiesChanged ( + a{sv}: properties + )

Parameters

properties - + a{sv} + (String_Variant_Map) +
+ A dictionary mapping property names to variant boxed values +

Properties:

HwAddress - + s - + (read)
+ Hardware address of the device. +
Carrier - + b - + (read)
+ Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). +
Slaves - + ao - + (read)
+ Array of object paths representing devices which are currently + slaved to this device. +
+ +

org.freedesktop.NetworkManager.Device.Bridge

Interface has no methods.

Signals:

PropertiesChanged ( + a{sv}: properties + )

Parameters

properties - + a{sv} + (String_Variant_Map) +
+ A dictionary mapping property names to variant boxed values +

Properties:

HwAddress - + s - + (read)
+ Hardware address of the device. +
Carrier - + b - + (read)
+ Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). +
Slaves - + ao - + (read)
+ Array of object paths representing devices which are currently + slaved to this device. +
+ +

org.freedesktop.NetworkManager.Device.Bluetooth

Interface has no methods.

Signals:

PropertiesChanged ( + a{sv}: properties + )

Parameters

properties - + a{sv} + (String_Variant_Map) +
+ A dictionary mapping property names to variant boxed values +

Properties:

HwAddress - + s - + (read)
+ Bluetooth hardware address of the device. +
Name - + s - + (read)
+ Bluetooth name of the device. +
BtCapabilities - + u - + (read) + (NM_BT_CAPABILITIES) +
+ Bluetooth capabilities of the device (either DUN or NAP). +

Sets of flags:

NM_BT_CAPABILITIES

+ Flags describing the capabilities of a Bluetooth device. +
NM_BT_CAPABILITY_NONE = 0x0
The device has no recognized capabilities.
NM_BT_CAPABILITY_DUN = 0x1
The device supports Bluetooth Dial-Up Networking.
NM_BT_CAPABILITY_PAN = 0x2
The device supports Bluetooth Personal Area Networking.
+

org.freedesktop.NetworkManager.Device.Wired

Interface has no methods.

Signals:

PropertiesChanged ( a{sv}: properties )

Parameters

properties - @@ -968,101 +1095,122 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
-

org.freedesktop.NetworkManager.Device.Wireless

Methods:

GetAccessPoints ( - - ) → - ao

- DEPRECATED. Get the list of access points visible to this device. Note - that this list does not include access points which hide their SSID. To - retrieve a list of all access points (including hidden ones) use the - GetAllAccessPoints() method. -

Returns

access_points - - ao
- List of access point object paths. -

GetAllAccessPoints ( - - ) → - ao

- Get the list of all access points visible to this device, including - hidden ones for which the SSID is not yet known. -

Returns

access_points - - ao
- List of access point object paths. -

RequestScan ( - a{sv}: options - ) → - nothing

- Request the device to scan -

Parameters

options - - a{sv}
- Options of scan. - Currently 'ssids' option with value of "aay" type is supported. -

Signals:

PropertiesChanged ( +

org.freedesktop.NetworkManager.Device.Generic

Interface has no methods.

Signals:

PropertiesChanged ( a{sv}: properties - )

- Emitted when the wireless device's properties changed. -

Parameters

properties - + )

Parameters

properties - a{sv} (String_Variant_Map)
- A dictionary containing the FIXME: check changed parameters. -

AccessPointAdded ( - o: access_point - )

- Emitted when a new access point is found by the device. -

Parameters

access_point - - o
- The object path of the newly found access point. -

AccessPointRemoved ( - o: access_point - )

- Emitted when an access point disappears from view of the device. -

Parameters

access_point - - o
- The object path of the access point that has disappeared. + A dictionary mapping property names to variant boxed values

Properties:

HwAddress - s - (read)
- The active hardware address of the device. -
PermHwAddress - + Hardware address of the device. +
TypeDescription - s - (read)
- The permanent hardware address of the device. -
Mode - - u - - (read) - (NM_802_11_MODE) + A (non-localized) description of the interface type, if known. +
+ +

org.freedesktop.NetworkManager.Device.Infiniband

Interface has no methods.

Signals:

PropertiesChanged ( + a{sv}: properties + )

Parameters

properties - + a{sv} + (String_Variant_Map)
- The operating mode of the wireless device. -
Bitrate - - u - + A dictionary mapping property names to variant boxed values +

Properties:

HwAddress - + s - (read)
- The bit rate currently used by the wireless device, in kilobits/second (Kb/s). -
AccessPoints - - ao - + Hardware address of the device. +
Carrier - + b - (read)
- List of object paths of access point visible to this wireless device. -
ActiveAccessPoint - + Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). +
+ +

org.freedesktop.NetworkManager.Device.IPTunnel

Interface has no methods.

Signals:

PropertiesChanged ( + a{sv}: properties + )

Parameters

properties - + a{sv} + (String_Variant_Map) +
+ A dictionary mapping property names to variant boxed values +

Properties:

Mode - + u - + (read)
+ The tunneling mode. +
Parent - o - (read)
- Object path of the access point currently used by the wireless device. -
WirelessCapabilities - + The object path of the parent device. +
Local - + s - + (read)
+ The local endpoint of the tunnel. +
Remote - + s - + (read)
+ The remote endpoint of the tunnel. +
Ttl - + y - + (read)
+ The TTL assigned to tunneled packets. 0 is a special value + meaning that packets inherit the TTL value +
Tos - + y - + (read)
+ The type of service (IPv4) or traffic class (IPv6) assigned to + tunneled packets. +
PathMtuDiscovery - + b - + (read)
+ Whether path MTU discovery is enabled on this tunnel. +
InputKey - + s - + (read)
+ The key used for incoming packets. +
OutputKey - + s - + (read)
+ The key used for outgoing packets. +
EncapsulationLimit - + y - + (read)
+ How many additional levels of encapsulation are permitted to + be prepended to packets. This property applies only to IPv6 + tunnels. +
FlowLabel - u - - (read) - (NM_802_11_DEVICE_CAP) + (read)
+ The flow label to assign to tunnel packets. This property + applies only to IPv6 tunnels. +
+ +

org.freedesktop.NetworkManager.Device.Macvlan

Interface has no methods.

Signals:

PropertiesChanged ( + a{sv}: properties + )

Parameters

properties - + a{sv} + (String_Variant_Map)
- The capabilities of the wireless device. -

Sets of flags:

NM_802_11_DEVICE_CAP

- Flags describing the capabilities of a wireless device. -
NM_802_11_DEVICE_CAP_NONE = 0x0
Null capability - syntactic sugar for no capabilities supported. Do not AND this with other capabilities!
NM_802_11_DEVICE_CAP_CIPHER_WEP40 = 0x1
The device supports the 40-bit WEP cipher.
NM_802_11_DEVICE_CAP_CIPHER_WEP104 = 0x2
The device supports the 104-bit WEP cipher.
NM_802_11_DEVICE_CAP_CIPHER_TKIP = 0x4
The device supports the TKIP cipher.
NM_802_11_DEVICE_CAP_CIPHER_CCMP = 0x8
The device supports the CCMP cipher.
NM_802_11_DEVICE_CAP_WPA = 0x10
The device supports the WPA encryption/authentication protocol.
NM_802_11_DEVICE_CAP_RSN = 0x20
The device supports the RSN encryption/authentication protocol.
NM_802_11_DEVICE_CAP_AP = 0x40
The device supports Access Point mode.
NM_802_11_DEVICE_CAP_ADHOC = 0x80
The device supports Ad-Hoc mode.
NM_802_11_DEVICE_CAP_FREQ_VALID = 0x100
- The device properly reports information about supported - frequencies and thus both NM_802_11_DEVICE_CAP_FREQ_2GHZ and - NM_802_11_DEVICE_CAP_FREQ_5GHZ are valid. -
NM_802_11_DEVICE_CAP_FREQ_2GHZ = 0x200
- The device supports 2.4GHz frequencies. -
NM_802_11_DEVICE_CAP_FREQ_5GHZ = 0x400
- The device supports 5GHz frequencies. -
+ A dictionary mapping property names to variant boxed values +

Properties:

Parent - + o - + (read)
+ The object path of the parent device. +
Mode - + s - + (read)
+ The macvlan mode, one of "private", "vepa", "bridge", or "passthru". +
NoPromisc - + b - + (read)
+ Whether the device is blocked from going into promiscuous mode. +
Tap - + b - + (read)
+ Whether the device is a macvtap. +

org.freedesktop.NetworkManager.Device.Modem

Interface has no methods.

Signals:

PropertiesChanged ( a{sv}: properties @@ -1103,31 +1251,6 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -

org.freedesktop.NetworkManager.Device.Bluetooth

Interface has no methods.

Signals:

PropertiesChanged ( - a{sv}: properties - )

Parameters

properties - - a{sv} - (String_Variant_Map) -
- A dictionary mapping property names to variant boxed values -

Properties:

HwAddress - - s - - (read)
- Bluetooth hardware address of the device. -
Name - - s - - (read)
- Bluetooth name of the device. -
BtCapabilities - - u - - (read) - (NM_BT_CAPABILITIES) -
- Bluetooth capabilities of the device (either DUN or NAP). -

Sets of flags:

NM_BT_CAPABILITIES

- Flags describing the capabilities of a Bluetooth device. -
NM_BT_CAPABILITY_NONE = 0x0
The device has no recognized capabilities.
NM_BT_CAPABILITY_DUN = 0x1
The device supports Bluetooth Dial-Up Networking.
NM_BT_CAPABILITY_PAN = 0x2
The device supports Bluetooth Personal Area Networking.
-

org.freedesktop.NetworkManager.Device.OlpcMesh

Interface has no methods.

Signals:

PropertiesChanged ( a{sv}: properties )

@@ -1151,83 +1274,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -

org.freedesktop.NetworkManager.Device.WiMax

Methods:

GetNspList ( - - ) → - ao

- Get the list of NSPs visible to this device. -

Returns

nsps - - ao
- List of NSP object paths -

Signals:

PropertiesChanged ( - a{sv}: properties - )

- Emitted when the WiMax device's properties changed. -

Parameters

properties - - a{sv} - (String_Variant_Map) -
- A dictionary mapping property names to variant boxed values. -

NspAdded ( - o: nsp - )

- Emitted when a new NSP is found by the device. -

Parameters

nsp - - o
- The object path of the newly found NSP. -

NspRemoved ( - o: nsp - )

- Emitted when an NSP disappears from view of the device. -

Parameters

nsp - - o
- The object path of the NSP that has disappeared. -

Properties:

Nsps - - ao - - (read)
- List of object paths of Network Service Providers (NSPs) visible to this - WiMAX device. -
HwAddress - - s - - (read)
- Hardware address of the device. -
CenterFrequency - - u - - (read)
- Center frequency (in KHz) of the radio channel the device is using to - communicate with the network when connected. Has no meaning when the - device is not connected. -
Rssi - - i - - (read)
- RSSI of the current radio link in dBm. This value indicates how strong - the raw received RF signal from the base station is, but does not - indicate the overall quality of the radio link. Has no meaning when the - device is not connected. -
Cinr - - i - - (read)
- CINR (Carrier to Interference + Noise Ratio) of the current radio link - in dB. CINR is a more accurate measure of radio link quality. Has no - meaning when the device is not connected. -
TxPower - - i - - (read)
- Average power of the last burst transmitted by the device, in units of - 0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of - -5.5 dBm. Has no meaning when the device is not connected. -
Bsid - - s - - (read)
- The ID of the serving base station as received from the network. Has - no meaning when the device is not connected. -
ActiveNsp - - o - - (read)
- Object path of the NSP currently used by the WiMax device. -
- -

org.freedesktop.NetworkManager.Device.Infiniband

Interface has no methods.

Signals:

PropertiesChanged ( +

org.freedesktop.NetworkManager.Device.Team

Interface has no methods.

Signals:

PropertiesChanged ( a{sv}: properties )

Parameters

properties - a{sv} @@ -1242,53 +1289,68 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.b - (read)
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). +
Slaves - + ao - + (read)
+ Array of object paths representing devices which are currently + slaved to this device.
-

org.freedesktop.NetworkManager.Device.Bond

Interface has no methods.

Signals:

PropertiesChanged ( +

org.freedesktop.NetworkManager.Device.Tun

Interface has no methods.

Signals:

PropertiesChanged ( a{sv}: properties )

Parameters

properties - a{sv} (String_Variant_Map)
A dictionary mapping property names to variant boxed values -

Properties:

HwAddress - +

Properties:

Owner - + x - + (read)
+ The uid of the tunnel owner, or -1 if it has no owner. +
Group - + x - + (read)
+ The gid of the tunnel group, or -1 if it has no owner. +
Mode - s - (read)
- Hardware address of the device. -
Carrier - + The tunnel mode, either "tun" or "tap". +
NoPi - b - (read)
- Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). -
Slaves - - ao - + The tunnel's "TUN_NO_PI" flag; true if no protocol info is + prepended to the tunnel packets. +
VnetHdr - + b - (read)
- Array of object paths representing devices which are currently - slaved to this device. + The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets + include a virtio network header. +
MultiQueue - + b - + (read)
+ The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to + the tap device multiple times, for multiple send/receive + queues. +
HwAddress - + s - + (read)
+ Hardware address of the device.
-

org.freedesktop.NetworkManager.Device.Bridge

Interface has no methods.

Signals:

PropertiesChanged ( +

org.freedesktop.NetworkManager.Device.Veth

Interface has no methods.

Signals:

PropertiesChanged ( a{sv}: properties )

Parameters

properties - a{sv} (String_Variant_Map)
A dictionary mapping property names to variant boxed values -

Properties:

HwAddress - - s - - (read)
- Hardware address of the device. -
Carrier - - b - - (read)
- Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). -
Slaves - - ao - +

Properties:

Peer - + o - (read)
- Array of object paths representing devices which are currently - slaved to this device. + The object path of the device's peer.
-

org.freedesktop.NetworkManager.Device.Team

Interface has no methods.

Signals:

PropertiesChanged ( +

org.freedesktop.NetworkManager.Device.Vlan

Interface has no methods.

Signals:

PropertiesChanged ( a{sv}: properties )

Parameters

properties - a{sv} @@ -1303,66 +1365,274 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.b - (read)
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). -
Slaves - - ao - +
Parent - + o - (read)
- Array of object paths representing devices which are currently - slaved to this device. + Object path of the parent device of this VLAN device. +
VlanId - + u - + (read)
+ The VLAN ID of this VLAN interface.
-

org.freedesktop.NetworkManager.Device.Generic

Interface has no methods.

Signals:

PropertiesChanged ( +

org.freedesktop.NetworkManager.Device.Vxlan

Interface has no methods.

Signals:

PropertiesChanged ( a{sv}: properties )

Parameters

properties - a{sv} (String_Variant_Map)
A dictionary mapping property names to variant boxed values -

Properties:

HwAddress - +

Properties:

Parent - + o - + (read)
+ The object path of the parent device (if the VXLAN is not + purely internal to this host). +
HwAddress - s - (read)
Hardware address of the device. -
TypeDescription - +
Id - + u - + (read)
+ The VXLAN Network Identifier (VNI). +
Group - s - (read)
- A (non-localized) description of the interface type, if known. + The IP (v4 or v6) multicast group used to communicate with other physical + hosts on this VXLAN. +
Local - + s - + (read)
+ The local IPv4 or IPv6 address to use when sending VXLAN packets to other + physical hosts. +
Tos - + y - + (read)
+ The value to use in the IP ToS field for VXLAN packets sent to + other physical hosts. +
Ttl - + y - + (read)
+ The value to use in the IP TTL field for VXLAN packets sent to + other physical hosts. +
Learning - + b - + (read)
+ True if the VXLAN dynamically learns remote IP addresses. +
Ageing - + u - + (read)
+ The interval in seconds at which the kernel purges stale + cached addresses. +
Limit - + u - + (read)
+ The maximum number of entries that can be added to the VXLAN's + forwarding table. +
DstPort - + q - + (read)
+ Destination port for outgoing VXLAN packets. +
SrcPortMin - + q - + (read)
+ The lowest source port number to use for outgoing VXLAN packets. +
SrcPortMax - + q - + (read)
+ The highest source port number to use for outgoing VXLAN packets. +
Proxy - + b - + (read)
+ True if the VXLAN is implementing DOVE ARP proxying for remote + clients. +
Rsc - + b - + (read)
+ True if the VXLAN is implementing DOVE route short-circuiting + of known remote IP addresses. +
L2miss - + b - + (read)
+ True if the VXLAN will emit netlink notifications of L2 switch + misses. +
L3miss - + b - + (read)
+ True if the VXLAN will emit netlink notifications of L3 switch + misses.
-

org.freedesktop.NetworkManager.Device.Vlan

Interface has no methods.

Signals:

PropertiesChanged ( +

org.freedesktop.NetworkManager.Device.Wireless

Methods:

GetAccessPoints ( + + ) → + ao

+ DEPRECATED. Get the list of access points visible to this device. Note + that this list does not include access points which hide their SSID. To + retrieve a list of all access points (including hidden ones) use the + GetAllAccessPoints() method. +

Returns

access_points - + ao
+ List of access point object paths. +

GetAllAccessPoints ( + + ) → + ao

+ Get the list of all access points visible to this device, including + hidden ones for which the SSID is not yet known. +

Returns

access_points - + ao
+ List of access point object paths. +

RequestScan ( + a{sv}: options + ) → + nothing

+ Request the device to scan +

Parameters

options - + a{sv}
+ Options of scan. + Currently 'ssids' option with value of "aay" type is supported. +

Signals:

PropertiesChanged ( a{sv}: properties - )

Parameters

properties - + )
+ Emitted when the wireless device's properties changed. +

Parameters

properties - a{sv} (String_Variant_Map)
- A dictionary mapping property names to variant boxed values + A dictionary containing the FIXME: check changed parameters. +

AccessPointAdded ( + o: access_point + )

+ Emitted when a new access point is found by the device. +

Parameters

access_point - + o
+ The object path of the newly found access point. +

AccessPointRemoved ( + o: access_point + )

+ Emitted when an access point disappears from view of the device. +

Parameters

access_point - + o
+ The object path of the access point that has disappeared.

Properties:

HwAddress - s - (read)
- Hardware address of the device. -
Carrier - - b - + The active hardware address of the device. +
PermHwAddress - + s - (read)
- Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). -
Parent - + The permanent hardware address of the device. +
Mode - + u - + (read) + (NM_802_11_MODE) +
+ The operating mode of the wireless device. +
Bitrate - + u - + (read)
+ The bit rate currently used by the wireless device, in kilobits/second (Kb/s). +
AccessPoints - + ao - + (read)
+ List of object paths of access point visible to this wireless device. +
ActiveAccessPoint - o - (read)
- Object path of the parent device of this VLAN device. -
VlanId - + Object path of the access point currently used by the wireless device. +
WirelessCapabilities - u - - (read)
- The VLAN ID of this VLAN interface. -
+ (read) + (NM_802_11_DEVICE_CAP) +
+ The capabilities of the wireless device. +

Sets of flags:

NM_802_11_DEVICE_CAP

+ Flags describing the capabilities of a wireless device. +
NM_802_11_DEVICE_CAP_NONE = 0x0
Null capability - syntactic sugar for no capabilities supported. Do not AND this with other capabilities!
NM_802_11_DEVICE_CAP_CIPHER_WEP40 = 0x1
The device supports the 40-bit WEP cipher.
NM_802_11_DEVICE_CAP_CIPHER_WEP104 = 0x2
The device supports the 104-bit WEP cipher.
NM_802_11_DEVICE_CAP_CIPHER_TKIP = 0x4
The device supports the TKIP cipher.
NM_802_11_DEVICE_CAP_CIPHER_CCMP = 0x8
The device supports the CCMP cipher.
NM_802_11_DEVICE_CAP_WPA = 0x10
The device supports the WPA encryption/authentication protocol.
NM_802_11_DEVICE_CAP_RSN = 0x20
The device supports the RSN encryption/authentication protocol.
NM_802_11_DEVICE_CAP_AP = 0x40
The device supports Access Point mode.
NM_802_11_DEVICE_CAP_ADHOC = 0x80
The device supports Ad-Hoc mode.
NM_802_11_DEVICE_CAP_FREQ_VALID = 0x100
+ The device properly reports information about supported + frequencies and thus both NM_802_11_DEVICE_CAP_FREQ_2GHZ and + NM_802_11_DEVICE_CAP_FREQ_5GHZ are valid. +
NM_802_11_DEVICE_CAP_FREQ_2GHZ = 0x200
+ The device supports 2.4GHz frequencies. +
NM_802_11_DEVICE_CAP_FREQ_5GHZ = 0x400
+ The device supports 5GHz frequencies. +
-

org.freedesktop.NetworkManager.Device.Adsl

Interface has no methods.

Signals:

PropertiesChanged ( +

org.freedesktop.NetworkManager.Device.WiMax

Methods:

GetNspList ( + + ) → + ao

+ Get the list of NSPs visible to this device. +

Returns

nsps - + ao
+ List of NSP object paths +

Signals:

PropertiesChanged ( a{sv}: properties - )

Parameters

properties - + )
+ Emitted when the WiMax device's properties changed. +

Parameters

properties - a{sv} (String_Variant_Map)
- A dictionary mapping property names to variant boxed values -

Properties:

Carrier - - b - + A dictionary mapping property names to variant boxed values. +

NspAdded ( + o: nsp + )

+ Emitted when a new NSP is found by the device. +

Parameters

nsp - + o
+ The object path of the newly found NSP. +

NspRemoved ( + o: nsp + )

+ Emitted when an NSP disappears from view of the device. +

Parameters

nsp - + o
+ The object path of the NSP that has disappeared. +

Properties:

Nsps - + ao - (read)
- Indicates whether the physical carrier is found. + List of object paths of Network Service Providers (NSPs) visible to this + WiMAX device. +
HwAddress - + s - + (read)
+ Hardware address of the device. +
CenterFrequency - + u - + (read)
+ Center frequency (in KHz) of the radio channel the device is using to + communicate with the network when connected. Has no meaning when the + device is not connected. +
Rssi - + i - + (read)
+ RSSI of the current radio link in dBm. This value indicates how strong + the raw received RF signal from the base station is, but does not + indicate the overall quality of the radio link. Has no meaning when the + device is not connected. +
Cinr - + i - + (read)
+ CINR (Carrier to Interference + Noise Ratio) of the current radio link + in dB. CINR is a more accurate measure of radio link quality. Has no + meaning when the device is not connected. +
TxPower - + i - + (read)
+ Average power of the last burst transmitted by the device, in units of + 0.5 dBm. i.e. a TxPower of -11 represents an actual device TX power of + -5.5 dBm. Has no meaning when the device is not connected. +
Bsid - + s - + (read)
+ The ID of the serving base station as received from the network. Has + no meaning when the device is not connected. +
ActiveNsp - + o - + (read)
+ Object path of the NSP currently used by the WiMax device.

org.freedesktop.NetworkManager.WiMax.Nsp

Interface has no methods.

Signals:

PropertiesChanged ( @@ -1776,6 +2046,15 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.Interface has no methods.

Signals:

PropertiesChanged ( a{sv}: properties )

Parameters

properties - @@ -2481,7 +2760,7 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.Index

Index of interfaces

Index of types