From 2bfb3eb7d0323e69affca154395f51d8b577414d Mon Sep 17 00:00:00 2001 From: Michael Biebl Date: Wed, 6 Apr 2016 00:46:19 +0200 Subject: Imported Upstream version 1.1.93 --- .../html/gdbus-org.freedesktop.NetworkManager.html | 215 ++++++++++++++------- 1 file changed, 150 insertions(+), 65 deletions(-) (limited to 'docs/api/html/gdbus-org.freedesktop.NetworkManager.html') diff --git a/docs/api/html/gdbus-org.freedesktop.NetworkManager.html b/docs/api/html/gdbus-org.freedesktop.NetworkManager.html index ec168881..d028c602 100644 --- a/docs/api/html/gdbus-org.freedesktop.NetworkManager.html +++ b/docs/api/html/gdbus-org.freedesktop.NetworkManager.html @@ -102,11 +102,12 @@

Method Details

-

The GetDevices() method

+

The GetDevices() method

 GetDevices (OUT ao devices);
-

Get the list of realized network devices.

+

Get the list of realized network devices. +

@@ -114,17 +115,18 @@ GetDevices (OUT ao devices); - +

OUT ao devices:

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

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

The GetAllDevices() method

+

The GetAllDevices() method

 GetAllDevices (OUT ao devices);
-

Get the list of all network devices.

+

Get the list of all network devices. +

@@ -132,18 +134,21 @@ GetAllDevices (OUT ao devices); - +

OUT ao devices:

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

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

The GetDeviceByIpIface() method

+

The GetDeviceByIpIface() method

 GetDeviceByIpIface (IN  s iface,
                     OUT o device);
-

Return the object path of the network device referenced by its IP interface name. Note that some devices (usually modems) only have an IP interface name when they are connected.

+

Return the object path of the network device referenced by its IP + interface name. Note that some devices (usually modems) only have an IP + interface name when they are connected. +

@@ -163,14 +168,15 @@ GetDeviceByIpIface (IN s iface,
-

The ActivateConnection() method

+

The ActivateConnection() method

 ActivateConnection (IN  o connection,
                     IN  o device,
                     IN  o specific_object,
                     OUT o active_connection);
-

Activate a connection using the supplied device.

+

Activate a connection using the supplied device. +

@@ -179,15 +185,15 @@ ActivateConnection (IN o connection, - + - + - + @@ -198,7 +204,7 @@ ActivateConnection (IN o connection,
-

The AddAndActivateConnection() method

+

The AddAndActivateConnection() method

 AddAndActivateConnection (IN  a{sa{sv}} connection,
                           IN  o         device,
@@ -206,7 +212,11 @@ AddAndActivateConnection (IN  a{sa{sv}} connection,
                           OUT o         path,
                           OUT o         active_connection);
-

Adds a new connection using the given details (if any) as a template (automatically filling in missing settings with the capabilities of the given device and specific object), then activate the new connection. Cannot be used for VPN connections at this time.

+

Adds a new connection using the given details (if any) as a template + (automatically filling in missing settings with the capabilities of the + given device and specific object), then activate the new connection. + Cannot be used for VPN connections at this time. +

IN o connection:

The connection to activate. If "/" is given, a valid device path must be given, and NetworkManager picks the best connection to activate for the given device. VPN connections must always pass a valid connection path.

The connection to activate. If "/" is given, a valid device path must be given, and NetworkManager picks the best connection to activate for the given device. VPN connections must always pass a valid connection path.

IN o device:

The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use.

The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use.

IN o specific_object:

The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device.

The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device.

OUT o active_connection:
@@ -215,7 +225,7 @@ AddAndActivateConnection (IN a{sa{sv}} connection, - + @@ -223,7 +233,7 @@ AddAndActivateConnection (IN a{sa{sv}} connection, - + @@ -238,11 +248,12 @@ AddAndActivateConnection (IN a{sa{sv}} connection,
-

The DeactivateConnection() method

+

The DeactivateConnection() method

 DeactivateConnection (IN  o active_connection);
-

Deactivate an active connection.

+

Deactivate an active connection. +

IN a{sa{sv}} connection:

Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object.

Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object.

IN o device:

IN o specific_object:

The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection.

The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection.

OUT o path:
@@ -256,11 +267,15 @@ DeactivateConnection (IN o active_connection);
-

The Sleep() method

+

The Sleep() method

 Sleep (IN  b sleep);
-

Control the NetworkManager daemon's sleep state. When asleep, all interfaces that it manages are deactivated. When awake, devices are available to be activated. This command should not be called directly by users or clients; it is intended for system suspend/resume tracking.

+

Control the NetworkManager daemon's sleep state. When asleep, all + interfaces that it manages are deactivated. When awake, devices are + available to be activated. This command should not be called directly by + users or clients; it is intended for system suspend/resume tracking. +

@@ -274,11 +289,16 @@ Sleep (IN b sleep);
-

The Enable() method

+

The Enable() method

 Enable (IN  b enable);
-

Control whether overall networking is enabled or disabled. When disabled, all interfaces that NM manages are deactivated. When enabled, all managed interfaces are re-enabled and available to be activated. This command should be used by clients that provide to users the ability to enable/disable all networking.

+

Control whether overall networking is enabled or disabled. When disabled, + all interfaces that NM manages are deactivated. When enabled, all managed + interfaces are re-enabled and available to be activated. This command + should be used by clients that provide to users the ability to + enable/disable all networking. +

@@ -286,17 +306,20 @@ Enable (IN b enable); - +

IN b enable:

If FALSE, indicates that all networking should be disabled. If TRUE, indicates that NetworkManager should begin managing network devices.

If FALSE, indicates that all networking should be disabled. If TRUE, indicates that NetworkManager should begin managing network devices.
-

The GetPermissions() method

+

The GetPermissions() method

 GetPermissions (OUT a{ss} permissions);
-

Returns the permissions a caller has for various authenticated operations that NetworkManager provides, like Enable/Disable networking, changing WiFi, WWAN, and WiMAX state, etc.

+

Returns the permissions a caller has for various authenticated operations + that NetworkManager provides, like Enable/Disable networking, changing + WiFi, WWAN, and WiMAX state, etc. +

@@ -304,18 +327,19 @@ GetPermissions (OUT a{ss} permissions); - +

OUT a{ss} permissions:

Dictionary of available permissions and results. Each permission is represented by a name (ie "org.freedesktop.NetworkManager.Foobar") and each result is one of the following values: "yes" (the permission is available), "auth" (the permission is available after a successful authentication), or "no" (the permission is denied). Clients may use these values in the UI to indicate the ability to perform certain operations.

Dictionary of available permissions and results. Each permission is represented by a name (ie "org.freedesktop.NetworkManager.Foobar") and each result is one of the following values: "yes" (the permission is available), "auth" (the permission is available after a successful authentication), or "no" (the permission is denied). Clients may use these values in the UI to indicate the ability to perform certain operations.
-

The SetLogging() method

+

The SetLogging() method

 SetLogging (IN  s level,
             IN  s domains);
-

Set logging verbosity and which operations are logged.

+

Set logging verbosity and which operations are logged. +

@@ -324,23 +348,24 @@ SetLogging (IN s level, - + - +

IN s level:

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.

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.

IN s domains:

A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations related to that domain. Available domains are: [PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. In addition to these domains, the following special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains should log at a different level from the default by appending a colon (':') and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the log level is changed but the current set of log domains remains unchanged.

A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations related to that domain. Available domains are: [PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. In addition to these domains, the following special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains should log at a different level from the default by appending a colon (':') and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the log level is changed but the current set of log domains remains unchanged.
-

The GetLogging() method

+

The GetLogging() method

 GetLogging (OUT s level,
             OUT s domains);
-

Get current logging verbosity level and operations domains.

+

Get current logging verbosity level and operations domains. +

@@ -353,18 +378,19 @@ GetLogging (OUT s level, - +

OUT s domains:

For available domains see SetLogging() call.

For available domains see SetLogging() call.
-

The CheckConnectivity() method

+

The CheckConnectivity() method

 CheckConnectivity (OUT u connectivity);
-

Re-check the network connectivity state.

+

Re-check the network connectivity state. +

@@ -372,17 +398,19 @@ CheckConnectivity (OUT u connectivity); - +

OUT u connectivity:

The current connectivity state.

(NMConnectivityState) The current connectivity state.
-

The state() method

+

The state() method

 state (OUT u state);
-

The overall networking state as determined by the NetworkManager daemon, based on the state of network devices under it's management.

+

The overall networking state as determined by the NetworkManager daemon, + based on the state of network devices under it's management. +

@@ -390,7 +418,7 @@ state (OUT u state); - +

OUT u state:

NMState
@@ -402,7 +430,9 @@ state (OUT u state); 
 CheckPermissions ();
-

Emitted when system authorization details change, indicating that clients may wish to recheck permissions with GetPermissions.

+

Emitted when system authorization details change, indicating that clients + may wish to recheck permissions with GetPermissions. +

@@ -410,7 +440,8 @@ CheckPermissions (); 
 StateChanged (u state);
-

NetworkManager's state changed.

+

NetworkManager's state changed. +

@@ -418,7 +449,7 @@ StateChanged (u state); - +

u state:

The new state of NetworkManager.

(NMState) The new state of NetworkManager.
@@ -428,7 +459,8 @@ StateChanged (u state); 
 PropertiesChanged (a{sv} properties);
-

NetworkManager's properties changed.

+

NetworkManager's properties changed. +

@@ -446,7 +478,8 @@ PropertiesChanged (a{sv} properties); 
 DeviceAdded (o device_path);
-

A device was added to the system

+

A device was added to the system +

@@ -464,7 +497,8 @@ DeviceAdded (o device_path); 
 DeviceRemoved (o device_path);
-

A device was removed from the system, and is no longer available.

+

A device was removed from the system, and is no longer available. +

@@ -484,7 +518,10 @@ DeviceRemoved (o device_path); 
 Devices  readable   ao
-

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

+

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

@@ -492,7 +529,10 @@ Devices readable ao 
 AllDevices  readable   ao
-

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.

+

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

@@ -500,7 +540,9 @@ AllDevices readable ao 
 NetworkingEnabled  readable   b
-

Indicates if overall networking is currently enabled or not. See the Enable() method.

+

Indicates if overall networking is currently enabled or not. See the + Enable() method. +

@@ -508,7 +550,8 @@ NetworkingEnabled readable b 
 WirelessEnabled  readwrite  b
-

Indicates if wireless is currently enabled or not.

+

Indicates if wireless is currently enabled or not. +

@@ -516,7 +559,9 @@ WirelessEnabled readwrite b 
 WirelessHardwareEnabled  readable   b
-

Indicates if the wireless hardware is currently enabled, i.e. the state of the RF kill switch.

+

Indicates if the wireless hardware is currently enabled, i.e. the state of + the RF kill switch. +

@@ -524,7 +569,8 @@ WirelessHardwareEnabled readable b 
 WwanEnabled  readwrite  b
-

Indicates if mobile broadband devices are currently enabled or not.

+

Indicates if mobile broadband devices are currently enabled or not. +

@@ -532,7 +578,9 @@ WwanEnabled readwrite b 
 WwanHardwareEnabled  readable   b
-

Indicates if the mobile broadband hardware is currently enabled, i.e. the state of the RF kill switch.

+

Indicates if the mobile broadband hardware is currently enabled, i.e. the + state of the RF kill switch. +

@@ -540,7 +588,8 @@ WwanHardwareEnabled readable b 
 WimaxEnabled  readwrite  b
-

Indicates if WiMAX devices are currently enabled or not.

+

Indicates if WiMAX devices are currently enabled or not. +

@@ -548,7 +597,9 @@ WimaxEnabled readwrite b 
 WimaxHardwareEnabled  readable   b
-

Indicates if the WiMAX hardware is currently enabled, i.e. the state of the RF kill switch.

+

Indicates if the WiMAX hardware is currently enabled, i.e. the state of + the RF kill switch. +

@@ -556,7 +607,8 @@ WimaxHardwareEnabled readable b 
 ActiveConnections  readable   ao
-

List of active connection object paths.

+

List of active connection object paths. +

@@ -564,7 +616,12 @@ ActiveConnections readable ao 
 PrimaryConnection  readable   o
-

The object path of the "primary" active connection being used to access the network. In particular, if there is no VPN active, or the VPN does not have the default route, then this indicates the connection that has the default route. If there is a VPN active with the default route, then this indicates the connection that contains the route to the VPN endpoint.

+

The object path of the "primary" active connection being used to access + the network. In particular, if there is no VPN active, or the VPN does not + have the default route, then this indicates the connection that has the + default route. If there is a VPN active with the default route, then this + indicates the connection that contains the route to the VPN endpoint. +

@@ -572,7 +629,10 @@ PrimaryConnection readable o 
 PrimaryConnectionType  readable   s
-

The connection type of the "primary" active connection being used to access the network. This is the same as the Type property on the object indicated by PrimaryConnection.

+

The connection type of the "primary" active connection being used to + access the network. This is the same as the Type property on the object + indicated by PrimaryConnection. +

@@ -580,7 +640,11 @@ PrimaryConnectionType readable s 
 Metered  readable   u
-

Indicates whether the connectivity is metered. This is equivalent to the metered property of the device associated with the primary connection.

+

Indicates whether the connectivity is metered. This is equivalent to the + metered property of the device associated with the primary connection. +

+

Returns: NMMetered +

@@ -588,7 +652,10 @@ Metered readable u 
 ActivatingConnection  readable   o
-

The object path of an active connection that is currently being activated and which is expected to become the new PrimaryConnection when it finishes activating.

+

The object path of an active connection that is currently being activated + and which is expected to become the new PrimaryConnection when it finishes + activating. +

@@ -596,7 +663,10 @@ ActivatingConnection readable o 
 Startup  readable   b
-

Indicates whether NM is still starting up; this becomes FALSE when NM has finished attempting to activate every connection that it might be able to activate at startup.

+

Indicates whether NM is still starting up; this becomes FALSE when NM has + finished attempting to activate every connection that it might be able to + activate at startup. +

@@ -604,7 +674,8 @@ Startup readable b 
 Version  readable   s
-

NetworkManager version.

+

NetworkManager version. +

@@ -612,7 +683,10 @@ Version readable s 
 State  readable   u
-

The overall state of the NetworkManager daemon.

+

The overall state of the NetworkManager daemon. +

+

Returns: NMState +

@@ -620,7 +694,10 @@ State readable u 
 Connectivity  readable   u
-

The network connectivity state.

+

The network connectivity state. +

+

Returns: NMConnectivityState +

@@ -628,7 +705,15 @@ Connectivity readable u 
 GlobalDnsConfiguration  readwrite  a{sv}
-

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.

+

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

-- cgit 1.3.0-6-gf8a5