Warning, /frameworks/networkmanager-qt/src/dbus/introspection/org.freedesktop.NetworkManager.xml is written in an unsupported language. File is not indexed.

0001 <?xml version="1.0" encoding="UTF-8"?>
0002 <node name="/org/freedesktop/NetworkManager">
0003   <interface name="org.freedesktop.NetworkManager">
0004     <annotation name="org.gtk.GDBus.C.Name" value="Manager"/>
0005 
0006     <!--
0007         Reload:
0008         @flags: optional flags to specify which parts shall be reloaded.
0009 
0010         Reload NetworkManager's configuration and perform certain updates, like flushing a cache or
0011         rewriting external state to disk. This is similar to sending SIGHUP to NetworkManager but it
0012         allows for more fine-grained control over what to reload (see @flags). It also allows
0013         non-root access via PolicyKit and contrary to signals it is synchronous.
0014 
0015         No flags (0x00) means to reload everything that is supported which is identical to
0016         sending a SIGHUP.
0017         (0x01) means to reload the NetworkManager.conf configuration from disk. Note that this
0018         does not include connections, which can be reloaded via Setting's ReloadConnections.
0019         (0x02) means to update DNS configuration, which usually involves writing /etc/resolv.conf
0020         anew.
0021         (0x04) means to restart the DNS plugin. This is for example useful when using
0022         dnsmasq plugin, which uses additional configuration in /etc/NetworkManager/dnsmasq.d.
0023         If you edit those files, you can restart the DNS plugin. This action shortly interrupts
0024         name resolution.
0025         Note that flags may affect each other. For example, restarting the DNS plugin (0x04)
0026         implicitly updates DNS too (0x02). Or when reloading the configuration (0x01), changes
0027         to DNS setting also cause a DNS update (0x02). However, (0x01) does not involve restarting
0028         the DNS plugin (0x04) or update resolv.conf (0x02), unless the DNS related configuration
0029         changes in NetworkManager.conf.
0030     -->
0031     <method name="Reload">
0032       <arg name="flags" type="u" direction="in"/>
0033     </method>
0034 
0035     <!--
0036         GetDevices:
0037         @devices: List of object paths of network devices known to the system. This list does not include device placeholders (see GetAllDevices()).
0038 
0039         Get the list of realized network devices.
0040     -->
0041     <method name="GetDevices">
0042       <arg name="devices" type="ao" direction="out"/>
0043     </method>
0044 
0045     <!--
0046         GetAllDevices:
0047         @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).
0048 
0049         Get the list of all network devices.
0050     -->
0051     <method name="GetAllDevices">
0052       <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_manager_get_all_devices"/>
0053       <arg name="devices" type="ao" direction="out"/>
0054     </method>
0055 
0056     <!--
0057         GetDeviceByIpIface:
0058         @iface: Interface name of the device to find.
0059         @device: Object path of the network device.
0060 
0061         Return the object path of the network device referenced by its IP
0062         interface name. Note that some devices (usually modems) only have an IP
0063         interface name when they are connected.
0064     -->
0065     <method name="GetDeviceByIpIface">
0066       <arg name="iface" type="s" direction="in"/>
0067       <arg name="device" type="o" direction="out"/>
0068     </method>
0069 
0070     <!--
0071         ActivateConnection:
0072         @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.
0073         @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.
0074         @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.
0075         @active_connection: The path of the active connection object representing this active connection.
0076 
0077         Activate a connection using the supplied device.
0078     -->
0079     <method name="ActivateConnection">
0080       <arg name="connection" type="o" direction="in"/>
0081       <arg name="device" type="o" direction="in"/>
0082       <arg name="specific_object" type="o" direction="in"/>
0083       <arg name="active_connection" type="o" direction="out"/>
0084     </method>
0085 
0086     <!--
0087         AddAndActivateConnection:
0088         @connection: Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object.
0089         @device: The object path of device to be activated using the given connection.
0090         @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.
0091         @path: Object path of the new connection that was just added.
0092         @active_connection: The path of the active connection object representing this active connection.
0093 
0094         Adds a new connection using the given details (if any) as a template
0095         (automatically filling in missing settings with the capabilities of the
0096         given device and specific object), then activate the new connection.
0097         Cannot be used for VPN connections at this time.
0098     -->
0099     <method name="AddAndActivateConnection">
0100       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMapMap"/>
0101       <arg name="connection" type="a{sa{sv}}" direction="in"/>
0102       <arg name="device" type="o" direction="in"/>
0103       <arg name="specific_object" type="o" direction="in"/>
0104       <arg name="path" type="o" direction="out"/>
0105       <arg name="active_connection" type="o" direction="out"/>
0106     </method>
0107 
0108     <!--
0109         AddAndActivateConnection2:
0110         @connection: Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object.
0111         @device: The object path of device to be activated using the given connection.
0112         @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 Wi-Fi 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.
0113         @options: Further options for the method call.
0114         @path: Object path of the new connection that was just added.
0115         @active_connection: The path of the active connection object representing this active connection.
0116         @result: a dictionary of additional output arguments for future extension. Currently not additional
0117           output arguments are supported.
0118 
0119         Adds a new connection using the given details (if any) as a template
0120         (automatically filling in missing settings with the capabilities of the
0121         given device and specific object), then activate the new connection.
0122         Cannot be used for VPN connections at this time.
0123 
0124         This method extends AddAndActivateConnection to allow passing further
0125         parameters. At this time the following options are supported:
0126 
0127          * persist: A string value of either "disk" (default), "memory" or "volatile". If "memory" is passed, the connection will not be saved to disk. If "volatile" is passed, the connection will not be saved to disk and will be destroyed when disconnected.
0128          * bind-activation: Bind the activation lifetime. Set to "dbus-name" to automatically disconnect when the requesting process disappears from the bus. The default of "none" means the connection is kept activated normally.
0129     -->
0130     <method name="AddAndActivateConnection2">
0131       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="NMVariantMapMap"/>
0132       <arg name="connection" type="a{sa{sv}}" direction="in"/>
0133       <arg name="device" type="o" direction="in"/>
0134       <arg name="specific_object" type="o" direction="in"/>
0135       <arg name="options" type="a{sv}" direction="in"/>
0136       <arg name="path" type="o" direction="out"/>
0137       <arg name="active_connection" type="o" direction="out"/>
0138       <arg name="result" type="a{sv}" direction="out"/>
0139     </method>
0140 
0141     <!--
0142         DeactivateConnection:
0143         @active_connection: The currently active connection to deactivate.
0144 
0145         Deactivate an active connection.
0146     -->
0147     <method name="DeactivateConnection">
0148       <arg name="active_connection" type="o" direction="in"/>
0149     </method>
0150 
0151     <!--
0152         Sleep:
0153         @sleep: Indicates whether the NetworkManager daemon should sleep or wake.
0154 
0155         Control the NetworkManager daemon's sleep state. When asleep, all
0156         interfaces that it manages are deactivated. When awake, devices are
0157         available to be activated. This command should not be called directly by
0158         users or clients; it is intended for system suspend/resume tracking.
0159     -->
0160     <method name="Sleep">
0161       <arg name="sleep" type="b" direction="in"/>
0162     </method>
0163 
0164     <!--
0165         Enable:
0166         @enable: If FALSE, indicates that all networking should be disabled. If TRUE, indicates that NetworkManager should begin managing network devices.
0167 
0168         Control whether overall networking is enabled or disabled. When disabled,
0169         all interfaces that NM manages are deactivated. When enabled, all managed
0170         interfaces are re-enabled and available to be activated. This command
0171         should be used by clients that provide to users the ability to
0172         enable/disable all networking.
0173     -->
0174     <method name="Enable">
0175       <arg name="enable" type="b" direction="in"/>
0176     </method>
0177 
0178     <!--
0179         GetPermissions:
0180         @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.
0181 
0182         Returns the permissions a caller has for various authenticated operations
0183         that NetworkManager provides, like Enable/Disable networking, changing
0184         WiFi, WWAN, and WiMAX state, etc.
0185     -->
0186     <method name="GetPermissions">
0187       <annotation name="org.qtproject.QtDBus.QtTypeName.Out0" value="NMStringMap"/>
0188       <arg name="permissions" type="a{ss}" direction="out"/>
0189     </method>
0190 
0191     <!--
0192         CheckPermissions:
0193 
0194         Emitted when system authorization details change, indicating that clients
0195         may wish to recheck permissions with GetPermissions.
0196     -->
0197     <signal name="CheckPermissions"/>
0198 
0199     <!--
0200         SetLogging:
0201         @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.
0202         @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.
0203 
0204         Set logging verbosity and which operations are logged.
0205     -->
0206     <method name="SetLogging">
0207       <arg name="level" type="s" direction="in"/>
0208       <arg name="domains" type="s" direction="in"/>
0209     </method>
0210 
0211     <!--
0212         GetLogging:
0213         @level: One of [ERR, WARN, INFO, DEBUG, TRACE].
0214         @domains: For available domains see SetLogging() call.
0215 
0216         Get current logging verbosity level and operations domains.
0217     -->
0218     <method name="GetLogging">
0219       <arg name="level" type="s" direction="out"/>
0220       <arg name="domains" type="s" direction="out"/>
0221     </method>
0222 
0223     <!--
0224         CheckConnectivity:
0225         @connectivity: (<link linkend="NMConnectivityState">NMConnectivityState</link>) The current connectivity state.
0226 
0227         Re-check the network connectivity state.
0228     -->
0229     <method name="CheckConnectivity">
0230       <arg name="connectivity" type="u" direction="out"/>
0231     </method>
0232 
0233     <!--
0234         state:
0235         @state: <link linkend="NMState">NMState</link>
0236 
0237         The overall networking state as determined by the NetworkManager daemon,
0238         based on the state of network devices under it's management.
0239     -->
0240     <method name="state">
0241       <arg name="state" type="u" direction="out"/>
0242     </method>
0243 
0244     <!--
0245         CheckpointCreate:
0246 
0247         @devices: a list of device paths for which a checkpoint should be created. An empty list means all devices.
0248         @rollback_timeout: the time in seconds until NetworkManager will automatically rollback to the checkpoint. Set to zero for infinite.
0249         @flags: optional flags that influence the creation.
0250         @checkpoint: on success, returns the path of the checkpoint.
0251 
0252         Create a checkpoint of the current networking configuration
0253         for given interfaces. If @rollback_timeout is not zero, a
0254         rollback is automatically performed after the given timeout.
0255     -->
0256     <method name="CheckpointCreate">
0257       <arg name="devices" type="ao" direction="in"/>
0258       <arg name="rollback_timeout" type="u" direction="in"/>
0259       <arg name="flags" type="u" direction="in"/>
0260       <arg name="checkpoint" type="o" direction="out"/>
0261     </method>
0262 
0263     <!--
0264         CheckpointDestroy:
0265         @checkpoint: the checkpoint to be destroyed. Set to empty to cancel all pending checkpoints.
0266 
0267         Destroy a previously created checkpoint.
0268     -->
0269     <method name="CheckpointDestroy">
0270       <arg name="checkpoint" type="o" direction="in"/>
0271     </method>
0272 
0273     <!--
0274         CheckpointRollback:
0275         @checkpoint: the checkpoint to be rolled back.
0276         @result: on return, a dictionary of devices and results. Devices are represented by their original D-Bus path; each result is a <link linkend="NMRollbackResult">RollbackResult</link>.
0277 
0278         Rollback a checkpoint before the timeout is reached.
0279     -->
0280     <!-- TODO enable and add missing annotation
0281     <method name="CheckpointRollback">
0282       <arg name="checkpoint" type="o" direction="in"/>
0283       <arg name="result" type="a{su}" direction="out" />
0284     </method> -->
0285 
0286     <!--
0287         Devices:
0288 
0289         The list of realized network devices. Realized devices are those which
0290         have backing resources (eg from the kernel or a management daemon like
0291         ModemManager, teamd, etc).
0292     -->
0293     <property name="Devices" type="ao" access="read"/>
0294 
0295     <!--
0296         AllDevices:
0297 
0298         The list of both realized and un-realized network devices. Un-realized
0299         devices are software devices which do not yet have backing resources, but
0300         for which backing resources can be created if the device is activated.
0301     -->
0302     <property name="AllDevices" type="ao" access="read"/>
0303 
0304     <!--
0305         NetworkingEnabled:
0306 
0307         Indicates if overall networking is currently enabled or not. See the
0308         Enable() method.
0309     -->
0310     <property name="NetworkingEnabled" type="b" access="read"/>
0311 
0312     <!--
0313         WirelessEnabled:
0314 
0315         Indicates if wireless is currently enabled or not.
0316     -->
0317     <property name="WirelessEnabled" type="b" access="readwrite"/>
0318 
0319     <!--
0320         WirelessHardwareEnabled:
0321 
0322         Indicates if the wireless hardware is currently enabled, i.e. the state of
0323         the RF kill switch.
0324     -->
0325     <property name="WirelessHardwareEnabled" type="b" access="read"/>
0326 
0327     <!--
0328         WwanEnabled:
0329 
0330         Indicates if mobile broadband devices are currently enabled or not.
0331     -->
0332     <property name="WwanEnabled" type="b" access="readwrite"/>
0333 
0334     <!--
0335         WwanHardwareEnabled:
0336 
0337         Indicates if the mobile broadband hardware is currently enabled, i.e. the
0338         state of the RF kill switch.
0339     -->
0340     <property name="WwanHardwareEnabled" type="b" access="read"/>
0341 
0342     <!--
0343         WimaxEnabled:
0344 
0345         Indicates if WiMAX devices are currently enabled or not.
0346     -->
0347     <property name="WimaxEnabled" type="b" access="readwrite"/>
0348 
0349     <!--
0350         WimaxHardwareEnabled:
0351 
0352         Indicates if the WiMAX hardware is currently enabled, i.e. the state of
0353         the RF kill switch.
0354     -->
0355     <property name="WimaxHardwareEnabled" type="b" access="read"/>
0356 
0357     <!--
0358         ActiveConnections:
0359 
0360         List of active connection object paths.
0361     -->
0362     <property name="ActiveConnections" type="ao" access="read"/>
0363 
0364     <!--
0365         PrimaryConnection:
0366 
0367         The object path of the "primary" active connection being used to access
0368         the network. In particular, if there is no VPN active, or the VPN does not
0369         have the default route, then this indicates the connection that has the
0370         default route. If there is a VPN active with the default route, then this
0371         indicates the connection that contains the route to the VPN endpoint.
0372     -->
0373     <property name="PrimaryConnection" type="o" access="read"/>
0374 
0375     <!--
0376         PrimaryConnectionType:
0377 
0378         The connection type of the "primary" active connection being used to
0379         access the network. This is the same as the Type property on the object
0380         indicated by PrimaryConnection.
0381     -->
0382     <property name="PrimaryConnectionType" type="s" access="read"/>
0383 
0384     <!--
0385         Metered:
0386 
0387         Indicates whether the connectivity is metered. This is equivalent to the
0388         metered property of the device associated with the primary connection.
0389 
0390         Returns: <link linkend="NMMetered">NMMetered</link>
0391     -->
0392     <property name="Metered" type="u" access="read"/>
0393 
0394     <!--
0395         ActivatingConnection:
0396 
0397         The object path of an active connection that is currently being activated
0398         and which is expected to become the new PrimaryConnection when it finishes
0399         activating.
0400     -->
0401     <property name="ActivatingConnection" type="o" access="read"/>
0402 
0403     <!--
0404         Startup:
0405 
0406         Indicates whether NM is still starting up; this becomes FALSE when NM has
0407         finished attempting to activate every connection that it might be able to
0408         activate at startup.
0409     -->
0410     <property name="Startup" type="b" access="read"/>
0411 
0412     <!--
0413         Version:
0414 
0415         NetworkManager version.
0416     -->
0417     <property name="Version" type="s" access="read"/>
0418 
0419     <!--
0420         Capabilities:
0421 
0422         The current set of capabilities. See <link
0423         linkend="NMCapability">NMCapability</link> for currently
0424         defined capability numbers. The array is guaranteed to
0425         be sorted in ascending order without duplicates.
0426     -->
0427     <property name="Capabilities" type="au" access="read">
0428         <annotation name="org.qtproject.QtDBus.QtTypeName" value="UIntList"/>
0429     </property>
0430     <!--
0431         State:
0432 
0433         The overall state of the NetworkManager daemon.
0434 
0435         This takes state of all active connections and the connectivity state into account
0436         to produce a single indicator of the network accessibility status.
0437 
0438         The graphical shells may use this property to provide network connection status
0439         indication and applications may use this to check if Internet connection is
0440         accessible. Shell that is able to cope with captive portals should use the
0441         "Connectivity" property to decide whether to present a captive portal authentication
0442         dialog.
0443 
0444         Returns: <link linkend="NMState">NMState</link>
0445     -->
0446     <property name="State" type="u" access="read"/>
0447 
0448     <!--
0449         StateChanged:
0450         @state: (<link linkend="NMState">NMState</link>) The new state of NetworkManager.
0451 
0452         NetworkManager's state changed.
0453     -->
0454     <signal name="StateChanged">
0455       <arg name="state" type="u"/>
0456     </signal>
0457 
0458     <!--
0459         Connectivity:
0460 
0461         The result of the last connectivity check. The connectivity check is triggered
0462         automatically when a default connection becomes available, periodically and by
0463         calling a CheckConnectivity() method.
0464 
0465         This property is in general useful for the graphical shell to determine whether
0466         the Internet access is being hijacked by an authentication gateway (a "captive
0467         portal"). In such case it would typically present a web browser window to give
0468         the user a chance to authenticate and call CheckConnectivity() when the user
0469         submits a form or dismisses the window.
0470 
0471         To determine the whether the user is able to access the Internet without dealing
0472         with captive portals (e.g. to provide a network connection indicator or disable
0473         controls that require Internet access), the "State" property is more suitable.
0474 
0475         Returns: <link linkend="NMConnectivityState">NMConnectivityState</link>
0476     -->
0477     <property name="Connectivity" type="u" access="read"/>
0478 
0479     <!--
0480         GlobalDnsConfiguration:
0481 
0482         Dictionary of global DNS settings where the key is one of "searches",
0483         "options" and "domains". The values for the "searches" and "options" keys
0484         are string arrays describing the list of search domains and resolver
0485         options, respectively. The value of the "domains" key is a second-level
0486         dictionary, where each key is a domain name, and each key's value is a
0487         third-level dictionary with the keys "servers" and "options". "servers" is
0488         a string array of DNS servers, "options" is a string array of
0489         domain-specific options.
0490     -->
0491     <property name="GlobalDnsConfiguration" type="a{sv}" access="readwrite">
0492         <annotation name="org.qtproject.QtDBus.QtTypeName" value="QVariantMap"/>
0493     </property>
0494     <!--
0495         PropertiesChanged:
0496         @properties: The changed properties.
0497 
0498         DEPRECATED. Use the standard "PropertiesChanged" signal from "org.freedesktop.DBus.Properties" instead which exists since version NetworkManager 1.2.0.
0499     -->
0500     <signal name="PropertiesChanged">
0501       <annotation name="org.qtproject.QtDBus.QtTypeName.In0" value="QVariantMap"/>
0502       <arg name="properties" type="a{sv}" direction="In"/>
0503     </signal>
0504 
0505     <!--
0506         DeviceAdded:
0507         @device_path: The object path of the newly added device.
0508 
0509         A device was added to the system
0510     -->
0511     <signal name="DeviceAdded">
0512       <arg name="device_path" type="o"/>
0513     </signal>
0514 
0515     <!--
0516         DeviceRemoved:
0517         @device_path: The object path of the device that was just removed.
0518 
0519         A device was removed from the system, and is no longer available.
0520     -->
0521     <signal name="DeviceRemoved">
0522       <arg name="device_path" type="o"/>
0523     </signal>
0524   </interface>
0525 </node>