/docs/api/version.xml
/docs/api/settings-spec.html
/docs/api/settings-spec.xml
-/docs/api/spec.html
/docs/api/*.stamp
/docs/api/html/
/docs/api/tmpl/
/introspection/all.xml
/introspection/nmdbus-*.c
/introspection/nmdbus-*.h
+/introspection/nmdbus-*.xml
/libgsystem/
<annotation name="org.gtk.GDBus.C.Name" value="Dispatcher"/>
<method name="Action">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
INTERNAL; not public API. Perform an action.
- </tp:docstring>
+ " />
<arg name="action" type="s" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The action being performed.
- </tp:docstring>
+ " />
</arg>
<arg name="connection" type="a{sa{sv}}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The connection for which this action was triggered.
- </tp:docstring>
+ " />
</arg>
<arg name="connection_properties" type="a{sv}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Properties of the connection, including service and path.
- </tp:docstring>
+ " />
</arg>
<arg name="device_properties" type="a{sv}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Properties of the device, including type, path, interface, and state.
- </tp:docstring>
+ " />
</arg>
<arg name="device_ip4_config" type="a{sv}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's IPv4 configuration.
- </tp:docstring>
+ " />
</arg>
<arg name="device_ip6_config" type="a{sv}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's IPv6 configuration.
- </tp:docstring>
+ " />
</arg>
<arg name="device_dhcp4_config" type="a{sv}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's DHCPv4 configuration.
- </tp:docstring>
+ " />
</arg>
<arg name="device_dhcp6_config" type="a{sv}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Properties of the device's DHCPv6 configuration.
- </tp:docstring>
+ " />
</arg>
<arg name="vpn_ip_iface" type="s" direction="in">
- <tp:docstring>VPN interface name.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="VPN interface name." />
</arg>
<arg name="vpn_ip4_config" type="a{sv}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Properties of the VPN's IPv4 configuration.
- </tp:docstring>
+ " />
</arg>
<arg name="vpn_ip6_config" type="a{sv}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Properties of the VPN's IPv6 configuration.
- </tp:docstring>
+ " />
</arg>
<arg name="debug" type="b" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Whether to log debug output.
- </tp:docstring>
+ " />
</arg>
<arg name="results" type="a(sus)" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Results of dispatching operations. Each element of the returned
array is a struct containing the path of an executed script (s),
the result of running that script (u), and a description of the
result (s).
- </tp:docstring>
+ " />
</arg>
</method>
+++ /dev/null
-********* NOTE *********
-This document is for historical reference only. The autogenerated 'spec.html' is the canonical D-Bus reference.
-********* NOTE *********
-
-
-
-NetworkManager DBUS API (unstable)
-----------------------------------
-
-NetworkManager (NM) exposes a DBUS service and API for two purposes: for programs to obtain information about the network state and network devices, and for programs or users to alter the network state in limited ways. This API is currently unstable and is likely to change in the future. Any methods or objects NOT described in this document are not part of the official API, are not meant for general use, and are not supported in any way.
-
-There are three types of "objects" that NM allows other programs to interact with: the NetworkManager object, Device objects, and Network objects. There is only one NetworkManager object as it performs system-wide networking functions and controls each Device. There can be a arbitrary number of Devices, including no Devices at all, each of which represent a network device present in the system. A Network is the representation of a wireless network, of which each Device object may have an arbitrary number (as long as it is a wireless device).
-
-
-Object structure:
- NetworkManager
- / \
- Device Device
- / \ (no networks)
- Network Network
-
-
-The NetworkManager object
--------------------------
-
-The following constants are used to uniquely refer to the NetworkManager object when making DBUS method calls against NetworkManager:
-
-DBUS Service: "org.freedesktop.NetworkManager"
-DBUS Object Path: "/org/freedesktop/NetworkManager"
-DBUS Interface: "org.freedesktop.NetworkManager"
-
-Methods:
-
- Name: getDevices Get the list of network devices NM knows about
- Args: (none)
- Returns: DBUS String Array Each item in the array is the NM identifier of a Device object
-
-
- Name: getActiveDevice Return the currently active network device
- Args: (none)
- Returns: DBUS_TYPE_STRING The NM identifier of a Device object
-
-
- Name: setActiveDevice Force NM to use a particular network device
- Args: 1) Device object (DBUS_TYPE_STRING) - Network device to switch to
- 2) Wireless Network ESSID (DBUS_TYPE_STRING, optional) - ESSID of the wireless network to switch to
- Returns: (nothing)
-
-
- Name: status Retrieve status information about the network state
- Args: (none)
- Returns: DBUS_TYPE_STRING "connecting" - there is a pending network connection (waiting for a
- DHCP request to complete, waiting for an encryption
- key/passphrase, waiting for a wireless network, etc)
- "connected" - there is an active network connection
- "scanning" - there is no active network connection, but NetworkManager
- is looking for an access point to associate with
- "disconnected" - there is no network connection
-
-Signals:
-
- Name: DeviceNoLongerActive Signals that a network device is no longer active
- Args: 1) Device object (DBUS_TYPE_STRING) - The deactivated network device
-
- Name: DeviceNowActive Signals that a network device is newly activated
- Args: 1) Device object (DBUS_TYPE_STRING) - The newly activated network device
-
- Name: DeviceActivating Signals that a network device is about to become active
- Args: 1) Device object (DBUS_TYPE_STRING) - The device about to become active
-
- Name: DevicesChanged Signals that a device was either added or removed from the system
- Args: 1) Device object (DBUS_TYPE_STRING) - The device which was added or removed
-
- Name: DeviceActivationFailed Signals that activation for a device could not complete (dhcp failed or so)
- Args: 1) Device object (DBUS_TYPE_STRING) - The device for which activation failed
- 2) Network name (DBUS_TYPE_STRING, optional) - ESSID of failed wireless network
-
- Name: DeviceStrengthChanged Signals that the wireless strength percentage for the device has changed.
- Args: 1) Device object (DBUS_TYPE_STRING) - The device for which strength changed
- 2) Strength (DBUS_TYPE_INT32) - The new strength percentage
-
-NOTE: the following 3 Signals are likely to change in the near future
-
- Name: DeviceIP4AddressChange Signals that a device's IPv4 address was changed
- Args: 1) Device object (DBUS_TYPE_STRING) - The device whose IPv4 address changed
-
- Name: WirelessNetworkAppeared Signals that a device found a new wireless network
- Args: 1) Device object (DBUS_TYPE_STRING) - The device which noticed the wireless network
- 2) Network object (DBUS_TYPE_STRING) - The new wireless network's identifier
-
- Name: WirelessNetworkDisappeared Signals that a device lost a new wireless network
- Args: 1) Device object (DBUS_TYPE_STRING) - The device which lost the wireless network
- 2) Network object (DBUS_TYPE_STRING) - The no-longer-visible wireless network's identifier
-
-
-
-
-The Device object
------------------
-
-The Device object is the NM representation of a network device. To refer to a NM Device, you must use the following constants when creating your DBUS message:
-
-DBUS Service: "org.freedesktop.NetworkManager"
-DBUS Interface: "org.freedesktop.NetworkManager.Devices"
-
-Note that there is no DBUS Object Path listed above, the object path will always the NM Device identfier returned from such methods as "getActiveDevice" and "getDevices".
-
-Methods:
-
- Name: getName Returns the system device name of the Device object (i.e. eth0)
- Args: (none)
- Returns: DBUS_TYPE_STRING The system device name
-
-
- Name: getType Returns the type of the device (ie wired, wireless, isdn, bluetooth, etc)
- Args: (none)
- Returns: DBUS_TYPE_INT32 0 - unknown type
- 1 - Wired ethernet
- 2 - Wireless (802.11a/b/g)
-
-
- Name: getHalUdi Returns the HAL UDI of the device
- Args: (none)
- Returns: DBUS_TYPE_STRING
-
-
- Name: getIP4Address Returns the IPv4 address of the device
- Args: (none)
- Returns: DBUS_TYPE_UINT32 The IPv4 address in network byte order
-
-
- Name: getLinkActive Returns the link state of the device
- Args: (none)
- Returns: DBUS_TYPE_BOOLEAN TRUE - the device has a valid network link
- Wired: cable is plugged in
- Wireless: good link to a base station
- FALSE - the device has no network link
- Wired: no cable plugged in
- Wireless: no base station, or bad encryption key
-
- Name: getActiveNetwork (Wireless only) Returns the Network object indentifier of the wireless network
- this device is currently associated with, if any
- Args: (none)
- Returns: DBUS_TYPE_STRING
-
-
- Name: getNetworks (Wireless only) Returns a list of Network objects this device knows about
- Args: (none)
- Returns: DBUS String Array Each item in the array is a Network object identifier
-
-
-
-The Network object
-------------------
-
-Each Device object that is of type 2 (Wireless device) keeps a list of Network objects that it knows about. Use the following constants to specify a Network object when creating DBUS method calls:
-
-DBUS Service: "org.freedesktop.NetworkManager"
-DBUS Interface: "org.freedesktop.NetworkManager.Devices"
-
-Again, note that there is no DBUS Object Path above, since the object path used for the method call will be the Network object indentifier returned from a Device object's "getActiveNetwork" or "getNetworks" methods.
-
-Methods:
-
- Name: getName Return the name of the network (ESSID)
- Args: (none)
- Returns: DBUS_TYPE_STRING
-
-
- Name: getAddress Returns the hardware address of the base station this wireless network belongs to.
- NOTE: this may change in the near future to an array of addresses.
- Args: (none)
- Returns: DBUS_TYPE_STRING
-
-
- Name: getStrength Return the strength percentage of the current wireless network
- Args: (none)
- Returns: DBUS_TYPE_INT32 The strength percentage of the current wireless network
-
-
- Name: getFrequency Returns the frequency/channel this wireless network
- Args: (none)
- Returns: DBUS_TYPE_DOUBLE A frequency in GHz (i.e. 2.417)
-
-
- Name: getRate Returns the max data rate this wireless network supports
- Args: (none)
- Returns: DBUS_TYPE_INT32 The max data rate in Mbps (i.e. 11)
-
-
- Name: getEncrypted Returns whether or not this wireless network requires encryption
- Args: (none)
- Returns: DBUS_TYPE_BOOLEAN
-
-
$(top_srcdir)/introspection/generic-types.xml \
$(top_srcdir)/introspection/errors.xml \
$(top_srcdir)/introspection/vpn-errors.xml \
- $(top_srcdir)/tools/doc-generator.xsl \
$(top_srcdir)/introspection/generic-types.xml
-GENERATED_FILES = spec.html
+GENERATED_FILES =
if SETTING_DOCS_AVAILABLE
GENERATED_FILES += settings-spec.xml
-endif
-
-if ENABLE_GTK_DOC
-
-spec.html: $(XMLS) $(OTHER_FILES) html-build.stamp
- $(XSLTPROC) --path "$(top_builddir)/introspection:$(top_srcdir)/introspection" $(top_srcdir)/tools/doc-generator.xsl $(top_builddir)/introspection/all.xml > spec.html
- mkdir -p $(builddir)/html/
- cp spec.html $(builddir)/html/
-
all: $(GENERATED_FILES)
endif
# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE)
content_files = \
version.xml \
- migrating-to-09.xml \
../../COPYING \
$(NULL)
+expand_content_files = \
+ $(top_builddir)/introspection/nmdbus-access-point-org.freedesktop.NetworkManager.AccessPoint.xml \
+ $(top_builddir)/introspection/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml \
+ $(top_builddir)/introspection/nmdbus-device-team-org.freedesktop.NetworkManager.Device.Team.xml \
+ $(top_builddir)/introspection/nmdbus-dhcp6-config-org.freedesktop.NetworkManager.DHCP6Config.xml \
+ $(top_builddir)/introspection/nmdbus-device-wifi-org.freedesktop.NetworkManager.Device.Wireless.xml \
+ $(top_builddir)/introspection/nmdbus-manager-org.freedesktop.NetworkManager.xml \
+ $(top_builddir)/introspection/nmdbus-vpn-connection-org.freedesktop.NetworkManager.VPN.Connection.xml \
+ $(top_builddir)/introspection/nmdbus-secret-agent-org.freedesktop.NetworkManager.SecretAgent.xml \
+ $(top_builddir)/introspection/nmdbus-device-org.freedesktop.NetworkManager.Device.xml \
+ $(top_builddir)/introspection/nmdbus-vpn-plugin-org.freedesktop.NetworkManager.VPN.Plugin.xml \
+ $(top_builddir)/introspection/nmdbus-device-bt-org.freedesktop.NetworkManager.Device.Bluetooth.xml \
+ $(top_builddir)/introspection/nmdbus-device-vxlan-org.freedesktop.NetworkManager.Device.Vxlan.xml \
+ $(top_builddir)/introspection/nmdbus-settings-connection-org.freedesktop.NetworkManager.Settings.Connection.xml \
+ $(top_builddir)/introspection/nmdbus-device-bond-org.freedesktop.NetworkManager.Device.Bond.xml \
+ $(top_builddir)/introspection/nmdbus-device-macvlan-org.freedesktop.NetworkManager.Device.Macvlan.xml \
+ $(top_builddir)/introspection/nmdbus-ppp-manager-org.freedesktop.NetworkManager.PPP.xml \
+ $(top_builddir)/introspection/nmdbus-device-vlan-org.freedesktop.NetworkManager.Device.Vlan.xml \
+ $(top_builddir)/introspection/nmdbus-device-adsl-org.freedesktop.NetworkManager.Device.Adsl.xml \
+ $(top_builddir)/introspection/nmdbus-agent-manager-org.freedesktop.NetworkManager.AgentManager.xml \
+ $(top_builddir)/introspection/nmdbus-device-wimax-org.freedesktop.NetworkManager.Device.WiMax.xml \
+ $(top_builddir)/introspection/nmdbus-device-ip-tunnel-org.freedesktop.NetworkManager.Device.IPTunnel.xml \
+ $(top_builddir)/introspection/nmdbus-device-tun-org.freedesktop.NetworkManager.Device.Tun.xml \
+ $(top_builddir)/introspection/nmdbus-device-bridge-org.freedesktop.NetworkManager.Device.Bridge.xml \
+ $(top_builddir)/introspection/nmdbus-device-olpc-mesh-org.freedesktop.NetworkManager.Device.OlpcMesh.xml \
+ $(top_builddir)/introspection/nmdbus-dhcp4-config-org.freedesktop.NetworkManager.DHCP4Config.xml \
+ $(top_builddir)/introspection/nmdbus-device-generic-org.freedesktop.NetworkManager.Device.Generic.xml \
+ $(top_builddir)/introspection/nmdbus-device-infiniband-org.freedesktop.NetworkManager.Device.Infiniband.xml \
+ $(top_builddir)/introspection/nmdbus-device-modem-org.freedesktop.NetworkManager.Device.Modem.xml \
+ $(top_builddir)/introspection/nmdbus-ip6-config-org.freedesktop.NetworkManager.IP6Config.xml \
+ $(top_builddir)/introspection/nmdbus-device-veth-org.freedesktop.NetworkManager.Device.Veth.xml \
+ $(top_builddir)/introspection/nmdbus-settings-org.freedesktop.NetworkManager.Settings.xml \
+ $(top_builddir)/introspection/nmdbus-device-ethernet-org.freedesktop.NetworkManager.Device.Wired.xml \
+ $(top_builddir)/introspection/nmdbus-ip4-config-org.freedesktop.NetworkManager.IP4Config.xml \
+ $(top_builddir)/man/NetworkManager.xml \
+ $(top_builddir)/man/NetworkManager.conf.xml \
+ $(top_builddir)/man/nmcli-examples.xml \
+ $(top_builddir)/man/nm-settings.xml \
+ $(top_builddir)/man/nm-settings-keyfile.xml \
+ $(top_builddir)/man/nm-settings-ifcfg-rh.xml
+
include $(top_srcdir)/gtk-doc.make
####################################
if BUILD_SETTING_DOCS
CLEANFILES += settings-spec.xml
endif
-
-if ENABLE_GTK_DOC
-CLEANFILES += spec.html
-endif
+++ /dev/null
-<?xml version="1.0"?>
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
- "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
-<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
-]>
-<chapter id="ref-migrating">
- <title>Migrating from NetworkManager 0.8 to NetworkManager 0.9</title>
-
- <para>
- NetworkManager 0.9 is a new major version of NetworkManager that breaks
- both API and ABI compared to previous versions. These changes are
- intended to make communication with NetworkManager much simpler, especially
- for network control and configuration programs. Thankfully, most changes
- are not difficult to implement, and the advantages of the simpler
- architecture of NetworkManager 0.9 greatly outweight the effort of
- updating client programs.
- </para>
-
- <section>
- <title>Architecture and D-Bus API Changes in 0.9</title>
-
- <para>
- This section details the architectural and D-Bus API changes in
- NetworkManager 0.9.
- </para>
-
- <section>
- <title>Elimination of the User Settings Service</title>
- <para>
- Previously there were two "settings services", or D-Bus services that
- provided and saved network configuration information. NetworkManager
- owned the "system" settings service, and one user-level applet owned the
- "user" settings service. Now, the "user" settings service has been
- eliminated, so clients only have to track one D-Bus service to read and
- update network configuration. The functionality of the old user settings
- service has been replaced with a "permissions" key on each connection
- object to preserve the ability to restrict which users can use the
- connection, and with a "secret agent" D-Bus API for user-session-level
- secure storage of network secrets and passwords.
- </para>
- <para>
- Elimination of the user settings service provides the following advantages
- for clients of NetworkManager:
- <itemizedlist>
- <listitem>Simpler discovery of network configuration and change tracking</listitem>
- <listitem>Simpler storage of user-level network secrets by control applets</listitem>
- <listitem>Correct operation of fast-user switching and multi-seat configurations</listitem>
- <listitem>More granular network connection permissions for system administrators</listitem>
- <listitem>Connections are now system-wide by default (unless restricted by the user or system administrator)</listitem>
- <listitem>Easier deployment of user-specific connections (ie, VPNs)</listitem>
- </itemizedlist>
- </para>
- <para>
- With this change, D-Bus methods that previously took a "service name"
- argument (like
- <literal>org.freedesktop.NetworkManager.ActivateConnection</literal>) and
- objects with service name properties (like ActiveConnection objects) no
- longer have those arguments or properties.
- </para>
- <para>
- <emphasis role="strong">Action:</emphasis> if you develop a network control
- applet that talks to NetworkManager and used to provide a user settings
- service, you can eliminate that code and rely on NetworkManager for all
- storage of network configuration. Your applet should now implement the
- Secret Agent D-Bus API (see below) to store user-specific secrets, and
- add legacy user-specific configuration to NetworkManager when run. More
- information about both these changes follows.
- </para>
- </section>
-
- <section>
- <title>User Secret Agents</title>
- <para>
- Even with the elimination of the user settings service, in some cases it
- is still desirable to store secrets in the user's session and not in
- system-wide storage (and thus available to all users). To allow this
- functionality the concept of agents has been introduced. Using the new
- <ulink url="spec.html#org.freedesktop.NetworkManager.AgentManager">
- <literal>org.freedesktop.NetworkManager.AgentManager</literal></ulink>
- D-Bus interface provided by NetworkManager, user applications can register
- themselves as "secret agents", ie programs capable of saving and providing
- secrets to NetworkManager. The agent should export the
- <ulink url="spec.html#org.freedesktop.NetworkManager.SecretAgent">
- <literal>org.freedesktop.NetworkManager.SecretAgent</literal></ulink>
- D-Bus interface, but should NOT claim a bus name on the system or session
- bus. Instead, NetworkManager talks to the agent directly over the D-Bus
- connection which the agent used to register itself.
- </para>
- <para>
- Each agent must send a unique identifier to NetworkManager when it
- registers. This identifier must follow certain rules (see the NM D-Bus
- API documentation for more details) but looks essentially the same as
- a D-Bus service name. Only one agent using a given identifier may be
- registered at the same time. The agent is automatically unregistered
- if it disconnects from D-Bus or exits.
- </para>
- <para>
- When NetworkManager requires secrets during the attempt to connect to a
- network, and no secrets are available from the internal settings service,
- NetworkManager queries each registered agent for secrets. Agents that
- are in "active" user sessions (as determined by ConsoleKit) are preferred
- over inactive ones. Only agents belonging to users who have permission
- to view and modify the connection are queried. For more information on
- connection permissions, see below.
- </para>
- When secrets are requested, the agent is also sent a set of flags that
- modify the behavior of the request. By default, the agent should never
- attempt to query the user for secrets, but should simply return any
- available saved secrets. Other flags allow the agent to explicitly
- request new secrets from the user.
- <para>
- <emphasis role="strong">Action:</emphasis> the parts of a previous user
- settings service that handled secrets may be easily repurposed as the bulk
- of the implementation of a secret agent. The agent is sent all available
- connection settings, and from those should be able to retrieve or save
- any saved user secrets, or to request new secrets from the user.
- </para>
- </section>
-
- <section>
- <title>Settings Service Interface Changes</title>
- <para>
- With the elimination of the user settings service, the old
- <literal>org.freedesktop.NetworkManagerUserSettings</literal> and
- <literal>org.freedesktop.NetworkManagerSystemSettings</literal> D-Bus
- service names are no longer used. Instead NetworkManager provides the
- settings service using its own D-Bus service name,
- <literal>org.freedesktop.NetworkManager</literal>. The object path of
- the settings service has also changed to
- <literal>/org/freedesktop/NetworkManager/Settings</literal>.
- </para>
- <para>
- Additionally, the D-Bus interface of the settings service has changed
- to <ulink url="spec.html#org.freedesktop.NetworkManager.Settings">
- <literal>org.freedesktop.NetworkManager.Settings</literal></ulink> from
- the old interface name of
- <literal>org.freedesktop.NetworkManagerSettings</literal>, and the old
- <literal>org.freedesktop.NetworkManagerSettings.System</literal>
- interface has been merged into the new
- <ulink url="spec.html#org.freedesktop.NetworkManager.Settings">
- <literal>org.freedesktop.NetworkManager.Settings</literal></ulink> interface
- as the split no longer made sense. This includes the
- <literal>SaveHostname</literal> method and the <literal>Hostname</literal>
- and <literal>CanModify</literal> properties.
- </para>
- <para>
- <emphasis role="strong">Action:</emphasis> change the service name and
- object path that your application uses to request system network settings
- to <literal>org.freedesktop.NetworkManager</literal> and
- <literal>/org/freedesktop/NetworkManager/Settings</literal> respectively,
- and update the D-Bus interface that codes uses to talk to the settings
- service to <ulink url="spec.html#org.freedesktop.NetworkManager.Settings">
- <literal>org.freedesktop.NetworkManager.Settings</literal></ulink>.
- Listen for hostname changes using the new interface name as well.
- </para>
- </section>
-
- <section>
- <title>Connection Object Interface Changes</title>
- <para>
- Consistent with the interface changes to the Settings object, the
- Connection object's D-Bus interface has changed to
- <ulink url="spec.html#org.freedesktop.NetworkManager.Settings.Connection">
- <literal>org.freedesktop.NetworkManager.Settings.Connection</literal></ulink>
- from the previous
- <literal>org.freedesktop.NetworkManagerSettings.Connection</literal>.
- </para>
- <para>
- Additionally, the
- <literal>org.freedesktop.NetworkManager.Settings.Connection.Updated</literal>
- signal of the Connection object no longer includes the updated settings
- data argument, as that might allow users who are not authorized to
- view the connection details to do so. Instead, when a client receives the
- Updated signal, it should requery the Connection's settings with the
- <literal>org.freedesktop.NetworkManager.Settings.Connection.GetSettings</literal>
- method. If the client receives an error as a result of this method call,
- it should assume the connection has been deleted.
- </para>
- <para>
- <emphasis role="strong">Action:</emphasis> where code manipulates
- Connection objects, update the D-Bus interface that code uses to be
- <literal>org.freedesktop.NetworkManager.Settings.Connection</literal>.
- Additionally, code that listens for the
- <literal>org.freedesktop.NetworkManager.Settings.Connection.Updated</literal>
- signal should no longer expect the new settings data as an argument, but
- instead should request the new settings data using the
- <literal>org.freedesktop.NetworkManager.Settings.Connection.GetSettings</literal>
- method.
- </para>
- </section>
-
- <section>
- <title>Permissions Methods Consolidation</title>
- <para>
- Previously there were two D-Bus method calls to retrieve the list of
- operations that a user client could perform, and two signals notifying
- callers that they should recheck permissions. Those two calls were:
- <itemizedlist>
- <listitem>
- <literal>org.freedesktop.NetworkManagerSettings.System.GetPermissions</literal>
- which returned a bitfield of operations the caller was allowed to
- perform related to modify system network settings and the machine
- hostname
- </listitem>
- <listitem>
- <literal>org.freedesktop.NetworkManager.GetPermissions</literal> which
- returned a dictionary mapping permission names to result strings like
- "yes", "auth", or "no", relating to network control permissions like
- the ability to enable or disable WiFi.
- </listitem>
- </itemizedlist>
- These two calls have been consolidated into an enhanced
- <literal>org.freedesktop.NetworkManager.GetPermissions</literal> call that
- uses the same arguments, but includes all permissions, including those which
- the settings service used to handle.
- </para>
- <para>
- With this change, the bitfield items from
- <literal>org.freedesktop.NetworkManagerSettings.System.GetPermissions</literal>
- are now string-based permissions. The mapping is as follows:
- <table>
- <tgroup cols="2">
- <thead>
- <row><entry>Old bitfield value</entry><entry>New permission name</entry></row>
- </thead>
- <tbody>
- <row>
- <entry><screen>0x1 (connection-modify)</screen></entry>
- <entry>
- <literal>org.freedesktop.NetworkManager.settings.modify.system</literal>
- or <literal>org.freedesktop.NetworkManager.settings.modify.system</literal>
- depending on the permissions of the connection.
- </entry>
- </row>
- <row>
- <entry><screen>0x2 (wifi-share-protected)</screen></entry>
- <entry>
- <literal>org.freedesktop.NetworkManager.wifi.share.protected</literal>
- </entry>
- </row>
- <row>
- <entry><screen>0x4 (wifi-share-open)</screen></entry>
- <entry>
- <literal>org.freedesktop.NetworkManager.wifi.share.open</literal>
- </entry>
- </row>
- <row>
- <entry><screen>0x8 (hostname-modify)</screen></entry>
- <entry>
- <literal>org.freedesktop.NetworkManager.settings.modify.hostname</literal>
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
- <para>
- <emphasis role="strong">Action:</emphasis> modify handling of existing
- code that checks permissions to recognize the new permissions names for
- old system settings permissions, and remove code that used to call
- <literal>org.freedesktop.NetworkManagerSettings.System.GetPermissions</literal>.
- </para>
- </section>
-
- <section>
- <title>AddConnection Returns Object Path of New Connection</title>
- <para>
- The <ulink url="spec.html#org.freedesktop.NetworkManager.Settings">
- <literal>org.freedesktop.NetworkManager.Settings.AddConnection</literal>
- </ulink> method call now returns the object path of the newly added
- connection. Previously, if code wanted to manipulate a connection
- post-addition, it had to wait for the new connection to be announced via
- the NewConnection signal by matching connection UUIDs. Now the object
- path is returned and this workaround is no longer required.
- </para>
- <para>
- <emphasis role="strong">Action:</emphasis> update code that adds new
- connections to handle the object path returned from AddConnection, and
- remove workarounds for finding the new connection via signals.
- </para>
- </section>
-
- <section>
- <title>Support for WiMAX Devices</title>
- <para>
- NetworkManager now supports Intel WiMAX mobile broadband devices. A
- corresponding device type (<literal>NM_DEVICE_TYPE_WIMAX</literal>) and
- a new <ulink url="spec.html#org.freedesktop.NetworkManager.Device.WiMax">
- <literal>org.freedesktop.NetworkManager.Device.WiMax</literal></ulink>
- D-Bus interface have been added. Furthermore, to support connection to
- different WiMAX Network Service Providers (NSPs) the
- <ulink url="spec.html#org.freedesktop.NetworkManager.Device.WiMax.Nsp">
- <literal>org.freedesktop.NetworkManager.Device.WiMax.Nsp</literal></ulink>
- interface has been added to access information about each available
- WiMAX network.
- </para>
- <para>
- <emphasis role="strong">Action:</emphasis> update code that handles
- devices and/or displays status to users to recognize the new device type,
- and to display available WiMAX NSPs similar to how WiFi Access Points
- are displayed. Also update code that creates new connections to allow
- creation of new WiMAX connections.
- </para>
- </section>
-
- <section>
- <title>New Device States</title>
- <para>
- A few <ulink url="spec.html#type-NM_DEVICE_STATE">new device states</ulink>
- have been added, and all device states have been renumbered for flexibility.
- The new devices states IP_CHECK, SECONDARIES, and DEACTIVATING.
- </para>
- <para>
- <emphasis role="strong">Action:</emphasis> where code checks device state
- or shows UI indication of the device's state, make sure the new device
- states are processed correctly, and that code in switch()-type statements
- is updated to handle the new states.
- </para>
- </section>
-
- <section>
- <title>New Active Connection State</title>
- <para>
- Along with the new device states, an
- <ulink url="spec.html#type-NM_ACTIVE_CONNECTION_STATE">additional
- ActiveConnection state</ulink> has been added: DEACTIVATING. This state
- is entered when the connection is being torn down and deactivated.
- </para>
- <para>
- <emphasis role="strong">Action:</emphasis> where code checks active
- connection states or shows UI indication of active connection states, make
- sure the DEACTIVATING state is processed correctly, and that code in
- switch()-type statements is updated to handle it.
- </para>
- </section>
-
- <section>
- <title>Consolidated Modem Devices</title>
- <para>
- Many new mobile broadband devices support multiple access families, like
- Qualcomm Gobi cards (CDMA/EVDO and GSM/UMTS), or multi-mode EVDO/LTE
- or UMTS/LTE modems like the Pantech UML290. The previous hard split
- between CDMA/EVDO and GSM/UMTS device classes was not flexible enough to
- deal with these new multi-mode devices. Thus the previously separate
- CDMA and GSM device classes have been combined into a single Modem
- device class, which exposes both hardware "ModemCapabilities" and
- runtime "CurrentCapabilities" which represent generic access technology
- families like CDMA/EVDO, GSM/UMTS, and LTE which the device supports.
- ModemCapabilities indicate all the access technology families which the
- modem is capable of supporting, while CurrentCapabilities indicate the
- immediate access technology families the device supports without reloading
- the firmware and thus restarting the device.
- </para>
- <para>
- Along with this change, the
- <literal>org.freedesktop.NetworkManager.Device.Serial</literal>
- interface has been removed as it's functionality will be incorporated
- into the
- <ulink url="spec.html#org.freedesktop.NetworkManager.Device.Modem">
- <literal>org.freedesktop.NetworkManager.Device.Modem</literal></ulink>
- interface in the future.
- </para>
- <para>
- <emphasis role="strong">Action:</emphasis> combine code that checks for
- the old CDMA and GSM device types, and instead handle the new Modem device
- type. Where behavior must change based on the capabilities of the device,
- check the CurrentCapabilities device property to determine whether to
- treat the device as CDMA, GSM, or LTE for purposes of configuration and
- status.
- </para>
- </section>
-
- <section>
- <title>Secret Property Flags</title>
- <para>
- In the Connection object's configuration properties, each setting's secret
- properties (like WiFi passphrases, or public key passwords, etc) now has
- an associated "flags" property that changes how NetworkManager treats the
- secret. The "flags" property is a bitfield of one or more of the
- following values:
- <table>
- <tgroup cols="2">
- <thead>
- <row><entry>Flag Value</entry><entry>Meaning</entry></row>
- </thead>
- <tbody>
- <row>
- <entry><screen>0x00 (none)</screen></entry>
- <entry>
- NetworkManager is responsible for providing and storing this
- secret (default)
- </entry>
- </row>
- <row>
- <entry><screen>0x01 (agent-owned)</screen></entry>
- <entry>
- A user secret agent is responsible for providing and storing
- this secret; when it is required agents will be asked to
- retrieve it
- </entry>
- </row>
- <row>
- <entry><screen>0x02 (not saved)</screen></entry>
- <entry>
- The secret is not saved, and should be requested each time it
- is required. Used for OTP/token configurations where the
- secret changes periodically, or if the user simply wants to
- manually enter the secret each time.
- </entry>
- </row>
- <row>
- <entry><screen>0x04 (not required)</screen></entry>
- <entry>
- In situations where it cannot be automatically determined that
- the secret is required (some VPNs and PPP providers dont require
- all possible secrets) this flag indicates that the specific
- secret is not required.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
- <para>
- <emphasis role="strong">Action:</emphasis> user interface code which
- handles entry of connection secrets should be updated to read and set
- secret flags. For example, code that creates new VPN connections may want
- to set the "agent-owned" flag to ensure that the user's VPN password is
- not available to all users. EAP-TLS and VPN interface code might add a
- checkbox that toggles the "not saved" bit to indicate that the
- password/PIN code should be requested from a hardware token each time it
- is required.
- </para>
- </section>
-
- <section>
- <title>Deprecated Methods Removed</title>
- <para>
- A few methods and signals of the <literal>org.freedesktop.NetworkManager</literal>
- interface deprecated in version 0.7 have been removed. All the
- replacement methods and signals have existed since version 0.7 and so are
- not new to this version of NetworkManager, but some older programs may
- be using removed items. The following table lists the removed items and
- their replacements:
- <table>
- <tgroup cols="2">
- <thead>
- <row><entry>Removed Item</entry><entry>Replacement</entry></row>
- </thead>
- <tbody>
- <row>
- <entry><screen>StateChange signal</screen></entry>
- <entry>
- Use the <literal>StateChanged</literal> signal, which has the
- same arguments.
- </entry>
- </row>
- <row>
- <entry><screen>sleep() and wake() methods</screen></entry>
- <entry>
- Use the <literal>Sleep()</literal> method instead, which takes
- a boolean argument indicating whether NetworkManager should
- go to sleep or wake up.
- </entry>
- </row>
- </tbody>
- </tgroup>
- </table>
- </para>
- <para>
- <emphasis role="strong">Action:</emphasis> update code to use these
- replacement methods and properties where it used old deprecated ones
- </para>
- </section>
-
- </section>
-
-</chapter>
]>
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
<bookinfo>
- <title>NetworkManager D-Bus Reference Manual</title>
+ <title>NetworkManager D-Bus API Reference Manual</title>
<releaseinfo>Version &version;</releaseinfo>
<copyright>
<year>2012</year>
+ <year>2016</year>
<holder>The NetworkManager Authors</holder>
</copyright>
</legalnotice>
</bookinfo>
- <chapter id="ref-dbus">
+ <chapter id="spec">
<title>D-Bus API Reference</title>
+
<para>
This part documents the D-Bus interface used to access the
NetworkManager daemon.
</para>
- <ulink url="spec.html"/>
+
+ <section id="dbus-interfaces">
+ <title>Interfaces</title>
+ <!-- TODO: Split me into chapters about daemon, vpn plugins, dispatcher and the secret agent.
+ Then describe the daemon's singletons and object hierarchy. -->
+ <xi:include href="xml/nmdbus-manager-org.freedesktop.NetworkManager.xml"/>
+ <xi:include href="xml/nmdbus-settings-org.freedesktop.NetworkManager.Settings.xml"/>
+ <xi:include href="xml/nmdbus-agent-manager-org.freedesktop.NetworkManager.AgentManager.xml"/>
+ <xi:include href="xml/nmdbus-access-point-org.freedesktop.NetworkManager.AccessPoint.xml"/>
+ <xi:include href="xml/nmdbus-ppp-manager-org.freedesktop.NetworkManager.PPP.xml"/>
+ <xi:include href="xml/nmdbus-settings-connection-org.freedesktop.NetworkManager.Settings.Connection.xml"/>
+ <xi:include href="xml/nmdbus-vpn-connection-org.freedesktop.NetworkManager.VPN.Connection.xml"/>
+ <xi:include href="xml/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml"/>
+ <xi:include href="xml/nmdbus-device-org.freedesktop.NetworkManager.Device.xml"/>
+ <xi:include href="xml/nmdbus-device-adsl-org.freedesktop.NetworkManager.Device.Adsl.xml"/>
+ <xi:include href="xml/nmdbus-device-bond-org.freedesktop.NetworkManager.Device.Bond.xml"/>
+ <xi:include href="xml/nmdbus-device-bridge-org.freedesktop.NetworkManager.Device.Bridge.xml"/>
+ <xi:include href="xml/nmdbus-device-bt-org.freedesktop.NetworkManager.Device.Bluetooth.xml"/>
+ <xi:include href="xml/nmdbus-device-ethernet-org.freedesktop.NetworkManager.Device.Wired.xml"/>
+ <xi:include href="xml/nmdbus-device-generic-org.freedesktop.NetworkManager.Device.Generic.xml"/>
+ <xi:include href="xml/nmdbus-device-infiniband-org.freedesktop.NetworkManager.Device.Infiniband.xml"/>
+ <xi:include href="xml/nmdbus-device-ip-tunnel-org.freedesktop.NetworkManager.Device.IPTunnel.xml"/>
+ <xi:include href="xml/nmdbus-device-macvlan-org.freedesktop.NetworkManager.Device.Macvlan.xml"/>
+ <xi:include href="xml/nmdbus-device-modem-org.freedesktop.NetworkManager.Device.Modem.xml"/>
+ <xi:include href="xml/nmdbus-device-olpc-mesh-org.freedesktop.NetworkManager.Device.OlpcMesh.xml"/>
+ <xi:include href="xml/nmdbus-device-team-org.freedesktop.NetworkManager.Device.Team.xml"/>
+ <xi:include href="xml/nmdbus-device-tun-org.freedesktop.NetworkManager.Device.Tun.xml"/>
+ <xi:include href="xml/nmdbus-device-veth-org.freedesktop.NetworkManager.Device.Veth.xml"/>
+ <xi:include href="xml/nmdbus-device-vlan-org.freedesktop.NetworkManager.Device.Vlan.xml"/>
+ <xi:include href="xml/nmdbus-device-vxlan-org.freedesktop.NetworkManager.Device.Vxlan.xml"/>
+ <xi:include href="xml/nmdbus-device-wifi-org.freedesktop.NetworkManager.Device.Wireless.xml"/>
+ <xi:include href="xml/nmdbus-device-wimax-org.freedesktop.NetworkManager.Device.WiMax.xml"/>
+ <xi:include href="xml/nmdbus-dhcp4-config-org.freedesktop.NetworkManager.DHCP4Config.xml"/>
+ <xi:include href="xml/nmdbus-dhcp6-config-org.freedesktop.NetworkManager.DHCP6Config.xml"/>
+ <xi:include href="xml/nmdbus-ip4-config-org.freedesktop.NetworkManager.IP4Config.xml"/>
+ <xi:include href="xml/nmdbus-ip6-config-org.freedesktop.NetworkManager.IP6Config.xml"/>
+ <xi:include href="xml/nmdbus-vpn-plugin-org.freedesktop.NetworkManager.VPN.Plugin.xml"/>
+ <xi:include href="xml/nmdbus-secret-agent-org.freedesktop.NetworkManager.SecretAgent.xml"/>
+ </section>
</chapter>
<chapter id="ref-settings">
</section>
</chapter>
- <xi:include href="migrating-to-09.xml" />
+ <chapter id="manpages">
+ <title>UNIX Manual Pages</title>
+ <xi:include href="xml/NetworkManager.xml"/>
+ <xi:include href="xml/NetworkManager.conf.xml"/>
+ <xi:include href="xml/nmcli-examples.xml"/>
+ <xi:include href="xml/nm-settings.xml"><xi:fallback /></xi:include>
+ <xi:include href="xml/nm-settings-keyfile.xml"><xi:fallback /></xi:include>
+ <xi:include href="xml/nm-settings-ifcfg-rh.xml"><xi:fallback /></xi:include>
+ </chapter>
+
<index>
<title>Index</title>
# This example configures a Bond from ethernet devices and activates it
#
# NetworkManager D-Bus API:
-# https://developer.gnome.org/NetworkManager/1.0/spec.html
+# https://developer.gnome.org/NetworkManager/stable/spec.html
#
import dbus, sys, uuid
nmdbus-vpn-plugin.c \
nmdbus-vpn-plugin.h
+DBUS_INTERFACE_DOCS = \
+ nmdbus-access-point-org.freedesktop.NetworkManager.AccessPoint.xml \
+ nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml \
+ nmdbus-device-team-org.freedesktop.NetworkManager.Device.Team.xml \
+ nmdbus-dhcp6-config-org.freedesktop.NetworkManager.DHCP6Config.xml \
+ nmdbus-device-wifi-org.freedesktop.NetworkManager.Device.Wireless.xml \
+ nmdbus-manager-org.freedesktop.NetworkManager.xml \
+ nmdbus-vpn-connection-org.freedesktop.NetworkManager.VPN.Connection.xml \
+ nmdbus-secret-agent-org.freedesktop.NetworkManager.SecretAgent.xml \
+ nmdbus-device-org.freedesktop.NetworkManager.Device.xml \
+ nmdbus-vpn-plugin-org.freedesktop.NetworkManager.VPN.Plugin.xml \
+ nmdbus-device-bt-org.freedesktop.NetworkManager.Device.Bluetooth.xml \
+ nmdbus-device-vxlan-org.freedesktop.NetworkManager.Device.Vxlan.xml \
+ nmdbus-settings-connection-org.freedesktop.NetworkManager.Settings.Connection.xml \
+ nmdbus-device-bond-org.freedesktop.NetworkManager.Device.Bond.xml \
+ nmdbus-device-macvlan-org.freedesktop.NetworkManager.Device.Macvlan.xml \
+ nmdbus-ppp-manager-org.freedesktop.NetworkManager.PPP.xml \
+ nmdbus-device-vlan-org.freedesktop.NetworkManager.Device.Vlan.xml \
+ nmdbus-device-adsl-org.freedesktop.NetworkManager.Device.Adsl.xml \
+ nmdbus-agent-manager-org.freedesktop.NetworkManager.AgentManager.xml \
+ nmdbus-device-wimax-org.freedesktop.NetworkManager.Device.WiMax.xml \
+ nmdbus-device-ip-tunnel-org.freedesktop.NetworkManager.Device.IPTunnel.xml \
+ nmdbus-device-tun-org.freedesktop.NetworkManager.Device.Tun.xml \
+ nmdbus-device-bridge-org.freedesktop.NetworkManager.Device.Bridge.xml \
+ nmdbus-device-olpc-mesh-org.freedesktop.NetworkManager.Device.OlpcMesh.xml \
+ nmdbus-dhcp4-config-org.freedesktop.NetworkManager.DHCP4Config.xml \
+ nmdbus-device-generic-org.freedesktop.NetworkManager.Device.Generic.xml \
+ nmdbus-device-infiniband-org.freedesktop.NetworkManager.Device.Infiniband.xml \
+ nmdbus-device-modem-org.freedesktop.NetworkManager.Device.Modem.xml \
+ nmdbus-ip6-config-org.freedesktop.NetworkManager.IP6Config.xml \
+ nmdbus-device-veth-org.freedesktop.NetworkManager.Device.Veth.xml \
+ nmdbus-settings-org.freedesktop.NetworkManager.Settings.xml \
+ nmdbus-device-ethernet-org.freedesktop.NetworkManager.Device.Wired.xml \
+ nmdbus-ip4-config-org.freedesktop.NetworkManager.IP4Config.xml
+
define _make_nmdbus_rule
$(1): $(patsubst nmdbus-%.c,nm-%.xml,$(1))
$$(AM_V_GEN) gdbus-codegen \
--generate-c-code $$(basename $$@) \
+ --generate-docbook $$(basename $$@) \
--c-namespace NMDBus \
--interface-prefix org.freedesktop.NetworkManager \
$$<
+$(filter $(basename $(1))-org.freedesktop.NetworkManager.%,$(DBUS_INTERFACE_DOCS)): $(1)
+ @true
+
$(basename $(1)).h: $(1)
@true
endef
$(foreach f,$(filter %.c,$(nodist_libnmdbus_la_SOURCES)),$(eval $(call _make_nmdbus_rule,$f)))
-CLEANFILES = $(nodist_libnmdbus_la_SOURCES)
+BUILT_SOURCES = $(nodist_libnmdbus_la_SOURCES) $(DBUS_INTERFACE_DOCS)
+
+CLEANFILES = $(BUILT_SOURCES)
EXTRA_DIST = \
all.xml.in \
<tp:copyright>Copyright (C) 2008 Novell, Inc.</tp:copyright>
<tp:error name="Unknown Connection">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Connection was not provided by the settings service.
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="Unknown Device">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Unknown device.
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="Permission Denied">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
User does not have the permission to activate this connection.
- </tp:docstring>
+ " />
</tp:error>
</tp:errors>
<tp:generic-types
xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<tp:mapping name="String_Variant_Map">
- <tp:docstring>A mapping from strings to variants representing extra
- key-value pairs.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="A mapping from strings to variants representing extra
+ key-value pairs." />
<tp:member type="s" name="Key"/>
<tp:member type="v" name="Value"/>
</tp:mapping>
<tp:mapping name="String_String_Map">
- <tp:docstring>A mapping from strings to strings representing extra
- key-value pairs.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="A mapping from strings to strings representing extra
+ key-value pairs." />
<tp:member type="s" name="Key"/>
<tp:member type="s" name="Value"/>
</tp:mapping>
<tp:mapping name="String_String_Variant_Map_Map">
- <tp:docstring>A mapping from strings to a map of string to variant.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="A mapping from strings to a map of string to variant." />
<tp:member type="s" name="Key"/>
<tp:member type="a{sv}" name="Value" tp:type="String_Variant_Map"/>
</tp:mapping>
<tp:enum name="NM_802_11_MODE" type="u">
- <tp:docstring></tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="" />
<tp:enumvalue suffix="UNKNOWN" value="0">
- <tp:docstring>Mode is unknown.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Mode is unknown." />
</tp:enumvalue>
<tp:enumvalue suffix="ADHOC" value="1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
For both devices and access point objects, indicates the object is
part of an Ad-Hoc 802.11 network without a central coordinating access
point.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="INFRA" value="2">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The wireless device or access point is in infrastructure mode. For
devices, this indicates the device is an 802.11 client/station. For
access point objects, this indicates the object is an access point that
provides connectivity to clients.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="AP" value="3">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is an access point/hotspot. Not valid for access point
objects themselves.
- </tp:docstring>
+ " />
</tp:enumvalue>
</tp:enum>
</tp:generic-types>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.AccessPoint">
<property name="Flags" type="u" access="read" tp:type="NM_802_11_AP_FLAGS">
- <tp:docstring>Flags describing the capabilities of the access point.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Flags describing the capabilities of the access point." />
</property>
<property name="WpaFlags" type="u" access="read" tp:type="NM_802_11_AP_SEC">
- <tp:docstring>Flags describing the access point's capabilities according to WPA (Wifi Protected Access).</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Flags describing the access point's capabilities according to WPA (Wifi Protected Access)." />
</property>
<property name="RsnFlags" type="u" access="read" tp:type="NM_802_11_AP_SEC">
- <tp:docstring>Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol." />
</property>
<property name="Ssid" type="ay" access="read">
<!-- gdbus-codegen assumes that "ay" means "non-UTF-8 string" and
won't deal with '\0' bytes correctly.
-->
<annotation name="org.gtk.GDBus.C.ForceGVariant" value="1"/>
- <tp:docstring>The Service Set Identifier identifying the access point.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The Service Set Identifier identifying the access point." />
</property>
<property name="Frequency" type="u" access="read">
- <tp:docstring>The radio channel frequency in use by the access point, in MHz.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The radio channel frequency in use by the access point, in MHz." />
</property>
<property name="HwAddress" type="s" access="read">
- <tp:docstring>The hardware address (BSSID) of the access point.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The hardware address (BSSID) of the access point." />
</property>
<property name="Mode" type="u" access="read" tp:type="NM_802_11_MODE">
- <tp:docstring>Describes the operating mode of the access point.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Describes the operating mode of the access point." />
</property>
<property name="MaxBitrate" type="u" access="read">
- <tp:docstring>The maximum bitrate this access point is capable of, in kilobits/second (Kb/s).</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The maximum bitrate this access point is capable of, in kilobits/second (Kb/s)." />
</property>
<property name="Strength" type="y" access="read">
- <tp:docstring>The current signal quality of the access point, in percent.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The current signal quality of the access point, in percent." />
</property>
<property name="LastSeen" type="i" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The timestamp (in CLOCK_BOOTTIME seconds) for the last time the access
point was found in scan results. A value of -1 means the access point
has never been found in scan results.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<tp:flags name="NM_802_11_AP_FLAGS" value-prefix="NM_802_11_AP_FLAGS" type="u">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Flags describing the general capabilities of the access point.
- </tp:docstring>
+ " />
<tp:flag suffix="NONE" value="0x0">
- <tp:docstring>Null capability - says nothing about the access point.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Null capability - says nothing about the access point." />
</tp:flag>
<tp:flag suffix="PRIVACY" value="0x1">
- <tp:docstring>Access point supports privacy measures.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Access point supports privacy measures." />
</tp:flag>
</tp:flags>
<tp:flags name="NM_802_11_AP_SEC" value-prefix="NM_802_11_AP_SEC" type="u">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Flags describing the security capabilities of the access point.
- </tp:docstring>
+ " />
<tp:flag suffix="NONE" value="0x0">
- <tp:docstring>Null flag.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Null flag." />
</tp:flag>
<tp:flag suffix="PAIR_WEP40" value="0x1">
- <tp:docstring>Access point supports pairwise 40-bit WEP encryption.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise 40-bit WEP encryption." />
</tp:flag>
<tp:flag suffix="PAIR_WEP104" value="0x2">
- <tp:docstring>Access point supports pairwise 104-bit WEP encryption.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise 104-bit WEP encryption." />
</tp:flag>
<tp:flag suffix="PAIR_TKIP" value="0x4">
- <tp:docstring>Access point supports pairwise TKIP encryption.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise TKIP encryption." />
</tp:flag>
<tp:flag suffix="PAIR_CCMP" value="0x8">
- <tp:docstring>Access point supports pairwise CCMP encryption.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise CCMP encryption." />
</tp:flag>
<tp:flag suffix="GROUP_WEP40" value="0x10">
- <tp:docstring>Access point supports a group 40-bit WEP cipher.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Access point supports a group 40-bit WEP cipher." />
</tp:flag>
<tp:flag suffix="GROUP_WEP104" value="0x20">
- <tp:docstring>Access point supports a group 104-bit WEP cipher.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Access point supports a group 104-bit WEP cipher." />
</tp:flag>
<tp:flag suffix="GROUP_TKIP" value="0x40">
- <tp:docstring>Access point supports a group TKIP cipher.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Access point supports a group TKIP cipher." />
</tp:flag>
<tp:flag suffix="GROUP_CCMP" value="0x80">
- <tp:docstring>Access point supports a group CCMP cipher.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Access point supports a group CCMP cipher." />
</tp:flag>
<tp:flag suffix="KEY_MGMT_PSK" value="0x100">
- <tp:docstring>Access point supports PSK key management.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Access point supports PSK key management." />
</tp:flag>
<tp:flag suffix="KEY_MGMT_802_1X" value="0x200">
- <tp:docstring>Access point supports 802.1x key management.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Access point supports 802.1x key management." />
</tp:flag>
</tp:flags>
</interface>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.Connection.Active">
<annotation name="org.gtk.GDBus.C.Name" value="ActiveConnection"/>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Objects that implement the Connection.Active interface represent an attempt
to connect to a network using the details provided by a Connection object.
The Connection.Active object tracks the life-cycle of the connection
attempt and if successful indicates whether the connected network is the
- "default" or preferred network for access.
+ "default" or preferred network for access.
NetworkManager has the concept of connections, which can be thought of as
settings, a profile or a configuration that can be applied on a networking
device.
versa. However, during activation and deactivation multiple active-connections
can reference the same device or settings-connection as they are waiting to
be activated or to be deactivated.
- </tp:docstring>
+ " />
<property name="Connection" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The path of the connection.
- </tp:docstring>
+ " />
</property>
<property name="SpecificObject" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A specific object associated with the active connection. This property
reflects the specific object used during connection activation, and will
not change over the lifetime of the ActiveConnection once set.
- </tp:docstring>
+ " />
</property>
<property name="Id" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The ID of the connection, provided as a convenience so that clients
do not have to retrieve all connection details.
- </tp:docstring>
+ " />
</property>
<property name="Uuid" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The UUID of the connection, provided as a convenience so that clients
do not have to retrieve all connection details.
- </tp:docstring>
+ " />
</property>
<property name="Type" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The type of the connection, provided as a convenience so that clients
do not have to retrieve all connection details.
- </tp:docstring>
+ " />
</property>
<property name="Devices" type="ao" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Array of object paths representing devices which are part of this active
connection.
- </tp:docstring>
+ " />
</property>
<property name="State" type="u" access="read" tp:type="NM_ACTIVE_CONNECTION_STATE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The state of this active connection.
- </tp:docstring>
+ " />
</property>
<property name="Default" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Whether this active connection is the default IPv4 connection, i.e.
whether it currently owns the default IPv4 route.
- </tp:docstring>
+ " />
</property>
<property name="Ip4Config" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the Ip4Config object describing the configuration of the
connection. Only valid when the connection is in the
NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
- </tp:docstring>
+ " />
</property>
<property name="Dhcp4Config" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the Dhcp4Config object describing the DHCP options
returned by the DHCP server (assuming the connection used DHCP). Only
valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED
state.
- </tp:docstring>
+ " />
</property>
<property name="Default6" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Whether this active connection is the default IPv6 connection, i.e.
whether it currently owns the default IPv6 route.
- </tp:docstring>
+ " />
</property>
<property name="Ip6Config" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the Ip6Config object describing the configuration of the
connection. Only valid when the connection is in the
NM_ACTIVE_CONNECTION_STATE_ACTIVATED state.
- </tp:docstring>
+ " />
</property>
<property name="Dhcp6Config" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the Dhcp6Config object describing the DHCP options
returned by the DHCP server (assuming the connection used DHCP). Only
valid when the connection is in the NM_ACTIVE_CONNECTION_STATE_ACTIVATED
state.
- </tp:docstring>
+ " />
</property>
<property name="Vpn" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Whether this active connection is also a VPN connection.
- </tp:docstring>
+ " />
</property>
<property name="Master" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The path to the master device if the connection is a slave.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<tp:enum name="NM_ACTIVE_CONNECTION_STATE" type="u">
<tp:enumvalue suffix="UNKNOWN" value="0">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The active connection is in an unknown state.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="ACTIVATING" value="1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The connection is activating.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="ACTIVATED" value="2">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The connection is activated.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="DEACTIVATING" value="3">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The connection is being torn down and cleaned up.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="DEACTIVATED" value="4">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The connection is no longer active.
- </tp:docstring>
+ " />
</tp:enumvalue>
</tp:enum>
</interface>
<interface name="org.freedesktop.NetworkManager.AgentManager">
<method name="Register">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Called by secret Agents to register their ability to provide and save
network secrets.
- </tp:docstring>
+ " />
<arg name="identifier" type="s" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Identifies this agent; only one agent in each user session may use the
same identifier. Identifier formatting follows the same rules as
D-Bus bus names with the exception that the ':' character is not
- allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the
+ allowed. The valid set of characters is "[A-Z][a-z][0-9]_-." and the
identifier is limited in length to 255 characters with a minimum
of 3 characters. An example valid identifier is 'org.gnome.nm-applet'
(without quotes).
- </tp:docstring>
+ " />
</arg>
</method>
<method name="RegisterWithCapabilities">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Like Register() but indicates agent capabilities to NetworkManager.
- </tp:docstring>
+ " />
<arg name="identifier" type="s" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
See the Register() method's identifier argument.
- </tp:docstring>
+ " />
</arg>
<arg name="capabilities" type="u" direction="in" tp:type="NM_SECRET_AGENT_CAPABILITIES">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates various agent capabilities to NetworkManager.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="Unregister">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Called by secret Agents to notify NetworkManager that they will no
longer handle requests for network secrets. Agents are automatically
unregistered when they disconnect from D-Bus.
- </tp:docstring>
+ " />
</method>
</interface>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<property name="Carrier" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates whether the physical carrier is found.
- </tp:docstring>
+ " />
</property>
</interface>
<interface name="org.freedesktop.NetworkManager.Device.Bond">
<property name="HwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Hardware address of the device.
- </tp:docstring>
+ " />
</property>
<property name="Carrier" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
- </tp:docstring>
+ " />
</property>
<property name="Slaves" type="ao" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Array of object paths representing devices which are currently
slaved to this device.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<interface name="org.freedesktop.NetworkManager.Device.Bridge">
<property name="HwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Hardware address of the device.
- </tp:docstring>
+ " />
</property>
<property name="Carrier" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
- </tp:docstring>
+ " />
</property>
<property name="Slaves" type="ao" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Array of object paths representing devices which are currently
slaved to this device.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<interface name="org.freedesktop.NetworkManager.Device.Bluetooth">
<property name="HwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Bluetooth hardware address of the device.
- </tp:docstring>
+ " />
</property>
<property name="Name" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Bluetooth name of the device.
- </tp:docstring>
+ " />
</property>
<property name="BtCapabilities" type="u" access="read" tp:type="NM_BT_CAPABILITIES">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Bluetooth capabilities of the device (either DUN or NAP).
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<tp:flags name="NM_BT_CAPABILITIES" value-prefix="NM_BT_CAPABILITY" type="u">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Flags describing the capabilities of a Bluetooth device.
- </tp:docstring>
+ " />
<tp:flag suffix="NONE" value="0x0">
- <tp:docstring>The device has no recognized capabilities.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The device has no recognized capabilities." />
</tp:flag>
<tp:flag suffix="DUN" value="0x1">
- <tp:docstring>The device supports Bluetooth Dial-Up Networking.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The device supports Bluetooth Dial-Up Networking." />
</tp:flag>
<tp:flag suffix="PAN" value="0x2">
- <tp:docstring>The device supports Bluetooth Personal Area Networking.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The device supports Bluetooth Personal Area Networking." />
</tp:flag>
</tp:flags>
<annotation name="org.gtk.GDBus.C.Name" value="DeviceEthernet"/>
<property name="HwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Active hardware address of the device.
- </tp:docstring>
+ " />
</property>
<property name="PermHwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Permanent hardware address of the device.
- </tp:docstring>
+ " />
</property>
<property name="Speed" type="u" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Design speed of the device, in megabits/second (Mb/s).
- </tp:docstring>
+ " />
</property>
<property name="S390Subchannels" type="as" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Array of S/390 subchannels for S/390 or z/Architecture devices.
- </tp:docstring>
+ " />
</property>
<property name="Carrier" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<interface name="org.freedesktop.NetworkManager.Device.Generic">
<property name="HwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Hardware address of the device.
- </tp:docstring>
+ " />
</property>
<property name="TypeDescription" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A (non-localized) description of the interface type, if known.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<interface name="org.freedesktop.NetworkManager.Device.Infiniband">
<property name="HwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Hardware address of the device.
- </tp:docstring>
+ " />
</property>
<property name="Carrier" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<interface name="org.freedesktop.NetworkManager.Device.IPTunnel">
<property name="Mode" type="u" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The tunneling mode.
- </tp:docstring>
+ " />
</property>
<property name="Parent" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The object path of the parent device.
- </tp:docstring>
+ " />
</property>
<property name="Local" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The local endpoint of the tunnel.
- </tp:docstring>
+ " />
</property>
<property name="Remote" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The remote endpoint of the tunnel.
- </tp:docstring>
+ " />
</property>
<property name="Ttl" type="y" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The TTL assigned to tunneled packets. 0 is a special value
meaning that packets inherit the TTL value
- </tp:docstring>
+ " />
</property>
<property name="Tos" type="y" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The type of service (IPv4) or traffic class (IPv6) assigned to
tunneled packets.
- </tp:docstring>
+ " />
</property>
<property name="PathMtuDiscovery" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Whether path MTU discovery is enabled on this tunnel.
- </tp:docstring>
+ " />
</property>
<property name="InputKey" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The key used for incoming packets.
- </tp:docstring>
+ " />
</property>
<property name="OutputKey" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The key used for outgoing packets.
- </tp:docstring>
+ " />
</property>
<property name="EncapsulationLimit" type="y" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
How many additional levels of encapsulation are permitted to
be prepended to packets. This property applies only to IPv6
tunnels.
- </tp:docstring>
+ " />
</property>
<property name="FlowLabel" type="u" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The flow label to assign to tunnel packets. This property
applies only to IPv6 tunnels.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<interface name="org.freedesktop.NetworkManager.Device.Macvlan">
<property name="Parent" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The object path of the parent device.
- </tp:docstring>
+ " />
</property>
<property name="Mode" type="s" access="read">
- <tp:docstring>
- The macvlan mode, one of "private", "vepa", "bridge", or "passthru".
- </tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
+ The macvlan mode, one of "private", "vepa", "bridge", or "passthru".
+ " />
</property>
<property name="NoPromisc" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Whether the device is blocked from going into promiscuous mode.
- </tp:docstring>
+ " />
</property>
<property name="Tap" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Whether the device is a macvtap.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<property name="ModemCapabilities" type="u" access="read" tp:type="NM_DEVICE_MODEM_CAPABILITIES">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The generic family of access technologies the modem supports. Not all
capabilities are available at the same time however; some modems require
a firmware reload or other reinitialization to switch between eg CDMA/EVDO
and GSM/UMTS.
- </tp:docstring>
+ " />
</property>
<property name="CurrentCapabilities" type="u" access="read" tp:type="NM_DEVICE_MODEM_CAPABILITIES">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The generic family of access technologies the modem currently supports
without a firmware reload or reinitialization.
- </tp:docstring>
+ " />
</property>
<tp:flags name="NM_DEVICE_MODEM_CAPABILITIES" value-prefix="NM_DEVICE_MODEM_CAPABILITY" type="u">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Flags describing one or more of the general access technology families
that a modem device supports.
- </tp:docstring>
+ " />
<tp:flag suffix="NONE" value="0x0">
- <tp:docstring>Modem has no capabilties.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Modem has no capabilties." />
</tp:flag>
<tp:flag suffix="POTS" value="0x1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Modem supports the analog wired telephone network (ie 56k dialup) and
does not have wireless/cellular capabilities.
- </tp:docstring>
+ " />
</tp:flag>
<tp:flag suffix="CDMA_EVDO" value="0x2">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Modem supports at least one of CDMA 1xRTT, EVDO revision 0, EVDO
revision A, or EVDO revision B.
- </tp:docstring>
+ " />
</tp:flag>
<tp:flag suffix="GSM_UMTS" value="0x4">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Modem supports at least one of GSM, GPRS, EDGE, UMTS, HSDPA, HSUPA, or
HSPA+ packet switched data capability.
- </tp:docstring>
+ " />
</tp:flag>
<tp:flag suffix="LTE" value="0x8">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Modem has at LTE data capability.
- </tp:docstring>
+ " />
</tp:flag>
</tp:flags>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.Device.OlpcMesh">
<property name="HwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The hardware address of the device.
- </tp:docstring>
+ " />
</property>
<property name="Companion" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The object path of the companion device.
- </tp:docstring>
+ " />
</property>
<property name="ActiveChannel" type="u" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The currently active channel.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary containing the FIXME: check changed parameters.
- </tp:docstring>
+ " />
</arg>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when the wireless device's properties changed.
- </tp:docstring>
+ " />
</signal>
</interface>
</node>
<interface name="org.freedesktop.NetworkManager.Device.Team">
<property name="HwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Hardware address of the device.
- </tp:docstring>
+ " />
</property>
<property name="Carrier" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
- </tp:docstring>
+ " />
</property>
<property name="Slaves" type="ao" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Array of object paths representing devices which are currently
slaved to this device.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<interface name="org.freedesktop.NetworkManager.Device.Tun">
<property name="Owner" type="x" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The uid of the tunnel owner, or -1 if it has no owner.
- </tp:docstring>
+ " />
</property>
<property name="Group" type="x" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The gid of the tunnel group, or -1 if it has no owner.
- </tp:docstring>
+ " />
</property>
<property name="Mode" type="s" access="read">
- <tp:docstring>
- The tunnel mode, either "tun" or "tap".
- </tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
+ The tunnel mode, either "tun" or "tap".
+ " />
</property>
<property name="NoPi" type="b" access="read">
- <tp:docstring>
- The tunnel's "TUN_NO_PI" flag; true if no protocol info is
+ <annotation name="org.gtk.GDBus.DocString" value="
+ The tunnel's "TUN_NO_PI" flag; true if no protocol info is
prepended to the tunnel packets.
- </tp:docstring>
+ " />
</property>
<property name="VnetHdr" type="b" access="read">
- <tp:docstring>
- The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets
+ <annotation name="org.gtk.GDBus.DocString" value="
+ The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets
include a virtio network header.
- </tp:docstring>
+ " />
</property>
<property name="MultiQueue" type="b" access="read">
- <tp:docstring>
- The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to
+ <annotation name="org.gtk.GDBus.DocString" value="
+ The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to
the tap device multiple times, for multiple send/receive
queues.
- </tp:docstring>
+ " />
</property>
<property name="HwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Hardware address of the device.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<interface name="org.freedesktop.NetworkManager.Device.Veth">
<property name="Peer" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The object path of the device's peer.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<interface name="org.freedesktop.NetworkManager.Device.Vlan">
<property name="HwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Hardware address of the device.
- </tp:docstring>
+ " />
</property>
<property name="Carrier" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not).
- </tp:docstring>
+ " />
</property>
<property name="Parent" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the parent device of this VLAN device.
- </tp:docstring>
+ " />
</property>
<property name="VlanId" type="u" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The VLAN ID of this VLAN interface.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<interface name="org.freedesktop.NetworkManager.Device.Vxlan">
<property name="Parent" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The object path of the parent device (if the VXLAN is not
purely internal to this host).
- </tp:docstring>
+ " />
</property>
<property name="HwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Hardware address of the device.
- </tp:docstring>
+ " />
</property>
<property name="Id" type="u" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The VXLAN Network Identifier (VNI).
- </tp:docstring>
+ " />
</property>
<property name="Group" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The IP (v4 or v6) multicast group used to communicate with other physical
hosts on this VXLAN.
- </tp:docstring>
+ " />
</property>
<property name="Local" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The local IPv4 or IPv6 address to use when sending VXLAN packets to other
physical hosts.
- </tp:docstring>
+ " />
</property>
<property name="Tos" type="y" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The value to use in the IP ToS field for VXLAN packets sent to
other physical hosts.
- </tp:docstring>
+ " />
</property>
<property name="Ttl" type="y" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The value to use in the IP TTL field for VXLAN packets sent to
other physical hosts.
- </tp:docstring>
+ " />
</property>
<property name="Learning" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
True if the VXLAN dynamically learns remote IP addresses.
- </tp:docstring>
+ " />
</property>
<property name="Ageing" type="u" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The interval in seconds at which the kernel purges stale
cached addresses.
- </tp:docstring>
+ " />
</property>
<property name="Limit" type="u" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The maximum number of entries that can be added to the VXLAN's
forwarding table.
- </tp:docstring>
+ " />
</property>
<property name="DstPort" type="q" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Destination port for outgoing VXLAN packets.
- </tp:docstring>
+ " />
</property>
<property name="SrcPortMin" type="q" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The lowest source port number to use for outgoing VXLAN packets.
- </tp:docstring>
+ " />
</property>
<property name="SrcPortMax" type="q" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The highest source port number to use for outgoing VXLAN packets.
- </tp:docstring>
+ " />
</property>
<property name="Proxy" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
True if the VXLAN is implementing DOVE ARP proxying for remote
clients.
- </tp:docstring>
+ " />
</property>
<property name="Rsc" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
True if the VXLAN is implementing DOVE route short-circuiting
of known remote IP addresses.
- </tp:docstring>
+ " />
</property>
<property name="L2miss" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
True if the VXLAN will emit netlink notifications of L2 switch
misses.
- </tp:docstring>
+ " />
</property>
<property name="L3miss" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
True if the VXLAN will emit netlink notifications of L3 switch
misses.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<method name="GetAccessPoints">
<arg name="access_points" type="ao" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
List of access point object paths.
- </tp:docstring>
+ " />
</arg>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</method>
<method name="GetAllAccessPoints">
<arg name="access_points" type="ao" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
List of access point object paths.
- </tp:docstring>
+ " />
</arg>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Get the list of all access points visible to this device, including
hidden ones for which the SSID is not yet known.
- </tp:docstring>
+ " />
</method>
<method name="RequestScan">
<arg name="options" type="a{sv}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Options of scan.
- Currently 'ssids' option with value of "aay" type is supported.
- </tp:docstring>
+ Currently 'ssids' option with value of "aay" type is supported.
+ " />
</arg>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Request the device to scan
- </tp:docstring>
+ " />
</method>
<property name="HwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The active hardware address of the device.
- </tp:docstring>
+ " />
</property>
<property name="PermHwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The permanent hardware address of the device.
- </tp:docstring>
+ " />
</property>
<property name="Mode" type="u" access="read" tp:type="NM_802_11_MODE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The operating mode of the wireless device.
- </tp:docstring>
+ " />
</property>
<property name="Bitrate" type="u" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The bit rate currently used by the wireless device, in kilobits/second (Kb/s).
- </tp:docstring>
+ " />
</property>
<property name="AccessPoints" type="ao" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
List of object paths of access point visible to this wireless device.
- </tp:docstring>
+ " />
</property>
<property name="ActiveAccessPoint" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the access point currently used by the wireless device.
- </tp:docstring>
+ " />
</property>
<property name="WirelessCapabilities" type="u" access="read" tp:type="NM_802_11_DEVICE_CAP">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The capabilities of the wireless device.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary containing the FIXME: check changed parameters.
- </tp:docstring>
+ " />
</arg>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when the wireless device's properties changed.
- </tp:docstring>
+ " />
</signal>
<signal name="AccessPointAdded">
<arg name="access_point" type="o">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The object path of the newly found access point.
- </tp:docstring>
+ " />
</arg>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when a new access point is found by the device.
- </tp:docstring>
+ " />
</signal>
<signal name="AccessPointRemoved">
<arg name="access_point" type="o">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The object path of the access point that has disappeared.
- </tp:docstring>
+ " />
</arg>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when an access point disappears from view of the device.
- </tp:docstring>
+ " />
</signal>
<tp:flags name="NM_802_11_DEVICE_CAP" type="u">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Flags describing the capabilities of a wireless device.
- </tp:docstring>
+ " />
<tp:flag suffix="NONE" value="0x0">
- <tp:docstring>Null capability - syntactic sugar for no capabilities supported. Do not AND this with other capabilities!</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Null capability - syntactic sugar for no capabilities supported. Do not AND this with other capabilities!" />
</tp:flag>
<tp:flag suffix="CIPHER_WEP40" value="0x1">
- <tp:docstring>The device supports the 40-bit WEP cipher.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The device supports the 40-bit WEP cipher." />
</tp:flag>
<tp:flag suffix="CIPHER_WEP104" value="0x2">
- <tp:docstring>The device supports the 104-bit WEP cipher.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The device supports the 104-bit WEP cipher." />
</tp:flag>
<tp:flag suffix="CIPHER_TKIP" value="0x4">
- <tp:docstring>The device supports the TKIP cipher.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The device supports the TKIP cipher." />
</tp:flag>
<tp:flag suffix="CIPHER_CCMP" value="0x8">
- <tp:docstring>The device supports the CCMP cipher.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The device supports the CCMP cipher." />
</tp:flag>
<tp:flag suffix="WPA" value="0x10">
- <tp:docstring>The device supports the WPA encryption/authentication protocol.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The device supports the WPA encryption/authentication protocol." />
</tp:flag>
<tp:flag suffix="RSN" value="0x20">
- <tp:docstring>The device supports the RSN encryption/authentication protocol.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The device supports the RSN encryption/authentication protocol." />
</tp:flag>
<tp:flag suffix="AP" value="0x40">
- <tp:docstring>The device supports Access Point mode.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The device supports Access Point mode." />
</tp:flag>
<tp:flag suffix="ADHOC" value="0x80">
- <tp:docstring>The device supports Ad-Hoc mode.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The device supports Ad-Hoc mode." />
</tp:flag>
<tp:flag suffix="FREQ_VALID" value="0x100">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</tp:flag>
<tp:flag suffix="FREQ_2GHZ" value="0x200">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device supports 2.4GHz frequencies.
- </tp:docstring>
+ " />
</tp:flag>
<tp:flag suffix="FREQ_5GHZ" value="0x400">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device supports 5GHz frequencies.
- </tp:docstring>
+ " />
</tp:flag>
</tp:flags>
</interface>
<interface name="org.freedesktop.NetworkManager.Device.WiMax">
<method name="GetNspList">
<arg name="nsps" type="ao" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
List of NSP object paths
- </tp:docstring>
+ " />
</arg>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Get the list of NSPs visible to this device.
- </tp:docstring>
+ " />
</method>
<property name="Nsps" type="ao" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
List of object paths of Network Service Providers (NSPs) visible to this
WiMAX device.
- </tp:docstring>
+ " />
</property>
<property name="HwAddress" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Hardware address of the device.
- </tp:docstring>
+ " />
</property>
<property name="CenterFrequency" type="u" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</property>
<property name="Rssi" type="i" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</property>
<property name="Cinr" type="i" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</property>
<property name="TxPower" type="i" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</property>
<property name="Bsid" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The ID of the serving base station as received from the network. Has
no meaning when the device is not connected.
- </tp:docstring>
+ " />
</property>
<property name="ActiveNsp" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the NSP currently used by the WiMax device.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values.
- </tp:docstring>
+ " />
</arg>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when the WiMax device's properties changed.
- </tp:docstring>
+ " />
</signal>
<signal name="NspAdded">
<arg name="nsp" type="o">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The object path of the newly found NSP.
- </tp:docstring>
+ " />
</arg>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when a new NSP is found by the device.
- </tp:docstring>
+ " />
</signal>
<signal name="NspRemoved">
<arg name="nsp" type="o">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The object path of the NSP that has disappeared.
- </tp:docstring>
+ " />
</arg>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when an NSP disappears from view of the device.
- </tp:docstring>
+ " />
</signal>
</interface>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.Device">
<property name="Udi" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Operating-system specific transient device hardware identifier. This
is an opaque string representing the underlying hardware for the device,
and shouldn't be used to keep track of individual devices. For some
object path. If you're looking for a way to track a specific piece of
hardware across reboot or hotplug, use a MAC address or USB serial
number.
- </tp:docstring>
+ " />
</property>
<property name="Interface" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The name of the device's control (and often data) interface.
- </tp:docstring>
+ " />
</property>
<property name="IpInterface" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The name of the device's data interface when available. This property
may not refer to the actual data interface until the device has
successfully established a data connection, indicated by the device's
State becoming ACTIVATED.
- </tp:docstring>
+ " />
</property>
<property name="Driver" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The driver handling the device.
- </tp:docstring>
+ " />
</property>
<property name="DriverVersion" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The version of the driver handling the device.
- </tp:docstring>
+ " />
</property>
<property name="FirmwareVersion" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The firmware version for the device.
- </tp:docstring>
+ " />
</property>
<property name="Capabilities" type="u" access="read" tp:type="NM_DEVICE_CAP">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Flags describing the capabilities of the device.
- </tp:docstring>
+ " />
</property>
<property name="Ip4Address" type="u" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object instead.
- </tp:docstring>
+ " />
</property>
<property name="State" type="u" access="read" tp:type="NM_DEVICE_STATE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The current state of the device.
- </tp:docstring>
+ " />
</property>
<property name="StateReason" type="(uu)" access="read" tp:type="NM_DEVICE_STATE_REASON_STRUCT">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The current state and reason for changing to that state.
- </tp:docstring>
+ " />
</property>
<property name="ActiveConnection" type="o" access="read">
- <tp:docstring>
- Object path of an ActiveConnection object that "owns" this device during
+ <annotation name="org.gtk.GDBus.DocString" value="
+ Object path of an ActiveConnection object that "owns" this device during
activation. The ActiveConnection object tracks the life-cycle of a
connection to a specific network and implements the
org.freedesktop.NetworkManager.Connection.Active D-Bus interface.
- </tp:docstring>
+ " />
</property>
<property name="Ip4Config" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the Ip4Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.
- </tp:docstring>
+ " />
</property>
<property name="Dhcp4Config" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the Dhcp4Config object describing the DHCP options returned by the DHCP server. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.
- </tp:docstring>
+ " />
</property>
<property name="Ip6Config" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the Ip6Config object describing the configuration of the device. Only valid when the device is in the NM_DEVICE_STATE_ACTIVATED state.
- </tp:docstring>
+ " />
</property>
<property name="Dhcp6Config" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the Dhcp6Config object describing the DHCP options
returned by the DHCP server. Only valid when the device is in the
NM_DEVICE_STATE_ACTIVATED state.
- </tp:docstring>
+ " />
</property>
<property name="Managed" type="b" access="readwrite">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Whether or not this device is managed by NetworkManager. Setting this
property has a similar effect to configuring the device as unmanaged
via the keyfile.unmanaged-devices setting in NetworkManager.conf.
Changes to this value are not persistent and lost after NetworkManager
restart.
- </tp:docstring>
+ " />
</property>
<property name="Autoconnect" type="b" access="readwrite">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
If TRUE, indicates the device is allowed to autoconnect. If FALSE,
manual intervention is required before the device will automatically
connect to a known network, such as activating a connection using the
device, or setting this property to TRUE. This property cannot be
set to TRUE for default-unmanaged devices, since they never autoconnect.
- </tp:docstring>
+ " />
</property>
<property name="FirmwareMissing" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
If TRUE, indicates the device is likely missing firmware necessary for
its operation.
- </tp:docstring>
+ " />
</property>
<property name="NmPluginMissing" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
If TRUE, indicates the NetworkManager plugin for the device is likely
missing or misconfigured.
- </tp:docstring>
+ " />
</property>
<property name="DeviceType" type="u" access="read" tp:type="NM_DEVICE_TYPE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The general type of the network device; ie Ethernet, WiFi, etc.
- </tp:docstring>
+ " />
</property>
<property name="AvailableConnections" type="ao" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
An array of object paths of every configured connection that is currently 'available' through this device.
- </tp:docstring>
+ " />
</property>
<property name="PhysicalPortId" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
If non-empty, an (opaque) indicator of the physical network
port associated with the device. This can be used to recognize
when two seemingly-separate hardware devices are actually just
different virtual interfaces to the same physical port.
- </tp:docstring>
+ " />
</property>
<property name="Mtu" type="u" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device MTU (maximum transmission unit).
- </tp:docstring>
+ " />
</property>
<property name="Metered" type="u" access="read" tp:type="NM_METERED">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Whether the amount of traffic flowing through the device is
subject to limitations, for example set by service providers.
- </tp:docstring>
+ " />
</property>
<property name="LldpNeighbors" type="aa{sv}" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Array of LLDP neighbors; each element is a dictionary mapping
LLDP TLV names to variant boxed values.
- </tp:docstring>
+ " />
</property>
<property name="Real" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
True if the device exists, or False for placeholder devices that
do not yet exist but could be automatically created by NetworkManager
if one of their AvailableConnections was activated.
- </tp:docstring>
+ " />
</property>
<method name="Reapply">
<arg name="connection" type="a{sa{sv}}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</arg>
<arg name="version_id" type="t" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</arg>
<arg name="flags" type="u" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</arg>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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
of NetworkManager).
Reapply can make the applied-connection different from the settings-connection,
just like updating the settings-connection can make them different.
- </tp:docstring>
+ " />
</method>
<method name="GetAppliedConnection">
<arg name="flags" type="u" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</arg>
<arg name="connection" type="a{sa{sv}}" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The effective connection settings that the connection has currently applied.
- </tp:docstring>
+ " />
</arg>
<arg name="version_id" type="t" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</arg>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</method>
<method name="Disconnect">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Disconnects a device and prevents the device from automatically activating further connections without user intervention.
- </tp:docstring>
+ " />
</method>
<method name="Delete">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Deletes a software device from NetworkManager and removes the interface from the system.
The method returns an error when called for a hardware device.
- </tp:docstring>
+ " />
</method>
<signal name="StateChanged">
<arg name="new_state" type="u" tp:type="NM_DEVICE_STATE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The new state of the device.
- </tp:docstring>
+ " />
</arg>
<arg name="old_state" type="u" tp:type="NM_DEVICE_STATE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The previous state of the device.
- </tp:docstring>
+ " />
</arg>
<arg name="reason" type="u" tp:type="NM_DEVICE_STATE_REASON">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A reason for the state transition.
- </tp:docstring>
+ " />
</arg>
</signal>
<tp:enum name="NM_DEVICE_STATE" type="u">
<tp:enumvalue suffix="UNKNOWN" value="0">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is in an unknown state.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="UNMANAGED" value="10">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is recognized but not managed by NetworkManager.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="UNAVAILABLE" value="20">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device cannot be used (carrier off, rfkill, etc).
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="DISCONNECTED" value="30">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is not connected.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="PREPARE" value="40">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is preparing to connect.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONFIG" value="50">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is being configured.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="NEED_AUTH" value="60">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is awaiting secrets necessary to continue connection.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="IP_CONFIG" value="70">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The IP settings of the device are being requested and configured.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="IP_CHECK" value="80">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device's IP connectivity ability is being determined.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SECONDARIES" value="90">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is waiting for secondary connections to be activated.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="ACTIVATED" value="100">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is active.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="DEACTIVATING" value="110">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device's network connection is being torn down.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="FAILED" value="120">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is in a failure state following an attempt to activate it.
- </tp:docstring>
+ " />
</tp:enumvalue>
</tp:enum>
<tp:enum name="NM_DEVICE_TYPE" type="u">
<tp:enumvalue suffix="UNKNOWN" value="0">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device type is unknown.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="ETHERNET" value="1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is wired Ethernet device.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="WIFI" value="2">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is an 802.11 WiFi device.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="UNUSED1" value="3">
- <tp:docstring>Unused</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Unused" />
</tp:enumvalue>
<tp:enumvalue suffix="UNUSED2" value="4">
- <tp:docstring>Unused</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Unused" />
</tp:enumvalue>
<tp:enumvalue suffix="BT" value="5">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is Bluetooth device that provides PAN or DUN capabilities.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="OLPC_MESH" value="6">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is an OLPC mesh networking device.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="WIMAX" value="7">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is an 802.16e Mobile WiMAX device.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="MODEM" value="8">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is a modem supporting one or more of analog telephone,
CDMA/EVDO, GSM/UMTS/HSPA, or LTE standards to access a cellular or
wireline data network.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="INFINIBAND" value="9">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is an IP-capable InfiniBand interface.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="BOND" value="10">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is a bond master interface.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="VLAN" value="11">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is a VLAN interface.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="ADSL" value="12">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is an ADSL device supporting PPPoE and PPPoATM protocols.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="BRIDGE" value="13">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is a bridge interface.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="GENERIC" value="14">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is a generic interface type unrecognized by NetworkManager.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="TEAM" value="15">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is a team master interface.
- </tp:docstring>
+ " />
</tp:enumvalue>
</tp:enum>
<tp:flags name="NM_DEVICE_CAP" value-prefix="NM_DEVICE_CAP" type="u">
<tp:flag suffix="NONE" value="0x0">
- <tp:docstring>Null capability.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Null capability." />
</tp:flag>
<tp:flag suffix="NM_SUPPORTED" value="0x1">
- <tp:docstring>The device is supported by NetworkManager.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The device is supported by NetworkManager." />
</tp:flag>
<tp:flag suffix="CARRIER_DETECT" value="0x2">
- <tp:docstring>The device supports carrier detection.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The device supports carrier detection." />
</tp:flag>
</tp:flags>
<tp:enum name="NM_DEVICE_STATE_REASON" type="u">
<tp:enumvalue suffix="UNKNOWN" value="0">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The reason for the device state change is unknown.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="NONE" value="1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The state change is normal.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="NOW_MANAGED" value="2">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is now managed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="NOW_UNMANAGED" value="3">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is no longer managed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONFIG_FAILED" value="4">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device could not be readied for configuration.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONFIG_UNAVAILABLE" value="5">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
IP configuration could not be reserved (no available address, timeout, etc).
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONFIG_EXPIRED" value="6">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The IP configuration is no longer valid.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="NO_SECRETS" value="7">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Secrets were required, but not provided.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SUPPLICANT_DISCONNECT" value="8">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The 802.1X supplicant disconnected from the access point or authentication server.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SUPPLICANT_CONFIG_FAILED" value="9">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Configuration of the 802.1X supplicant failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SUPPLICANT_FAILED" value="10">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The 802.1X supplicant quit or failed unexpectedly.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SUPPLICANT_TIMEOUT" value="11">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The 802.1X supplicant took too long to authenticate.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="PPP_START_FAILED" value="12">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The PPP service failed to start within the allowed time.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="PPP_DISCONNECT" value="13">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The PPP service disconnected unexpectedly.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="PPP_FAILED" value="14">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The PPP service quit or failed unexpectedly.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="DHCP_START_FAILED" value="15">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The DHCP service failed to start within the allowed time.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="DHCP_ERROR" value="16">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The DHCP service reported an unexpected error.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="DHCP_FAILED" value="17">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The DHCP service quit or failed unexpectedly.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SHARED_START_FAILED" value="18">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The shared connection service failed to start.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SHARED_FAILED" value="19">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The shared connection service quit or failed unexpectedly.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="AUTOIP_START_FAILED" value="20">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The AutoIP service failed to start.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="AUTOIP_ERROR" value="21">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The AutoIP service reported an unexpected error.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="AUTOIP_FAILED" value="22">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The AutoIP service quit or failed unexpectedly.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="MODEM_BUSY" value="23">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Dialing failed because the line was busy.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="MODEM_NO_DIAL_TONE" value="24">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Dialing failed because there was no dial tone.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="MODEM_NO_CARRIER" value="25">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Dialing failed because there was carrier.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="MODEM_DIAL_TIMEOUT" value="26">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Dialing timed out.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="MODEM_DIAL_FAILED" value="27">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Dialing failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="MODEM_INIT_FAILED" value="28">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Modem initialization failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="GSM_APN_FAILED" value="29">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Failed to select the specified GSM APN.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="GSM_REGISTRATION_NOT_SEARCHING" value="30">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Not searching for networks.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="GSM_REGISTRATION_DENIED" value="31">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Network registration was denied.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="GSM_REGISTRATION_TIMEOUT" value="32">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Network registration timed out.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="GSM_REGISTRATION_FAILED" value="33">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Failed to register with the requested GSM network.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="GSM_PIN_CHECK_FAILED" value="34">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
PIN check failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="FIRMWARE_MISSING" value="35">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Necessary firmware for the device may be missing.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="REMOVED" value="36">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device was removed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SLEEPING" value="37">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
NetworkManager went to sleep.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONNECTION_REMOVED" value="38">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device's active connection was removed or disappeared.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="USER_REQUESTED" value="39">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A user or client requested the disconnection.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CARRIER" value="40">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device's carrier/link changed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONNECTION_ASSUMED" value="41">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device's existing connection was assumed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SUPPLICANT_AVAILABLE" value="42">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The 802.1x supplicant is now available.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="MODEM_NOT_FOUND" value="43">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The modem could not be found.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="BT_FAILED" value="44">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The Bluetooth connection timed out or failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="GSM_SIM_NOT_INSERTED" value="45">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
GSM Modem's SIM Card not inserted.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="GSM_SIM_PIN_REQUIRED" value="46">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
GSM Modem's SIM Pin required.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="GSM_SIM_PUK_REQUIRED" value="47">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
GSM Modem's SIM Puk required.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="GSM_SIM_WRONG" value="48">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
GSM Modem's SIM wrong
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="INFINIBAND_MODE" value="49">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
InfiniBand device does not support connected mode.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="DEPENDENCY_FAILED" value="50">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dependency of the connection failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="BR2684_FAILED" value="51">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Problem with the RFC 2684 Ethernet over ADSL bridge.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="MODEM_MANAGER_UNAVAILABLE" value="52">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
ModemManager was not running or quit unexpectedly.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SSID_NOT_FOUND" value="53">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The 802.11 Wi-Fi network could not be found.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SECONDARY_CONNECTION_FAILED" value="54">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A secondary connection of the base connection failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="DCB_FCOE_FAILED" value="55">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
DCB or FCoE setup failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="TEAMD_CONTROL_FAILED" value="56">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
teamd control failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="MODEM_FAILED" value="57">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Modem failed or no longer available.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="MODEM_AVAILABLE" value="58">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Modem now ready and available.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SIM_PIN_INCORRECT" value="59">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The SIM PIN was incorrect.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="NEW_ACTIVATION" value="60">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A new connection activation was enqueued.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="PARENT_CHANGED" value="61">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device's parent changed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="PARENT_MANAGED_CHANGED" value="62">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device parent's management changed.
- </tp:docstring>
+ " />
</tp:enumvalue>
</tp:enum>
<tp:enum name="NM_METERED" type="u">
<tp:enumvalue suffix="UNKNOWN" value="0">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device metered status is unknown.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="YES" value="1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is metered and the value was statically set.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="NO" value="2">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is not metered and the value was statically set.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="GUESS_YES" value="3">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is metered and the value was guessed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="GUESS_NO" value="4">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device is not metered and the value was guessed.
- </tp:docstring>
+ " />
</tp:enumvalue>
</tp:enum>
<tp:struct name="NM_DEVICE_STATE_REASON_STRUCT">
<tp:member type="u" name="state" tp:type="NM_DEVICE_STATE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The device state.
- </tp:docstring>
+ " />
</tp:member>
<tp:member type="u" name="reason" tp:type="NM_DEVICE_STATE_REASON">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The reason for originally changing to the device state.
- </tp:docstring>
+ " />
</tp:member>
</tp:struct>
</interface>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.DHCP4Config">
<annotation name="org.gtk.GDBus.C.Name" value="Dhcp4Config"/>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Options and configuration returned by the IPv4 DHCP server.
- </tp:docstring>
+ " />
<property name="Options" type="a{sv}" access="read">
- <tp:docstring>Configuration options returned by a DHCP server, if any.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Configuration options returned by a DHCP server, if any." />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
</interface>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.DHCP6Config">
<annotation name="org.gtk.GDBus.C.Name" value="Dhcp6Config"/>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Options and configuration returned by the IPv6 DHCP server.
- </tp:docstring>
+ " />
<property name="Options" type="a{sv}" access="read">
- <tp:docstring>Configuration options returned by a DHCP server, if any.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Configuration options returned by a DHCP server, if any." />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
</interface>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.IP4Config">
<property name="Addresses" type="aau" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Array of arrays of IPv4 address/prefix/gateway. All 3
elements of each array are in network byte order. Essentially:
[(addr, prefix, gateway), (addr, prefix, gateway), ...]
Deprecated: use AddressData and Gateway
- </tp:docstring>
+ " />
</property>
<property name="AddressData" type="aa{sv}" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Array of IP address data objects. All addresses will include
- "address" (an IP address string), and "prefix" (a uint). Some
+ "address" (an IP address string), and "prefix" (a uint). Some
addresses may include additional attributes.
- </tp:docstring>
+ " />
</property>
<property name="Gateway" type="s" access="read">
- <tp:docstring>The gateway in use.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The gateway in use." />
</property>
<property name="Routes" type="aau" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Arrays of IPv4 route/prefix/next-hop/metric. All 4 elements of
each tuple are in network byte order. 'route' and 'next hop'
are IPv4 addresses, while prefix and metric are simple
metric), (route, prefix, next-hop, metric), ...]
Deprecated: use RouteData
- </tp:docstring>
+ " />
</property>
<property name="RouteData" type="aa{sv}" access="read">
- <tp:docstring>
- Array of IP route data objects. All routes will include "dest"
- (an IP address string) and "prefix" (a uint). Some routes may
- include "next-hop" (an IP address string), "metric" (a uint),
+ <annotation name="org.gtk.GDBus.DocString" value="
+ Array of IP route data objects. All routes will include "dest"
+ (an IP address string) and "prefix" (a uint). Some routes may
+ include "next-hop" (an IP address string), "metric" (a uint),
and additional attributes.
- </tp:docstring>
+ " />
</property>
<property name="Nameservers" type="au" access="read">
- <tp:docstring>The nameservers in use.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The nameservers in use." />
</property>
<property name="Domains" type="as" access="read">
- <tp:docstring>A list of domains this address belongs to.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="A list of domains this address belongs to." />
</property>
<property name="Searches" type="as" access="read">
- <tp:docstring>A list of dns searches.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="A list of dns searches." />
</property>
<property name="DnsOptions" type="as" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A list of DNS options that modify the behavior of the DNS
resolver. See resolv.conf(5) manual page for the list of
supported options.
- </tp:docstring>
+ " />
</property>
<property name="WinsServers" type="au" access="read">
- <tp:docstring>The Windows Internet Name Service servers associated with the connection. Each address is in network byte order.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The Windows Internet Name Service servers associated with the connection. Each address is in network byte order." />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
</interface>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.IP6Config">
<property name="Addresses" type="a(ayuay)" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Array of tuples of IPv6 address/prefix/gateway.
Deprecated: use AddressData and Gateway.
- </tp:docstring>
+ " />
</property>
<property name="AddressData" type="aa{sv}" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Array of IP address data objects. All addresses will include
- "address" (an IP address string), and "prefix" (a uint). Some
+ "address" (an IP address string), and "prefix" (a uint). Some
addresses may include additional attributes.
- </tp:docstring>
+ " />
</property>
<property name="Gateway" type="s" access="read">
- <tp:docstring>The gateway in use.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The gateway in use." />
</property>
<property name="Routes" type="a(ayuayu)" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Tuples of IPv6 route/prefix/next-hop/metric.
Deprecated: use RouteData
- </tp:docstring>
+ " />
</property>
<property name="RouteData" type="aa{sv}" access="read">
- <tp:docstring>
- Array of IP route data objects. All routes will include "dest"
- (an IP address string) and "prefix" (a uint). Some routes may
- include "next-hop" (an IP address string), "metric" (a uint),
+ <annotation name="org.gtk.GDBus.DocString" value="
+ Array of IP route data objects. All routes will include "dest"
+ (an IP address string) and "prefix" (a uint). Some routes may
+ include "next-hop" (an IP address string), "metric" (a uint),
and additional attributes.
- </tp:docstring>
+ " />
</property>
<property name="Nameservers" type="aay" access="read">
<!-- gdbus-codegen assumes that "aay" means "array of non-UTF-8
- string" and so would make this a char **.
+ string" and so would make this a char **.
-->
<annotation name="org.gtk.GDBus.C.ForceGVariant" value="1"/>
- <tp:docstring>The nameservers in use.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The nameservers in use." />
</property>
<property name="Domains" type="as" access="read">
- <tp:docstring>A list of domains this address belongs to.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="A list of domains this address belongs to." />
</property>
<property name="Searches" type="as" access="read">
- <tp:docstring>A list of dns searches.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="A list of dns searches." />
</property>
<property name="DnsOptions" type="as" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A list of DNS options that modify the behavior of the DNS
resolver. See resolv.conf(5) manual page for the list of
supported options.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
</interface>
<annotation name="org.gtk.GDBus.C.Name" value="Manager"/>
<method name="GetDevices">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Get the list of realized network devices.
- </tp:docstring>
+ " />
<arg name="devices" type="ao" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
List of object paths of network devices known to the system. This
list does not include device placeholders (see GetAllDevices()).
- </tp:docstring>
+ " />
</arg>
</method>
<method name="GetAllDevices">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Get the list of all network devices.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_manager_get_all_devices"/>
<arg name="devices" type="ao" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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).
- </tp:docstring>
+ " />
</arg>
</method>
<method name="GetDeviceByIpIface">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
<arg name="iface" type="s" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Interface name of the device to find.
- </tp:docstring>
+ " />
</arg>
<arg name="device" type="o" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the network device.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="ActivateConnection">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Activate a connection using the supplied device.
- </tp:docstring>
+ " />
<arg name="connection" type="o" direction="in">
- <tp:docstring>
- The connection to activate. If "/" is given, a valid device path must
+ <annotation name="org.gtk.GDBus.DocString" value="
+ 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.
- </tp:docstring>
+ " />
</arg>
<arg name="device" type="o" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</arg>
<arg name="specific_object" type="o" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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
+ 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
+ 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.
- </tp:docstring>
+ "base" connection (to which the VPN connections lifetime will be tied),
+ or pass "/" and NM will automatically use the current default device.
+ " />
</arg>
<arg name="active_connection" type="o" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The path of the active connection object representing this active connection.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="AddAndActivateConnection">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
<arg name="connection" type="a{sa{sv}}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Connection settings and properties; if incomplete missing settings will
be automatically completed using the given device and specific object.
- </tp:docstring>
+ " />
</arg>
<arg name="device" type="o" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The object path of device to be activated using the given connection.
- </tp:docstring>
+ " />
</arg>
<arg name="specific_object" type="o" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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
+ 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.
- </tp:docstring>
+ " />
</arg>
<arg name="path" type="o" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the new connection that was just added.
- </tp:docstring>
+ " />
</arg>
<arg name="active_connection" type="o" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The path of the active connection object representing this active connection.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="DeactivateConnection">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Deactivate an active connection.
- </tp:docstring>
+ " />
<arg name="active_connection" type="o" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The currently active connection to deactivate.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="Sleep">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
<arg name="sleep" type="b" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates whether the NetworkManager daemon should sleep or wake.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="Enable">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
<arg name="enable" type="b" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
If FALSE, indicates that all networking should be disabled. If TRUE,
indicates that NetworkManager should begin managing network devices.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="GetPermissions">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Returns the permissions a caller has for various authenticated operations
that NetworkManager provides, like Enable/Disable networking, changing
WiFi, WWAN, and WiMAX state, etc.
- </tp:docstring>
+ " />
<arg name="permissions" type="a{ss}" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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
+ 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.
- </tp:docstring>
+ " />
</arg>
</method>
<signal name="CheckPermissions">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when system authorization details change, indicating that
clients may wish to recheck permissions with GetPermissions.
- </tp:docstring>
+ " />
</signal>
<method name="SetLogging">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Set logging verbosity and which operations are logged.
- </tp:docstring>
+ " />
<arg name="level" type="s" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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
+ 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.
- </tp:docstring>
+ " />
</arg>
<arg name="domains" type="s" direction="in">
- <tp:docstring>
- A combination of logging domains separated by commas (','), or "NONE"
+ <annotation name="org.gtk.GDBus.DocString" value="
+ 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,
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.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="GetLogging">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Get current logging verbosity level and operations domains.
- </tp:docstring>
+ " />
<arg name="level" type="s" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
One of [ERR, WARN, INFO, DEBUG, TRACE].
- </tp:docstring>
+ " />
</arg>
<arg name="domains" type="s" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
For available domains see SetLogging() call.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="CheckConnectivity">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Re-check the network connectivity state.
- </tp:docstring>
+ " />
<arg name="connectivity" type="u" tp:type="NM_CONNECTIVITY" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The current connectivity state.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="state">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The overall networking state as determined by the NetworkManager daemon,
based on the state of network devices under it's management.
- </tp:docstring>
+ " />
<arg name="state" type="u" direction="out" tp:type="NM_STATE"/>
</method>
<property name="Devices" type="ao" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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).
- </tp:docstring>
+ " />
</property>
<property name="AllDevices" type="ao" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</property>
<property name="NetworkingEnabled" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates if overall networking is currently enabled or not. See the
Enable() method.
- </tp:docstring>
+ " />
</property>
<property name="WirelessEnabled" type="b" access="readwrite">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates if wireless is currently enabled or not.
- </tp:docstring>
+ " />
</property>
<property name="WirelessHardwareEnabled" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates if the wireless hardware is currently enabled, i.e. the state of the RF kill switch.
- </tp:docstring>
+ " />
</property>
<property name="WwanEnabled" type="b" access="readwrite">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates if mobile broadband devices are currently enabled or not.
- </tp:docstring>
+ " />
</property>
<property name="WwanHardwareEnabled" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates if the mobile broadband hardware is currently enabled, i.e. the state of the RF kill switch.
- </tp:docstring>
+ " />
</property>
<property name="WimaxEnabled" type="b" access="readwrite">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates if WiMAX devices are currently enabled or not.
- </tp:docstring>
+ " />
</property>
<property name="WimaxHardwareEnabled" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates if the WiMAX hardware is currently enabled, i.e. the state of the RF kill switch.
- </tp:docstring>
+ " />
</property>
<property name="ActiveConnections" type="ao" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
List of active connection object paths.
- </tp:docstring>
+ " />
</property>
<property name="PrimaryConnection" type="o" access="read">
- <tp:docstring>
- The object path of the "primary" active connection being used
+ <annotation name="org.gtk.GDBus.DocString" value="
+ 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.
- </tp:docstring>
+ " />
</property>
<property name="PrimaryConnectionType" type="s" access="read">
- <tp:docstring>
- The connection type of the "primary" active connection being
+ <annotation name="org.gtk.GDBus.DocString" value="
+ 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.
- </tp:docstring>
+ " />
</property>
<property name="Metered" type="u" access="read" tp:type="NM_METERED">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicates whether the connectivity is metered. This is equivalent
to the metered property of the device associated with the primary
connection.
- </tp:docstring>
+ " />
</property>
<property name="ActivatingConnection" type="o" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</property>
<property name="Startup" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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.
- </tp:docstring>
+ " />
</property>
<property name="Version" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
NetworkManager version.
- </tp:docstring>
+ " />
</property>
<property name="State" type="u" access="read" tp:type="NM_STATE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The overall state of the NetworkManager daemon.
- </tp:docstring>
+ " />
</property>
<signal name="StateChanged">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
NetworkManager's state changed.
- </tp:docstring>
+ " />
<arg name="state" type="u" tp:type="NM_STATE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The new state of NetworkManager.
- </tp:docstring>
+ " />
</arg>
</signal>
<property name="Connectivity" type="u" access="read" tp:type="NM_CONNECTIVITY">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The network connectivity state.
- </tp:docstring>
+ " />
</property>
<property name="GlobalDnsConfiguration" type="a{sv}" access="readwrite">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
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
+ "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,
+ 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.
- </tp:docstring>
+ 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.
+ " />
</property>
<signal name="PropertiesChanged">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
NetworkManager's properties changed.
- </tp:docstring>
+ " />
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The changed properties.
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="DeviceAdded">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A device was added to the system
- </tp:docstring>
+ " />
<arg name="device_path" type="o">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The object path of the newly added device.
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="DeviceRemoved">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A device was removed from the system, and is no longer available.
- </tp:docstring>
+ " />
<arg name="device_path" type="o">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The object path of the device that was just removed.
- </tp:docstring>
+ " />
</arg>
</signal>
<tp:enum name="NM_STATE" type="u">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Describes the overall state of the daemon.
- </tp:docstring>
+ " />
<tp:enumvalue suffix="UNKNOWN" value="0">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Networking state is unknown.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="ASLEEP" value="10">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Networking is inactive and all devices are disabled.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="DISCONNECTED" value="20">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
There is no active network connection.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="DISCONNECTING" value="30">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Network connections are being cleaned up.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONNECTING" value="40">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A network device is connecting to a network and there is no other
available network connection.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONNECTED_LOCAL" value="50">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A network device is connected, but there is only link-local connectivity.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONNECTED_SITE" value="60">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A network device is connected, but there is only site-local connectivity.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONNECTED_GLOBAL" value="70">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A network device is connected, with global network connectivity.
- </tp:docstring>
+ " />
</tp:enumvalue>
</tp:enum>
<tp:enum name="NM_CONNECTIVITY" type="u">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Describes the network-connectivity state.
- </tp:docstring>
+ " />
<tp:enumvalue suffix="UNKNOWN" value="0">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Network connectivity is unknown.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="NONE" value="1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The host is not connected to any network.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="PORTAL" value="2">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The host is behind a captive portal and cannot reach the
full Internet.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="LIMITED" value="3">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The host is connected to a network, but does not appear to
be able to reach the full Internet.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="FULL" value="4">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The host is connected to a network, and appears to be able
to reach the full Internet
- </tp:docstring>
+ " />
</tp:enumvalue>
</tp:enum>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.SecretAgent">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Private D-Bus interface used by secret agents that store and provide
secrets to NetworkManager. If an agent provides secrets to
NetworkManager as part of connection creation, and the some of those
- secrets are "agent owned" the agent should store those secrets
+ secrets are "agent owned" the agent should store those secrets
itself and should not expect its SaveSecrets() method to be called.
SaveSecrets() will be called eg if some program other than the
agent itself (like a connection editor) changes the secrets out of
band. The agent should implement this D-Bus interface on an object
with the path /org/freedesktop/NetworkManager/SecretAgent.
- </tp:docstring>
+ " />
<method name="GetSecrets">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Retrieve and return stored secrets, if any, or request new
secrets from the agent's user. If user interaction is allowed
and the user enters new secrets, the agent is expected to save
secrets back to the same agent via a SaveSecrets() call. If
the user canceled any interaction, the agent should return the
UserCanceled error (see below).
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_get_secrets"/>
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Nested settings maps containing the connection for which
secrets are being requested. This may contain system-owned
secrets if the agent has successfully authenticated to
modify system network settings and the GetSecrets request
flags allow user interaction.
- </tp:docstring>
+ " />
</arg>
<arg name="connection_path" type="o" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the connection for which secrets are being
requested.
- </tp:docstring>
+ " />
</arg>
<arg name="setting_name" type="s" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Setting name for which secrets are being requested.
- </tp:docstring>
+ " />
</arg>
<arg name="hints" type="as" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Array of strings of key names in the requested setting for
which NetworkManager thinks a secrets may be required,
and/or well-known identifiers and data that may be useful
in this request. Some hints have special prefixes that
provide information to the agent; for example, VPN requests
may send server-specific messages prefixed with
- "x-vpn-message:".
- </tp:docstring>
+ "x-vpn-message:".
+ " />
</arg>
<arg name="flags" type="u" direction="in" tp:type="NM_SECRET_AGENT_GET_SECRETS_FLAGS">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Flags which modify the behavior of the secrets request.
If true, new secrets are assumed to be invalid or incorrect,
and the agent should ask the user for new secrets. If false,
existing secrets should be retrieved from storage and
returned without interrupting the user.
- </tp:docstring>
+ " />
</arg>
<arg name="secrets" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Nested settings maps containing secrets. Each setting MUST
contain at least the 'name' field, containing the name of
the setting, and one or more secrets.
- </tp:docstring>
+ " />
</arg>
<tp:possible-errors>
<tp:error name="org.freedesktop.NetworkManager.SecretAgent.NotAuthorized">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Should be returned when the process requesting secrets is
not authorized to do so (like if the caller is not root
or not NetworkManager).
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="org.freedesktop.NetworkManager.SecretAgent.InvalidConnection">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Should be returned if the 'connection' argument is invalid.
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="org.freedesktop.NetworkManager.SecretAgent.UserCanceled">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Should be returned when the user has canceled the request.
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="org.freedesktop.NetworkManager.SecretAgent.AgentCanceled">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Should be returned when NetworkManager has requested that
the agent cancel the request.
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="org.freedesktop.NetworkManager.SecretAgent.InternalError">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Should be returned if the agent has encountered some internal
error processing the request.
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="org.freedesktop.NetworkManager.SecretAgent.NoSecrets">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Should be returned if there are no available secrets, for
example if user interaction is not allowed and there are
no secrets stored by the agent for this connection.
- </tp:docstring>
+ " />
</tp:error>
</tp:possible-errors>
</method>
<tp:flags name="NM_SECRET_AGENT_GET_SECRETS_FLAGS" value-prefix="NM_SECRET_AGENT_GET_SECRETS_FLAG" type="u">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Flags modifying the behavior of GetSecrets request.
- </tp:docstring>
+ " />
<tp:flag suffix="NONE" value="0x0">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
No special behavior; by default no user interaction is allowed and
requests for secrets are fulfilled from persistent storage, or
if no secrets are available an error is returned.
- </tp:docstring>
+ " />
</tp:flag>
<tp:flag suffix="ALLOW_INTERACTION" value="0x1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Allows the request to interact with the user, possibly prompting
via UI for secrets if any are required, or if none are found in
persistent storage.
- </tp:docstring>
+ " />
</tp:flag>
<tp:flag suffix="REQUEST_NEW" value="0x2">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Explicitly prompt for new secrets from the user. This flag
signals that NetworkManager thinks any existing secrets are
invalid or wrong. This flag implies that interaction is allowed.
- </tp:docstring>
+ " />
</tp:flag>
<tp:flag suffix="USER_REQUESTED" value="0x4">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Set if the request was initiated by user-requested action via the
D-Bus interface, as opposed to automatically initiated by
NetworkManager in response to (for example) scan results or
carrier changes.
- </tp:docstring>
+ " />
</tp:flag>
</tp:flags>
<method name="CancelGetSecrets">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Cancel a pending GetSecrets request for secrets of the given
connection. Any GetSecrets request with the same
'connection_path' and 'setting_name' that are given in a
CancelGetSecrets request should be canceled.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_cancel_get_secrets"/>
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="connection_path" type="o" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the connection for which, if secrets for
the given 'setting_name' are being requested, the request
should be canceled.
- </tp:docstring>
+ " />
</arg>
<arg name="setting_name" type="s" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Setting name for which secrets for this connection were
originally being requested.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="SaveSecrets">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Save given secrets to backing storage.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_save_secrets"/>
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Nested settings maps containing the entire connection
(including secrets), for which the agent should save the
secrets to backing storage. This method will not be called
when the agent itself is the process creating or updating
a connection; in that case the agent is assumed to have
already saved those secrets since it had them already.
- </tp:docstring>
+ " />
</arg>
<arg name="connection_path" type="o" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the connection for which the agent should
save secrets to backing storage.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="DeleteSecrets">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Delete secrets from backing storage.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_secret_agent_delete_secrets"/>
<annotation name="org.freedesktop.DBus.GLib.Async" value=""/>
<arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Nested settings maps containing the connection properties
(sans secrets), for which the agent should delete the
secrets from backing storage.
- </tp:docstring>
+ " />
</arg>
<arg name="connection_path" type="o" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the connection for which the agent should
delete secrets from backing storage.
- </tp:docstring>
+ " />
</arg>
</method>
<tp:flags name="NM_SECRET_AGENT_CAPABILITIES" value-prefix="NM_SECRET_AGENT_CAPABILITY" type="u">
<tp:flag suffix="NONE" value="0x0">
- <tp:docstring>No special capabilities.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="No special capabilities." />
</tp:flag>
<tp:flag suffix="VPN_HINTS" value="0x1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The agent supports passing hints to VPN plugin authentication
dialogs.
- </tp:docstring>
+ " />
</tp:flag>
</tp:flags>
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.Settings.Connection">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Represents a single network connection configuration.
- </tp:docstring>
+ " />
<method name="Update">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Update the connection with new settings and properties (replacing
all previous settings and properties) and save the connection to
disk. Secrets may be part of the update request, and will be either
stored in persistent storage or sent to a Secret Agent for storage,
depending on the flags associated with each secret.
- </tp:docstring>
+ " />
<arg name="properties" type="a{sa{sv}}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
New connection settings, properties, and (optionally) secrets.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="UpdateUnsaved">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Update the connection with new settings and properties (replacing
all previous settings and properties) but do not immediately save
the connection to disk. Secrets may be part of the update request
that unsaved changes will be lost if the connection is
reloaded from disk (either automatically on file change or
due to an explicit ReloadConnections call).
- </tp:docstring>
+ " />
<arg name="properties" type="a{sa{sv}}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
New connection settings, properties, and (optionally) secrets.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="Delete">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Delete the connection.
- </tp:docstring>
+ " />
</method>
<method name="GetSettings">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Get the settings maps describing this network configuration.
This will never include any secrets required for connection
to the network, as those are often protected. Secrets must
be requested separately using the GetSecrets() call.
- </tp:docstring>
+ " />
<arg name="settings" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The nested settings maps describing this object.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="GetSecrets">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Get the secrets belonging to this network configuration. Only
secrets from persistent storage or a Secret Agent running in
the requestor's session will be returned. The user will never
be prompted for secrets as a result of this request.
- </tp:docstring>
+ " />
<arg name="setting_name" type="s" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Name of the setting to return secrets for. If empty, all
all secrets will be returned.
- </tp:docstring>
+ " />
</arg>
<arg name="secrets" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Nested settings maps containing secrets.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="ClearSecrets">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Clear the secrets belonging to this network connection profile.
- </tp:docstring>
+ " />
</method>
<method name="Save">
- <tp:docstring>
- Saves a "dirty" connection (that had previously been
+ <annotation name="org.gtk.GDBus.DocString" value="
+ Saves a "dirty" connection (that had previously been
updated with UpdateUnsaved) to persistent storage.
- </tp:docstring>
+ " />
</method>
<signal name="Updated">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when any settings or permissions change. When handling
this signal, clients should re-read the connection using the
GetSettings method to get the changes and to ensure the client
still has permission to access the connection.
- </tp:docstring>
+ " />
</signal>
<signal name="Removed">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when this connection is no longer available. This
happens when the connection is deleted or if it is no longer
accessible by any of the system's logged-in users. After
receipt of this signal, the object no longer exists. Also
see the Settings.ConnectionRemoved signal.
- </tp:docstring>
+ " />
</signal>
<property name="Unsaved" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
If set, indicates that the in-memory state of the
connection does not match the on-disk state. This flag
will be set when UpdateUnsaved() is called or when any
connection details change, and cleared when the connection
is saved to disk via Save() or from internal operations.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values.
- </tp:docstring>
+ " />
</arg>
</signal>
<node name="/org/freedesktop/NetworkManager/Settings" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="org.freedesktop.NetworkManager.Settings">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The Settings interface allows clients to view and administrate the connections stored and used by NetworkManager.
- </tp:docstring>
+ " />
<method name="ListConnections">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
List the saved network connections known to NetworkManager.
- </tp:docstring>
+ " />
<arg name="connections" type="ao" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
List of connections.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="GetConnectionByUuid">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Retrieve the object path of a connection, given that connection's UUID.
- </tp:docstring>
+ " />
<arg name="uuid" type="s" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The UUID to find the connection object path for.
- </tp:docstring>
+ " />
</arg>
<arg name="connection" type="o" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The connection's object path.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="AddConnection">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Add new connection and save it to disk. This operation does not start
the network connection unless (1) device is idle and able to connect to
the network described by the new connection, and (2) the connection
is allowed to be started automatically.
- </tp:docstring>
+ " />
<arg name="connection" type="a{sa{sv}}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Connection settings and properties.
- </tp:docstring>
+ " />
</arg>
<arg name="path" type="o" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the new connection that was just added.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="AddConnectionUnsaved">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Add new connection but do not save it to disk immediately. This
operation does not start the network connection unless (1) device is
idle and able to connect to the network described by the new connection,
to disk. Note that unsaved changes will be lost if the
connection is reloaded from disk (either automatically on file
change or due to an explicit ReloadConnections call).
- </tp:docstring>
+ " />
<arg name="connection" type="a{sa{sv}}" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Connection settings and properties.
- </tp:docstring>
+ " />
</arg>
<arg name="path" type="o" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the new connection that was just added.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="LoadConnections">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Loads or reloads the indicated connections from disk. You
should call this after making changes directly to an on-disk
connection file to make sure that NetworkManager sees the
- changes. (If "monitor-connection-files" in NetworkManager.conf
- is "true", then this will have no real effect, but is
+ changes. (If "monitor-connection-files" in NetworkManager.conf
+ is "true", then this will have no real effect, but is
harmless.) As with AddConnection(), this operation does not
necessarily start the network connection.
- </tp:docstring>
+ " />
<arg name="filenames" type="as" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Array of paths to on-disk connection profiles in directories
monitored by NetworkManager.
- </tp:docstring>
+ " />
</arg>
<arg name="status" type="b" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Success or failure of the operation as a whole. True if
NetworkManager at least tried to load the indicated
connections, even if it did not succeed. False if an error
occurred before trying to load the connections (eg,
permission denied).
- </tp:docstring>
+ " />
</arg>
<arg name="failures" type="as" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Paths of connection files that could not be loaded.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="ReloadConnections">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Tells NetworkManager to reload all connection files from disk,
including noticing any added or deleted connection files. By
default, connections are re-read automatically any time they
change, so you only need to use this command if you have set
- "monitor-connection-files=false" in NetworkManager.conf.
- </tp:docstring>
+ "monitor-connection-files=false" in NetworkManager.conf.
+ " />
<arg name="status" type="b" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Success or failure.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="SaveHostname">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Save the hostname to persistent configuration.
- </tp:docstring>
+ " />
<arg name="hostname" type="s" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The hostname to save to persistent configuration. If blank, the persistent hostname is cleared.
- </tp:docstring>
+ " />
</arg>
</method>
<property name="Connections" type="ao" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
List of object paths of available network connection profiles.
- </tp:docstring>
+ " />
</property>
<property name="Hostname" type="s" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The machine hostname stored in persistent configuration.
- </tp:docstring>
+ " />
</property>
<property name="CanModify" type="b" access="read">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
If true, adding and modifying connections is supported.
- </tp:docstring>
+ " />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="NewConnection">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when a new connection has been added after NetworkManager has
started up and initialized. This signal is not emitted for connections
read while starting up, because NetworkManager's D-Bus service is only
connection list, call the ListConnections() method once, and then listen
for individual Settings.NewConnection and Settings.Connection.Deleted
signals for further updates.
- </tp:docstring>
+ " />
<arg name="connection" type="o">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the new connection.
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="ConnectionRemoved">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when a connection is no longer available. This happens when
the connection is deleted or if it is no longer accessible by any of
the system's logged-in users. After receipt of this signal, the
connection no longer exists and cannot be used. Also see the
Settings.Connection.Removed signal.
- </tp:docstring>
+ " />
<arg name="connection" type="o">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Object path of the removed connection.
- </tp:docstring>
+ " />
</arg>
</signal>
<interface name="org.freedesktop.NetworkManager.VPN.Connection">
<annotation name="org.gtk.GDBus.C.Name" value="VpnConnection"/>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Represents an active connection to a Virtual Private Network.
- </tp:docstring>
+ " />
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values
- </tp:docstring>
+ " />
</arg>
</signal>
<property name="VpnState" type="u" access="read" tp:type="NM_VPN_CONNECTION_STATE">
- <tp:docstring>The VPN-specific state of the connection.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The VPN-specific state of the connection." />
</property>
<property name="Banner" type="s" access="read">
- <tp:docstring>The banner string of the VPN connection.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The banner string of the VPN connection." />
</property>
<signal name="VpnStateChanged">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when the state of the VPN connection has changed.
- </tp:docstring>
+ " />
<arg name="state" type="u" tp:type="NM_VPN_CONNECTION_STATE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The new state of the VPN connection.
- </tp:docstring>
+ " />
</arg>
<arg name="reason" type="u" tp:type="NM_VPN_CONNECTION_STATE_REASON">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Reason code describing the change to the new state.
- </tp:docstring>
+ " />
</arg>
</signal>
<tp:enum name="NM_VPN_CONNECTION_STATE" type="u">
<tp:enumvalue suffix="UNKNOWN" value="0">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The state of the VPN connection is unknown.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="PREPARE" value="1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The VPN connection is preparing to connect.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="NEED_AUTH" value="2">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The VPN connection needs authorization credentials.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONNECT" value="3">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The VPN connection is being established. FIXME: Should be CONNECTING or CONNECTED.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="IP_CONFIG_GET" value="4">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The VPN connection is getting an IP address. FIXME: Should be an -ING
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="ACTIVATED" value="5">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The VPN connection is active.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="FAILED" value="6">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The VPN connection failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="DISCONNECTED" value="7">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The VPN connection is disconnected.
- </tp:docstring>
+ " />
</tp:enumvalue>
</tp:enum>
<tp:enum name="NM_VPN_CONNECTION_STATE_REASON" type="u">
<tp:enumvalue suffix="UNKNOWN" value="0">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The reason for the VPN connection state change is unknown.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="NONE" value="1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
No reason was given for the VPN connection state change.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="USER_DISCONNECTED" value="2">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The VPN connection changed state because the user disconnected it.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="DEVICE_DISCONNECTED" value="3">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The VPN connection changed state because the device it was using was disconnected.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SERVICE_STOPPED" value="4">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The service providing the VPN connection was stopped.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="IP_CONFIG_INVALID" value="5">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The IP config of the VPN connection was invalid.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONNECT_TIMEOUT" value="6">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The connection attempt to the VPN service timed out.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SERVICE_START_TIMEOUT" value="7">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A timeout occurred while starting the service providing the VPN connection.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SERVICE_START_FAILED" value="8">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Starting the service starting the service providing the VPN connection failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="NO_SECRETS" value="9">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Necessary secrets for the VPN connection were not provided.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="LOGIN_FAILED" value="10">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Authentication to the VPN server failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONNECTION_REMOVED" value="11">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The connection was deleted from settings.
- </tp:docstring>
+ " />
</tp:enumvalue>
</tp:enum>
</interface>
<interface name="org.freedesktop.NetworkManager.VPN.Plugin">
<annotation name="org.gtk.GDBus.C.Name" value="VpnPlugin"/>
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
This interface is provided by plugins providing VPN services to the NetworkManager daemon.
- </tp:docstring>
+ " />
<method name="Connect">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Tells the plugin to connect. Interactive secrets requests (eg, emitting
the SecretsRequired signal) are not allowed.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_connect"/>
<arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Describes the connection to be established.
- </tp:docstring>
+ " />
</arg>
<tp:possible-errors>
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"/>
</method>
<method name="ConnectInteractive">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Tells the plugin to connect, allowing interactive secrets requests (eg
the plugin is allowed to emit the SecretsRequired signal if the VPN
service indicates that it needs additional secrets during the connect
process).
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_connect_interactive"/>
<arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Describes the connection to be established.
- </tp:docstring>
+ " />
</arg>
<arg name="details" type="a{sv}" direction="in" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Additional details about the Connect process.
- </tp:docstring>
+ " />
</arg>
<tp:possible-errors>
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"/>
</method>
<method name="NeedSecrets">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Asks the plugin whether the provided connection will require secrets to connect successfully.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_need_secrets"/>
<arg name="settings" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Describes the connection that may need secrets.
- </tp:docstring>
+ " />
</arg>
<arg name="setting_name" type="s" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The setting name within the provided connection that requires secrets, if any.
- </tp:docstring>
+ " />
</arg>
<tp:possible-errors>
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid"/>
</method>
<method name="Disconnect">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Disconnect the plugin.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_disconnect"/>
<tp:possible-errors>
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"/>
</method>
<method name="SetConfig">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Set generic connection details on the connection.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_config"/>
<arg name="config" type="a{sv}" direction="in" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Generic configuration details for the connection.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="SetIp4Config">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Set IPv4 details on the connection.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_ip4_config"/>
<arg name="config" type="a{sv}" direction="in" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Ip4Config details for the connection. You must call
SetConfig() before calling this.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="SetIp6Config">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Set IPv6 details on the connection.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_ip6_config"/>
<arg name="config" type="a{sv}" direction="in" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Ip6Config details for the connection. You must call
SetConfig() before calling this.
- </tp:docstring>
+ " />
</arg>
</method>
<method name="SetFailure">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Indicate a failure to the plugin.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_failure"/>
<arg name="reason" type="s" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The reason for the failure.
- </tp:docstring>
+ " />
</arg>
</method>
<property name="State" type="u" access="read" tp:type="NM_VPN_SERVICE_STATE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The state of the plugin.
- </tp:docstring>
+ " />
</property>
<signal name="StateChanged">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when the plugin state changes.
- </tp:docstring>
+ " />
<arg name="state" type="u" tp:type="NM_VPN_SERVICE_STATE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The new state of the plugin.
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="SecretsRequired">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted during an ongoing ConnectInteractive() request when the plugin
has determined that new secrets are required. NetworkManager will then
call the NewSecrets() method with a connection hash including the new
secrets.
- </tp:docstring>
+ " />
<arg name="message" type="s" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Informational message, if any, about the request. For example, if
a second PIN is required, could indicate to the user to wait for
the token code to change until entering the next PIN.
- </tp:docstring>
+ " />
</arg>
<arg name="secrets" type="as" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Array of strings of VPN secret names which the plugin thinks
secrets may be required for, or other VPN-specific data to be
processed by the VPN's front-end.
- </tp:docstring>
+ " />
</arg>
</signal>
<method name="NewSecrets">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Called in response to a SecretsRequired signal to deliver updated secrets
or other information to the plugin.
- </tp:docstring>
+ " />
<annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_new_secrets"/>
<arg name="connection" type="a{sa{sv}}" direction="in" tp:type="String_String_Variant_Map_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Describes the connection including the new secrets.
- </tp:docstring>
+ " />
</arg>
<tp:possible-errors>
<tp:error name="org.freedesktop.NetworkManager.VPN.Error.WrongState"/>
</method>
<signal name="Config">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin obtained generic configuration information.
- </tp:docstring>
+ " />
<arg name="config" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The configuration information.
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="Ip4Config">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin obtained an IPv4 configuration.
- </tp:docstring>
+ " />
<arg name="ip4config" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The IPv4 configuration.
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="Ip6Config">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin obtained an IPv6 configuration.
- </tp:docstring>
+ " />
<arg name="ip6config" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The IPv6 configuration.
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="LoginBanner">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when the plugin receives a login banner from the VPN service.
- </tp:docstring>
+ " />
<arg name="banner" type="s">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The login banner string.
- </tp:docstring>
+ " />
</arg>
</signal>
<signal name="Failure">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Emitted when a failure in the VPN plugin occurs.
- </tp:docstring>
+ " />
<arg name="reason" type="u" tp:type="NM_VPN_PLUGIN_FAILURE">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Reason code for the failure.
- </tp:docstring>
+ " />
</arg>
</signal>
<tp:enum name="NM_VPN_SERVICE_STATE" type="u">
<tp:enumvalue suffix="UNKNOWN" value="0">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The state of the VPN plugin is unknown.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="INIT" value="1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The VPN plugin is initialized.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="SHUTDOWN" value="2">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
(Not used.)
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="STARTING" value="3">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin is attempting to connect to a VPN server.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="STARTED" value="4">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin has connected to a VPN server.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="STOPPING" value="5">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin is disconnecting from the VPN server.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="STOPPED" value="6">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin has disconnected from the VPN server.
- </tp:docstring>
+ " />
</tp:enumvalue>
</tp:enum>
<tp:enum name="NM_VPN_PLUGIN_FAILURE" type="u">
<tp:enumvalue suffix="LOGIN_FAILED" value="0">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Login failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="CONNECT_FAILED" value="1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Connect failed.
- </tp:docstring>
+ " />
</tp:enumvalue>
<tp:enumvalue suffix="BAD_IP_CONFIG" value="2">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Invalid IP configuration returned from the VPN plugin.
- </tp:docstring>
+ " />
</tp:enumvalue>
</tp:enum>
<interface name="org.freedesktop.NetworkManager.WiMax.Nsp">
<property name="Name" type="s" access="read">
- <tp:docstring>The name of the NSP.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The name of the NSP." />
</property>
<property name="SignalQuality" type="u" access="read">
- <tp:docstring>The current signal quality of the NSP, in percent.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The current signal quality of the NSP, in percent." />
</property>
<property name="NetworkType" type="u" access="read" tp:type="NM_WIMAX_NSP_NETWORK_TYPE">
- <tp:docstring>The network type of the NSP.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="The network type of the NSP." />
</property>
<signal name="PropertiesChanged">
<arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A dictionary mapping property names to variant boxed values.
- </tp:docstring>
+ " />
</arg>
</signal>
<tp:flags name="NM_WIMAX_NSP_NETWORK_TYPE" value-prefix="NM_WIMAX_NSP_NETWORK_TYPE" type="u">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Network type of the NSP.
- </tp:docstring>
+ " />
<tp:flag suffix="UNKNOWN" value="0x0">
- <tp:docstring>Unknown network.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Unknown network." />
</tp:flag>
<tp:flag suffix="HOME" value="0x1">
- <tp:docstring>Home network.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Home network." />
</tp:flag>
<tp:flag suffix="PARTNER" value="0x2">
- <tp:docstring>Partner network.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Partner network." />
</tp:flag>
<tp:flag suffix="ROAMING_PARTNER" value="0x3">
- <tp:docstring>Roaming partner network.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="Roaming partner network." />
</tp:flag>
</tp:flags>
<tp:errors xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"
namespace="org.freedesktop.NetworkManager.VPN.Error">
<tp:error name="General">
- <tp:docstring>General failure without further details.</tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="General failure without further details." />
</tp:error>
<tp:error name="StartingInProgress">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin is already starting, and another connect request was received.
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="AlreadyStarted">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin is already connected, and another connect request was received.
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="StoppingInProgress">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin is already stopping, and another stop request was received.
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="AlreadyStopped">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The plugin is already stopped, and another disconnect request was received.
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="WrongState">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The request could not be processed because the VPN plugin is in the wrong
state for this type of request.
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="BadArguments">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The request could not be processed because it contained malformed
arguments, or arguments of unexpected type. It usually means that one of
the VPN setting data items or secrets was not of the expected type (i.e.
int, string, bool, etc).
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="LaunchFailed">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
A binary providing the service failed to launch.
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="ConnectionInvalid">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The request could not be processed because the connection was invalid. It
usually means that the connection's VPN setting was missing some required
data item or secret.
- </tp:docstring>
+ " />
</tp:error>
<tp:error name="InteractiveNotSupported">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The request could not be processed because the plugin does not support
interactive operations, such as ConnectInteractive() or NewSecrets().
- </tp:docstring>
+ " />
</tp:error>
</tp:errors>
by a system administrator and are not meant to be changed by users. The usual
place for the polkit configuration is /usr/share/polkit-1/actions/org.freedesktop.NetworkManager.policy.
<emphasis>pkaction</emphasis> command can display description for polkit actions.
- <programlisting><command>
- pkaction --action-id org.freedesktop.NetworkManager.network-control --verbose
- </command></programlisting>
+ <synopsis><command>
+pkaction --action-id org.freedesktop.NetworkManager.network-control --verbose
+ </command></synopsis>
More information about polkit can be found at http://www.freedesktop.org/wiki/Software/polkit.
</para>
</para>
<example><title>Adding a bonding master and two slave connection profiles</title>
- <programlisting><emphasis role="bold">
+ <synopsis><emphasis role="bold">
$ nmcli con add type bond ifname mybond0 mode active-backup
$ nmcli con add type ethernet ifname eth1 master mybond0
$ nmcli con add type ethernet ifname eth2 master mybond0
- </emphasis></programlisting>
+ </emphasis></synopsis>
</example>
<para>
This example demonstrates adding a bond master connection and two slaves. The
</para>
<example><title>Adding a team master and two slave connection profiles</title>
- <programlisting><emphasis role="bold">
+ <synopsis><emphasis role="bold">
$ nmcli con add type team con-name Team1 ifname Team1 config team1-master-json.conf
$ nmcli con add type ethernet con-name Team1-slave1 ifname em1 master Team1
$ nmcli con add type ethernet con-name Team1-slave2 ifname em2 master Team1
- </emphasis></programlisting>
+ </emphasis></synopsis>
</example>
<para>
This example demonstrates adding a team master connection profile and two slaves. It is
<emphasis>em2</emphasis>. The slaves don't specify <emphasis>config</emphasis> and thus
<emphasis>teamd</emphasis> will use its default configuration. You will activate the whole setup
by activating both slaves:
- <programlisting><emphasis role="bold">
+ <synopsis><emphasis role="bold">
$ nmcli con up Team1-slave1
$ nmcli con up Team1-slave2
- </emphasis></programlisting>
+ </emphasis></synopsis>
By default, the created profiles are marked for auto-activation. But if another
connection has been activated on the device, the new profile won't activate
automatically and you need to activate it manually.
</para>
<example><title>Adding a bridge and two slave profiles</title>
- <programlisting><emphasis role="bold">
+ <synopsis><emphasis role="bold">
$ nmcli con add type bridge con-name TowerBridge ifname TowerBridge
$ nmcli con add type ethernet con-name br-slave-1 ifname ens3 master TowerBridge
$ nmcli con add type ethernet con-name br-slave-2 ifname ens4 master TowerBridge
$ nmcli con modify TowerBridge bridge.stp no
- </emphasis></programlisting>
+ </emphasis></synopsis>
</example>
<para>
This example demonstrates adding a bridge master connection and two slaves. The
</para>
<example><title>Adding an ethernet connection profile with manual IP configuration</title>
- <programlisting>
+ <synopsis>
<emphasis role="bold">
$ nmcli con add con-name my-con-em1 ifname em1 type ethernet ip4 192.168.100.100/24 gw4 192.168.100.1 ip4 1.2.3.4 ip6 abbe::cafe
$ nmcli con mod my-con-em1 ipv4.dns "8.8.8.8 8.8.4.4"
$ nmcli con mod my-con-em1 ipv6.dns "2001:4860:4860::8888 2001:4860:4860::8844"
$ nmcli -p con show my-con-em1
</emphasis>
- </programlisting>
+ </synopsis>
</example>
<para>
The first command adds an Ethernet connection profile named <emphasis>my-con-em1</emphasis>
</para>
<example><title>Escaping colon characters in tabular mode</title>
- <programlisting>
+ <synopsis>
<emphasis role="bold">
$ nmcli -t -f general -e yes -m tab dev show eth0
</emphasis>
- </programlisting>
+ </synopsis>
<screen>
GENERAL:eth0:ethernet:Intel Corporation:82567LM Gigabit Network Connection:e1000e:2.1.4-k:1.8-3:00\:22\:68\:15\:29\:21:1500:100 (connected):0 (No reason given):/sys/devices/pci0000\:00/0000\:00\:19.0/net/eth0:eth0:yes:yes:no:ethernet-13:89cbcbc6-dc85-456c-9c8b-bd828fee3917:/org/freedesktop/NetworkManager/ActiveConnection/9
</screen>
<para><emphasis role="bold">Example sessions of interactive connection editor</emphasis></para>
<example><title>Adding an ethernet connection profile in interactive editor (a)</title>
- <programlisting>
+ <synopsis>
<emphasis role="bold">
$ nmcli connection edit type ethernet
</emphasis>
- </programlisting>
+ </synopsis>
<screen>
===| nmcli interactive connection editor |===
<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
<interface name="com.redhat.ifcfgrh1">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Utility methods for handling NM integration with standard Red Hat ifcfg files.
- </tp:docstring>
+ " />
<method name="GetIfcfgDetails">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
Given an ifcfg file, return various internal information about it.
- </tp:docstring>
+ " />
<arg name="ifcfg" type="s" direction="in">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The full path to an ifcfg file.
- </tp:docstring>
+ " />
</arg>
<arg name="uuid" type="s" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The UUID of the NM connection backed by this ifcfg file. If the ifcfg file does not contain a UUID tag, this UUID is generated by NM, otherwise the UUID from the ifcfg file is used.
- </tp:docstring>
+ " />
</arg>
<arg name="path" type="o" direction="out">
- <tp:docstring>
+ <annotation name="org.gtk.GDBus.DocString" value="
The object path of the NM connected backed by this ifcfg file.
- </tp:docstring>
+ " />
</arg>
</method>
</interface>
EXTRA_DIST = \
check-exports.sh \
debug-helper.py \
- doc-generator.xsl \
run-test-valgrind.sh \
run-test-dbus-session.sh \
test-networkmanager-service.py \
+++ /dev/null
-<!-- Generate HTML documentation from the Telepathy specification.
-The master copy of this stylesheet is in the Telepathy spec repository -
-please make any changes there.
-
-Copyright (C) 2006, 2007 Collabora Limited
-
-This library is free software; you can redistribute it and/or
-modify it under the terms of the GNU Lesser General Public
-License as published by the Free Software Foundation; either
-version 2.1 of the License, or (at your option) any later version.
-
-This library is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-Lesser 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 St, Fifth Floor, Boston, MA 02110-1301 USA
--->
-
-<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
- xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"
- exclude-result-prefixes="tp">
- <!--Don't move the declaration of the HTML namespace up here - XMLNSs
- don't work ideally in the presence of two things that want to use the
- absence of a prefix, sadly. -->
-
- <xsl:template match="*" mode="identity">
- <xsl:copy>
- <xsl:apply-templates mode="identity"/>
- </xsl:copy>
- </xsl:template>
-
- <xsl:template match="tp:docstring">
- <xsl:apply-templates select="node()" mode="identity"/>
- </xsl:template>
-
- <xsl:template match="tp:errors">
- <h1 xmlns="http://www.w3.org/1999/xhtml">Errors:</h1>
- <xsl:apply-templates/>
- </xsl:template>
-
- <xsl:template match="tp:generic-types">
- <h1 xmlns="http://www.w3.org/1999/xhtml">Generic types:</h1>
- <xsl:call-template name="do-types"/>
- </xsl:template>
-
- <xsl:template name="do-types">
- <xsl:if test="tp:simple-type">
- <h2 xmlns="http://www.w3.org/1999/xhtml">Simple types:</h2>
- <xsl:apply-templates select="tp:simple-type"/>
- </xsl:if>
-
- <xsl:if test="tp:enum">
- <h2 xmlns="http://www.w3.org/1999/xhtml">Enumerated types:</h2>
- <xsl:apply-templates select="tp:enum"/>
- </xsl:if>
-
- <xsl:if test="tp:flags">
- <h2 xmlns="http://www.w3.org/1999/xhtml">Sets of flags:</h2>
- <xsl:apply-templates select="tp:flags"/>
- </xsl:if>
-
- <xsl:if test="tp:struct">
- <h2 xmlns="http://www.w3.org/1999/xhtml">Structure types:</h2>
- <xsl:apply-templates select="tp:struct"/>
- </xsl:if>
-
- <xsl:if test="tp:mapping">
- <h2 xmlns="http://www.w3.org/1999/xhtml">Mapping types:</h2>
- <xsl:apply-templates select="tp:mapping"/>
- </xsl:if>
-
- <xsl:if test="tp:external-type">
- <h2 xmlns="http://www.w3.org/1999/xhtml">Types defined elsewhere:</h2>
- <dl><xsl:apply-templates select="tp:external-type"/></dl>
- </xsl:if>
- </xsl:template>
-
- <xsl:template match="tp:error">
- <h2 xmlns="http://www.w3.org/1999/xhtml"><a name="{concat(../@namespace, '.', translate(@name, ' ', ''))}"></a><xsl:value-of select="concat(../@namespace, '.', translate(@name, ' ', ''))"/></h2>
- <xsl:apply-templates select="tp:docstring"/>
- </xsl:template>
-
- <xsl:template match="/tp:spec/tp:copyright">
- <div xmlns="http://www.w3.org/1999/xhtml">
- <xsl:apply-templates/>
- </div>
- </xsl:template>
- <xsl:template match="/tp:spec/tp:license">
- <div xmlns="http://www.w3.org/1999/xhtml" class="license">
- <xsl:apply-templates mode="identity"/>
- </div>
- </xsl:template>
-
- <xsl:template match="tp:copyright"/>
- <xsl:template match="tp:license"/>
-
- <xsl:template match="interface">
- <h1 xmlns="http://www.w3.org/1999/xhtml"><a name="{@name}"></a><xsl:value-of select="@name"/></h1>
-
- <xsl:if test="@tp:causes-havoc">
- <p xmlns="http://www.w3.org/1999/xhtml" class="causes-havoc">
- This interface is <xsl:value-of select="@tp:causes-havoc"/>
- and is likely to cause havoc to your API/ABI if bindings are generated.
- Don't include it in libraries that care about compatibility.
- </p>
- </xsl:if>
-
- <xsl:if test="tp:requires">
- <p>Implementations of this interface must also implement:</p>
- <ul xmlns="http://www.w3.org/1999/xhtml">
- <xsl:for-each select="tp:requires">
- <li><code><a href="#{@interface}"><xsl:value-of select="@interface"/></a></code></li>
- </xsl:for-each>
- </ul>
- </xsl:if>
-
- <xsl:apply-templates select="tp:docstring" />
-
- <xsl:choose>
- <xsl:when test="method">
- <h2 xmlns="http://www.w3.org/1999/xhtml">Methods:</h2>
- <xsl:apply-templates select="method"/>
- </xsl:when>
- <xsl:otherwise>
- <p xmlns="http://www.w3.org/1999/xhtml">Interface has no methods.</p>
- </xsl:otherwise>
- </xsl:choose>
-
- <xsl:choose>
- <xsl:when test="signal">
- <h2 xmlns="http://www.w3.org/1999/xhtml">Signals:</h2>
- <xsl:apply-templates select="signal"/>
- </xsl:when>
- <xsl:otherwise>
- <p xmlns="http://www.w3.org/1999/xhtml">Interface has no signals.</p>
- </xsl:otherwise>
- </xsl:choose>
-
- <xsl:choose>
- <xsl:when test="property">
- <h2 xmlns="http://www.w3.org/1999/xhtml">Properties:</h2>
- <dl xmlns="http://www.w3.org/1999/xhtml">
- <xsl:apply-templates select="property"/>
- </dl>
- </xsl:when>
- <xsl:otherwise>
- <p xmlns="http://www.w3.org/1999/xhtml">Interface has no properties.</p>
- </xsl:otherwise>
- </xsl:choose>
-
- <xsl:call-template name="do-types"/>
-
- </xsl:template>
-
- <xsl:template match="tp:flags">
- <h3>
- <a name="type-{@name}">
- <xsl:value-of select="@name"/>
- </a>
- </h3>
- <xsl:apply-templates select="tp:docstring" />
- <dl xmlns="http://www.w3.org/1999/xhtml">
- <xsl:variable name="value-prefix">
- <xsl:choose>
- <xsl:when test="@value-prefix">
- <xsl:value-of select="@value-prefix"/>
- </xsl:when>
- <xsl:otherwise>
- <xsl:value-of select="@name"/>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:variable>
- <xsl:for-each select="tp:flag">
- <dt xmlns="http://www.w3.org/1999/xhtml"><code><xsl:value-of select="concat($value-prefix, '_', @suffix)"/> = <xsl:value-of select="@value"/></code></dt>
- <xsl:choose>
- <xsl:when test="tp:docstring">
- <dd xmlns="http://www.w3.org/1999/xhtml"><xsl:apply-templates select="tp:docstring" /></dd>
- </xsl:when>
- <xsl:otherwise>
- <dd xmlns="http://www.w3.org/1999/xhtml">(Undocumented)</dd>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:for-each>
- </dl>
- </xsl:template>
-
- <xsl:template match="tp:enum">
- <h3 xmlns="http://www.w3.org/1999/xhtml">
- <a name="type-{@name}">
- <xsl:value-of select="@name"/>
- </a>
- </h3>
- <xsl:apply-templates select="tp:docstring" />
- <dl xmlns="http://www.w3.org/1999/xhtml">
- <xsl:variable name="value-prefix">
- <xsl:choose>
- <xsl:when test="@value-prefix">
- <xsl:value-of select="@value-prefix"/>
- </xsl:when>
- <xsl:otherwise>
- <xsl:value-of select="@name"/>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:variable>
- <xsl:for-each select="tp:enumvalue">
- <dt xmlns="http://www.w3.org/1999/xhtml"><code><xsl:value-of select="concat($value-prefix, '_', @suffix)"/> = <xsl:value-of select="@value"/></code></dt>
- <xsl:choose>
- <xsl:when test="tp:docstring">
- <dd xmlns="http://www.w3.org/1999/xhtml"><xsl:apply-templates select="tp:docstring" /></dd>
- </xsl:when>
- <xsl:otherwise>
- <dd xmlns="http://www.w3.org/1999/xhtml">(Undocumented)</dd>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:for-each>
- </dl>
- </xsl:template>
-
- <xsl:template match="property">
- <dt xmlns="http://www.w3.org/1999/xhtml">
- <xsl:if test="@name">
- <code><xsl:value-of select="@name"/></code> -
- </xsl:if>
- <code><xsl:value-of select="@type"/></code> -
- <code>(<xsl:value-of select="@access"/>)</code>
- <xsl:call-template name="parenthesized-tp-type"/>
- </dt>
- <dd xmlns="http://www.w3.org/1999/xhtml">
- <xsl:apply-templates select="tp:docstring"/>
- </dd>
- </xsl:template>
-
- <xsl:template match="tp:mapping">
- <div xmlns="http://www.w3.org/1999/xhtml" class="struct">
- <h3>
- <a name="type-{@name}">
- <xsl:value-of select="@name"/>
- </a> - a{
- <xsl:for-each select="tp:member">
- <xsl:value-of select="@type"/>
- <xsl:text>: </xsl:text>
- <xsl:value-of select="@name"/>
- <xsl:if test="position() != last()"> → </xsl:if>
- </xsl:for-each>
- }
- </h3>
- <div class="docstring">
- <xsl:apply-templates select="tp:docstring"/>
- </div>
- <div>
- <h4>Members</h4>
- <dl>
- <xsl:apply-templates select="tp:member" mode="members-in-docstring"/>
- </dl>
- </div>
- </div>
- </xsl:template>
-
- <xsl:template match="tp:docstring" mode="in-index"/>
-
- <xsl:template match="tp:simple-type | tp:enum | tp:flags | tp:external-type"
- mode="in-index">
- - <xsl:value-of select="@type"/>
- </xsl:template>
-
- <xsl:template match="tp:simple-type">
- <div xmlns="http://www.w3.org/1999/xhtml" class="simple-type">
- <h3>
- <a name="type-{@name}">
- <xsl:value-of select="@name"/>
- </a> - <xsl:value-of select="@type"/>
- </h3>
- <div class="docstring">
- <xsl:apply-templates select="tp:docstring"/>
- </div>
- </div>
- </xsl:template>
-
- <xsl:template match="tp:external-type">
- <div xmlns="http://www.w3.org/1999/xhtml" class="external-type">
- <dt>
- <a name="type-{@name}">
- <xsl:value-of select="@name"/>
- </a> - <xsl:value-of select="@type"/>
- </dt>
- <dd>Defined by: <xsl:value-of select="@from"/></dd>
- </div>
- </xsl:template>
-
- <xsl:template match="tp:struct" mode="in-index">
- - ( <xsl:for-each select="tp:member">
- <xsl:value-of select="@type"/>
- <xsl:if test="position() != last()">, </xsl:if>
- </xsl:for-each> )
- </xsl:template>
-
- <xsl:template match="tp:mapping" mode="in-index">
- - a{ <xsl:for-each select="tp:member">
- <xsl:value-of select="@type"/>
- <xsl:if test="position() != last()"> → </xsl:if>
- </xsl:for-each> }
- </xsl:template>
-
- <xsl:template match="tp:struct">
- <div xmlns="http://www.w3.org/1999/xhtml" class="struct">
- <h3>
- <a name="type-{@name}">
- <xsl:value-of select="@name"/>
- </a> - (
- <xsl:for-each select="tp:member">
- <xsl:value-of select="@type"/>
- <xsl:text>: </xsl:text>
- <xsl:value-of select="@name"/>
- <xsl:if test="position() != last()">, </xsl:if>
- </xsl:for-each>
- )
- </h3>
- <div class="docstring">
- <xsl:apply-templates select="tp:docstring"/>
- </div>
- <xsl:choose>
- <xsl:when test="string(@array-name) != ''">
- <p>In bindings that need a separate name, arrays of
- <xsl:value-of select="@name"/> should be called
- <xsl:value-of select="@array-name"/>.</p>
- </xsl:when>
- <xsl:otherwise>
- <p>Arrays of <xsl:value-of select="@name"/> don't generally
- make sense.</p>
- </xsl:otherwise>
- </xsl:choose>
- <div>
- <h4>Members</h4>
- <dl>
- <xsl:apply-templates select="tp:member" mode="members-in-docstring"/>
- </dl>
- </div>
- </div>
- </xsl:template>
-
- <xsl:template match="method">
- <div xmlns="http://www.w3.org/1999/xhtml" class="method">
- <h3 xmlns="http://www.w3.org/1999/xhtml">
- <a name="{concat(../@name, concat('.', @name))}">
- <xsl:value-of select="@name"/>
- </a> (
- <xsl:for-each xmlns="" select="arg[@direction='in']">
- <xsl:value-of select="@type"/>: <xsl:value-of select="@name"/>
- <xsl:if test="position() != last()">, </xsl:if>
- </xsl:for-each>
- ) →
- <xsl:choose>
- <xsl:when test="arg[@direction='out']">
- <xsl:for-each xmlns="" select="arg[@direction='out']">
- <xsl:value-of select="@type"/>
- <xsl:if test="position() != last()">, </xsl:if>
- </xsl:for-each>
- </xsl:when>
- <xsl:otherwise>nothing</xsl:otherwise>
- </xsl:choose>
- </h3>
- <div xmlns="http://www.w3.org/1999/xhtml" class="docstring">
- <xsl:apply-templates select="tp:docstring" />
- </div>
-
- <xsl:if test="arg[@direction='in']">
- <div xmlns="http://www.w3.org/1999/xhtml">
- <h4>Parameters</h4>
- <dl xmlns="http://www.w3.org/1999/xhtml">
- <xsl:apply-templates select="arg[@direction='in']"
- mode="parameters-in-docstring"/>
- </dl>
- </div>
- </xsl:if>
-
- <xsl:if test="arg[@direction='out']">
- <div xmlns="http://www.w3.org/1999/xhtml">
- <h4>Returns</h4>
- <dl xmlns="http://www.w3.org/1999/xhtml">
- <xsl:apply-templates select="arg[@direction='out']"
- mode="returns-in-docstring"/>
- </dl>
- </div>
- </xsl:if>
-
- <xsl:if test="tp:possible-errors">
- <div xmlns="http://www.w3.org/1999/xhtml">
- <h4>Possible errors</h4>
- <dl xmlns="http://www.w3.org/1999/xhtml">
- <xsl:apply-templates select="tp:possible-errors/tp:error"/>
- </dl>
- </div>
- </xsl:if>
-
- </div>
- </xsl:template>
-
- <xsl:template name="parenthesized-tp-type">
- <xsl:if test="@tp:type">
- <xsl:variable name="tp-type" select="@tp:type"/>
- <xsl:variable name="single-type">
- <xsl:choose>
- <xsl:when test="contains($tp-type, '[]')">
- <xsl:value-of select="substring-before($tp-type, '[]')"/>
- </xsl:when>
- <xsl:otherwise>
- <xsl:value-of select="$tp-type"/>
- </xsl:otherwise>
- </xsl:choose>
- </xsl:variable>
- <xsl:choose>
- <xsl:when test="//tp:simple-type[@name=$tp-type]" />
- <xsl:when test="//tp:simple-type[concat(@name, '[]')=$tp-type]" />
- <xsl:when test="//tp:struct[concat(@name, '[]')=$tp-type][string(@array-name) != '']" />
- <xsl:when test="//tp:struct[@name=$tp-type]" />
- <xsl:when test="//tp:enum[@name=$tp-type]" />
- <xsl:when test="//tp:enum[concat(@name, '[]')=$tp-type]" />
- <xsl:when test="//tp:flags[@name=$tp-type]" />
- <xsl:when test="//tp:flags[concat(@name, '[]')=$tp-type]" />
- <xsl:when test="//tp:mapping[@name=$tp-type]" />
- <xsl:when test="//tp:external-type[concat(@name, '[]')=$tp-type]" />
- <xsl:when test="//tp:external-type[@name=$tp-type]" />
- <xsl:otherwise>
- <xsl:message terminate="yes">
- <xsl:text>ERR: Unable to find type '</xsl:text>
- <xsl:value-of select="$tp-type"/>
- <xsl:text>' </xsl:text>
- </xsl:message>
- </xsl:otherwise>
- </xsl:choose>
- (<a href="#type-{$single-type}"><xsl:value-of select="$tp-type"/></a>)
- </xsl:if>
- </xsl:template>
-
- <xsl:template match="tp:member" mode="members-in-docstring">
- <dt xmlns="http://www.w3.org/1999/xhtml">
- <code><xsl:value-of select="@name"/></code> -
- <code><xsl:value-of select="@type"/></code>
- <xsl:call-template name="parenthesized-tp-type"/>
- </dt>
- <dd xmlns="http://www.w3.org/1999/xhtml">
- <xsl:choose>
- <xsl:when test="tp:docstring">
- <xsl:apply-templates select="tp:docstring" />
- </xsl:when>
- <xsl:otherwise>
- <em>(undocumented)</em>
- </xsl:otherwise>
- </xsl:choose>
- </dd>
- </xsl:template>
-
- <xsl:template match="arg" mode="parameters-in-docstring">
- <dt xmlns="http://www.w3.org/1999/xhtml">
- <code><xsl:value-of select="@name"/></code> -
- <code><xsl:value-of select="@type"/></code>
- <xsl:call-template name="parenthesized-tp-type"/>
- </dt>
- <dd xmlns="http://www.w3.org/1999/xhtml">
- <xsl:apply-templates select="tp:docstring" />
- </dd>
- </xsl:template>
-
- <xsl:template match="arg" mode="returns-in-docstring">
- <dt xmlns="http://www.w3.org/1999/xhtml">
- <xsl:if test="@name">
- <code><xsl:value-of select="@name"/></code> -
- </xsl:if>
- <code><xsl:value-of select="@type"/></code>
- <xsl:call-template name="parenthesized-tp-type"/>
- </dt>
- <dd xmlns="http://www.w3.org/1999/xhtml">
- <xsl:apply-templates select="tp:docstring"/>
- </dd>
- </xsl:template>
-
- <xsl:template match="tp:possible-errors/tp:error">
- <dt xmlns="http://www.w3.org/1999/xhtml">
- <code><xsl:value-of select="@name"/></code>
- </dt>
- <dd xmlns="http://www.w3.org/1999/xhtml">
- <xsl:variable name="name" select="@name"/>
- <xsl:choose>
- <xsl:when test="tp:docstring">
- <xsl:apply-templates select="tp:docstring"/>
- </xsl:when>
- <xsl:when test="//tp:errors/tp:error[concat(../@namespace, '.', translate(@name, ' ', ''))=$name]/tp:docstring">
- <xsl:apply-templates select="//tp:errors/tp:error[concat(../@namespace, '.', translate(@name, ' ', ''))=$name]/tp:docstring"/> <em xmlns="http://www.w3.org/1999/xhtml">(generic description)</em>
- </xsl:when>
- <xsl:otherwise>
- (Undocumented.)
- </xsl:otherwise>
- </xsl:choose>
- </dd>
- </xsl:template>
-
- <xsl:template match="signal">
- <div xmlns="http://www.w3.org/1999/xhtml" class="signal">
- <h3 xmlns="http://www.w3.org/1999/xhtml">
- <a name="{concat(../@name, concat('.', @name))}">
- <xsl:value-of select="@name"/>
- </a> (
- <xsl:for-each xmlns="" select="arg">
- <xsl:value-of select="@type"/>: <xsl:value-of select="@name"/>
- <xsl:if test="position() != last()">, </xsl:if>
- </xsl:for-each>
- )</h3>
- <div xmlns="http://www.w3.org/1999/xhtml" class="docstring">
- <xsl:apply-templates select="tp:docstring"/>
- </div>
-
- <xsl:if test="arg">
- <div xmlns="http://www.w3.org/1999/xhtml">
- <h4>Parameters</h4>
- <dl xmlns="http://www.w3.org/1999/xhtml">
- <xsl:apply-templates select="arg" mode="parameters-in-docstring"/>
- </dl>
- </div>
- </xsl:if>
- </div>
- </xsl:template>
-
- <xsl:output method="xml" indent="no" encoding="ascii"
- omit-xml-declaration="yes"
- doctype-system="http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"
- doctype-public="-//W3C//DTD XHTML 1.0 Strict//EN" />
-
- <xsl:template match="/tp:spec">
- <html xmlns="http://www.w3.org/1999/xhtml">
- <head>
- <title>
- <xsl:value-of select="tp:title"/>
- <xsl:if test="tp:version">
- <xsl:text> version </xsl:text>
- <xsl:value-of select="tp:version"/>
- </xsl:if>
- </title>
- <style type="text/css">
-
- body {
- font-family: sans-serif;
- margin: 2em;
- height: 100%;
- font-size: 1.2em;
- }
- h1 {
- padding-top: 5px;
- padding-bottom: 5px;
- font-size: 1.6em;
- background: #dadae2;
- }
- h2 {
- font-size: 1.3em;
- }
- h3 {
- font-size: 1.2em;
- }
- a:link, a:visited, a:link:hover, a:visited:hover {
- font-weight: bold;
- }
- .topbox {
- padding-top: 10px;
- padding-left: 10px;
- border-bottom: black solid 1px;
- padding-bottom: 10px;
- background: #dadae2;
- font-size: 2em;
- font-weight: bold;
- color: #5c5c5c;
- }
- .topnavbox {
- padding-left: 10px;
- padding-top: 5px;
- padding-bottom: 5px;
- background: #abacba;
- border-bottom: black solid 1px;
- font-size: 1.2em;
- }
- .topnavbox a{
- color: black;
- font-weight: normal;
- }
- .sidebar {
- float: left;
- /* width:9em;
- border-right:#abacba solid 1px;
- border-left: #abacba solid 1px;
- height:100%; */
- border: #abacba solid 1px;
- padding-left: 10px;
- margin-left: 10px;
- padding-right: 10px;
- margin-right: 10px;
- color: #5d5d5d;
- background: #dadae2;
- }
- .sidebar a {
- text-decoration: none;
- border-bottom: #e29625 dotted 1px;
- color: #e29625;
- font-weight: normal;
- }
- .sidebar h1 {
- font-size: 1.2em;
- color: black;
- }
- .sidebar ul {
- padding-left: 25px;
- padding-bottom: 10px;
- border-bottom: #abacba solid 1px;
- }
- .sidebar li {
- padding-top: 2px;
- padding-bottom: 2px;
- }
- .sidebar h2 {
- font-style:italic;
- font-size: 0.81em;
- padding-left: 5px;
- padding-right: 5px;
- font-weight: normal;
- }
- .date {
- font-size: 0.6em;
- float: right;
- font-style: italic;
- }
- .method {
- margin-left: 1em;
- margin-right: 4em;
- }
- .signal {
- margin-left: 1em;
- margin-right: 4em;
- }
-
- </style>
- </head>
- <body>
- <h1 class="topbox">
- <xsl:value-of select="tp:title" />
- </h1>
- <xsl:if test="tp:version">
- <h2>Version <xsl:apply-templates select="tp:version"/></h2>
- </xsl:if>
- <xsl:apply-templates select="tp:copyright"/>
- <xsl:apply-templates select="tp:license"/>
- <xsl:apply-templates select="tp:docstring"/>
-
- <h2>Interfaces</h2>
- <ul>
- <xsl:for-each select="node/interface">
- <li><code><a href="#{@name}"><xsl:value-of select="@name"/></a></code></li>
- </xsl:for-each>
- </ul>
-
- <xsl:apply-templates select="node"/>
- <xsl:apply-templates select="tp:generic-types"/>
- <xsl:apply-templates select="tp:errors"/>
-
- <h1>Index</h1>
- <h2>Index of interfaces</h2>
- <ul>
- <xsl:for-each select="node/interface">
- <li><code><a href="#{@name}"><xsl:value-of select="@name"/></a></code></li>
- </xsl:for-each>
- </ul>
- <h2>Index of types</h2>
- <ul>
- <xsl:for-each select="//tp:simple-type | //tp:enum | //tp:flags | //tp:mapping | //tp:struct | //tp:external-type">
- <xsl:sort select="@name"/>
- <li>
- <code>
- <a href="#type-{@name}">
- <xsl:value-of select="@name"/>
- </a>
- </code>
- <xsl:apply-templates mode="in-index" select="."/>
- </li>
- </xsl:for-each>
- </ul>
- </body>
- </html>
- </xsl:template>
-
-</xsl:stylesheet>
-
-<!-- vim:set sw=2 sts=2 et: -->
projects / NetworkManager.git / commitdiff