org.freedesktop.NetworkManagerorg.freedesktop.NetworkManagerorg.freedesktop.NetworkManagerMethods
Reload (IN u flags);
GetDevices (OUT ao devices);
GetAllDevices (OUT ao devices);
GetDeviceByIpIface (IN s iface,
OUT o device);
ActivateConnection (IN o connection,
IN o device,
IN o specific_object,
OUT o active_connection);
AddAndActivateConnection (IN a{sa{sv}} connection,
IN o device,
IN o specific_object,
OUT o path,
OUT o active_connection);
DeactivateConnection (IN o active_connection);
Sleep (IN b sleep);
Enable (IN b enable);
GetPermissions (OUT a{ss} permissions);
SetLogging (IN s level,
IN s domains);
GetLogging (OUT s level,
OUT s domains);
CheckConnectivity (OUT u connectivity);
state (OUT u state);
CheckpointCreate (IN ao devices,
IN u rollback_timeout,
IN u flags,
OUT o checkpoint);
CheckpointDestroy (IN o checkpoint);
CheckpointRollback (IN o checkpoint,
OUT a{su} result);
Signals
CheckPermissions ();
StateChanged (u state);
PropertiesChanged (a{sv} properties);
DeviceAdded (o device_path);
DeviceRemoved (o device_path);
Properties
Devices readable ao
AllDevices readable ao
NetworkingEnabled readable b
WirelessEnabled readwrite b
WirelessHardwareEnabled readable b
WwanEnabled readwrite b
WwanHardwareEnabled readable b
WimaxEnabled readwrite b
WimaxHardwareEnabled readable b
ActiveConnections readable ao
PrimaryConnection readable o
PrimaryConnectionType readable s
Metered readable u
ActivatingConnection readable o
Startup readable b
Version readable s
Capabilities readable au
State readable u
Connectivity readable u
GlobalDnsConfiguration readwrite a{sv}
DescriptionMethod DetailsThe Reload() methodorg.freedesktop.NetworkManager.Reload()
Reload (IN u flags);
Reload NetworkManager's configuration and perform certain updates, like flushing a cache or
rewriting external state to disk. This is similar to sending SIGHUP to NetworkManager but it
allows for more fine-grained control over what to reload (see flags). It also allows
non-root access via PolicyKit and contrary to signals it is synchronous.
No flags (0x00) means to reload everything that is supported which is identical to
sending a SIGHUP.
(0x01) means to reload the NetworkManager.conf configuration from disk. Note that this
does not include connections, which can be reloaded via Setting's ReloadConnections.
(0x02) means to update DNS configuration, which usually involves writing /etc/resolv.conf
anew.
(0x04) means to restart the DNS plugin. This is for example useful when using
dnsmasq plugin, which uses additional configuration in /etc/NetworkManager/dnsmasq.d.
If you edit those files, you can restart the DNS plugin. This action shortly interrupts
name resolution.
Note that flags may affect each other. For example, restarting the DNS plugin (0x04)
implicitly updates DNS too (0x02). Or when reloading the configuration (0x01), changes
to DNS setting also cause a DNS update (0x02). However, (0x01) does not involve restarting
the DNS plugin (0x04) or update resolv.conf (0x02), unless the DNS related configuration
changes in NetworkManager.conf.
IN u flags:optional flags to specify which parts shall be reloaded.The GetDevices() methodorg.freedesktop.NetworkManager.GetDevices()
GetDevices (OUT ao devices);
Get the list of realized network devices.
OUT ao devices:List of object paths of network devices known to the system. This list does not include device placeholders (see GetAllDevices()).The GetAllDevices() methodorg.freedesktop.NetworkManager.GetAllDevices()
GetAllDevices (OUT ao devices);
Get the list of all network 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).The GetDeviceByIpIface() methodorg.freedesktop.NetworkManager.GetDeviceByIpIface()
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.
IN s iface:Interface name of the device to find.OUT o device:Object path of the network device.The ActivateConnection() methodorg.freedesktop.NetworkManager.ActivateConnection()
ActivateConnection (IN o connection,
IN o device,
IN o specific_object,
OUT o active_connection);
Activate a connection using the supplied device.
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.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.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.OUT o active_connection:The path of the active connection object representing this active connection.The AddAndActivateConnection() methodorg.freedesktop.NetworkManager.AddAndActivateConnection()
AddAndActivateConnection (IN a{sa{sv}} connection,
IN o device,
IN o specific_object,
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.
IN a{sa{sv}} connection:Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object.IN o device:The object path of device to be activated using the given connection.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.OUT o path:Object path of the new connection that was just added.OUT o active_connection:The path of the active connection object representing this active connection.The DeactivateConnection() methodorg.freedesktop.NetworkManager.DeactivateConnection()
DeactivateConnection (IN o active_connection);
Deactivate an active connection.
IN o active_connection:The currently active connection to deactivate.The Sleep() methodorg.freedesktop.NetworkManager.Sleep()
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.
IN b sleep:Indicates whether the NetworkManager daemon should sleep or wake.The Enable() methodorg.freedesktop.NetworkManager.Enable()
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.
IN b enable:If FALSE, indicates that all networking should be disabled. If TRUE, indicates that NetworkManager should begin managing network devices.The GetPermissions() methodorg.freedesktop.NetworkManager.GetPermissions()
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.
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.The SetLogging() methodorg.freedesktop.NetworkManager.SetLogging()
SetLogging (IN s level,
IN s domains);
Set logging verbosity and which operations are logged.
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.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.The GetLogging() methodorg.freedesktop.NetworkManager.GetLogging()
GetLogging (OUT s level,
OUT s domains);
Get current logging verbosity level and operations domains.
OUT s level:One of [ERR, WARN, INFO, DEBUG, TRACE].OUT s domains:For available domains see SetLogging() call.The CheckConnectivity() methodorg.freedesktop.NetworkManager.CheckConnectivity()
CheckConnectivity (OUT u connectivity);
Re-check the network connectivity state.
OUT u connectivity:(NMConnectivityState) The current connectivity state.The state() methodorg.freedesktop.NetworkManager.state()
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.
OUT u state:NMStateThe CheckpointCreate() methodorg.freedesktop.NetworkManager.CheckpointCreate()
CheckpointCreate (IN ao devices,
IN u rollback_timeout,
IN u flags,
OUT o checkpoint);
devices: a list of device paths for which a checkpoint should be created. An empty list means all devices.
rollback_timeout: the time in seconds until NetworkManager will automatically rollback to the checkpoint. Set to zero for infinite.
flags: optional flags that influence the creation.
checkpoint: on success, returns the path of the checkpoint.
Create a checkpoint of the current networking configuration
for given interfaces. If rollback_timeout is not zero, a
rollback is automatically performed after the given timeout.
IN ao devices:IN u rollback_timeout:IN u flags:OUT o checkpoint:The CheckpointDestroy() methodorg.freedesktop.NetworkManager.CheckpointDestroy()
CheckpointDestroy (IN o checkpoint);
Destroy a previously created checkpoint.
IN o checkpoint:the checkpoint to be destroyed. Set to empty to cancel all pending checkpoints.The CheckpointRollback() methodorg.freedesktop.NetworkManager.CheckpointRollback()
CheckpointRollback (IN o checkpoint,
OUT a{su} result);
Rollback a checkpoint before the timeout is reached.
IN o checkpoint:the checkpoint to be rolled back.OUT a{su} result:on return, a dictionary of devices and results. Devices are represented by their original D-Bus path; each result is a RollbackResult.Signal DetailsThe "CheckPermissions" signalorg.freedesktop.NetworkManager::CheckPermissions
CheckPermissions ();
Emitted when system authorization details change, indicating that clients
may wish to recheck permissions with GetPermissions.
The "StateChanged" signalorg.freedesktop.NetworkManager::StateChanged
StateChanged (u state);
NetworkManager's state changed.
u state:(NMState) The new state of NetworkManager.The "PropertiesChanged" signalorg.freedesktop.NetworkManager::PropertiesChanged
PropertiesChanged (a{sv} properties);
DEPRECATED. Use the standard "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" instead which exists since version NetworkManager 1.2.0.
a{sv} properties:The changed properties.The "DeviceAdded" signalorg.freedesktop.NetworkManager::DeviceAdded
DeviceAdded (o device_path);
A device was added to the system
o device_path:The object path of the newly added device.The "DeviceRemoved" signalorg.freedesktop.NetworkManager::DeviceRemoved
DeviceRemoved (o device_path);
A device was removed from the system, and is no longer available.
o device_path:The object path of the device that was just removed.Property DetailsThe "Devices" propertyorg.freedesktop.NetworkManager:Devices
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 "AllDevices" propertyorg.freedesktop.NetworkManager:AllDevices
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 "NetworkingEnabled" propertyorg.freedesktop.NetworkManager:NetworkingEnabled
NetworkingEnabled readable b
Indicates if overall networking is currently enabled or not. See the
Enable() method.
The "WirelessEnabled" propertyorg.freedesktop.NetworkManager:WirelessEnabled
WirelessEnabled readwrite b
Indicates if wireless is currently enabled or not.
The "WirelessHardwareEnabled" propertyorg.freedesktop.NetworkManager:WirelessHardwareEnabled
WirelessHardwareEnabled readable b
Indicates if the wireless hardware is currently enabled, i.e. the state of
the RF kill switch.
The "WwanEnabled" propertyorg.freedesktop.NetworkManager:WwanEnabled
WwanEnabled readwrite b
Indicates if mobile broadband devices are currently enabled or not.
The "WwanHardwareEnabled" propertyorg.freedesktop.NetworkManager:WwanHardwareEnabled
WwanHardwareEnabled readable b
Indicates if the mobile broadband hardware is currently enabled, i.e. the
state of the RF kill switch.
The "WimaxEnabled" propertyorg.freedesktop.NetworkManager:WimaxEnabled
WimaxEnabled readwrite b
Indicates if WiMAX devices are currently enabled or not.
The "WimaxHardwareEnabled" propertyorg.freedesktop.NetworkManager:WimaxHardwareEnabled
WimaxHardwareEnabled readable b
Indicates if the WiMAX hardware is currently enabled, i.e. the state of
the RF kill switch.
The "ActiveConnections" propertyorg.freedesktop.NetworkManager:ActiveConnections
ActiveConnections readable ao
List of active connection object paths.
The "PrimaryConnection" propertyorg.freedesktop.NetworkManager:PrimaryConnection
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 "PrimaryConnectionType" propertyorg.freedesktop.NetworkManager:PrimaryConnectionType
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 "Metered" propertyorg.freedesktop.NetworkManager:Metered
Metered readable u
Indicates whether the connectivity is metered. This is equivalent to the
metered property of the device associated with the primary connection.
Returns: NMMetered
The "ActivatingConnection" propertyorg.freedesktop.NetworkManager:ActivatingConnection
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 "Startup" propertyorg.freedesktop.NetworkManager:Startup
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.
The "Version" propertyorg.freedesktop.NetworkManager:Version
Version readable s
NetworkManager version.
The "Capabilities" propertyorg.freedesktop.NetworkManager:Capabilities
Capabilities readable au
The current set of capabilities. See NMCapability for currently
defined capability numbers. The array is guaranteed to
be sorted in ascending order without duplicates.
The "State" propertyorg.freedesktop.NetworkManager:State
State readable u
The overall state of the NetworkManager daemon.
Returns: NMState
The "Connectivity" propertyorg.freedesktop.NetworkManager:Connectivity
Connectivity readable u
The network connectivity state.
Returns: NMConnectivityState
The "GlobalDnsConfiguration" propertyorg.freedesktop.NetworkManager:GlobalDnsConfiguration
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.