diff options
| author | Lubomir Rintel <lkundrak@v3.sk> | 2016-04-05 14:38:11 +0200 |
|---|---|---|
| committer | Lubomir Rintel <lkundrak@v3.sk> | 2016-04-05 14:38:11 +0200 |
| commit | cc8016073b0a0490d25037cbbb479d669fb7164d (patch) | |
| tree | cfc8f1710b190646f4240d7b6f3e3ab2d1ee990d | |
| parent | 322b6e8a32a9de1fea8a6d894f9d8fe04654ecfd (diff) | |
| parent | a8e8e766414dc433ca0b10787ca3c8c2979c5929 (diff) | |
| download | NetworkManager-cc8016073b0a0490d25037cbbb479d669fb7164d.tar.gz | |
merge: branch 'lr/docbook'
Various documentation improvements.
64 files changed, 5991 insertions, 5345 deletions
diff --git a/.gitignore b/.gitignore index fbf35bd361..6ca88f8067 100644 --- a/.gitignore +++ b/.gitignore @@ -138,7 +138,6 @@ test-*.trs /shared/nm-version-macros.h -/introspection/all.xml /introspection/nmdbus-*.c /introspection/nmdbus-*.h /introspection/nmdbus-*.xml @@ -220,6 +219,7 @@ test-*.trs /man/nm-settings.xml /man/nm-settings-ifcfg-rh.xml /man/nm-settings-keyfile.xml +/man/common.ent /po/*.gmo /po/.intltool-merge-cache diff --git a/callouts/nm-dispatcher.xml b/callouts/nm-dispatcher.xml index e2e89a89ad..27f15fe5b9 100644 --- a/callouts/nm-dispatcher.xml +++ b/callouts/nm-dispatcher.xml @@ -1,93 +1,40 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.nm_dispatcher"> <annotation name="org.gtk.GDBus.C.Name" value="Dispatcher"/> + <!-- + Action: + @action: The action being performed. + @connection: The connection for which this action was triggered. + @connection_properties: Properties of the connection, including service and path. + @device_properties: Properties of the device, including type, path, interface, and state. + @device_ip4_config: Properties of the device's IPv4 configuration. + @device_ip6_config: Properties of the device's IPv6 configuration. + @device_dhcp4_config: Properties of the device's DHCPv4 configuration. + @device_dhcp6_config: Properties of the device's DHCPv6 configuration. + @vpn_ip_iface: VPN interface name. + @vpn_ip4_config: Properties of the VPN's IPv4 configuration. + @vpn_ip6_config: Properties of the VPN's IPv6 configuration. + @debug: Whether to log debug output. + @results: 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). + + INTERNAL; not public API. Perform an action. + --> <method name="Action"> - <annotation name="org.gtk.GDBus.DocString" value=" - INTERNAL; not public API. Perform an action. - " /> - - <arg name="action" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The action being performed. - " /> - </arg> - - <arg name="connection" type="a{sa{sv}}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection for which this action was triggered. - " /> - </arg> - - <arg name="connection_properties" type="a{sv}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Properties of the connection, including service and path. - " /> - </arg> - - <arg name="device_properties" type="a{sv}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Properties of the device, including type, path, interface, and state. - " /> - </arg> - - <arg name="device_ip4_config" type="a{sv}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Properties of the device's IPv4 configuration. - " /> - </arg> - - <arg name="device_ip6_config" type="a{sv}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Properties of the device's IPv6 configuration. - " /> - </arg> - - <arg name="device_dhcp4_config" type="a{sv}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Properties of the device's DHCPv4 configuration. - " /> - </arg> - - <arg name="device_dhcp6_config" type="a{sv}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Properties of the device's DHCPv6 configuration. - " /> - </arg> - - <arg name="vpn_ip_iface" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value="VPN interface name." /> - </arg> - - <arg name="vpn_ip4_config" type="a{sv}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Properties of the VPN's IPv4 configuration. - " /> - </arg> - - <arg name="vpn_ip6_config" type="a{sv}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Properties of the VPN's IPv6 configuration. - " /> - </arg> - - <arg name="debug" type="b" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Whether to log debug output. - " /> - </arg> - - <arg name="results" type="a(sus)" direction="out"> - <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). - " /> - </arg> - + <arg name="action" type="s" direction="in"/> + <arg name="connection" type="a{sa{sv}}" direction="in"/> + <arg name="connection_properties" type="a{sv}" direction="in"/> + <arg name="device_properties" type="a{sv}" direction="in"/> + <arg name="device_ip4_config" type="a{sv}" direction="in"/> + <arg name="device_ip6_config" type="a{sv}" direction="in"/> + <arg name="device_dhcp4_config" type="a{sv}" direction="in"/> + <arg name="device_dhcp6_config" type="a{sv}" direction="in"/> + <arg name="vpn_ip_iface" type="s" direction="in"/> + <arg name="vpn_ip4_config" type="a{sv}" direction="in"/> + <arg name="vpn_ip6_config" type="a{sv}" direction="in"/> + <arg name="debug" type="b" direction="in"/> + <arg name="results" type="a(sus)" direction="out"/> </method> </interface> </node> diff --git a/configure.ac b/configure.ac index 131c5d185b..6446f3f079 100644 --- a/configure.ac +++ b/configure.ac @@ -961,11 +961,14 @@ GTK_DOC_CHECK(1.0) # check for pregenerated manpages to be installed install_pregen_manpages=no if test "$enable_gtk_doc" != "yes" \ + -a -f man/nmcli.1 \ + -a -f man/nmtui.1 \ + -a -f man/nm-online.1 \ -a -f man/NetworkManager.conf.5 \ -a -f man/nm-settings.5 \ -a -f man/nm-settings-keyfile.5 \ -a -f man/nm-settings-ifcfg-rh.5 \ - -a -f man/nmcli-examples.5 \ + -a -f man/nmcli-examples.7 \ -a -f man/NetworkManager.8; then install_pregen_manpages=yes fi @@ -1072,12 +1075,8 @@ clients/cli/Makefile clients/tui/Makefile clients/tui/newt/Makefile introspection/Makefile -introspection/all.xml man/Makefile -man/nm-system-settings.conf.5 -man/nm-online.1 -man/nmcli.1 -man/nmtui.1 +man/common.ent po/Makefile.in policy/Makefile policy/org.freedesktop.NetworkManager.policy.in diff --git a/contrib/fedora/rpm/NetworkManager.spec b/contrib/fedora/rpm/NetworkManager.spec index a3fac60203..1f40e01a5f 100644 --- a/contrib/fedora/rpm/NetworkManager.spec +++ b/contrib/fedora/rpm/NetworkManager.spec @@ -524,6 +524,7 @@ fi %dir %{nmlibdir}/VPN %{_mandir}/man1/* %{_mandir}/man5/* +%{_mandir}/man7/* %{_mandir}/man8/* %dir %{_localstatedir}/lib/NetworkManager %dir %{_sysconfdir}/NetworkManager/system-connections diff --git a/docs/api/Makefile.am b/docs/api/Makefile.am index a82e70fe74..aeba9d29b0 100644 --- a/docs/api/Makefile.am +++ b/docs/api/Makefile.am @@ -3,13 +3,6 @@ AUTOMAKE_OPTIONS = 1.7 XSLTPROC = xsltproc --xinclude --nonet XMLS = $(wildcard $(top_srcdir)/introspection/nm-*.xml) -OTHER_FILES= \ - $(top_builddir)/introspection/all.xml \ - $(top_srcdir)/introspection/generic-types.xml \ - $(top_srcdir)/introspection/errors.xml \ - $(top_srcdir)/introspection/vpn-errors.xml \ - $(top_srcdir)/introspection/generic-types.xml - GENERATED_FILES = if SETTING_DOCS_AVAILABLE @@ -47,11 +40,6 @@ MKHTML_OPTIONS=--path="$(abs_srcdir)" # Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE) content_files = \ - version.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 \ @@ -85,14 +73,20 @@ expand_content_files = \ $(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/nmcli.xml \ + $(top_builddir)/man/nmtui.xml \ + $(top_builddir)/man/nm-online.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-keyfile.xml \ + version.xml \ + ../../COPYING \ + $(NULL) if CONFIG_PLUGIN_IFCFG_RH -expand_content_files += $(top_builddir)/man/nm-settings-ifcfg-rh.xml +content_files += $(top_builddir)/man/nm-settings-ifcfg-rh.xml endif include $(top_srcdir)/gtk-doc.make diff --git a/docs/api/network-manager-docs.xml b/docs/api/network-manager-docs.xml index 48f592653c..3cf2c9edb0 100644 --- a/docs/api/network-manager-docs.xml +++ b/docs/api/network-manager-docs.xml @@ -49,39 +49,39 @@ <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"/> + <xi:include href="../../introspection/nmdbus-manager-org.freedesktop.NetworkManager.xml"/> + <xi:include href="../../introspection/nmdbus-settings-org.freedesktop.NetworkManager.Settings.xml"/> + <xi:include href="../../introspection/nmdbus-agent-manager-org.freedesktop.NetworkManager.AgentManager.xml"/> + <xi:include href="../../introspection/nmdbus-access-point-org.freedesktop.NetworkManager.AccessPoint.xml"/> + <xi:include href="../../introspection/nmdbus-ppp-manager-org.freedesktop.NetworkManager.PPP.xml"/> + <xi:include href="../../introspection/nmdbus-settings-connection-org.freedesktop.NetworkManager.Settings.Connection.xml"/> + <xi:include href="../../introspection/nmdbus-vpn-connection-org.freedesktop.NetworkManager.VPN.Connection.xml"/> + <xi:include href="../../introspection/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml"/> + <xi:include href="../../introspection/nmdbus-device-org.freedesktop.NetworkManager.Device.xml"/> + <xi:include href="../../introspection/nmdbus-device-adsl-org.freedesktop.NetworkManager.Device.Adsl.xml"/> + <xi:include href="../../introspection/nmdbus-device-bond-org.freedesktop.NetworkManager.Device.Bond.xml"/> + <xi:include href="../../introspection/nmdbus-device-bridge-org.freedesktop.NetworkManager.Device.Bridge.xml"/> + <xi:include href="../../introspection/nmdbus-device-bt-org.freedesktop.NetworkManager.Device.Bluetooth.xml"/> + <xi:include href="../../introspection/nmdbus-device-ethernet-org.freedesktop.NetworkManager.Device.Wired.xml"/> + <xi:include href="../../introspection/nmdbus-device-generic-org.freedesktop.NetworkManager.Device.Generic.xml"/> + <xi:include href="../../introspection/nmdbus-device-infiniband-org.freedesktop.NetworkManager.Device.Infiniband.xml"/> + <xi:include href="../../introspection/nmdbus-device-ip-tunnel-org.freedesktop.NetworkManager.Device.IPTunnel.xml"/> + <xi:include href="../../introspection/nmdbus-device-macvlan-org.freedesktop.NetworkManager.Device.Macvlan.xml"/> + <xi:include href="../../introspection/nmdbus-device-modem-org.freedesktop.NetworkManager.Device.Modem.xml"/> + <xi:include href="../../introspection/nmdbus-device-olpc-mesh-org.freedesktop.NetworkManager.Device.OlpcMesh.xml"/> + <xi:include href="../../introspection/nmdbus-device-team-org.freedesktop.NetworkManager.Device.Team.xml"/> + <xi:include href="../../introspection/nmdbus-device-tun-org.freedesktop.NetworkManager.Device.Tun.xml"/> + <xi:include href="../../introspection/nmdbus-device-veth-org.freedesktop.NetworkManager.Device.Veth.xml"/> + <xi:include href="../../introspection/nmdbus-device-vlan-org.freedesktop.NetworkManager.Device.Vlan.xml"/> + <xi:include href="../../introspection/nmdbus-device-vxlan-org.freedesktop.NetworkManager.Device.Vxlan.xml"/> + <xi:include href="../../introspection/nmdbus-device-wifi-org.freedesktop.NetworkManager.Device.Wireless.xml"/> + <xi:include href="../../introspection/nmdbus-device-wimax-org.freedesktop.NetworkManager.Device.WiMax.xml"/> + <xi:include href="../../introspection/nmdbus-dhcp4-config-org.freedesktop.NetworkManager.DHCP4Config.xml"/> + <xi:include href="../../introspection/nmdbus-dhcp6-config-org.freedesktop.NetworkManager.DHCP6Config.xml"/> + <xi:include href="../../introspection/nmdbus-ip4-config-org.freedesktop.NetworkManager.IP4Config.xml"/> + <xi:include href="../../introspection/nmdbus-ip6-config-org.freedesktop.NetworkManager.IP6Config.xml"/> + <xi:include href="../../introspection/nmdbus-vpn-plugin-org.freedesktop.NetworkManager.VPN.Plugin.xml"/> + <xi:include href="../../introspection/nmdbus-secret-agent-org.freedesktop.NetworkManager.SecretAgent.xml"/> </section> </chapter> @@ -144,12 +144,15 @@ <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> + <xi:include href="../../man/nmcli.xml"/> + <xi:include href="../../man/nmtui.xml"/> + <xi:include href="../../man/nm-online.xml"/> + <xi:include href="../../man/NetworkManager.xml"/> + <xi:include href="../../man/NetworkManager.conf.xml"/> + <xi:include href="../../man/nmcli-examples.xml"/> + <xi:include href="../../man/nm-settings.xml"><xi:fallback /></xi:include> + <xi:include href="../../man/nm-settings-keyfile.xml"><xi:fallback /></xi:include> + <xi:include href="../../man/nm-settings-ifcfg-rh.xml"><xi:fallback /></xi:include> </chapter> diff --git a/introspection/Makefile.am b/introspection/Makefile.am index 4d2e129834..3a627930b9 100644 --- a/introspection/Makefile.am +++ b/introspection/Makefile.am @@ -136,10 +136,6 @@ BUILT_SOURCES = $(nodist_libnmdbus_la_SOURCES) $(DBUS_INTERFACE_DOCS) CLEANFILES = $(BUILT_SOURCES) EXTRA_DIST = \ - all.xml.in \ - generic-types.xml \ - errors.xml \ - vpn-errors.xml \ nm-access-point.xml \ nm-active-connection.xml \ nm-agent-manager.xml \ diff --git a/introspection/all.xml.in b/introspection/all.xml.in deleted file mode 100644 index 273c0fda4d..0000000000 --- a/introspection/all.xml.in +++ /dev/null @@ -1,74 +0,0 @@ -<tp:spec - xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" - xmlns:xi="http://www.w3.org/2001/XInclude"> - -<tp:title>NetworkManager D-Bus Interface Specification</tp:title> -<tp:version>@VERSION@</tp:version> - - -<tp:copyright>Copyright (C) 2008 - 2016 Red Hat, Inc.</tp:copyright> -<tp:copyright>Copyright (C) 2008 - 2009 Novell, Inc.</tp:copyright> - -<tp:license xmlns="http://www.w3.org/1999/xhtml"> -<p>This program is free software; you can redistribute it and/or modify -it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2 of the License, or -(at your option) any later version.</p> - -<p>This program 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 -General Public License for more details.</p> - -<p>You should have received a copy of the GNU Lesser General Public -License along with this library; if not, write to the Free Software -Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.</p> -</tp:license> - -<xi:include href="nm-manager.xml"/> -<xi:include href="nm-access-point.xml"/> -<xi:include href="nm-device.xml"/> -<xi:include href="nm-device-adsl.xml"/> -<xi:include href="nm-device-bond.xml"/> -<xi:include href="nm-device-bridge.xml"/> -<xi:include href="nm-device-bt.xml"/> -<xi:include href="nm-device-ethernet.xml"/> -<xi:include href="nm-device-generic.xml"/> -<xi:include href="nm-device-infiniband.xml"/> -<xi:include href="nm-device-ip-tunnel.xml"/> -<xi:include href="nm-device-macvlan.xml"/> -<xi:include href="nm-device-modem.xml"/> -<xi:include href="nm-device-olpc-mesh.xml"/> -<xi:include href="nm-device-team.xml"/> -<xi:include href="nm-device-tun.xml"/> -<xi:include href="nm-device-veth.xml"/> -<xi:include href="nm-device-vlan.xml"/> -<xi:include href="nm-device-vxlan.xml"/> -<xi:include href="nm-device-wifi.xml"/> -<xi:include href="nm-device-wimax.xml"/> -<xi:include href="nm-wimax-nsp.xml"/> -<xi:include href="nm-ip4-config.xml"/> -<xi:include href="nm-ip6-config.xml"/> -<xi:include href="nm-dhcp4-config.xml"/> -<xi:include href="nm-dhcp6-config.xml"/> -<xi:include href="nm-settings.xml"/> -<xi:include href="nm-settings-connection.xml"/> -<xi:include href="nm-active-connection.xml"/> -<xi:include href="nm-agent-manager.xml"/> -<xi:include href="nm-secret-agent.xml"/> -<xi:include href="nm-vpn-connection.xml"/> -<xi:include href="nm-vpn-plugin.xml"/> - -<xi:include href="errors.xml"/> -<xi:include href="vpn-errors.xml"/> -<xi:include href="generic-types.xml"/> - -<!-- -<xi:include href="extensions.xml"> - <xi:fallback> - <!- - absence of non-spec extensions is OK - -> - </xi:fallback> -</xi:include> ---> - -</tp:spec> diff --git a/introspection/errors.xml b/introspection/errors.xml deleted file mode 100644 index 34a0a7b96f..0000000000 --- a/introspection/errors.xml +++ /dev/null @@ -1,24 +0,0 @@ -<?xml version="1.0" ?> -<tp:errors xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" - namespace="org.freedesktop.NetworkManager.Error"> - <tp:copyright>Copyright (C) 2008 Novell, Inc.</tp:copyright> - - <tp:error name="Unknown Connection"> - <annotation name="org.gtk.GDBus.DocString" value=" - Connection was not provided by the settings service. - " /> - </tp:error> - - <tp:error name="Unknown Device"> - <annotation name="org.gtk.GDBus.DocString" value=" - Unknown device. - " /> - </tp:error> - - <tp:error name="Permission Denied"> - <annotation name="org.gtk.GDBus.DocString" value=" - User does not have the permission to activate this connection. - " /> - </tp:error> - -</tp:errors> diff --git a/introspection/generic-types.xml b/introspection/generic-types.xml deleted file mode 100644 index 2fb680af92..0000000000 --- a/introspection/generic-types.xml +++ /dev/null @@ -1,50 +0,0 @@ -<tp:generic-types - xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> - <tp:mapping name="String_Variant_Map"> - <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"> - <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"> - <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"> - <annotation name="org.gtk.GDBus.DocString" value="" /> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value="Mode is unknown." /> - </tp:enumvalue> - <tp:enumvalue suffix="ADHOC" value="1"> - <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:enumvalue> - <tp:enumvalue suffix="INFRA" value="2"> - <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:enumvalue> - <tp:enumvalue suffix="AP" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is an access point/hotspot. Not valid for access point - objects themselves. - " /> - </tp:enumvalue> - </tp:enum> -</tp:generic-types> diff --git a/introspection/nm-access-point.xml b/introspection/nm-access-point.xml index 603be7132e..0c1ebf23ca 100644 --- a/introspection/nm-access-point.xml +++ b/introspection/nm-access-point.xml @@ -1,103 +1,101 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.AccessPoint"> - <property name="Flags" type="u" access="read" tp:type="NM_802_11_AP_FLAGS"> - <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"> - <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"> - <annotation name="org.gtk.GDBus.DocString" value="Flags describing the access point's capabilities according to the RSN (Robust Secure Network) protocol." /> - </property> + + <!-- + Flags: + + Flags describing the capabilities of the access point. + + Returns: <link linkend="NM80211ApFlags">NM80211ApFlags</link> + --> + <property name="Flags" type="u" access="read"/> + + <!-- + WpaFlags: + + Flags describing the access point's capabilities according to WPA (Wifi + Protected Access). + + Returns: <link linkend="NM80211ApSecurityFlags">NM80211ApSecurityFlags</link> + --> + <property name="WpaFlags" type="u" access="read"/> + + <!-- + RsnFlags: + + Flags describing the access point's capabilities according to the RSN + (Robust Secure Network) protocol. + + Returns: <link linkend="NM80211ApSecurityFlags">NM80211ApSecurityFlags</link> + --> + <property name="RsnFlags" type="u" access="read"/> + + <!-- + Ssid: + + The Service Set Identifier identifying the access point. + --> <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"/> - <annotation name="org.gtk.GDBus.DocString" value="The Service Set Identifier identifying the access point." /> - </property> - <property name="Frequency" type="u" access="read"> - <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"> - <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"> - <annotation name="org.gtk.GDBus.DocString" value="Describes the operating mode of the access point." /> - </property> - <property name="MaxBitrate" type="u" access="read"> - <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"> - <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"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Frequency: + + The radio channel frequency in use by the access point, in MHz. + --> + <property name="Frequency" type="u" access="read"/> + + <!-- + HwAddress: + + The hardware address (BSSID) of the access point. + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Mode: + + Describes the operating mode of the access point. + + Returns: <link linkend="NM80211Mode">NM80211Mode</link> + --> + <property name="Mode" type="u" access="read"/> + + <!-- + MaxBitrate: + + The maximum bitrate this access point is capable of, in kilobits/second + (Kb/s). + --> + <property name="MaxBitrate" type="u" access="read"/> + + <!-- + Strength: + + The current signal quality of the access point, in percent. + --> + <property name="Strength" type="y" access="read"/> + + <!-- + LastSeen: + 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. - " /> - </property> + point was found in scan results. A value of -1 means the access point has + never been found in scan results. + --> + <property name="LastSeen" type="i" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - <tp:flags name="NM_802_11_AP_FLAGS" value-prefix="NM_802_11_AP_FLAGS" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags describing the general capabilities of the access point. - " /> - <tp:flag suffix="NONE" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="Null capability - says nothing about the access point." /> - </tp:flag> - <tp:flag suffix="PRIVACY" value="0x1"> - <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"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags describing the security capabilities of the access point. - " /> - <tp:flag suffix="NONE" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="Null flag." /> - </tp:flag> - <tp:flag suffix="PAIR_WEP40" value="0x1"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise 40-bit WEP encryption." /> - </tp:flag> - <tp:flag suffix="PAIR_WEP104" value="0x2"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise 104-bit WEP encryption." /> - </tp:flag> - <tp:flag suffix="PAIR_TKIP" value="0x4"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise TKIP encryption." /> - </tp:flag> - <tp:flag suffix="PAIR_CCMP" value="0x8"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports pairwise CCMP encryption." /> - </tp:flag> - <tp:flag suffix="GROUP_WEP40" value="0x10"> - <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"> - <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"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports a group TKIP cipher." /> - </tp:flag> - <tp:flag suffix="GROUP_CCMP" value="0x80"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports a group CCMP cipher." /> - </tp:flag> - <tp:flag suffix="KEY_MGMT_PSK" value="0x100"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports PSK key management." /> - </tp:flag> - <tp:flag suffix="KEY_MGMT_802_1X" value="0x200"> - <annotation name="org.gtk.GDBus.DocString" value="Access point supports 802.1x key management." /> - </tp:flag> - </tp:flags> </interface> </node> - diff --git a/introspection/nm-active-connection.xml b/introspection/nm-active-connection.xml index 59bf78f4d0..a4e9417041 100644 --- a/introspection/nm-active-connection.xml +++ b/introspection/nm-active-connection.xml @@ -1,154 +1,156 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> + <!-- + org.freedesktop.NetworkManager.Connection.Active: + + 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. 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. + Such settings-connections are exposed as D-Bus object and the + active-connection expresses this relationship between device and + settings-connection. At any time a settings-connection can only be + activated on one device and vice 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. + --> <interface name="org.freedesktop.NetworkManager.Connection.Active"> <annotation name="org.gtk.GDBus.C.Name" value="ActiveConnection"/> - <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. - 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. - Such settings-connections are exposed as D-Bus object and the active-connection - expresses this relationship between device and settings-connection. - At any time a settings-connection can only be activated on one device and vice - 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. - " /> - - <property name="Connection" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + + <!-- + Connection: + The path of the connection. - " /> - </property> - <property name="SpecificObject" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - A specific object associated with the active connection. This property + --> + <property name="Connection" type="o" access="read"/> + + <!-- + SpecificObject: + + 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. - " /> - </property> - <property name="Id" type="s" access="read"> - <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. - " /> - </property> - <property name="Uuid" type="s" access="read"> - <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. - " /> - </property> - <property name="Type" type="s" access="read"> - <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. - " /> - </property> - <property name="Devices" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="SpecificObject" type="o" access="read"/> + + <!-- + Id: + + The ID of the connection, provided as a convenience so that clients do not + have to retrieve all connection details. + --> + <property name="Id" type="s" access="read"/> + + <!-- + Uuid: + + The UUID of the connection, provided as a convenience so that clients do + not have to retrieve all connection details. + --> + <property name="Uuid" type="s" access="read"/> + + <!-- + Type: + + The type of the connection, provided as a convenience so that clients do + not have to retrieve all connection details. + --> + <property name="Type" type="s" access="read"/> + + <!-- + Devices: + Array of object paths representing devices which are part of this active connection. - " /> - </property> - <property name="State" type="u" access="read" tp:type="NM_ACTIVE_CONNECTION_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Devices" type="ao" access="read"/> + + <!-- + State: + The state of this active connection. - " /> - </property> - <property name="Default" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + + Returns: <link linkend="NMActiveConnectionState">NMActiveConnectionState</link> + --> + <property name="State" type="u" access="read"/> + + <!-- + Default: + Whether this active connection is the default IPv4 connection, i.e. whether it currently owns the default IPv4 route. - " /> - </property> - <property name="Ip4Config" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Default" type="b" access="read"/> + + <!-- + Ip4Config: + 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. - " /> - </property> - <property name="Dhcp4Config" type="o" access="read"> - <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. - " /> - </property> - <property name="Default6" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Ip4Config" type="o" access="read"/> + + <!-- + Dhcp4Config: + + 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. + --> + <property name="Dhcp4Config" type="o" access="read"/> + + <!-- + Default6: + Whether this active connection is the default IPv6 connection, i.e. whether it currently owns the default IPv6 route. - " /> - </property> - <property name="Ip6Config" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Default6" type="b" access="read"/> + + <!-- + Ip6Config: + 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. - " /> - </property> - <property name="Dhcp6Config" type="o" access="read"> - <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. - " /> - </property> - <property name="Vpn" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Ip6Config" type="o" access="read"/> + + <!-- + Dhcp6Config: + + 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. + --> + <property name="Dhcp6Config" type="o" access="read"/> + + <!-- + Vpn: + Whether this active connection is also a VPN connection. - " /> - </property> - <property name="Master" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Vpn" type="b" access="read"/> + + <!-- + Master: + The path to the master device if the connection is a slave. - " /> - </property> + --> + <property name="Master" type="o" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - - <tp:enum name="NM_ACTIVE_CONNECTION_STATE" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The active connection is in an unknown state. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="ACTIVATING" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection is activating. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="ACTIVATED" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection is activated. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DEACTIVATING" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection is being torn down and cleaned up. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DEACTIVATED" value="4"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection is no longer active. - " /> - </tp:enumvalue> - </tp:enum> </interface> </node> - diff --git a/introspection/nm-agent-manager.xml b/introspection/nm-agent-manager.xml index 52460eeeec..86b4404a1a 100644 --- a/introspection/nm-agent-manager.xml +++ b/introspection/nm-agent-manager.xml @@ -1,50 +1,37 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/org/freedesktop/NetworkManager/AgentManager" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/org/freedesktop/NetworkManager/AgentManager"> <interface name="org.freedesktop.NetworkManager.AgentManager"> - <method name="Register"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Register: + @identifier: 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 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). + Called by secret Agents to register their ability to provide and save network secrets. - " /> - <arg name="identifier" type="s" direction="in"> - <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 - 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). - " /> - </arg> + --> + <method name="Register"> + <arg name="identifier" type="s" direction="in"/> </method> - <method name="RegisterWithCapabilities"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + RegisterWithCapabilities: + @identifier: See the Register() method's identifier argument. + @capabilities: (<link linkend="NMSecretAgentCapabilities">NMSecretAgentCapabilities</link>) Indicates various agent capabilities to NetworkManager. + Like Register() but indicates agent capabilities to NetworkManager. - " /> - <arg name="identifier" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - See the Register() method's identifier argument. - " /> - </arg> - <arg name="capabilities" type="u" direction="in" tp:type="NM_SECRET_AGENT_CAPABILITIES"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates various agent capabilities to NetworkManager. - " /> - </arg> + --> + <method name="RegisterWithCapabilities"> + <arg name="identifier" type="s" direction="in"/> + <arg name="capabilities" type="u" direction="in"/> </method> - <method name="Unregister"> - <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. - " /> - </method> + <!-- + Unregister: + 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. + --> + <method name="Unregister"/> </interface> </node> - diff --git a/introspection/nm-device-adsl.xml b/introspection/nm-device-adsl.xml index 68859d3bea..5ad397e6a4 100644 --- a/introspection/nm-device-adsl.xml +++ b/introspection/nm-device-adsl.xml @@ -1,21 +1,20 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Adsl"> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - <property name="Carrier" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the physical carrier is found. - " /> - </property> + <!-- + Carrier: + Indicates whether the physical carrier is found. + --> + <property name="Carrier" type="b" access="read"/> </interface> </node> diff --git a/introspection/nm-device-bond.xml b/introspection/nm-device-bond.xml index 9bc21225a3..fc0249d937 100644 --- a/introspection/nm-device-bond.xml +++ b/introspection/nm-device-bond.xml @@ -1,34 +1,36 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Bond"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Carrier: - <property name="Carrier" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). - " /> - </property> + Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). + --> + <property name="Carrier" type="b" access="read"/> - <property name="Slaves" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of object paths representing devices which are currently - slaved to this device. - " /> - </property> + <!-- + Slaves: + Array of object paths representing devices which are currently slaved to + this device. + --> + <property name="Slaves" type="ao" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-bridge.xml b/introspection/nm-device-bridge.xml index 6cf99a10c2..c2e8ffd3b3 100644 --- a/introspection/nm-device-bridge.xml +++ b/introspection/nm-device-bridge.xml @@ -1,34 +1,36 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Bridge"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Carrier: - <property name="Carrier" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). - " /> - </property> + Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). + --> + <property name="Carrier" type="b" access="read"/> - <property name="Slaves" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of object paths representing devices which are currently - slaved to this device. - " /> - </property> + <!-- + Slaves: + Array of object paths representing devices which are currently slaved to + this device. + --> + <property name="Slaves" type="ao" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-bt.xml b/introspection/nm-device-bt.xml index 3b487158e8..6249085b2e 100644 --- a/introspection/nm-device-bt.xml +++ b/introspection/nm-device-bt.xml @@ -1,48 +1,36 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Bluetooth"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Bluetooth hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Name: - <property name="Name" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Bluetooth name of the device. - " /> - </property> + --> + <property name="Name" type="s" access="read"/> + + <!-- + BtCapabilities: - <property name="BtCapabilities" type="u" access="read" tp:type="NM_BT_CAPABILITIES"> - <annotation name="org.gtk.GDBus.DocString" value=" Bluetooth capabilities of the device (either DUN or NAP). - " /> - </property> + Returns: <link linkend="NMBluetoothCapabilities">NMBluetoothCapabilities</link> + --> + <property name="BtCapabilities" type="u" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - - <tp:flags name="NM_BT_CAPABILITIES" value-prefix="NM_BT_CAPABILITY" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags describing the capabilities of a Bluetooth device. - " /> - <tp:flag suffix="NONE" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="The device has no recognized capabilities." /> - </tp:flag> - <tp:flag suffix="DUN" value="0x1"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports Bluetooth Dial-Up Networking." /> - </tp:flag> - <tp:flag suffix="PAN" value="0x2"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports Bluetooth Personal Area Networking." /> - </tp:flag> - </tp:flags> - </interface> </node> diff --git a/introspection/nm-device-ethernet.xml b/introspection/nm-device-ethernet.xml index 87b7f755d6..ddfa74bb09 100644 --- a/introspection/nm-device-ethernet.xml +++ b/introspection/nm-device-ethernet.xml @@ -1,46 +1,50 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Wired"> <annotation name="org.gtk.GDBus.C.Name" value="DeviceEthernet"/> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Active hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + PermHwAddress: - <property name="PermHwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Permanent hardware address of the device. - " /> - </property> + --> + <property name="PermHwAddress" type="s" access="read"/> + + <!-- + Speed: - <property name="Speed" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Design speed of the device, in megabits/second (Mb/s). - " /> - </property> + --> + <property name="Speed" type="u" access="read"/> + + <!-- + S390Subchannels: - <property name="S390Subchannels" type="as" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Array of S/390 subchannels for S/390 or z/Architecture devices. - " /> - </property> + --> + <property name="S390Subchannels" type="as" access="read"/> + + <!-- + Carrier: - <property name="Carrier" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). - " /> - </property> + Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). + --> + <property name="Carrier" type="b" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-generic.xml b/introspection/nm-device-generic.xml index 2f8fc7eead..e79ff700ac 100644 --- a/introspection/nm-device-generic.xml +++ b/introspection/nm-device-generic.xml @@ -1,27 +1,27 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Generic"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + TypeDescription: - <property name="TypeDescription" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" A (non-localized) description of the interface type, if known. - " /> - </property> + --> + <property name="TypeDescription" type="s" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-infiniband.xml b/introspection/nm-device-infiniband.xml index 169c2c66cc..9848a07430 100644 --- a/introspection/nm-device-infiniband.xml +++ b/introspection/nm-device-infiniband.xml @@ -1,27 +1,28 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Infiniband"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> - <property name="Carrier" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). - " /> - </property> + <!-- + Carrier: + Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). + --> + <property name="Carrier" type="b" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-ip-tunnel.xml b/introspection/nm-device-ip-tunnel.xml index 3ca04ee66c..45f3a3f710 100644 --- a/introspection/nm-device-ip-tunnel.xml +++ b/introspection/nm-device-ip-tunnel.xml @@ -1,86 +1,94 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.IPTunnel"> - <property name="Mode" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Mode: + The tunneling mode. - " /> - </property> + --> + <property name="Mode" type="u" access="read"/> + + <!-- + Parent: - <property name="Parent" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The object path of the parent device. - " /> - </property> + --> + <property name="Parent" type="o" access="read"/> + + <!-- + Local: - <property name="Local" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The local endpoint of the tunnel. - " /> - </property> + --> + <property name="Local" type="s" access="read"/> + + <!-- + Remote: - <property name="Remote" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The remote endpoint of the tunnel. - " /> - </property> - - <property name="Ttl" type="y" access="read"> - <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 - " /> - </property> - - <property name="Tos" type="y" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The type of service (IPv4) or traffic class (IPv6) assigned to - tunneled packets. - " /> - </property> - - <property name="PathMtuDiscovery" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Remote" type="s" access="read"/> + + <!-- + Ttl: + + The TTL assigned to tunneled packets. 0 is a special value meaning that + packets inherit the TTL value + --> + <property name="Ttl" type="y" access="read"/> + + <!-- + Tos: + + The type of service (IPv4) or traffic class (IPv6) assigned to tunneled + packets. + --> + <property name="Tos" type="y" access="read"/> + + <!-- + PathMtuDiscovery: + Whether path MTU discovery is enabled on this tunnel. - " /> - </property> + --> + <property name="PathMtuDiscovery" type="b" access="read"/> + + <!-- + InputKey: - <property name="InputKey" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The key used for incoming packets. - " /> - </property> + --> + <property name="InputKey" type="s" access="read"/> + + <!-- + OutputKey: - <property name="OutputKey" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The key used for outgoing packets. - " /> - </property> - - <property name="EncapsulationLimit" type="y" access="read"> - <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. - " /> - </property> - - <property name="FlowLabel" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The flow label to assign to tunnel packets. This property - applies only to IPv6 tunnels. - " /> - </property> + --> + <property name="OutputKey" type="s" access="read"/> + + <!-- + EncapsulationLimit: + How many additional levels of encapsulation are permitted to be prepended + to packets. This property applies only to IPv6 tunnels. + --> + <property name="EncapsulationLimit" type="y" access="read"/> + + <!-- + FlowLabel: + + The flow label to assign to tunnel packets. This property applies only to + IPv6 tunnels. + --> + <property name="FlowLabel" type="u" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-macvlan.xml b/introspection/nm-device-macvlan.xml index d5d66068df..876b685cc9 100644 --- a/introspection/nm-device-macvlan.xml +++ b/introspection/nm-device-macvlan.xml @@ -1,39 +1,41 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Macvlan"> - <property name="Parent" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Parent: + The object path of the parent device. - " /> - </property> + --> + <property name="Parent" type="o" access="read"/> + + <!-- + Mode: - <property name="Mode" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The macvlan mode, one of "private", "vepa", "bridge", or "passthru". - " /> - </property> + The macvlan mode, one of "private", "vepa", "bridge", or "passthru". + --> + <property name="Mode" type="s" access="read"/> + + <!-- + NoPromisc: - <property name="NoPromisc" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Whether the device is blocked from going into promiscuous mode. - " /> - </property> + --> + <property name="NoPromisc" type="b" access="read"/> + + <!-- + Tap: - <property name="Tap" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Whether the device is a macvtap. - " /> - </property> + --> + <property name="Tap" type="b" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-modem.xml b/introspection/nm-device-modem.xml index 67742c463d..1d4bd65ee9 100644 --- a/introspection/nm-device-modem.xml +++ b/introspection/nm-device-modem.xml @@ -1,64 +1,35 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Modem"> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - <property name="ModemCapabilities" type="u" access="read" tp:type="NM_DEVICE_MODEM_CAPABILITIES"> - <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 + <!-- + ModemCapabilities: + + 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. - " /> - </property> - <property name="CurrentCapabilities" type="u" access="read" tp:type="NM_DEVICE_MODEM_CAPABILITIES"> - <annotation name="org.gtk.GDBus.DocString" value=" + Returns: <link linkend="NMDeviceModemCapabilities">NMDeviceModemCapabilities</link> + --> + <property name="ModemCapabilities" type="u" access="read"/> + + <!-- + CurrentCapabilities: + The generic family of access technologies the modem currently supports without a firmware reload or reinitialization. - " /> - </property> - - <tp:flags name="NM_DEVICE_MODEM_CAPABILITIES" value-prefix="NM_DEVICE_MODEM_CAPABILITY" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags describing one or more of the general access technology families - that a modem device supports. - " /> - <tp:flag suffix="NONE" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="Modem has no capabilties." /> - </tp:flag> - <tp:flag suffix="POTS" value="0x1"> - <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:flag> - <tp:flag suffix="CDMA_EVDO" value="0x2"> - <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:flag> - <tp:flag suffix="GSM_UMTS" value="0x4"> - <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:flag> - <tp:flag suffix="LTE" value="0x8"> - <annotation name="org.gtk.GDBus.DocString" value=" - Modem has at LTE data capability. - " /> - </tp:flag> - </tp:flags> + Returns: <link linkend="NMDeviceModemCapabilities">NMDeviceModemCapabilities</link> + --> + <property name="CurrentCapabilities" type="u" access="read"/> </interface> </node> diff --git a/introspection/nm-device-olpc-mesh.xml b/introspection/nm-device-olpc-mesh.xml index a92e73709a..b2ab126ec6 100644 --- a/introspection/nm-device-olpc-mesh.xml +++ b/introspection/nm-device-olpc-mesh.xml @@ -1,34 +1,36 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.OlpcMesh"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + + <!-- + HwAddress: + The hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Companion: - <property name="Companion" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The object path of the companion device. - " /> - </property> + --> + <property name="Companion" type="o" access="read"/> + + <!-- + ActiveChannel: - <property name="ActiveChannel" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The currently active channel. - " /> - </property> + --> + <property name="ActiveChannel" type="u" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary containing the FIXME: check changed parameters. + Emitted when the wireless device's properties changed. + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary containing the FIXME: check changed parameters. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when the wireless device's properties changed. - " /> + <arg name="properties" type="a{sv}"/> </signal> </interface> </node> diff --git a/introspection/nm-device-team.xml b/introspection/nm-device-team.xml index 982b767018..05bbbafe46 100644 --- a/introspection/nm-device-team.xml +++ b/introspection/nm-device-team.xml @@ -1,34 +1,36 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Team"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Carrier: - <property name="Carrier" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). - " /> - </property> + Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). + --> + <property name="Carrier" type="b" access="read"/> - <property name="Slaves" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of object paths representing devices which are currently - slaved to this device. - " /> - </property> + <!-- + Slaves: + Array of object paths representing devices which are currently slaved to + this device. + --> + <property name="Slaves" type="ao" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-tun.xml b/introspection/nm-device-tun.xml index 0f74cf8c41..a11461c1a1 100644 --- a/introspection/nm-device-tun.xml +++ b/introspection/nm-device-tun.xml @@ -1,61 +1,65 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Tun"> - <property name="Owner" type="x" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Owner: + The uid of the tunnel owner, or -1 if it has no owner. - " /> - </property> + --> + <property name="Owner" type="x" access="read"/> + + <!-- + Group: - <property name="Group" type="x" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The gid of the tunnel group, or -1 if it has no owner. - " /> - </property> - - <property name="Mode" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The tunnel mode, either "tun" or "tap". - " /> - </property> - - <property name="NoPi" type="b" access="read"> - <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. - " /> - </property> - - <property name="VnetHdr" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets - include a virtio network header. - " /> - </property> - - <property name="MultiQueue" type="b" access="read"> - <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. - " /> - </property> - - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Group" type="x" access="read"/> + + <!-- + Mode: + + The tunnel mode, either "tun" or "tap". + --> + <property name="Mode" type="s" access="read"/> + + <!-- + NoPi: + + The tunnel's "TUN_NO_PI" flag; true if no protocol info is prepended to + the tunnel packets. + --> + <property name="NoPi" type="b" access="read"/> + + <!-- + VnetHdr: + + The tunnel's "TUN_VNET_HDR" flag; true if the tunnel packets include a + virtio network header. + --> + <property name="VnetHdr" type="b" access="read"/> + + <!-- + MultiQueue: + + The tunnel's "TUN_TAP_MQ" flag; true if callers can connect to the tap + device multiple times, for multiple send/receive queues. + --> + <property name="MultiQueue" type="b" access="read"/> + + <!-- + HwAddress: + Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-veth.xml b/introspection/nm-device-veth.xml index a3cff6da08..b064874e0d 100644 --- a/introspection/nm-device-veth.xml +++ b/introspection/nm-device-veth.xml @@ -1,21 +1,20 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Veth"> - <property name="Peer" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Peer: + The object path of the device's peer. - " /> - </property> + --> + <property name="Peer" type="o" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-vlan.xml b/introspection/nm-device-vlan.xml index bac220e899..7d8fbdce92 100644 --- a/introspection/nm-device-vlan.xml +++ b/introspection/nm-device-vlan.xml @@ -1,39 +1,42 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Vlan"> - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + HwAddress: + Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Carrier: - <property name="Carrier" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the physical carrier is found (e.g. whether a cable is plugged in or not). - " /> - </property> + Indicates whether the physical carrier is found (e.g. whether a cable is + plugged in or not). + --> + <property name="Carrier" type="b" access="read"/> + + <!-- + Parent: - <property name="Parent" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Object path of the parent device of this VLAN device. - " /> - </property> + --> + <property name="Parent" type="o" access="read"/> + + <!-- + VlanId: - <property name="VlanId" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The VLAN ID of this VLAN interface. - " /> - </property> + --> + <property name="VlanId" type="u" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-vxlan.xml b/introspection/nm-device-vxlan.xml index de23020d5b..ec17717d6f 100644 --- a/introspection/nm-device-vxlan.xml +++ b/introspection/nm-device-vxlan.xml @@ -1,128 +1,139 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Vxlan"> - <property name="Parent" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the parent device (if the VXLAN is not - purely internal to this host). - " /> - </property> + <!-- + Parent: + + The object path of the parent device (if the VXLAN is not purely internal + to this host). + --> + <property name="Parent" type="o" access="read"/> + + <!-- + HwAddress: - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + Id: - <property name="Id" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The VXLAN Network Identifier (VNI). - " /> - </property> + --> + <property name="Id" type="u" access="read"/> + + <!-- + Group: - <property name="Group" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The IP (v4 or v6) multicast group used to communicate with other physical - hosts on this VXLAN. - " /> - </property> + hosts on this VXLAN. + --> + <property name="Group" type="s" access="read"/> + + <!-- + Local: - <property name="Local" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The local IPv4 or IPv6 address to use when sending VXLAN packets to other - physical hosts. - " /> - </property> - - <property name="Tos" type="y" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The value to use in the IP ToS field for VXLAN packets sent to - other physical hosts. - " /> - </property> - - <property name="Ttl" type="y" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The value to use in the IP TTL field for VXLAN packets sent to - other physical hosts. - " /> - </property> - - <property name="Learning" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + physical hosts. + --> + <property name="Local" type="s" access="read"/> + + <!-- + Tos: + + The value to use in the IP ToS field for VXLAN packets sent to other + physical hosts. + --> + <property name="Tos" type="y" access="read"/> + + <!-- + Ttl: + + The value to use in the IP TTL field for VXLAN packets sent to other + physical hosts. + --> + <property name="Ttl" type="y" access="read"/> + + <!-- + Learning: + True if the VXLAN dynamically learns remote IP addresses. - " /> - </property> - - <property name="Ageing" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The interval in seconds at which the kernel purges stale - cached addresses. - " /> - </property> - - <property name="Limit" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The maximum number of entries that can be added to the VXLAN's - forwarding table. - " /> - </property> - - <property name="DstPort" type="q" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Learning" type="b" access="read"/> + + <!-- + Ageing: + + The interval in seconds at which the kernel purges stale cached addresses. + --> + <property name="Ageing" type="u" access="read"/> + + <!-- + Limit: + + The maximum number of entries that can be added to the VXLAN's forwarding + table. + --> + <property name="Limit" type="u" access="read"/> + + <!-- + DstPort: + Destination port for outgoing VXLAN packets. - " /> - </property> + --> + <property name="DstPort" type="q" access="read"/> + + <!-- + SrcPortMin: - <property name="SrcPortMin" type="q" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The lowest source port number to use for outgoing VXLAN packets. - " /> - </property> + --> + <property name="SrcPortMin" type="q" access="read"/> + + <!-- + SrcPortMax: - <property name="SrcPortMax" type="q" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The highest source port number to use for outgoing VXLAN packets. - " /> - </property> - - <property name="Proxy" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - True if the VXLAN is implementing DOVE ARP proxying for remote - clients. - " /> - </property> - - <property name="Rsc" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - True if the VXLAN is implementing DOVE route short-circuiting - of known remote IP addresses. - " /> - </property> - - <property name="L2miss" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - True if the VXLAN will emit netlink notifications of L2 switch - misses. - " /> - </property> - - <property name="L3miss" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - True if the VXLAN will emit netlink notifications of L3 switch - misses. - " /> - </property> + --> + <property name="SrcPortMax" type="q" access="read"/> + + <!-- + Proxy: + + True if the VXLAN is implementing DOVE ARP proxying for remote clients. + --> + <property name="Proxy" type="b" access="read"/> + <!-- + Rsc: + + True if the VXLAN is implementing DOVE route short-circuiting of known + remote IP addresses. + --> + <property name="Rsc" type="b" access="read"/> + + <!-- + L2miss: + + True if the VXLAN will emit netlink notifications of L2 switch misses. + --> + <property name="L2miss" type="b" access="read"/> + + <!-- + L3miss: + + True if the VXLAN will emit netlink notifications of L3 switch misses. + --> + <property name="L3miss" type="b" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - </interface> </node> diff --git a/introspection/nm-device-wifi.xml b/introspection/nm-device-wifi.xml index 2ece0ef0ae..c1f378d8c0 100644 --- a/introspection/nm-device-wifi.xml +++ b/introspection/nm-device-wifi.xml @@ -1,170 +1,124 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.Wireless"> <annotation name="org.gtk.GDBus.C.Name" value="DeviceWifi"/> - <method name="GetAccessPoints"> - <arg name="access_points" type="ao" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - List of access point object paths. - " /> - </arg> - <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 + <!-- + GetAccessPoints: + @access_points: List of access point object paths. + + 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. - " /> - </method> + --> + <method name="GetAccessPoints"> + <arg name="access_points" type="ao" direction="out"/> + </method> + + <!-- + GetAllAccessPoints: + @access_points: List of access point object paths. + Get the list of all access points visible to this device, including hidden + ones for which the SSID is not yet known. + --> <method name="GetAllAccessPoints"> - <arg name="access_points" type="ao" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - List of access point object paths. - " /> - </arg> - <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. - " /> - </method> + <arg name="access_points" type="ao" direction="out"/> + </method> + + <!-- + RequestScan: + @options: Options of scan. Currently 'ssids' option with value of "aay" type is supported. - <method name="RequestScan"> - <arg name="options" type="a{sv}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Options of scan. - Currently 'ssids' option with value of "aay" type is supported. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" Request the device to scan - " /> - </method> + --> + <method name="RequestScan"> + <arg name="options" type="a{sv}" direction="in"/> + </method> + + <!-- + HwAddress: - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The active hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + PermHwAddress: - <property name="PermHwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The permanent hardware address of the device. - " /> - </property> + --> + <property name="PermHwAddress" type="s" access="read"/> + + <!-- + Mode: - <property name="Mode" type="u" access="read" tp:type="NM_802_11_MODE"> - <annotation name="org.gtk.GDBus.DocString" value=" The operating mode of the wireless device. - " /> - </property> - <property name="Bitrate" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - The bit rate currently used by the wireless device, in kilobits/second (Kb/s). - " /> - </property> + Returns: <link linkend="NM80211Mode">NM80211Mode</link> + --> + <property name="Mode" type="u" access="read"/> + + <!-- + Bitrate: + + The bit rate currently used by the wireless device, in kilobits/second + (Kb/s). + --> + <property name="Bitrate" type="u" access="read"/> + + <!-- + AccessPoints: - <property name="AccessPoints" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" List of object paths of access point visible to this wireless device. - " /> - </property> + --> + <property name="AccessPoints" type="ao" access="read"/> + + <!-- + ActiveAccessPoint: - <property name="ActiveAccessPoint" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Object path of the access point currently used by the wireless device. - " /> - </property> + --> + <property name="ActiveAccessPoint" type="o" access="read"/> + + <!-- + WirelessCapabilities: - <property name="WirelessCapabilities" type="u" access="read" tp:type="NM_802_11_DEVICE_CAP"> - <annotation name="org.gtk.GDBus.DocString" value=" The capabilities of the wireless device. - " /> - </property> + Returns: <link linkend="NMDeviceWifiCapabilities">NMDeviceWifiCapabilities</link> + --> + <property name="WirelessCapabilities" type="u" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary containing the FIXME: check changed parameters. + + Emitted when the wireless device's properties changed. + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary containing the FIXME: check changed parameters. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when the wireless device's properties changed. - " /> - </signal> + <arg name="properties" type="a{sv}"/> + </signal> + + <!-- + AccessPointAdded: + @access_point: The object path of the newly found access point. + Emitted when a new access point is found by the device. + --> <signal name="AccessPointAdded"> - <arg name="access_point" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the newly found access point. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when a new access point is found by the device. - " /> - </signal> + <arg name="access_point" type="o"/> + </signal> + <!-- + AccessPointRemoved: + @access_point: The object path of the access point that has disappeared. + + Emitted when an access point disappears from view of the device. + --> <signal name="AccessPointRemoved"> - <arg name="access_point" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the access point that has disappeared. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when an access point disappears from view of the device. - " /> + <arg name="access_point" type="o"/> </signal> - - <tp:flags name="NM_802_11_DEVICE_CAP" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags describing the capabilities of a wireless device. - " /> - <tp:flag suffix="NONE" value="0x0"> - <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"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports the 40-bit WEP cipher." /> - </tp:flag> - <tp:flag suffix="CIPHER_WEP104" value="0x2"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports the 104-bit WEP cipher." /> - </tp:flag> - <tp:flag suffix="CIPHER_TKIP" value="0x4"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports the TKIP cipher." /> - </tp:flag> - <tp:flag suffix="CIPHER_CCMP" value="0x8"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports the CCMP cipher." /> - </tp:flag> - <tp:flag suffix="WPA" value="0x10"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports the WPA encryption/authentication protocol." /> - </tp:flag> - <tp:flag suffix="RSN" value="0x20"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports the RSN encryption/authentication protocol." /> - </tp:flag> - <tp:flag suffix="AP" value="0x40"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports Access Point mode." /> - </tp:flag> - <tp:flag suffix="ADHOC" value="0x80"> - <annotation name="org.gtk.GDBus.DocString" value="The device supports Ad-Hoc mode." /> - </tp:flag> - <tp:flag suffix="FREQ_VALID" value="0x100"> - <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:flag> - <tp:flag suffix="FREQ_2GHZ" value="0x200"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device supports 2.4GHz frequencies. - " /> - </tp:flag> - <tp:flag suffix="FREQ_5GHZ" value="0x400"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device supports 5GHz frequencies. - " /> - </tp:flag> - </tp:flags> </interface> </node> diff --git a/introspection/nm-device-wimax.xml b/introspection/nm-device-wimax.xml index e790e4fc62..02539dbb66 100644 --- a/introspection/nm-device-wimax.xml +++ b/introspection/nm-device-wimax.xml @@ -1,109 +1,112 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device.WiMax"> - <method name="GetNspList"> - <arg name="nsps" type="ao" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - List of NSP object paths - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" + + <!-- + GetNspList: + @nsps: List of NSP object paths + Get the list of NSPs visible to this device. - " /> - </method> + --> + <method name="GetNspList"> + <arg name="nsps" type="ao" direction="out"/> + </method> + + <!-- + Nsps: - <property name="Nsps" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" List of object paths of Network Service Providers (NSPs) visible to this WiMAX device. - " /> - </property> + --> + <property name="Nsps" type="ao" access="read"/> + + <!-- + HwAddress: - <property name="HwAddress" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" Hardware address of the device. - " /> - </property> + --> + <property name="HwAddress" type="s" access="read"/> + + <!-- + CenterFrequency: - <property name="CenterFrequency" type="u" access="read"> - <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. - " /> - </property> - - <property name="Rssi" type="i" access="read"> - <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 + communicate with the network when connected. Has no meaning when the device is not connected. - " /> - </property> + --> + <property name="CenterFrequency" type="u" access="read"/> + + <!-- + Rssi: + + 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. + --> + <property name="Rssi" type="i" access="read"/> + + <!-- + Cinr: - <property name="Cinr" type="i" access="read"> - <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 + 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. + --> + <property name="Cinr" type="i" access="read"/> + + <!-- + TxPower: + + 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. + --> + <property name="TxPower" type="i" access="read"/> + + <!-- + Bsid: + + The ID of the serving base station as received from the network. Has no meaning when the device is not connected. - " /> - </property> - - <property name="TxPower" type="i" access="read"> - <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. - " /> - </property> - - <property name="Bsid" type="s" access="read"> - <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. - " /> - </property> - - <property name="ActiveNsp" type="o" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Bsid" type="s" access="read"/> + + <!-- + ActiveNsp: + Object path of the NSP currently used by the WiMax device. - " /> - </property> + --> + <property name="ActiveNsp" type="o" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values. + + Emitted when the WiMax device's properties changed. + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when the WiMax device's properties changed. - " /> - </signal> + <arg name="properties" type="a{sv}"/> + </signal> + + <!-- + NspAdded: + @nsp: The object path of the newly found NSP. + Emitted when a new NSP is found by the device. + --> <signal name="NspAdded"> - <arg name="nsp" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the newly found NSP. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when a new NSP is found by the device. - " /> - </signal> + <arg name="nsp" type="o"/> + </signal> + + <!-- + NspRemoved: + @nsp: The object path of the NSP that has disappeared. + Emitted when an NSP disappears from view of the device. + --> <signal name="NspRemoved"> - <arg name="nsp" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the NSP that has disappeared. - " /> - </arg> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when an NSP disappears from view of the device. - " /> + <arg name="nsp" type="o"/> </signal> - </interface> </node> diff --git a/introspection/nm-device.xml b/introspection/nm-device.xml index 321cace13b..d4535a84da 100644 --- a/introspection/nm-device.xml +++ b/introspection/nm-device.xml @@ -1,798 +1,321 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.Device"> - <property name="Udi" type="s" access="read"> - <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 - device types (Bluetooth, Modems) it is an identifier used by the - hardware service (ie bluez or ModemManager) to refer to that device, - and client programs use it get additional information from those - services which NM does not provide. The Udi is not guaranteed to be - consistent across reboots or hotplugs of the hardware. If you're looking - for a way to uniquely track each device in your application, use the - 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. - " /> - </property> - <property name="Interface" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + + <!-- + Udi: + + 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 device + types (Bluetooth, Modems) it is an identifier used by the hardware service + (ie bluez or ModemManager) to refer to that device, and client programs + use it get additional information from those services which NM does not + provide. The Udi is not guaranteed to be consistent across reboots or + hotplugs of the hardware. If you're looking for a way to uniquely track + each device in your application, use the 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. + --> + <property name="Udi" type="s" access="read"/> + + <!-- + Interface: + The name of the device's control (and often data) interface. - " /> - </property> - <property name="IpInterface" type="s" access="read"> - <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. - " /> - </property> - <property name="Driver" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Interface" type="s" access="read"/> + + <!-- + IpInterface: + + 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. + --> + <property name="IpInterface" type="s" access="read"/> + + <!-- + Driver: + The driver handling the device. - " /> - </property> - <property name="DriverVersion" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Driver" type="s" access="read"/> + + <!-- + DriverVersion: + The version of the driver handling the device. - " /> - </property> - <property name="FirmwareVersion" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="DriverVersion" type="s" access="read"/> + + <!-- + FirmwareVersion: + The firmware version for the device. - " /> - </property> - <property name="Capabilities" type="u" access="read" tp:type="NM_DEVICE_CAP"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="FirmwareVersion" type="s" access="read"/> + + <!-- + Capabilities: + Flags describing the capabilities of the device. - " /> - </property> - <property name="Ip4Address" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object instead. - " /> - </property> - <property name="State" type="u" access="read" tp:type="NM_DEVICE_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" + + Returns: <link linkend="NMDeviceCapabilities">NMDeviceCapabilities</link> + --> + <property name="Capabilities" type="u" access="read"/> + + <!-- + Ip4Address: + + DEPRECATED; use the 'Addresses' property of the 'Ip4Config' object + instead. + --> + <property name="Ip4Address" type="u" access="read"/> + + <!-- + State: + The current state of the device. - " /> - </property> - <property name="StateReason" type="(uu)" access="read" tp:type="NM_DEVICE_STATE_REASON_STRUCT"> - <annotation name="org.gtk.GDBus.DocString" value=" + + Returns: <link linkend="NMDeviceState">NMDeviceState</link> + --> + <property name="State" type="u" access="read"/> + + <!-- + StateReason: + The current state and reason for changing to that state. - " /> - </property> - <property name="ActiveConnection" type="o" access="read"> - <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 + + Returns: A tuple of <link linkend="NMDeviceState">NMDeviceState</link> and <link linkend="NMDeviceStateReason">NMDeviceStateReason</link>. + --> + <property name="StateReason" type="(uu)" access="read"/> + + <!-- + ActiveConnection: + + 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. - " /> - </property> - <property name="Ip4Config" type="o" access="read"> - <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. - " /> - </property> - <property name="Dhcp4Config" type="o" access="read"> - <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. - " /> - </property> - <property name="Ip6Config" type="o" access="read"> - <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. - " /> - </property> - <property name="Dhcp6Config" type="o" access="read"> - <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 + --> + <property name="ActiveConnection" type="o" access="read"/> + + <!-- + Ip4Config: + + 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. + --> + <property name="Ip4Config" type="o" access="read"/> + + <!-- + Dhcp4Config: + + 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. + --> + <property name="Dhcp4Config" type="o" access="read"/> + + <!-- + Ip6Config: + + 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. + --> + <property name="Ip6Config" type="o" access="read"/> + + <!-- + Dhcp6Config: + + 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. - " /> - </property> - <property name="Managed" type="b" access="readwrite"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="Dhcp6Config" type="o" access="read"/> + + <!-- + Managed: + 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. - " /> - </property> - <property name="Autoconnect" type="b" access="readwrite"> - <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. - " /> - </property> - <property name="FirmwareMissing" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - If TRUE, indicates the device is likely missing firmware necessary for - its operation. - " /> - </property> - <property name="NmPluginMissing" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + 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. + --> + <property name="Managed" type="b" access="readwrite"/> + + <!-- + Autoconnect: + + 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. + --> + <property name="Autoconnect" type="b" access="readwrite"/> + + <!-- + FirmwareMissing: + + If TRUE, indicates the device is likely missing firmware necessary for its + operation. + --> + <property name="FirmwareMissing" type="b" access="read"/> + + <!-- + NmPluginMissing: + If TRUE, indicates the NetworkManager plugin for the device is likely missing or misconfigured. - " /> - </property> - <property name="DeviceType" type="u" access="read" tp:type="NM_DEVICE_TYPE"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="NmPluginMissing" type="b" access="read"/> + + <!-- + DeviceType: + The general type of the network device; ie Ethernet, WiFi, etc. - " /> - </property> - <property name="AvailableConnections" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - An array of object paths of every configured connection that is currently 'available' through this device. - " /> - </property> - <property name="PhysicalPortId" type="s" access="read"> - <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. - " /> - </property> - <property name="Mtu" type="u" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + + Returns: <link linkend="NMDeviceType">NMDeviceType</link> + --> + <property name="DeviceType" type="u" access="read"/> + + <!-- + AvailableConnections: + + An array of object paths of every configured connection that is currently + 'available' through this device. + --> + <property name="AvailableConnections" type="ao" access="read"/> + + <!-- + PhysicalPortId: + + 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. + --> + <property name="PhysicalPortId" type="s" access="read"/> + + <!-- + Mtu: + The device MTU (maximum transmission unit). - " /> - </property> - <property name="Metered" type="u" access="read" tp:type="NM_METERED"> - <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. - " /> - </property> - <property name="LldpNeighbors" type="aa{sv}" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of LLDP neighbors; each element is a dictionary mapping - LLDP TLV names to variant boxed values. - " /> - </property> - <property name="Real" type="b" access="read"> - <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. - " /> - </property> + --> + <property name="Mtu" type="u" access="read"/> + + <!-- + Metered: + + Whether the amount of traffic flowing through the device is subject to + limitations, for example set by service providers. + + Returns: <link linkend="NMMetered">NMMetered</link> + --> + <property name="Metered" type="u" access="read"/> + + <!-- + LldpNeighbors: + + Array of LLDP neighbors; each element is a dictionary mapping LLDP TLV + names to variant boxed values. + --> + <property name="LldpNeighbors" type="aa{sv}" access="read"/> + + <!-- + Real: + 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. + --> + <property name="Real" type="b" access="read"/> + + <!-- + Reapply: + @connection: The optional connection settings that will be reapplied on the device. If empty, the currently active settings-connection will be used. The connection cannot arbitrarly differ from the current applied-connection otherwise the call will fail. Only certain changes are supported, like adding or removing IP addresses. + @version_id: If non-zero, the current version id of the applied-connection must match. The current version id can be retrieved via GetAppliedConnection. This optional argument allows to catch concurrent modifications between the GetAppliedConnection call and Reapply. + @flags: 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. + + Attempts to update the configuration of a device without deactivating it. + NetworkManager has the concept of connections, which are profiles that + contain the configuration for a networking device. Those connections are + exposed via D-Bus as individual objects that can be created, modified and + deleted. When activating such a settings-connection on a device, the + settings-connection is cloned to become an applied-connection and used to + configure the device (see GetAppliedConnection). Subsequent modification + of the settings-connection don't propagate automatically to the device's + applied-connection (with exception of the firewall-zone and the metered + property). For the changes to take effect, you can either re-activate the + settings-connection, or call Reapply. The Reapply call allows you to + directly update the applied-connection and reconfigure the device. Reapply + can also be useful if the currently applied-connection is equal to the + connection that is about to be reapplied. This allows to reconfigure the + device and revert external changes like removing or adding an IP address + (which NetworkManager doesn't revert automatically because it is assumed + that the user made these changes intentionally outside of NetworkManager). + Reapply can make the applied-connection different from the + settings-connection, just like updating the settings-connection can make + them different. + --> <method name="Reapply"> - <arg name="connection" type="a{sa{sv}}" direction="in"> - <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. - " /> - </arg> - <arg name="version_id" type="t" direction="in"> - <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. - " /> - </arg> - <arg name="flags" type="u" direction="in"> - <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. - " /> - </arg> - <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 - that can be created, modified and deleted. When activating such a settings-connection - on a device, the settings-connection is cloned to become an applied-connection and used to - configure the device (see GetAppliedConnection). Subsequent modification of the - settings-connection don't propagate automatically to the device's applied-connection - (with exception of the firewall-zone and the metered property). For the changes to take - effect, you can either re-activate the settings-connection, or call Reapply. - The Reapply call allows you to directly update the applied-connection and reconfigure - the device. - Reapply can also be useful if the currently applied-connection is equal to the connection - that is about to be reapplied. This allows to reconfigure the device and revert external - changes like removing or adding an IP address (which NetworkManager doesn't revert - automatically because it is assumed that the user made these changes intentionally outside - of NetworkManager). - Reapply can make the applied-connection different from the settings-connection, - just like updating the settings-connection can make them different. - " /> - </method> + <arg name="connection" type="a{sa{sv}}" direction="in"/> + <arg name="version_id" type="t" direction="in"/> + <arg name="flags" type="u" direction="in"/> + </method> + <!-- + GetAppliedConnection: + @flags: 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. + @connection: The effective connection settings that the connection has currently applied. + @version_id: 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. + + 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. + --> <method name="GetAppliedConnection"> - <arg name="flags" type="u" direction="in"> - <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. - " /> - </arg> - <arg name="connection" type="a{sa{sv}}" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - The effective connection settings that the connection has currently applied. - " /> - </arg> - <arg name="version_id" type="t" direction="out"> - <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. - " /> - </arg> - <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. - " /> - </method> - - <method name="Disconnect"> - <annotation name="org.gtk.GDBus.DocString" value=" - Disconnects a device and prevents the device from automatically activating further connections without user intervention. - " /> - </method> - - <method name="Delete"> - <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. - " /> - </method> + <arg name="flags" type="u" direction="in"/> + <arg name="connection" type="a{sa{sv}}" direction="out"/> + <arg name="version_id" type="t" direction="out"/> + </method> + + <!-- + Disconnect: + Disconnects a device and prevents the device from automatically activating + further connections without user intervention. + --> + <method name="Disconnect"/> + + <!-- + Delete: + + Deletes a software device from NetworkManager and removes the interface + from the system. The method returns an error when called for a hardware + device. + --> + <method name="Delete"/> + + <!-- + StateChanged: + @new_state: (<link linkend="NMDeviceState">NMDeviceState</link>) The new state of the device. + @old_state: (<link linkend="NMDeviceState">NMDeviceState</link>) The previous state of the device. + @reason: (<link linkend="NMDeviceStateReason">NMDeviceStateReason</link>) A reason for the state transition. + --> <signal name="StateChanged"> - <arg name="new_state" type="u" tp:type="NM_DEVICE_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" - The new state of the device. - " /> - </arg> - <arg name="old_state" type="u" tp:type="NM_DEVICE_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" - The previous state of the device. - " /> - </arg> - <arg name="reason" type="u" tp:type="NM_DEVICE_STATE_REASON"> - <annotation name="org.gtk.GDBus.DocString" value=" - A reason for the state transition. - " /> - </arg> + <arg name="new_state" type="u"/> + <arg name="old_state" type="u"/> + <arg name="reason" type="u"/> </signal> - - <tp:enum name="NM_DEVICE_STATE" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is in an unknown state. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="UNMANAGED" value="10"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is recognized but not managed by NetworkManager. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="UNAVAILABLE" value="20"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device cannot be used (carrier off, rfkill, etc). - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DISCONNECTED" value="30"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is not connected. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PREPARE" value="40"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is preparing to connect. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONFIG" value="50"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is being configured. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NEED_AUTH" value="60"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is awaiting secrets necessary to continue connection. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="IP_CONFIG" value="70"> - <annotation name="org.gtk.GDBus.DocString" value=" - The IP settings of the device are being requested and configured. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="IP_CHECK" value="80"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device's IP connectivity ability is being determined. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SECONDARIES" value="90"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is waiting for secondary connections to be activated. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="ACTIVATED" value="100"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is active. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DEACTIVATING" value="110"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device's network connection is being torn down. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="FAILED" value="120"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is in a failure state following an attempt to activate it. - " /> - </tp:enumvalue> - </tp:enum> - - <tp:enum name="NM_DEVICE_TYPE" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device type is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="ETHERNET" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is wired Ethernet device. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="WIFI" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is an 802.11 WiFi device. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="UNUSED1" value="3"> - <annotation name="org.gtk.GDBus.DocString" value="Unused" /> - </tp:enumvalue> - <tp:enumvalue suffix="UNUSED2" value="4"> - <annotation name="org.gtk.GDBus.DocString" value="Unused" /> - </tp:enumvalue> - <tp:enumvalue suffix="BT" value="5"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is Bluetooth device that provides PAN or DUN capabilities. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="OLPC_MESH" value="6"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is an OLPC mesh networking device. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="WIMAX" value="7"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is an 802.16e Mobile WiMAX device. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM" value="8"> - <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:enumvalue> - <tp:enumvalue suffix="INFINIBAND" value="9"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is an IP-capable InfiniBand interface. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="BOND" value="10"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is a bond master interface. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="VLAN" value="11"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is a VLAN interface. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="ADSL" value="12"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is an ADSL device supporting PPPoE and PPPoATM protocols. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="BRIDGE" value="13"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is a bridge interface. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GENERIC" value="14"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is a generic interface type unrecognized by NetworkManager. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="TEAM" value="15"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is a team master interface. - " /> - </tp:enumvalue> - </tp:enum> - - <tp:flags name="NM_DEVICE_CAP" value-prefix="NM_DEVICE_CAP" type="u"> - <tp:flag suffix="NONE" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="Null capability." /> - </tp:flag> - <tp:flag suffix="NM_SUPPORTED" value="0x1"> - <annotation name="org.gtk.GDBus.DocString" value="The device is supported by NetworkManager." /> - </tp:flag> - <tp:flag suffix="CARRIER_DETECT" value="0x2"> - <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"> - <annotation name="org.gtk.GDBus.DocString" value=" - The reason for the device state change is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NONE" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The state change is normal. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NOW_MANAGED" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is now managed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NOW_UNMANAGED" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is no longer managed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONFIG_FAILED" value="4"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device could not be readied for configuration. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONFIG_UNAVAILABLE" value="5"> - <annotation name="org.gtk.GDBus.DocString" value=" - IP configuration could not be reserved (no available address, timeout, etc). - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONFIG_EXPIRED" value="6"> - <annotation name="org.gtk.GDBus.DocString" value=" - The IP configuration is no longer valid. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NO_SECRETS" value="7"> - <annotation name="org.gtk.GDBus.DocString" value=" - Secrets were required, but not provided. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SUPPLICANT_DISCONNECT" value="8"> - <annotation name="org.gtk.GDBus.DocString" value=" - The 802.1X supplicant disconnected from the access point or authentication server. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SUPPLICANT_CONFIG_FAILED" value="9"> - <annotation name="org.gtk.GDBus.DocString" value=" - Configuration of the 802.1X supplicant failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SUPPLICANT_FAILED" value="10"> - <annotation name="org.gtk.GDBus.DocString" value=" - The 802.1X supplicant quit or failed unexpectedly. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SUPPLICANT_TIMEOUT" value="11"> - <annotation name="org.gtk.GDBus.DocString" value=" - The 802.1X supplicant took too long to authenticate. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PPP_START_FAILED" value="12"> - <annotation name="org.gtk.GDBus.DocString" value=" - The PPP service failed to start within the allowed time. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PPP_DISCONNECT" value="13"> - <annotation name="org.gtk.GDBus.DocString" value=" - The PPP service disconnected unexpectedly. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PPP_FAILED" value="14"> - <annotation name="org.gtk.GDBus.DocString" value=" - The PPP service quit or failed unexpectedly. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DHCP_START_FAILED" value="15"> - <annotation name="org.gtk.GDBus.DocString" value=" - The DHCP service failed to start within the allowed time. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DHCP_ERROR" value="16"> - <annotation name="org.gtk.GDBus.DocString" value=" - The DHCP service reported an unexpected error. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DHCP_FAILED" value="17"> - <annotation name="org.gtk.GDBus.DocString" value=" - The DHCP service quit or failed unexpectedly. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SHARED_START_FAILED" value="18"> - <annotation name="org.gtk.GDBus.DocString" value=" - The shared connection service failed to start. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SHARED_FAILED" value="19"> - <annotation name="org.gtk.GDBus.DocString" value=" - The shared connection service quit or failed unexpectedly. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="AUTOIP_START_FAILED" value="20"> - <annotation name="org.gtk.GDBus.DocString" value=" - The AutoIP service failed to start. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="AUTOIP_ERROR" value="21"> - <annotation name="org.gtk.GDBus.DocString" value=" - The AutoIP service reported an unexpected error. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="AUTOIP_FAILED" value="22"> - <annotation name="org.gtk.GDBus.DocString" value=" - The AutoIP service quit or failed unexpectedly. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_BUSY" value="23"> - <annotation name="org.gtk.GDBus.DocString" value=" - Dialing failed because the line was busy. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_NO_DIAL_TONE" value="24"> - <annotation name="org.gtk.GDBus.DocString" value=" - Dialing failed because there was no dial tone. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_NO_CARRIER" value="25"> - <annotation name="org.gtk.GDBus.DocString" value=" - Dialing failed because there was carrier. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_DIAL_TIMEOUT" value="26"> - <annotation name="org.gtk.GDBus.DocString" value=" - Dialing timed out. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_DIAL_FAILED" value="27"> - <annotation name="org.gtk.GDBus.DocString" value=" - Dialing failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_INIT_FAILED" value="28"> - <annotation name="org.gtk.GDBus.DocString" value=" - Modem initialization failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_APN_FAILED" value="29"> - <annotation name="org.gtk.GDBus.DocString" value=" - Failed to select the specified GSM APN. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_REGISTRATION_NOT_SEARCHING" value="30"> - <annotation name="org.gtk.GDBus.DocString" value=" - Not searching for networks. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_REGISTRATION_DENIED" value="31"> - <annotation name="org.gtk.GDBus.DocString" value=" - Network registration was denied. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_REGISTRATION_TIMEOUT" value="32"> - <annotation name="org.gtk.GDBus.DocString" value=" - Network registration timed out. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_REGISTRATION_FAILED" value="33"> - <annotation name="org.gtk.GDBus.DocString" value=" - Failed to register with the requested GSM network. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_PIN_CHECK_FAILED" value="34"> - <annotation name="org.gtk.GDBus.DocString" value=" - PIN check failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="FIRMWARE_MISSING" value="35"> - <annotation name="org.gtk.GDBus.DocString" value=" - Necessary firmware for the device may be missing. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="REMOVED" value="36"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device was removed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SLEEPING" value="37"> - <annotation name="org.gtk.GDBus.DocString" value=" - NetworkManager went to sleep. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECTION_REMOVED" value="38"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device's active connection was removed or disappeared. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="USER_REQUESTED" value="39"> - <annotation name="org.gtk.GDBus.DocString" value=" - A user or client requested the disconnection. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CARRIER" value="40"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device's carrier/link changed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECTION_ASSUMED" value="41"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device's existing connection was assumed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SUPPLICANT_AVAILABLE" value="42"> - <annotation name="org.gtk.GDBus.DocString" value=" - The 802.1x supplicant is now available. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_NOT_FOUND" value="43"> - <annotation name="org.gtk.GDBus.DocString" value=" - The modem could not be found. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="BT_FAILED" value="44"> - <annotation name="org.gtk.GDBus.DocString" value=" - The Bluetooth connection timed out or failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_SIM_NOT_INSERTED" value="45"> - <annotation name="org.gtk.GDBus.DocString" value=" - GSM Modem's SIM Card not inserted. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_SIM_PIN_REQUIRED" value="46"> - <annotation name="org.gtk.GDBus.DocString" value=" - GSM Modem's SIM Pin required. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_SIM_PUK_REQUIRED" value="47"> - <annotation name="org.gtk.GDBus.DocString" value=" - GSM Modem's SIM Puk required. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GSM_SIM_WRONG" value="48"> - <annotation name="org.gtk.GDBus.DocString" value=" - GSM Modem's SIM wrong - " /> - </tp:enumvalue> - <tp:enumvalue suffix="INFINIBAND_MODE" value="49"> - <annotation name="org.gtk.GDBus.DocString" value=" - InfiniBand device does not support connected mode. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DEPENDENCY_FAILED" value="50"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dependency of the connection failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="BR2684_FAILED" value="51"> - <annotation name="org.gtk.GDBus.DocString" value=" - Problem with the RFC 2684 Ethernet over ADSL bridge. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_MANAGER_UNAVAILABLE" value="52"> - <annotation name="org.gtk.GDBus.DocString" value=" - ModemManager was not running or quit unexpectedly. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SSID_NOT_FOUND" value="53"> - <annotation name="org.gtk.GDBus.DocString" value=" - The 802.11 Wi-Fi network could not be found. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SECONDARY_CONNECTION_FAILED" value="54"> - <annotation name="org.gtk.GDBus.DocString" value=" - A secondary connection of the base connection failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DCB_FCOE_FAILED" value="55"> - <annotation name="org.gtk.GDBus.DocString" value=" - DCB or FCoE setup failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="TEAMD_CONTROL_FAILED" value="56"> - <annotation name="org.gtk.GDBus.DocString" value=" - teamd control failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_FAILED" value="57"> - <annotation name="org.gtk.GDBus.DocString" value=" - Modem failed or no longer available. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="MODEM_AVAILABLE" value="58"> - <annotation name="org.gtk.GDBus.DocString" value=" - Modem now ready and available. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SIM_PIN_INCORRECT" value="59"> - <annotation name="org.gtk.GDBus.DocString" value=" - The SIM PIN was incorrect. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NEW_ACTIVATION" value="60"> - <annotation name="org.gtk.GDBus.DocString" value=" - A new connection activation was enqueued. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PARENT_CHANGED" value="61"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device's parent changed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PARENT_MANAGED_CHANGED" value="62"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device parent's management changed. - " /> - </tp:enumvalue> - </tp:enum> - - <tp:enum name="NM_METERED" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device metered status is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="YES" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is metered and the value was statically set. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NO" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is not metered and the value was statically set. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GUESS_YES" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is metered and the value was guessed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="GUESS_NO" value="4"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device is not metered and the value was guessed. - " /> - </tp:enumvalue> - </tp:enum> - - <tp:struct name="NM_DEVICE_STATE_REASON_STRUCT"> - <tp:member type="u" name="state" tp:type="NM_DEVICE_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" - The device state. - " /> - </tp:member> - <tp:member type="u" name="reason" tp:type="NM_DEVICE_STATE_REASON"> - <annotation name="org.gtk.GDBus.DocString" value=" - The reason for originally changing to the device state. - " /> - </tp:member> - </tp:struct> </interface> </node> diff --git a/introspection/nm-dhcp4-config.xml b/introspection/nm-dhcp4-config.xml index bca34fc53f..e9363f9e21 100644 --- a/introspection/nm-dhcp4-config.xml +++ b/introspection/nm-dhcp4-config.xml @@ -1,21 +1,27 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> -<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"/> - <annotation name="org.gtk.GDBus.DocString" value=" - Options and configuration returned by the IPv4 DHCP server. - " /> - <property name="Options" type="a{sv}" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="Configuration options returned by a DHCP server, if any." /> - </property> + <!-- + org.freedesktop.NetworkManager.DHCP4Config: - <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> - </signal> - </interface> + Options and configuration returned by the IPv4 DHCP server. + --> + <interface name="org.freedesktop.NetworkManager.DHCP4Config"> + <annotation name="org.gtk.GDBus.C.Name" value="Dhcp4Config"/> + + <!-- + Options: + + Configuration options returned by a DHCP server, if any. + --> + <property name="Options" type="a{sv}" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> + <signal name="PropertiesChanged"> + <arg name="properties" type="a{sv}"/> + </signal> + </interface> </node> diff --git a/introspection/nm-dhcp6-config.xml b/introspection/nm-dhcp6-config.xml index 84e13b77b1..7ecdf35cab 100644 --- a/introspection/nm-dhcp6-config.xml +++ b/introspection/nm-dhcp6-config.xml @@ -1,21 +1,27 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> -<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"/> - <annotation name="org.gtk.GDBus.DocString" value=" - Options and configuration returned by the IPv6 DHCP server. - " /> - <property name="Options" type="a{sv}" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="Configuration options returned by a DHCP server, if any." /> - </property> + <!-- + org.freedesktop.NetworkManager.DHCP6Config: - <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> - </signal> - </interface> + Options and configuration returned by the IPv6 DHCP server. + --> + <interface name="org.freedesktop.NetworkManager.DHCP6Config"> + <annotation name="org.gtk.GDBus.C.Name" value="Dhcp6Config"/> + + <!-- + Options: + + Configuration options returned by a DHCP server, if any. + --> + <property name="Options" type="a{sv}" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> + <signal name="PropertiesChanged"> + <arg name="properties" type="a{sv}"/> + </signal> + </interface> </node> diff --git a/introspection/nm-ip4-config.xml b/introspection/nm-ip4-config.xml index 111e1acf78..c2a0f06828 100644 --- a/introspection/nm-ip4-config.xml +++ b/introspection/nm-ip4-config.xml @@ -1,72 +1,95 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.IP4Config"> - <property name="Addresses" type="aau" access="read"> - <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 - " /> - </property> - <property name="AddressData" type="aa{sv}" access="read"> - <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 - addresses may include additional attributes. - " /> - </property> - <property name="Gateway" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The gateway in use." /> - </property> - <property name="Routes" type="aau" access="read"> - <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 - unsigned integers. Essentially: [(route, prefix, next-hop, - metric), (route, prefix, next-hop, metric), ...] - - Deprecated: use RouteData - " /> - </property> - <property name="RouteData" type="aa{sv}" access="read"> - <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. - " /> - </property> - <property name="Nameservers" type="au" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The nameservers in use." /> - </property> - <property name="Domains" type="as" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="A list of domains this address belongs to." /> - </property> - <property name="Searches" type="as" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="A list of dns searches." /> - </property> - <property name="DnsOptions" type="as" access="read"> - <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. - " /> - </property> - <property name="WinsServers" type="au" access="read"> - <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> + <!-- + Addresses: + + 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 + --> + <property name="Addresses" type="aau" access="read"/> + + <!-- + AddressData: + + Array of IP address data objects. All addresses will include "address" (an + IP address string), and "prefix" (a uint). Some addresses may include + additional attributes. + --> + <property name="AddressData" type="aa{sv}" access="read"/> + + <!-- + Gateway: + + The gateway in use. + --> + <property name="Gateway" type="s" access="read"/> + + <!-- + Routes: + + 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 unsigned integers. Essentially: + [(route, prefix, next-hop, metric), (route, prefix, next-hop, metric), + ...] Deprecated: use RouteData + --> + <property name="Routes" type="aau" access="read"/> + + <!-- + RouteData: + + 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. + --> + <property name="RouteData" type="aa{sv}" access="read"/> + + <!-- + Nameservers: + + The nameservers in use. + --> + <property name="Nameservers" type="au" access="read"/> + + <!-- + Domains: + + A list of domains this address belongs to. + --> + <property name="Domains" type="as" access="read"/> + + <!-- + Searches: + + A list of dns searches. + --> + <property name="Searches" type="as" access="read"/> + + <!-- + DnsOptions: + + 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. + --> + <property name="DnsOptions" type="as" access="read"/> + + <!-- + WinsServers: + + The Windows Internet Name Service servers associated with the connection. + Each address is in network byte order. + --> + <property name="WinsServers" type="au" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> </interface> </node> - diff --git a/introspection/nm-ip6-config.xml b/introspection/nm-ip6-config.xml index 0cca33c4f9..606761dd2b 100644 --- a/introspection/nm-ip6-config.xml +++ b/introspection/nm-ip6-config.xml @@ -1,67 +1,87 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.IP6Config"> - <property name="Addresses" type="a(ayuay)" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of tuples of IPv6 address/prefix/gateway. - - Deprecated: use AddressData and Gateway. - " /> - </property> - <property name="AddressData" type="aa{sv}" access="read"> - <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 - addresses may include additional attributes. - " /> - </property> - <property name="Gateway" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The gateway in use." /> - </property> - <property name="Routes" type="a(ayuayu)" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Tuples of IPv6 route/prefix/next-hop/metric. - - Deprecated: use RouteData - " /> - </property> - <property name="RouteData" type="aa{sv}" access="read"> - <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. - " /> - </property> + + <!-- + Addresses: + + Array of tuples of IPv6 address/prefix/gateway. Deprecated: use + AddressData and Gateway. + --> + <property name="Addresses" type="a(ayuay)" access="read"/> + + <!-- + AddressData: + + Array of IP address data objects. All addresses will include "address" (an + IP address string), and "prefix" (a uint). Some addresses may include + additional attributes. + --> + <property name="AddressData" type="aa{sv}" access="read"/> + + <!-- + Gateway: + + The gateway in use. + --> + <property name="Gateway" type="s" access="read"/> + + <!-- + Routes: + + Tuples of IPv6 route/prefix/next-hop/metric. Deprecated: use RouteData + --> + <property name="Routes" type="a(ayuayu)" access="read"/> + + <!-- + RouteData: + + 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. + --> + <property name="RouteData" type="aa{sv}" access="read"/> + + <!-- + Nameservers: + + The nameservers in use. + --> <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 **. --> <annotation name="org.gtk.GDBus.C.ForceGVariant" value="1"/> - <annotation name="org.gtk.GDBus.DocString" value="The nameservers in use." /> - </property> - <property name="Domains" type="as" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="A list of domains this address belongs to." /> - </property> - <property name="Searches" type="as" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="A list of dns searches." /> - </property> - <property name="DnsOptions" type="as" access="read"> - <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. - " /> - </property> + </property> + + <!-- + Domains: + + A list of domains this address belongs to. + --> + <property name="Domains" type="as" access="read"/> + <!-- + Searches: + + A list of dns searches. + --> + <property name="Searches" type="as" access="read"/> + + <!-- + DnsOptions: + + 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. + --> + <property name="DnsOptions" type="as" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> </interface> </node> - diff --git a/introspection/nm-manager.xml b/introspection/nm-manager.xml index 8203020b39..e5cb23a563 100644 --- a/introspection/nm-manager.xml +++ b/introspection/nm-manager.xml @@ -1,533 +1,385 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/org/freedesktop/NetworkManager" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/org/freedesktop/NetworkManager"> <interface name="org.freedesktop.NetworkManager"> <annotation name="org.gtk.GDBus.C.Name" value="Manager"/> - <method name="GetDevices"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + GetDevices: + @devices: List of object paths of network devices known to the system. This list does not include device placeholders (see GetAllDevices()). + Get the list of realized network devices. - " /> - <arg name="devices" type="ao" direction="out"> - <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()). - " /> - </arg> + --> + <method name="GetDevices"> + <arg name="devices" type="ao" direction="out"/> </method> - <method name="GetAllDevices"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + GetAllDevices: + @devices: List of object paths of network devices and device placeholders (eg, devices that do not yet exist but which can be automatically created by NetworkManager if one of their AvailableConnections was activated). + Get the list of all network devices. - " /> + --> + <method name="GetAllDevices"> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_manager_get_all_devices"/> - <arg name="devices" type="ao" direction="out"> - <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). - " /> - </arg> + <arg name="devices" type="ao" direction="out"/> </method> - <method name="GetDeviceByIpIface"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + GetDeviceByIpIface: + @iface: Interface name of the device to find. + @device: Object path of the network device. + Return the object path of the network device referenced by its IP - interface name. Note that some devices (usually modems) only have an - IP interface name when they are connected. - " /> - <arg name="iface" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Interface name of the device to find. - " /> - </arg> - <arg name="device" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the network device. - " /> - </arg> + interface name. Note that some devices (usually modems) only have an IP + interface name when they are connected. + --> + <method name="GetDeviceByIpIface"> + <arg name="iface" type="s" direction="in"/> + <arg name="device" type="o" direction="out"/> </method> - <method name="ActivateConnection"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + ActivateConnection: + @connection: The connection to activate. If "/" is given, a valid device path must be given, and NetworkManager picks the best connection to activate for the given device. VPN connections must always pass a valid connection path. + @device: The object path of device to be activated for physical connections. This parameter is ignored for VPN connections, because the specific_object (if provided) specifies the device to use. + @specific_object: The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, or "/" to pick an AP automatically. For VPN connections, pass the object path of an ActiveConnection object that should serve as the "base" connection (to which the VPN connections lifetime will be tied), or pass "/" and NM will automatically use the current default device. + @active_connection: The path of the active connection object representing this active connection. + Activate a connection using the supplied device. - " /> - <arg name="connection" type="o" direction="in"> - <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. - " /> - </arg> - <arg name="device" type="o" direction="in"> - <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. - " /> - </arg> - <arg name="specific_object" type="o" direction="in"> - <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 - connections, pass the object path of a specific AP from the card's scan - list, or "/" to pick an AP automatically. For VPN connections, pass - the object path of an ActiveConnection object that should serve as the - "base" connection (to which the VPN connections lifetime will be tied), - or pass "/" and NM will automatically use the current default device. - " /> - </arg> - <arg name="active_connection" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - The path of the active connection object representing this active connection. - " /> - </arg> + --> + <method name="ActivateConnection"> + <arg name="connection" type="o" direction="in"/> + <arg name="device" type="o" direction="in"/> + <arg name="specific_object" type="o" direction="in"/> + <arg name="active_connection" type="o" direction="out"/> </method> - <method name="AddAndActivateConnection"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + AddAndActivateConnection: + @connection: Connection settings and properties; if incomplete missing settings will be automatically completed using the given device and specific object. + @device: The object path of device to be activated using the given connection. + @specific_object: The path of a connection-type-specific object this activation should use. This parameter is currently ignored for wired and mobile broadband connections, and the value of "/" should be used (ie, no specific object). For WiFi connections, pass the object path of a specific AP from the card's scan list, which will be used to complete the details of the newly added connection. + @path: Object path of the new connection that was just added. + @active_connection: The path of the active connection object representing this active connection. + Adds a new connection using the given details (if any) as a template (automatically filling in missing settings with the capabilities of the given device and specific object), then activate the new connection. Cannot be used for VPN connections at this time. - " /> - <arg name="connection" type="a{sa{sv}}" direction="in"> - <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. - " /> - </arg> - <arg name="device" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of device to be activated using the given connection. - " /> - </arg> - <arg name="specific_object" type="o" direction="in"> - <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 - 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. - " /> - </arg> - <arg name="path" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the new connection that was just added. - " /> - </arg> - <arg name="active_connection" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - The path of the active connection object representing this active connection. - " /> - </arg> + --> + <method name="AddAndActivateConnection"> + <arg name="connection" type="a{sa{sv}}" direction="in"/> + <arg name="device" type="o" direction="in"/> + <arg name="specific_object" type="o" direction="in"/> + <arg name="path" type="o" direction="out"/> + <arg name="active_connection" type="o" direction="out"/> </method> - <method name="DeactivateConnection"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + DeactivateConnection: + @active_connection: The currently active connection to deactivate. + Deactivate an active connection. - " /> - <arg name="active_connection" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The currently active connection to deactivate. - " /> - </arg> + --> + <method name="DeactivateConnection"> + <arg name="active_connection" type="o" direction="in"/> </method> + <!-- + Sleep: + @sleep: Indicates whether the NetworkManager daemon should sleep or wake. + + 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. + --> <method name="Sleep"> - <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. - " /> - <arg name="sleep" type="b" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates whether the NetworkManager daemon should sleep or wake. - " /> - </arg> + <arg name="sleep" type="b" direction="in"/> </method> + <!-- + Enable: + @enable: If FALSE, indicates that all networking should be disabled. If TRUE, indicates that NetworkManager should begin managing network devices. + + 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. + --> <method name="Enable"> - <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. - " /> - <arg name="enable" type="b" direction="in"> - <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. - " /> - </arg> + <arg name="enable" type="b" direction="in"/> </method> - <method name="GetPermissions"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + GetPermissions: + @permissions: Dictionary of available permissions and results. Each permission is represented by a name (ie "org.freedesktop.NetworkManager.Foobar") and each result is one of the following values: "yes" (the permission is available), "auth" (the permission is available after a successful authentication), or "no" (the permission is denied). Clients may use these values in the UI to indicate the ability to perform certain operations. + Returns the permissions a caller has for various authenticated operations that NetworkManager provides, like Enable/Disable networking, changing WiFi, WWAN, and WiMAX state, etc. - " /> - <arg name="permissions" type="a{ss}" direction="out"> - <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 - these values in the UI to indicate the ability to perform certain - operations. - " /> - </arg> + --> + <method name="GetPermissions"> + <arg name="permissions" type="a{ss}" direction="out"/> </method> - <signal name="CheckPermissions"> - <annotation name="org.gtk.GDBus.DocString" value=" - Emitted when system authorization details change, indicating that - clients may wish to recheck permissions with GetPermissions. - " /> - </signal> + <!-- + CheckPermissions: + + Emitted when system authorization details change, indicating that clients + may wish to recheck permissions with GetPermissions. + --> + <signal name="CheckPermissions"/> + + <!-- + SetLogging: + @level: One of [ERR, WARN, INFO, DEBUG, TRACE, OFF, KEEP]. This level is applied to the domains as specified in the domains argument. Except for the special level "KEEP", all unmentioned domains are disabled entirely. "KEEP" is special and allows not to change the current setting except for the specified domains. E.g. level=KEEP and domains=PLATFORM:DEBUG will only touch the platform domain. + @domains: A combination of logging domains separated by commas (','), or "NONE" to disable logging. Each domain enables logging for operations related to that domain. Available domains are: [PLATFORM, RFKILL, ETHER, WIFI, BT, MB, DHCP4, DHCP6, PPP, WIFI_SCAN, IP4, IP6, AUTOIP4, DNS, VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. In addition to these domains, the following special domains can be used: [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains should log at a different level from the default by appending a colon (':') and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the log level is changed but the current set of log domains remains unchanged. - <method name="SetLogging"> - <annotation name="org.gtk.GDBus.DocString" value=" Set logging verbosity and which operations are logged. - " /> - <arg name="level" type="s" direction="in"> - <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 - 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. - " /> - </arg> - <arg name="domains" type="s" direction="in"> - <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, - VPN, SHARING, SUPPLICANT, AGENTS, SETTINGS, SUSPEND, CORE, DEVICE, - OLPC, WIMAX, INFINIBAND, FIREWALL, ADSL, BOND, VLAN, BRIDGE, DBUS_PROPS, - TEAM, CONCHECK, DCB, DISPATCH, AUDIT]. - In addition to these domains, the following special domains can be used: - [NONE, ALL, DEFAULT, DHCP, IP]. You can also specify that some domains - should log at a different level from the default by appending a colon (':') - and a log level (eg, 'WIFI:DEBUG'). If an empty string is given, the - log level is changed but the current set of log domains remains - unchanged. - " /> - </arg> + --> + <method name="SetLogging"> + <arg name="level" type="s" direction="in"/> + <arg name="domains" type="s" direction="in"/> </method> - <method name="GetLogging"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + GetLogging: + @level: One of [ERR, WARN, INFO, DEBUG, TRACE]. + @domains: For available domains see SetLogging() call. + Get current logging verbosity level and operations domains. - " /> - <arg name="level" type="s" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - One of [ERR, WARN, INFO, DEBUG, TRACE]. - " /> - </arg> - <arg name="domains" type="s" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - For available domains see SetLogging() call. - " /> - </arg> + --> + <method name="GetLogging"> + <arg name="level" type="s" direction="out"/> + <arg name="domains" type="s" direction="out"/> </method> + <!-- + CheckConnectivity: + @connectivity: (<link linkend="NMConnectivityState">NMConnectivityState</link>) The current connectivity state. + + Re-check the network connectivity state. + --> <method name="CheckConnectivity"> - <annotation name="org.gtk.GDBus.DocString" value=" - Re-check the network connectivity state. - " /> - <arg name="connectivity" type="u" tp:type="NM_CONNECTIVITY" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - The current connectivity state. - " /> - </arg> + <arg name="connectivity" type="u" direction="out"/> </method> - <method name="state"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + state: + @state: <link linkend="NMState">NMState</link> + The overall networking state as determined by the NetworkManager daemon, based on the state of network devices under it's management. - " /> - <arg name="state" type="u" direction="out" tp:type="NM_STATE"/> + --> + <method name="state"> + <arg name="state" type="u" direction="out"/> </method> - <property name="Devices" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Devices: + 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). - " /> - </property> + --> + <property name="Devices" type="ao" access="read"/> + + <!-- + AllDevices: - <property name="AllDevices" type="ao" access="read"> - <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. - " /> - </property> - - <property name="NetworkingEnabled" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates if overall networking is currently enabled or not. See the + devices are software devices which do not yet have backing resources, but + for which backing resources can be created if the device is activated. + --> + <property name="AllDevices" type="ao" access="read"/> + + <!-- + NetworkingEnabled: + + Indicates if overall networking is currently enabled or not. See the Enable() method. - " /> - </property> + --> + <property name="NetworkingEnabled" type="b" access="read"/> + + <!-- + WirelessEnabled: - <property name="WirelessEnabled" type="b" access="readwrite"> - <annotation name="org.gtk.GDBus.DocString" value=" Indicates if wireless is currently enabled or not. - " /> - </property> + --> + <property name="WirelessEnabled" type="b" access="readwrite"/> + + <!-- + WirelessHardwareEnabled: + + Indicates if the wireless hardware is currently enabled, i.e. the state of + the RF kill switch. + --> + <property name="WirelessHardwareEnabled" type="b" access="read"/> - <property name="WirelessHardwareEnabled" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates if the wireless hardware is currently enabled, i.e. the state of the RF kill switch. - " /> - </property> + <!-- + WwanEnabled: - <property name="WwanEnabled" type="b" access="readwrite"> - <annotation name="org.gtk.GDBus.DocString" value=" Indicates if mobile broadband devices are currently enabled or not. - " /> - </property> + --> + <property name="WwanEnabled" type="b" access="readwrite"/> + + <!-- + WwanHardwareEnabled: + + Indicates if the mobile broadband hardware is currently enabled, i.e. the + state of the RF kill switch. + --> + <property name="WwanHardwareEnabled" type="b" access="read"/> - <property name="WwanHardwareEnabled" type="b" access="read"> - <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. - " /> - </property> + <!-- + WimaxEnabled: - <property name="WimaxEnabled" type="b" access="readwrite"> - <annotation name="org.gtk.GDBus.DocString" value=" Indicates if WiMAX devices are currently enabled or not. - " /> - </property> + --> + <property name="WimaxEnabled" type="b" access="readwrite"/> - <property name="WimaxHardwareEnabled" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" - Indicates if the WiMAX hardware is currently enabled, i.e. the state of the RF kill switch. - " /> - </property> + <!-- + WimaxHardwareEnabled: + + Indicates if the WiMAX hardware is currently enabled, i.e. the state of + the RF kill switch. + --> + <property name="WimaxHardwareEnabled" type="b" access="read"/> + + <!-- + ActiveConnections: - <property name="ActiveConnections" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" List of active connection object paths. - " /> - </property> - - <property name="PrimaryConnection" type="o" access="read"> - <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. - " /> - </property> - - <property name="PrimaryConnectionType" type="s" access="read"> - <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. - " /> - </property> - - <property name="Metered" type="u" access="read" tp:type="NM_METERED"> - <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. - " /> - </property> - - <property name="ActivatingConnection" type="o" access="read"> - <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. - " /> - </property> - - <property name="Startup" type="b" access="read"> - <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. - " /> - </property> - - <property name="Version" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + --> + <property name="ActiveConnections" type="ao" access="read"/> + + <!-- + PrimaryConnection: + + 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. + --> + <property name="PrimaryConnection" type="o" access="read"/> + + <!-- + PrimaryConnectionType: + + 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. + --> + <property name="PrimaryConnectionType" type="s" access="read"/> + + <!-- + Metered: + + Indicates whether the connectivity is metered. This is equivalent to the + metered property of the device associated with the primary connection. + + Returns: <link linkend="NMMetered">NMMetered</link> + --> + <property name="Metered" type="u" access="read"/> + + <!-- + ActivatingConnection: + + 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. + --> + <property name="ActivatingConnection" type="o" access="read"/> + + <!-- + Startup: + + Indicates whether NM is still starting up; this becomes FALSE when NM has + finished attempting to activate every connection that it might be able to + activate at startup. + --> + <property name="Startup" type="b" access="read"/> + + <!-- + Version: + NetworkManager version. - " /> - </property> + --> + <property name="Version" type="s" access="read"/> + + <!-- + State: - <property name="State" type="u" access="read" tp:type="NM_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" The overall state of the NetworkManager daemon. - " /> - </property> - <signal name="StateChanged"> - <annotation name="org.gtk.GDBus.DocString" value=" + Returns: <link linkend="NMState">NMState</link> + --> + <property name="State" type="u" access="read"/> + + <!-- + StateChanged: + @state: (<link linkend="NMState">NMState</link>) The new state of NetworkManager. + NetworkManager's state changed. - " /> - <arg name="state" type="u" tp:type="NM_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" - The new state of NetworkManager. - " /> - </arg> + --> + <signal name="StateChanged"> + <arg name="state" type="u"/> </signal> - <property name="Connectivity" type="u" access="read" tp:type="NM_CONNECTIVITY"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Connectivity: + The network connectivity state. - " /> - </property> - - <property name="GlobalDnsConfiguration" type="a{sv}" access="readwrite"> - <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 - list of search domains and resolver options, respectively. - The value of the "domains" key is a second-level dictionary, - where each key is a domain name, and each key's value is a - third-level dictionary with the keys "servers" and - "options". "servers" is a string array of DNS servers, - "options" is a string array of domain-specific options. - " /> - </property> - <signal name="PropertiesChanged"> - <annotation name="org.gtk.GDBus.DocString" value=" + Returns: <link linkend="NMConnectivityState">NMConnectivityState</link> + --> + <property name="Connectivity" type="u" access="read"/> + + <!-- + GlobalDnsConfiguration: + + Dictionary of global DNS settings where the key is one of "searches", + "options" and "domains". The values for the "searches" and "options" keys + are string arrays describing the list of search domains and resolver + options, respectively. The value of the "domains" key is a second-level + dictionary, where each key is a domain name, and each key's value is a + third-level dictionary with the keys "servers" and "options". "servers" is + a string array of DNS servers, "options" is a string array of + domain-specific options. + --> + <property name="GlobalDnsConfiguration" type="a{sv}" access="readwrite"/> + + <!-- + PropertiesChanged: + @properties: The changed properties. + NetworkManager's properties changed. - " /> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - The changed properties. - " /> - </arg> + --> + <signal name="PropertiesChanged"> + <arg name="properties" type="a{sv}"/> </signal> - <signal name="DeviceAdded"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + DeviceAdded: + @device_path: The object path of the newly added device. + A device was added to the system - " /> - <arg name="device_path" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the newly added device. - " /> - </arg> + --> + <signal name="DeviceAdded"> + <arg name="device_path" type="o"/> </signal> - <signal name="DeviceRemoved"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + DeviceRemoved: + @device_path: The object path of the device that was just removed. + A device was removed from the system, and is no longer available. - " /> - <arg name="device_path" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the device that was just removed. - " /> - </arg> + --> + <signal name="DeviceRemoved"> + <arg name="device_path" type="o"/> </signal> - - <tp:enum name="NM_STATE" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Describes the overall state of the daemon. - " /> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - Networking state is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="ASLEEP" value="10"> - <annotation name="org.gtk.GDBus.DocString" value=" - Networking is inactive and all devices are disabled. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DISCONNECTED" value="20"> - <annotation name="org.gtk.GDBus.DocString" value=" - There is no active network connection. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DISCONNECTING" value="30"> - <annotation name="org.gtk.GDBus.DocString" value=" - Network connections are being cleaned up. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECTING" value="40"> - <annotation name="org.gtk.GDBus.DocString" value=" - A network device is connecting to a network and there is no other - available network connection. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECTED_LOCAL" value="50"> - <annotation name="org.gtk.GDBus.DocString" value=" - A network device is connected, but there is only link-local connectivity. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECTED_SITE" value="60"> - <annotation name="org.gtk.GDBus.DocString" value=" - A network device is connected, but there is only site-local connectivity. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECTED_GLOBAL" value="70"> - <annotation name="org.gtk.GDBus.DocString" value=" - A network device is connected, with global network connectivity. - " /> - </tp:enumvalue> - </tp:enum> - - <tp:enum name="NM_CONNECTIVITY" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Describes the network-connectivity state. - " /> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - Network connectivity is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NONE" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The host is not connected to any network. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PORTAL" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The host is behind a captive portal and cannot reach the - full Internet. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="LIMITED" value="3"> - <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:enumvalue> - <tp:enumvalue suffix="FULL" value="4"> - <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:enumvalue> - </tp:enum> - </interface> </node> diff --git a/introspection/nm-secret-agent.xml b/introspection/nm-secret-agent.xml index ec7ede0912..33296fb06f 100644 --- a/introspection/nm-secret-agent.xml +++ b/introspection/nm-secret-agent.xml @@ -1,243 +1,92 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> + <!-- + org.freedesktop.NetworkManager.SecretAgent: - <interface name="org.freedesktop.NetworkManager.SecretAgent"> - <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 - 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. - " /> + 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 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. + --> + <interface name="org.freedesktop.NetworkManager.SecretAgent"> - <method name="GetSecrets"> - <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 - the new secrets to persistent storage (if the secret's flags - include AGENT_OWNED) as NetworkManager will not send these - 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). - " /> - <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"> - <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. - " /> - </arg> - <arg name="connection_path" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the connection for which secrets are being - requested. - " /> - </arg> - <arg name="setting_name" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Setting name for which secrets are being requested. - " /> - </arg> - <arg name="hints" type="as" direction="in"> - <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 - to the client in processing the secrets request. Note that - it's not always possible to determine which secret is - required, so in some cases no hints may be given. The Agent - should return any secrets it has, or that it thinks are - required, regardless of what hints NetworkManager sends - 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:". - " /> - </arg> - <arg name="flags" type="u" direction="in" tp:type="NM_SECRET_AGENT_GET_SECRETS_FLAGS"> - <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. - " /> - </arg> + <!-- + GetSecrets: + @connection: 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. + @connection_path: Object path of the connection for which secrets are being requested. + @setting_name: Setting name for which secrets are being requested. + @hints: 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 to the client in processing the secrets request. Note that it's not always possible to determine which secret is required, so in some cases no hints may be given. The Agent should return any secrets it has, or that it thinks are required, regardless of what hints NetworkManager sends 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:". + @flags: (<link linkend="NMSecretAgentGetSecretsFlags">NMSecretAgentGetSecretsFlags</link>) 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. + @secrets: 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. - <arg name="secrets" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map"> - <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. - " /> - </arg> + 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 the new secrets to persistent + storage (if the secret's flags include AGENT_OWNED) as NetworkManager will + not send these 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). + --> + <method name="GetSecrets"> + <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"/> + <arg name="connection_path" type="o" direction="in"/> + <arg name="setting_name" type="s" direction="in"/> + <arg name="hints" type="as" direction="in"/> + <arg name="flags" type="u" direction="in"/> - <tp:possible-errors> - <tp:error name="org.freedesktop.NetworkManager.SecretAgent.NotAuthorized"> - <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:error> - <tp:error name="org.freedesktop.NetworkManager.SecretAgent.InvalidConnection"> - <annotation name="org.gtk.GDBus.DocString" value=" - Should be returned if the 'connection' argument is invalid. - " /> - </tp:error> - <tp:error name="org.freedesktop.NetworkManager.SecretAgent.UserCanceled"> - <annotation name="org.gtk.GDBus.DocString" value=" - Should be returned when the user has canceled the request. - " /> - </tp:error> - <tp:error name="org.freedesktop.NetworkManager.SecretAgent.AgentCanceled"> - <annotation name="org.gtk.GDBus.DocString" value=" - Should be returned when NetworkManager has requested that - the agent cancel the request. - " /> - </tp:error> - <tp:error name="org.freedesktop.NetworkManager.SecretAgent.InternalError"> - <annotation name="org.gtk.GDBus.DocString" value=" - Should be returned if the agent has encountered some internal - error processing the request. - " /> - </tp:error> - <tp:error name="org.freedesktop.NetworkManager.SecretAgent.NoSecrets"> - <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:error> - </tp:possible-errors> - </method> + <arg name="secrets" type="a{sa{sv}}" direction="out"/> + </method> - <tp:flags name="NM_SECRET_AGENT_GET_SECRETS_FLAGS" value-prefix="NM_SECRET_AGENT_GET_SECRETS_FLAG" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Flags modifying the behavior of GetSecrets request. - " /> - <tp:flag suffix="NONE" value="0x0"> - <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:flag> - <tp:flag suffix="ALLOW_INTERACTION" value="0x1"> - <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:flag> - <tp:flag suffix="REQUEST_NEW" value="0x2"> - <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:flag> - <tp:flag suffix="USER_REQUESTED" value="0x4"> - <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:flag> - </tp:flags> + <!-- + CancelGetSecrets: + @connection_path: Object path of the connection for which, if secrets for the given 'setting_name' are being requested, the request should be canceled. + @setting_name: Setting name for which secrets for this connection were originally being requested. - <method name="CancelGetSecrets"> - <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. - " /> - <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"> - <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. - " /> - </arg> - <arg name="setting_name" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Setting name for which secrets for this connection were - originally being requested. - " /> - </arg> - </method> + 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. + --> + <method name="CancelGetSecrets"> + <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"/> + <arg name="setting_name" type="s" direction="in"/> + </method> - <method name="SaveSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" - Save given secrets to backing storage. - " /> - <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"> - <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. - " /> - </arg> - <arg name="connection_path" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the connection for which the agent should - save secrets to backing storage. - " /> - </arg> - </method> + <!-- + SaveSecrets: + @connection: 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. + @connection_path: Object path of the connection for which the agent should save secrets to backing storage. - <method name="DeleteSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" - Delete secrets from backing storage. - " /> - <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"> - <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. - " /> - </arg> - <arg name="connection_path" type="o" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the connection for which the agent should - delete secrets from backing storage. - " /> - </arg> - </method> + Save given secrets to backing storage. + --> + <method name="SaveSecrets"> + <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"/> + <arg name="connection_path" type="o" direction="in"/> + </method> - <tp:flags name="NM_SECRET_AGENT_CAPABILITIES" value-prefix="NM_SECRET_AGENT_CAPABILITY" type="u"> - <tp:flag suffix="NONE" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="No special capabilities." /> - </tp:flag> - <tp:flag suffix="VPN_HINTS" value="0x1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The agent supports passing hints to VPN plugin authentication - dialogs. - " /> - </tp:flag> - </tp:flags> - - </interface> + <!-- + DeleteSecrets: + @connection: Nested settings maps containing the connection properties (sans secrets), for which the agent should delete the secrets from backing storage. + @connection_path: Object path of the connection for which the agent should delete secrets from backing storage. + Delete secrets from backing storage. + --> + <method name="DeleteSecrets"> + <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"/> + <arg name="connection_path" type="o" direction="in"/> + </method> + </interface> </node> diff --git a/introspection/nm-settings-connection.xml b/introspection/nm-settings-connection.xml index fc62046c80..15b380348c 100644 --- a/introspection/nm-settings-connection.xml +++ b/introspection/nm-settings-connection.xml @@ -1,138 +1,131 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> - - <interface name="org.freedesktop.NetworkManager.Settings.Connection"> - <annotation name="org.gtk.GDBus.DocString" value=" - Represents a single network connection configuration. - " /> - - <method name="Update"> - <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. - " /> - <arg name="properties" type="a{sa{sv}}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - New connection settings, properties, and (optionally) secrets. - " /> - </arg> - </method> - - <method name="UpdateUnsaved"> - <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 - and may sent to a Secret Agent for storage, depending on the - flags associated with each secret. - - Use the 'Save' method to save these changes 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). - " /> - <arg name="properties" type="a{sa{sv}}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - New connection settings, properties, and (optionally) secrets. - " /> - </arg> - </method> - - <method name="Delete"> - <annotation name="org.gtk.GDBus.DocString" value=" - Delete the connection. - " /> - </method> - - <method name="GetSettings"> - <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. - " /> - <arg name="settings" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - The nested settings maps describing this object. - " /> - </arg> - </method> - - <method name="GetSecrets"> - <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. - " /> - <arg name="setting_name" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Name of the setting to return secrets for. If empty, all - all secrets will be returned. - " /> - </arg> - - <arg name="secrets" type="a{sa{sv}}" direction="out" tp:type="String_String_Variant_Map_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Nested settings maps containing secrets. - " /> - </arg> - </method> - - <method name="ClearSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" - Clear the secrets belonging to this network connection profile. - " /> - </method> - - <method name="Save"> - <annotation name="org.gtk.GDBus.DocString" value=" - Saves a "dirty" connection (that had previously been - updated with UpdateUnsaved) to persistent storage. - " /> - </method> - - <signal name="Updated"> - <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. - " /> - </signal> - - <signal name="Removed"> - <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. - " /> - </signal> - - <property name="Unsaved" type="b" access="read"> - <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. - " /> - </property> - - <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values. - " /> - </arg> - </signal> - - </interface> - +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> + + <!-- + org.freedesktop.NetworkManager.Settings.Connection: + + Represents a single network connection configuration. + --> + <interface name="org.freedesktop.NetworkManager.Settings.Connection"> + + <!-- + Update: + @properties: New connection settings, properties, and (optionally) secrets. + + 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. + --> + <method name="Update"> + <arg name="properties" type="a{sa{sv}}" direction="in"/> + </method> + + <!-- + UpdateUnsaved: + @properties: New connection settings, properties, and (optionally) secrets. + + 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 and may sent + to a Secret Agent for storage, depending on the flags associated with each + secret. Use the 'Save' method to save these changes 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). + --> + <method name="UpdateUnsaved"> + <arg name="properties" type="a{sa{sv}}" direction="in"/> + </method> + + <!-- + Delete: + + Delete the connection. + --> + <method name="Delete"/> + + <!-- + GetSettings: + @settings: The nested settings maps describing this object. + + 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. + --> + <method name="GetSettings"> + <arg name="settings" type="a{sa{sv}}" direction="out"/> + </method> + + <!-- + GetSecrets: + @setting_name: Name of the setting to return secrets for. If empty, all all secrets will be returned. + @secrets: Nested settings maps containing secrets. + + 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. + --> + <method name="GetSecrets"> + <arg name="setting_name" type="s" direction="in"/> + + <arg name="secrets" type="a{sa{sv}}" direction="out"/> + </method> + + <!-- + ClearSecrets: + + Clear the secrets belonging to this network connection profile. + --> + <method name="ClearSecrets"/> + + <!-- + Save: + + Saves a "dirty" connection (that had previously been updated with + UpdateUnsaved) to persistent storage. + --> + <method name="Save"/> + + <!-- + Updated: + + 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. + --> + <signal name="Updated"/> + + <!-- + Removed: + + 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. + --> + <signal name="Removed"/> + + <!-- + Unsaved: + + 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. + --> + <property name="Unsaved" type="b" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values. + --> + <signal name="PropertiesChanged"> + <arg name="properties" type="a{sv}"/> + </signal> + </interface> </node> diff --git a/introspection/nm-settings.xml b/introspection/nm-settings.xml index 6289202511..7f5b546c58 100644 --- a/introspection/nm-settings.xml +++ b/introspection/nm-settings.xml @@ -1,198 +1,170 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/org/freedesktop/NetworkManager/Settings"> -<node name="/org/freedesktop/NetworkManager/Settings" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> + <!-- + org.freedesktop.NetworkManager.Settings: + + The Settings interface allows clients to view and administrate the + connections stored and used by NetworkManager. + --> <interface name="org.freedesktop.NetworkManager.Settings"> - <annotation name="org.gtk.GDBus.DocString" value=" - The Settings interface allows clients to view and administrate the connections stored and used by NetworkManager. - " /> - <method name="ListConnections"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + ListConnections: + @connections: List of connections. + List the saved network connections known to NetworkManager. - " /> - <arg name="connections" type="ao" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - List of connections. - " /> - </arg> + --> + <method name="ListConnections"> + <arg name="connections" type="ao" direction="out"/> </method> - <method name="GetConnectionByUuid"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + GetConnectionByUuid: + @uuid: The UUID to find the connection object path for. + @connection: The connection's object path. + Retrieve the object path of a connection, given that connection's UUID. - " /> - <arg name="uuid" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The UUID to find the connection object path for. - " /> - </arg> - <arg name="connection" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection's object path. - " /> - </arg> + --> + <method name="GetConnectionByUuid"> + <arg name="uuid" type="s" direction="in"/> + <arg name="connection" type="o" direction="out"/> </method> + <!-- + AddConnection: + @connection: Connection settings and properties. + @path: Object path of the new connection that was just added. + + 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. + --> <method name="AddConnection"> - <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. - " /> - <arg name="connection" type="a{sa{sv}}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Connection settings and properties. - " /> - </arg> - <arg name="path" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the new connection that was just added. - " /> - </arg> + <arg name="connection" type="a{sa{sv}}" direction="in"/> + <arg name="path" type="o" direction="out"/> </method> + <!-- + AddConnectionUnsaved: + @connection: Connection settings and properties. + @path: Object path of the new connection that was just added. + + 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, and (2) the + connection is allowed to be started automatically. Use the 'Save' method + on the connection to save these changes 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). + --> <method name="AddConnectionUnsaved"> - <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, - and (2) the connection is allowed to be started automatically. - - Use the 'Save' method on the connection to save these changes - 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). - " /> - <arg name="connection" type="a{sa{sv}}" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Connection settings and properties. - " /> - </arg> - <arg name="path" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the new connection that was just added. - " /> - </arg> + <arg name="connection" type="a{sa{sv}}" direction="in"/> + <arg name="path" type="o" direction="out"/> </method> + <!-- + LoadConnections: + @filenames: Array of paths to on-disk connection profiles in directories monitored by NetworkManager. + @status: 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). + @failures: Paths of connection files that could not be loaded. + + 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 + harmless.) As with AddConnection(), this operation does not necessarily + start the network connection. + --> <method name="LoadConnections"> - <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 - harmless.) As with AddConnection(), this operation does not - necessarily start the network connection. - " /> - <arg name="filenames" type="as" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - Array of paths to on-disk connection profiles in directories - monitored by NetworkManager. - " /> - </arg> - <arg name="status" type="b" direction="out"> - <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). - " /> - </arg> - <arg name="failures" type="as" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Paths of connection files that could not be loaded. - " /> - </arg> + <arg name="filenames" type="as" direction="in"/> + <arg name="status" type="b" direction="out"/> + <arg name="failures" type="as" direction="out"/> </method> + <!-- + ReloadConnections: + @status: Success or failure. + + 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. + --> <method name="ReloadConnections"> - <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. - " /> - <arg name="status" type="b" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - Success or failure. - " /> - </arg> + <arg name="status" type="b" direction="out"/> </method> - <method name="SaveHostname"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + SaveHostname: + @hostname: The hostname to save to persistent configuration. If blank, the persistent hostname is cleared. + Save the hostname to persistent configuration. - " /> - <arg name="hostname" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The hostname to save to persistent configuration. If blank, the persistent hostname is cleared. - " /> - </arg> + --> + <method name="SaveHostname"> + <arg name="hostname" type="s" direction="in"/> </method> - <property name="Connections" type="ao" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Connections: + List of object paths of available network connection profiles. - " /> - </property> + --> + <property name="Connections" type="ao" access="read"/> + + <!-- + Hostname: - <property name="Hostname" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" The machine hostname stored in persistent configuration. - " /> - </property> + --> + <property name="Hostname" type="s" access="read"/> + + <!-- + CanModify: - <property name="CanModify" type="b" access="read"> - <annotation name="org.gtk.GDBus.DocString" value=" If true, adding and modifying connections is supported. - " /> - </property> + --> + <property name="CanModify" type="b" access="read"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - <signal name="NewConnection"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + NewConnection: + @connection: Object path of the new connection. + Emitted when a new connection has been added after NetworkManager has - started up and initialized. This signal is not emitted for connections + started up and initialized. This signal is not emitted for connections read while starting up, because NetworkManager's D-Bus service is only available after all connections have been read, and to prevent spamming - listeners with too many signals at one time. To retrieve the initial + listeners with too many signals at one time. To retrieve the initial connection list, call the ListConnections() method once, and then listen for individual Settings.NewConnection and Settings.Connection.Deleted signals for further updates. - " /> - <arg name="connection" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the new connection. - " /> - </arg> + --> + <signal name="NewConnection"> + <arg name="connection" type="o"/> </signal> + <!-- + ConnectionRemoved: + @connection: Object path of the removed connection. + + 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. + --> <signal name="ConnectionRemoved"> - <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. - " /> - <arg name="connection" type="o"> - <annotation name="org.gtk.GDBus.DocString" value=" - Object path of the removed connection. - " /> - </arg> + <arg name="connection" type="o"/> </signal> - </interface> </node> - diff --git a/introspection/nm-vpn-connection.xml b/introspection/nm-vpn-connection.xml index 6a4fb37db4..430998f3d1 100644 --- a/introspection/nm-vpn-connection.xml +++ b/introspection/nm-vpn-connection.xml @@ -1,148 +1,48 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> - <interface name="org.freedesktop.NetworkManager.VPN.Connection"> - <annotation name="org.gtk.GDBus.C.Name" value="VpnConnection"/> + <!-- + org.freedesktop.NetworkManager.VPN.Connection: - <annotation name="org.gtk.GDBus.DocString" value=" Represents an active connection to a Virtual Private Network. - " /> + --> + <interface name="org.freedesktop.NetworkManager.VPN.Connection"> + <annotation name="org.gtk.GDBus.C.Name" value="VpnConnection"/> + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values + --> <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values - " /> - </arg> + <arg name="properties" type="a{sv}"/> </signal> - <property name="VpnState" type="u" access="read" tp:type="NM_VPN_CONNECTION_STATE"> - <annotation name="org.gtk.GDBus.DocString" value="The VPN-specific state of the connection." /> - </property> - <property name="Banner" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The banner string of the VPN connection." /> - </property> + <!-- + VpnState: + + The VPN-specific state of the connection. + + Returns: <link linkend="NMVpnConnectionState">NMVpnConnectionState</link> + --> + <property name="VpnState" type="u" access="read"/> + + <!-- + Banner: + + The banner string of the VPN connection. + --> + <property name="Banner" type="s" access="read"/> + + <!-- + VpnStateChanged: + @state: (<link linkend="NMVpnConnectionState">NMVpnConnectionState</link>) The new state of the VPN connection. + @reason: (<link linkend="NMVpnConnectionStateReason">NMVpnConnectionStateReason</link>) Reason code describing the change to the new state. - <signal name="VpnStateChanged"> - <annotation name="org.gtk.GDBus.DocString" value=" Emitted when the state of the VPN connection has changed. - " /> - <arg name="state" type="u" tp:type="NM_VPN_CONNECTION_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" - The new state of the VPN connection. - " /> - </arg> - <arg name="reason" type="u" tp:type="NM_VPN_CONNECTION_STATE_REASON"> - <annotation name="org.gtk.GDBus.DocString" value=" - Reason code describing the change to the new state. - " /> - </arg> + --> + <signal name="VpnStateChanged"> + <arg name="state" type="u"/> + <arg name="reason" type="u"/> </signal> - - <tp:enum name="NM_VPN_CONNECTION_STATE" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The state of the VPN connection is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="PREPARE" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection is preparing to connect. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NEED_AUTH" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection needs authorization credentials. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECT" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection is being established. FIXME: Should be CONNECTING or CONNECTED. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="IP_CONFIG_GET" value="4"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection is getting an IP address. FIXME: Should be an -ING - " /> - </tp:enumvalue> - <tp:enumvalue suffix="ACTIVATED" value="5"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection is active. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="FAILED" value="6"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DISCONNECTED" value="7"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection is disconnected. - " /> - </tp:enumvalue> - </tp:enum> - <tp:enum name="NM_VPN_CONNECTION_STATE_REASON" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The reason for the VPN connection state change is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NONE" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - No reason was given for the VPN connection state change. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="USER_DISCONNECTED" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection changed state because the user disconnected it. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="DEVICE_DISCONNECTED" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN connection changed state because the device it was using was disconnected. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SERVICE_STOPPED" value="4"> - <annotation name="org.gtk.GDBus.DocString" value=" - The service providing the VPN connection was stopped. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="IP_CONFIG_INVALID" value="5"> - <annotation name="org.gtk.GDBus.DocString" value=" - The IP config of the VPN connection was invalid. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECT_TIMEOUT" value="6"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection attempt to the VPN service timed out. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SERVICE_START_TIMEOUT" value="7"> - <annotation name="org.gtk.GDBus.DocString" value=" - A timeout occurred while starting the service providing the VPN connection. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SERVICE_START_FAILED" value="8"> - <annotation name="org.gtk.GDBus.DocString" value=" - Starting the service starting the service providing the VPN connection failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="NO_SECRETS" value="9"> - <annotation name="org.gtk.GDBus.DocString" value=" - Necessary secrets for the VPN connection were not provided. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="LOGIN_FAILED" value="10"> - <annotation name="org.gtk.GDBus.DocString" value=" - Authentication to the VPN server failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECTION_REMOVED" value="11"> - <annotation name="org.gtk.GDBus.DocString" value=" - The connection was deleted from settings. - " /> - </tp:enumvalue> - </tp:enum> </interface> </node> - diff --git a/introspection/nm-vpn-plugin.xml b/introspection/nm-vpn-plugin.xml index ee8c69f8bf..7eed97210f 100644 --- a/introspection/nm-vpn-plugin.xml +++ b/introspection/nm-vpn-plugin.xml @@ -1,313 +1,202 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> + <!-- + org.freedesktop.NetworkManager.VPN.Plugin: + + This interface is provided by plugins providing VPN services to the + NetworkManager daemon. + --> <interface name="org.freedesktop.NetworkManager.VPN.Plugin"> <annotation name="org.gtk.GDBus.C.Name" value="VpnPlugin"/> - <annotation name="org.gtk.GDBus.DocString" value=" - This interface is provided by plugins providing VPN services to the NetworkManager daemon. - " /> + <!-- + Connect: + @connection: Describes the connection to be established. - <method name="Connect"> - <annotation name="org.gtk.GDBus.DocString" value=" - Tells the plugin to connect. Interactive secrets requests (eg, emitting + Tells the plugin to connect. Interactive secrets requests (eg, emitting the SecretsRequired signal) are not allowed. - " /> + --> + <method name="Connect"> <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"> - <annotation name="org.gtk.GDBus.DocString" value=" - Describes the connection to be established. - " /> - </arg> - <tp:possible-errors> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.BadArguments"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.WrongState"/> - </tp:possible-errors> + <arg name="connection" type="a{sa{sv}}" direction="in"/> </method> + <!-- + ConnectInteractive: + @connection: Describes the connection to be established. + @details: Additional details about the Connect process. + + 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). + --> <method name="ConnectInteractive"> - <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). - " /> <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"> - <annotation name="org.gtk.GDBus.DocString" value=" - Describes the connection to be established. - " /> - </arg> - <arg name="details" type="a{sv}" direction="in" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - Additional details about the Connect process. - " /> - </arg> - <tp:possible-errors> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.StartingInProgress"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStarted"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.BadArguments"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.WrongState"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported"/> - </tp:possible-errors> + <arg name="connection" type="a{sa{sv}}" direction="in"/> + <arg name="details" type="a{sv}" direction="in"/> </method> + <!-- + NeedSecrets: + @settings: Describes the connection that may need secrets. + @setting_name: The setting name within the provided connection that requires secrets, if any. + + Asks the plugin whether the provided connection will require secrets to + connect successfully. + --> <method name="NeedSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" - Asks the plugin whether the provided connection will require secrets to connect successfully. - " /> <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"> - <annotation name="org.gtk.GDBus.DocString" value=" - Describes the connection that may need secrets. - " /> - </arg> - <arg name="setting_name" type="s" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - The setting name within the provided connection that requires secrets, if any. - " /> - </arg> - <tp:possible-errors> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.ConnectionInvalid"/> - </tp:possible-errors> + <arg name="settings" type="a{sa{sv}}" direction="in"/> + <arg name="setting_name" type="s" direction="out"/> </method> - <method name="Disconnect"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Disconnect: + Disconnect the plugin. - " /> + --> + <method name="Disconnect"> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_disconnect"/> - <tp:possible-errors> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.StoppingInProgress"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.AlreadyStopped"/> - </tp:possible-errors> </method> - <method name="SetConfig"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + SetConfig: + @config: Generic configuration details for the connection. + Set generic connection details on the connection. - " /> + --> + <method name="SetConfig"> <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"> - <annotation name="org.gtk.GDBus.DocString" value=" - Generic configuration details for the connection. - " /> - </arg> + <arg name="config" type="a{sv}" direction="in"/> </method> - <method name="SetIp4Config"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + SetIp4Config: + @config: Ip4Config details for the connection. You must call SetConfig() before calling this. + Set IPv4 details on the connection. - " /> + --> + <method name="SetIp4Config"> <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"> - <annotation name="org.gtk.GDBus.DocString" value=" - Ip4Config details for the connection. You must call - SetConfig() before calling this. - " /> - </arg> + <arg name="config" type="a{sv}" direction="in"/> </method> - <method name="SetIp6Config"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + SetIp6Config: + @config: Ip6Config details for the connection. You must call SetConfig() before calling this. + Set IPv6 details on the connection. - " /> + --> + <method name="SetIp6Config"> <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"> - <annotation name="org.gtk.GDBus.DocString" value=" - Ip6Config details for the connection. You must call - SetConfig() before calling this. - " /> - </arg> + <arg name="config" type="a{sv}" direction="in"/> </method> - <method name="SetFailure"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + SetFailure: + @reason: The reason for the failure. + Indicate a failure to the plugin. - " /> + --> + <method name="SetFailure"> <annotation name="org.freedesktop.DBus.GLib.CSymbol" value="impl_vpn_plugin_set_failure"/> - <arg name="reason" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The reason for the failure. - " /> - </arg> + <arg name="reason" type="s" direction="in"/> </method> - <property name="State" type="u" access="read" tp:type="NM_VPN_SERVICE_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + State: + The state of the plugin. - " /> - </property> - <signal name="StateChanged"> - <annotation name="org.gtk.GDBus.DocString" value=" + Returns: <link linkend="NMVpnServiceState">NMVpnServiceState</link> + --> + <property name="State" type="u" access="read"/> + + <!-- + StateChanged: + @state: (<link linkend="NMVpnServiceState">NMVpnServiceState</link>) The new state of the plugin. + Emitted when the plugin state changes. - " /> - <arg name="state" type="u" tp:type="NM_VPN_SERVICE_STATE"> - <annotation name="org.gtk.GDBus.DocString" value=" - The new state of the plugin. - " /> - </arg> + --> + <signal name="StateChanged"> + <arg name="state" type="u"/> </signal> + <!-- + SecretsRequired: + @message: 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. + @secrets: 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. + + 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. + --> <signal name="SecretsRequired"> - <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. - " /> - <arg name="message" type="s" direction="out"> - <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. - " /> - </arg> - <arg name="secrets" type="as" direction="out"> - <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. - " /> - </arg> + <arg name="message" type="s" direction="out"/> + <arg name="secrets" type="as" direction="out"/> </signal> - <method name="NewSecrets"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + NewSecrets: + @connection: Describes the connection including the new secrets. + Called in response to a SecretsRequired signal to deliver updated secrets or other information to the plugin. - " /> + --> + <method name="NewSecrets"> <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"> - <annotation name="org.gtk.GDBus.DocString" value=" - Describes the connection including the new secrets. - " /> - </arg> - <tp:possible-errors> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.WrongState"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.BadArguments"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.LaunchFailed"/> - <tp:error name="org.freedesktop.NetworkManager.VPN.Error.InteractiveNotSupported"/> - </tp:possible-errors> + <arg name="connection" type="a{sa{sv}}" direction="in"/> </method> - <signal name="Config"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Config: + @config: The configuration information. + The plugin obtained generic configuration information. - " /> - <arg name="config" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - The configuration information. - " /> - </arg> + --> + <signal name="Config"> + <arg name="config" type="a{sv}"/> </signal> - <signal name="Ip4Config"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Ip4Config: + @ip4config: The IPv4 configuration. + The plugin obtained an IPv4 configuration. - " /> - <arg name="ip4config" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - The IPv4 configuration. - " /> - </arg> + --> + <signal name="Ip4Config"> + <arg name="ip4config" type="a{sv}"/> </signal> - <signal name="Ip6Config"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Ip6Config: + @ip6config: The IPv6 configuration. + The plugin obtained an IPv6 configuration. - " /> - <arg name="ip6config" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - The IPv6 configuration. - " /> - </arg> + --> + <signal name="Ip6Config"> + <arg name="ip6config" type="a{sv}"/> </signal> - <signal name="LoginBanner"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + LoginBanner: + @banner: The login banner string. + Emitted when the plugin receives a login banner from the VPN service. - " /> - <arg name="banner" type="s"> - <annotation name="org.gtk.GDBus.DocString" value=" - The login banner string. - " /> - </arg> + --> + <signal name="LoginBanner"> + <arg name="banner" type="s"/> </signal> - <signal name="Failure"> - <annotation name="org.gtk.GDBus.DocString" value=" + <!-- + Failure: + @reason: (<link linkend="NMVpnPluginFailure">NMVpnPluginFailure</link>) Reason code for the failure. + Emitted when a failure in the VPN plugin occurs. - " /> - <arg name="reason" type="u" tp:type="NM_VPN_PLUGIN_FAILURE"> - <annotation name="org.gtk.GDBus.DocString" value=" - Reason code for the failure. - " /> - </arg> + --> + <signal name="Failure"> + <arg name="reason" type="u"/> </signal> - - <tp:enum name="NM_VPN_SERVICE_STATE" type="u"> - <tp:enumvalue suffix="UNKNOWN" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - The state of the VPN plugin is unknown. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="INIT" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - The VPN plugin is initialized. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="SHUTDOWN" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - (Not used.) - " /> - </tp:enumvalue> - <tp:enumvalue suffix="STARTING" value="3"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin is attempting to connect to a VPN server. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="STARTED" value="4"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin has connected to a VPN server. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="STOPPING" value="5"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin is disconnecting from the VPN server. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="STOPPED" value="6"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin has disconnected from the VPN server. - " /> - </tp:enumvalue> - </tp:enum> - - <tp:enum name="NM_VPN_PLUGIN_FAILURE" type="u"> - <tp:enumvalue suffix="LOGIN_FAILED" value="0"> - <annotation name="org.gtk.GDBus.DocString" value=" - Login failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="CONNECT_FAILED" value="1"> - <annotation name="org.gtk.GDBus.DocString" value=" - Connect failed. - " /> - </tp:enumvalue> - <tp:enumvalue suffix="BAD_IP_CONFIG" value="2"> - <annotation name="org.gtk.GDBus.DocString" value=" - Invalid IP configuration returned from the VPN plugin. - " /> - </tp:enumvalue> - </tp:enum> - </interface> </node> diff --git a/introspection/nm-wimax-nsp.xml b/introspection/nm-wimax-nsp.xml index 6174ad6738..8b9a2fcc9f 100644 --- a/introspection/nm-wimax-nsp.xml +++ b/introspection/nm-wimax-nsp.xml @@ -1,44 +1,36 @@ -<?xml version="1.0" encoding="UTF-8" ?> - -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> <interface name="org.freedesktop.NetworkManager.WiMax.Nsp"> - <property name="Name" type="s" access="read"> - <annotation name="org.gtk.GDBus.DocString" value="The name of the NSP." /> - </property> - <property name="SignalQuality" type="u" access="read"> - <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"> - <annotation name="org.gtk.GDBus.DocString" value="The network type of the NSP." /> - </property> + <!-- + Name: - <signal name="PropertiesChanged"> - <arg name="properties" type="a{sv}" tp:type="String_Variant_Map"> - <annotation name="org.gtk.GDBus.DocString" value=" - A dictionary mapping property names to variant boxed values. - " /> - </arg> - </signal> + The name of the NSP. + --> + <property name="Name" type="s" access="read"/> + + <!-- + SignalQuality: + + The current signal quality of the NSP, in percent. + --> + <property name="SignalQuality" type="u" access="read"/> - <tp:flags name="NM_WIMAX_NSP_NETWORK_TYPE" value-prefix="NM_WIMAX_NSP_NETWORK_TYPE" type="u"> - <annotation name="org.gtk.GDBus.DocString" value=" - Network type of the NSP. - " /> - <tp:flag suffix="UNKNOWN" value="0x0"> - <annotation name="org.gtk.GDBus.DocString" value="Unknown network." /> - </tp:flag> - <tp:flag suffix="HOME" value="0x1"> - <annotation name="org.gtk.GDBus.DocString" value="Home network." /> - </tp:flag> - <tp:flag suffix="PARTNER" value="0x2"> - <annotation name="org.gtk.GDBus.DocString" value="Partner network." /> - </tp:flag> - <tp:flag suffix="ROAMING_PARTNER" value="0x3"> - <annotation name="org.gtk.GDBus.DocString" value="Roaming partner network." /> - </tp:flag> - - </tp:flags> + <!-- + NetworkType: + The network type of the NSP. + + Returns: <link linkend="NMWimaxNspNetworkType">NMWimaxNspNetworkType</link> + --> + <property name="NetworkType" type="u" access="read"/> + + <!-- + PropertiesChanged: + @properties: A dictionary mapping property names to variant boxed values. + --> + <signal name="PropertiesChanged"> + <arg name="properties" type="a{sv}"/> + </signal> </interface> </node> diff --git a/introspection/vpn-errors.xml b/introspection/vpn-errors.xml deleted file mode 100644 index c1e02aacb2..0000000000 --- a/introspection/vpn-errors.xml +++ /dev/null @@ -1,60 +0,0 @@ -<?xml version="1.0" ?> -<tp:errors xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0" - namespace="org.freedesktop.NetworkManager.VPN.Error"> - <tp:error name="General"> - <annotation name="org.gtk.GDBus.DocString" value="General failure without further details." /> - </tp:error> - <tp:error name="StartingInProgress"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin is already starting, and another connect request was received. - " /> - </tp:error> - <tp:error name="AlreadyStarted"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin is already connected, and another connect request was received. - " /> - </tp:error> - <tp:error name="StoppingInProgress"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin is already stopping, and another stop request was received. - " /> - </tp:error> - <tp:error name="AlreadyStopped"> - <annotation name="org.gtk.GDBus.DocString" value=" - The plugin is already stopped, and another disconnect request was received. - " /> - </tp:error> - <tp:error name="WrongState"> - <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:error> - <tp:error name="BadArguments"> - <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:error> - <tp:error name="LaunchFailed"> - <annotation name="org.gtk.GDBus.DocString" value=" - A binary providing the service failed to launch. - " /> - </tp:error> - <tp:error name="ConnectionInvalid"> - <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:error> - <tp:error name="InteractiveNotSupported"> - <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:error> -</tp:errors> - diff --git a/libnm-core/nm-dbus-interface.h b/libnm-core/nm-dbus-interface.h index d76c564061..84e080afdc 100644 --- a/libnm-core/nm-dbus-interface.h +++ b/libnm-core/nm-dbus-interface.h @@ -94,8 +94,6 @@ * @NM_STATE_CONNECTED_GLOBAL: there is global IPv4 and/or IPv6 Internet connectivity * * #NMState values indicate the current overall networking state. - * - * (Corresponds to the NM_STATE type in nm-manager.xml.) **/ typedef enum { NM_STATE_UNKNOWN = 0, @@ -118,8 +116,6 @@ typedef enum { * does not appear to be able to reach the full Internet. * @NM_CONNECTIVITY_FULL: The host is connected to a network, and * appears to be able to reach the full Internet. - * - * (Corresponds to the NM_CONNECTIVITY type in nm-manager.xml.) */ typedef enum { NM_CONNECTIVITY_UNKNOWN, @@ -156,8 +152,6 @@ typedef enum { * * #NMDeviceType values indicate the type of hardware represented by * an #NMDevice. - * - * (Corresponds to the NM_DEVICE_TYPE type in nm-device.xml.) **/ typedef enum { NM_DEVICE_TYPE_UNKNOWN = 0, @@ -191,8 +185,6 @@ typedef enum { * @NM_DEVICE_CAP_IS_SOFTWARE: this device is a software device * * General device capability flags. - * - * (Corresponds to the NM_DEVICE_CAP type in nm-device-wifi.xml.) **/ typedef enum { /*< flags >*/ NM_DEVICE_CAP_NONE = 0x00000000, @@ -218,8 +210,6 @@ typedef enum { /*< flags >*/ * @NM_WIFI_DEVICE_CAP_FREQ_5GHZ: device supports 5GHz frequencies * * 802.11 specific device encryption and authentication capabilities. - * - * (Corresponds to the NM_802_11_DEVICE_CAP type in nm-device-wifi.xml.) **/ typedef enum { /*< flags >*/ NM_WIFI_DEVICE_CAP_NONE = 0x00000000, @@ -244,8 +234,6 @@ typedef enum { /*< flags >*/ * encryption (usually means WEP) * * 802.11 access point flags. - * - * (Corresponds to the NM_802_11_AP_FLAGS type in nm-access-point.xml.) **/ typedef enum { /*< underscore_name=nm_802_11_ap_flags, flags >*/ NM_802_11_AP_FLAGS_NONE = 0x00000000, @@ -276,8 +264,6 @@ typedef enum { /*< underscore_name=nm_802_11_ap_flags, flags >*/ * 802.11 access point security and authentication flags. These flags describe * the current security requirements of an access point as determined from the * access point's beacon. - * - * (Corresponds to the NM_802_11_AP_SEC type in nm-access-point.xml.) **/ typedef enum { /*< underscore_name=nm_802_11_ap_security_flags, flags >*/ NM_802_11_AP_SEC_NONE = 0x00000000, @@ -307,8 +293,6 @@ typedef enum { /*< underscore_name=nm_802_11_ap_security_flags, flags >*/ * access point objects; used only for hotspot mode on the local machine. * * Indicates the 802.11 mode an access point or device is currently in. - * - * (Corresponds to the NM_802_11_MODE type in generic-types.xml.) **/ typedef enum { /*< underscore_name=nm_802_11_mode >*/ NM_802_11_MODE_UNKNOWN = 0, @@ -325,8 +309,6 @@ typedef enum { /*< underscore_name=nm_802_11_mode >*/ * * #NMBluetoothCapabilities values indicate the usable capabilities of a * Bluetooth device. - * - * (Corresponds to the NM_BT_CAPABILITY type in nm-device-bt.xml.) **/ typedef enum { /*< flags >*/ NM_BT_CAPABILITY_NONE = 0x00000000, @@ -349,8 +331,6 @@ typedef enum { /*< flags >*/ * technology families a modem device supports. For more information on the * specific access technologies the device supports use the ModemManager D-Bus * API. - * - * (Corresponds to the NM_DEVICE_MODEM_CAPABILITY type in nm-device-modem.xml.) **/ typedef enum { /*< flags >*/ NM_DEVICE_MODEM_CAPABILITY_NONE = 0x00000000, @@ -360,6 +340,21 @@ typedef enum { /*< flags >*/ NM_DEVICE_MODEM_CAPABILITY_LTE = 0x00000008, } NMDeviceModemCapabilities; +/** + * NMWimaxNspNetworkType: + * @NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN: unknown network type + * @NM_WIMAX_NSP_NETWORK_TYPE_HOME: home network + * @NM_WIMAX_NSP_NETWORK_TYPE_PARTNER: partner network + * @NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER: roaming partner network + * + * WiMAX network type. + */ +typedef enum { + NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN = 0, + NM_WIMAX_NSP_NETWORK_TYPE_HOME = 1, + NM_WIMAX_NSP_NETWORK_TYPE_PARTNER = 2, + NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER = 3 +} NMWimaxNspNetworkType; /** * NMDeviceState: @@ -398,8 +393,6 @@ typedef enum { /*< flags >*/ * that connection. The network connection may still be valid. * @NM_DEVICE_STATE_FAILED: the device failed to connect to the requested * network and is cleaning up the connection request - * - * (Corresponds to the NM_DEVICE_STATE type in nm-device.xml.) **/ typedef enum { NM_DEVICE_STATE_UNKNOWN = 0, @@ -484,8 +477,6 @@ typedef enum { * @NM_DEVICE_STATE_REASON_PARENT_MANAGED_CHANGED: the device parent's management changed * * Device state change reason codes - * - * (Corresponds to the NM_DEVICE_STATE_REASON type in nm-device.xml.) */ typedef enum { NM_DEVICE_STATE_REASON_NONE = 0, @@ -561,8 +552,6 @@ typedef enum { * @NM_METERED_GUESS_YES: Metered, the value was guessed * @NM_METERED_GUESS_NO: Not metered, the value was guessed * - * (Corresponds to the NM_METERED type in nm-device.xml.) - * * Since: 1.2 **/ NM_AVAILABLE_IN_1_2 @@ -587,8 +576,6 @@ typedef enum { * #NMActiveConnectionState values indicate the state of a connection to a * specific network while it is starting, connected, or disconnecting from that * network. - * - * (Corresponds to the NM_ACTIVE_CONNECTION_STATE type in nm-active-connection.xml.) **/ typedef enum { NM_ACTIVE_CONNECTION_STATE_UNKNOWN = 0, @@ -620,8 +607,6 @@ typedef enum { * the D-Bus API. * * #NMSecretAgentGetSecretsFlags values modify the behavior of a GetSecrets request. - * - * (Corresponds to the NM_SECRET_AGENT_GET_SECRETS_FLAGS type in nm-secret-agent.xml.) */ typedef enum { /*< flags >*/ NM_SECRET_AGENT_GET_SECRETS_FLAG_NONE = 0x0, @@ -642,8 +627,6 @@ typedef enum { /*< flags >*/ * @NM_SECRET_AGENT_CAPABILITY_LAST: bounds checking value; should not be used. * * #NMSecretAgentCapabilities indicate various capabilities of the agent. - * - * (Corresponds to the NM_SECRET_AGENT_CAPABILITIES type in nm-secret-agent.xml.) */ typedef enum /*< flags >*/ { NM_SECRET_AGENT_CAPABILITY_NONE = 0x0, diff --git a/libnm-core/nm-vpn-dbus-interface.h b/libnm-core/nm-vpn-dbus-interface.h index c4099be2ad..9226458d30 100644 --- a/libnm-core/nm-vpn-dbus-interface.h +++ b/libnm-core/nm-vpn-dbus-interface.h @@ -78,8 +78,6 @@ * @NM_VPN_SERVICE_STATE_STOPPED: The plugin has disconnected from the VPN server. * * VPN daemon states - * - * (Corresponds to the NM_VPN_SERVICE_STATE type in nm-vpn-connection.xml.) */ typedef enum { NM_VPN_SERVICE_STATE_UNKNOWN = 0, @@ -108,8 +106,6 @@ typedef enum { * @NM_VPN_CONNECTION_STATE_DISCONNECTED: The VPN connection is disconnected. * * VPN connection states - * - * (Corresponds to the NM_VPN_CONNECTION_STATE type in nm-vpn-connection.xml.) */ typedef enum { NM_VPN_CONNECTION_STATE_UNKNOWN = 0, @@ -150,8 +146,6 @@ typedef enum { * deleted from settings. * * VPN connection state reasons - * - * (Corresponds to the NM_VPN_CONNECTION_STATE_REASON type in nm-vpn-connection.xml.) */ typedef enum { NM_VPN_CONNECTION_STATE_REASON_UNKNOWN = 0, @@ -176,8 +170,6 @@ typedef enum { * the VPN plugin. * * VPN plugin failure reasons - * - * (Corresponds to the NM_VPN_PLUGIN_FAILURE type in nm-vpn-plugin.xml.) */ typedef enum { NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED, diff --git a/libnm-util/NetworkManager.h b/libnm-util/NetworkManager.h index c4105fd4c0..9053fad27b 100644 --- a/libnm-util/NetworkManager.h +++ b/libnm-util/NetworkManager.h @@ -92,8 +92,6 @@ * @NM_STATE_CONNECTED_GLOBAL: there is global IPv4 and/or IPv6 Internet connectivity * * #NMState values indicate the current overall networking state. - * - * (Corresponds to the NM_STATE type in nm-manager.xml.) **/ typedef enum { NM_STATE_UNKNOWN = 0, @@ -120,8 +118,6 @@ typedef enum { * @NM_CONNECTIVITY_FULL: The host is connected to a network, and * appears to be able to reach the full Internet. * - * (Corresponds to the NM_CONNECTIVITY type in nm-manager.xml.) - * * Since: 0.9.8.6 */ typedef enum { @@ -159,8 +155,6 @@ typedef enum { * * #NMDeviceType values indicate the type of hardware represented by * an #NMDevice. - * - * (Corresponds to the NM_DEVICE_TYPE type in nm-device.xml.) **/ typedef enum { NM_DEVICE_TYPE_UNKNOWN = 0, @@ -194,8 +188,6 @@ typedef enum { * @NM_DEVICE_CAP_IS_SOFTWARE: this device is a software device * * General device capability flags. - * - * (Corresponds to the NM_DEVICE_CAP type in nm-device-wifi.xml.) **/ typedef enum { /*< flags >*/ NM_DEVICE_CAP_NONE = 0x00000000, @@ -221,8 +213,6 @@ typedef enum { /*< flags >*/ * @NM_WIFI_DEVICE_CAP_FREQ_5GHZ: device supports 5GHz frequencies * * 802.11 specific device encryption and authentication capabilities. - * - * (Corresponds to the NM_802_11_DEVICE_CAP type in nm-device-wifi.xml.) **/ typedef enum { /*< flags >*/ NM_WIFI_DEVICE_CAP_NONE = 0x00000000, @@ -247,8 +237,6 @@ typedef enum { /*< flags >*/ * encryption (usually means WEP) * * 802.11 access point flags. - * - * (Corresponds to the NM_802_11_AP_FLAGS type in nm-access-point.xml.) **/ typedef enum { /*< underscore_name=nm_802_11_ap_flags, flags >*/ NM_802_11_AP_FLAGS_NONE = 0x00000000, @@ -279,8 +267,6 @@ typedef enum { /*< underscore_name=nm_802_11_ap_flags, flags >*/ * 802.11 access point security and authentication flags. These flags describe * the current security requirements of an access point as determined from the * access point's beacon. - * - * (Corresponds to the NM_802_11_AP_SEC type in nm-access-point.xml.) **/ typedef enum { /*< underscore_name=nm_802_11_ap_security_flags, flags >*/ NM_802_11_AP_SEC_NONE = 0x00000000, @@ -310,8 +296,6 @@ typedef enum { /*< underscore_name=nm_802_11_ap_security_flags, flags >*/ * access point objects; used only for hotspot mode on the local machine. * * Indicates the 802.11 mode an access point or device is currently in. - * - * (Corresponds to the NM_802_11_MODE type in generic-types.xml.) **/ typedef enum { /*< underscore_name=nm_802_11_mode >*/ NM_802_11_MODE_UNKNOWN = 0, @@ -328,8 +312,6 @@ typedef enum { /*< underscore_name=nm_802_11_mode >*/ * * #NMBluetoothCapabilities values indicate the usable capabilities of a * Bluetooth device. - * - * (Corresponds to the NM_BT_CAPABILITY type in nm-device-bt.xml.) **/ typedef enum { /*< flags >*/ NM_BT_CAPABILITY_NONE = 0x00000000, @@ -352,8 +334,6 @@ typedef enum { /*< flags >*/ * technology families a modem device supports. For more information on the * specific access technologies the device supports use the ModemManager D-Bus * API. - * - * (Corresponds to the NM_DEVICE_MODEM_CAPABILITY type in nm-device-modem.xml.) **/ typedef enum { /*< flags >*/ NM_DEVICE_MODEM_CAPABILITY_NONE = 0x00000000, @@ -401,8 +381,6 @@ typedef enum { /*< flags >*/ * that connection. The network connection may still be valid. * @NM_DEVICE_STATE_FAILED: the device failed to connect to the requested * network and is cleaning up the connection request - * - * (Corresponds to the NM_DEVICE_STATE type in nm-device.xml.) **/ typedef enum { NM_DEVICE_STATE_UNKNOWN = 0, @@ -488,8 +466,6 @@ typedef enum { * @NM_DEVICE_STATE_REASON_PARENT_MANAGED_CHANGED: the device parent's management changed * * Device state change reason codes - * - * (Corresponds to the NM_DEVICE_STATE_REASON type in nm-device.xml.) */ typedef enum { NM_DEVICE_STATE_REASON_NONE = 0, @@ -573,8 +549,6 @@ typedef enum { * #NMActiveConnectionState values indicate the state of a connection to a * specific network while it is starting, connected, or disconnecting from that * network. - * - * (Corresponds to the NM_ACTIVE_CONNECTION_STATE type in nm-active-connection.xml.) **/ typedef enum { NM_ACTIVE_CONNECTION_STATE_UNKNOWN = 0, diff --git a/libnm-util/NetworkManagerVPN.h b/libnm-util/NetworkManagerVPN.h index 882d39739c..756619864f 100644 --- a/libnm-util/NetworkManagerVPN.h +++ b/libnm-util/NetworkManagerVPN.h @@ -78,8 +78,6 @@ * @NM_VPN_SERVICE_STATE_STOPPED: The plugin has disconnected from the VPN server. * * VPN daemon states - * - * (Corresponds to the NM_VPN_SERVICE_STATE type in nm-vpn-connection.xml.) */ typedef enum NMVPNServiceState { NM_VPN_SERVICE_STATE_UNKNOWN = 0, @@ -108,8 +106,6 @@ typedef enum NMVPNServiceState { * @NM_VPN_CONNECTION_STATE_DISCONNECTED: The VPN connection is disconnected. * * VPN connection states - * - * (Corresponds to the NM_VPN_CONNECTION_STATE type in nm-vpn-connection.xml.) */ typedef enum NMVPNConnectionState { NM_VPN_CONNECTION_STATE_UNKNOWN = 0, @@ -150,8 +146,6 @@ typedef enum NMVPNConnectionState { * deleted from settings. * * VPN connection state reasons - * - * (Corresponds to the NM_VPN_CONNECTION_STATE_REASON type in nm-vpn-connection.xml.) */ typedef enum NMVPNConnectionStateReason { NM_VPN_CONNECTION_STATE_REASON_UNKNOWN = 0, @@ -176,8 +170,6 @@ typedef enum NMVPNConnectionStateReason { * the VPN plugin. * * VPN plugin failure reasons - * - * (Corresponds to the NM_VPN_PLUGIN_FAILURE type in nm-vpn-plugin.xml.) */ typedef enum { NM_VPN_PLUGIN_FAILURE_LOGIN_FAILED, diff --git a/libnm/nm-wimax-nsp.h b/libnm/nm-wimax-nsp.h index cdc7b23665..5dd982efe7 100644 --- a/libnm/nm-wimax-nsp.h +++ b/libnm/nm-wimax-nsp.h @@ -41,22 +41,6 @@ G_BEGIN_DECLS #define NM_WIMAX_NSP_SIGNAL_QUALITY "signal-quality" #define NM_WIMAX_NSP_NETWORK_TYPE "network-type" -/** - * NMWimaxNspNetworkType: - * @NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN: unknown network type - * @NM_WIMAX_NSP_NETWORK_TYPE_HOME: home network - * @NM_WIMAX_NSP_NETWORK_TYPE_PARTNER: partner network - * @NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER: roaming partner network - * - * WiMAX network type. - */ -typedef enum { - NM_WIMAX_NSP_NETWORK_TYPE_UNKNOWN = 0, - NM_WIMAX_NSP_NETWORK_TYPE_HOME = 1, - NM_WIMAX_NSP_NETWORK_TYPE_PARTNER = 2, - NM_WIMAX_NSP_NETWORK_TYPE_ROAMING_PARTNER = 3 -} NMWimaxNspNetworkType; - struct _NMWimaxNsp { NMObject parent; }; diff --git a/man/Makefile.am b/man/Makefile.am index 65d8d007fc..fafc6852f4 100644 --- a/man/Makefile.am +++ b/man/Makefile.am @@ -17,10 +17,16 @@ XSLTPROC_MAN_FLAGS = \ if ENABLE_GTK_DOC -%.8: %.xml +%.1: %.xml common.ent $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< -%.5: %.xml +%.5: %.xml common.ent + $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< + +%.7: %.xml common.ent + $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< + +%.8: %.xml common.ent $(AM_V_GEN) xsltproc $(XSLTPROC_MAN_FLAGS) $< endif @@ -38,25 +44,13 @@ NetworkManager.conf.xml: $(srcdir)/NetworkManager.conf.xml.in if BUILD_SETTING_DOCS nm-settings.xml: nm-settings.xsl $(top_builddir)/libnm/nm-setting-docs.xml - $(AM_V_GEN) xsltproc \ - --output $@ \ - --stringparam version $(NM_VERSION) \ - --stringparam date "`date +'%d %B %Y'`" \ - $^ + $(AM_V_GEN) xsltproc --output $@ $^ nm-settings-keyfile.xml: nm-settings-keyfile.xsl $(top_builddir)/libnm/nm-keyfile-docs.xml - $(AM_V_GEN) xsltproc \ - --output $@ \ - --stringparam version $(NM_VERSION) \ - --stringparam date "`date +'%d %B %Y'`" \ - $^ + $(AM_V_GEN) xsltproc --output $@ $^ nm-settings-ifcfg-rh.xml: nm-settings-ifcfg-rh.xsl $(top_builddir)/libnm/nm-ifcfg-rh-docs.xml - $(AM_V_GEN) xsltproc \ - --output $@ \ - --stringparam version $(NM_VERSION) \ - --stringparam date "`date +'%d %B %Y'`" \ - $^ + $(AM_V_GEN) xsltproc --output $@ $^ CLEANFILES += \ nm-settings.xml \ @@ -65,63 +59,65 @@ CLEANFILES += \ endif -configure_generated_man_pages = \ - nmcli.1 \ - nmtui.1 \ - nm-online.1 \ - nm-system-settings.conf.5 +man_pages = \ + nmcli.1 \ + nmtui.1 \ + nm-online.1 \ + NetworkManager.conf.5 \ + nmcli-examples.7 \ + NetworkManager.8 -docbook_generated_man_pages = \ - NetworkManager.8 \ - NetworkManager.conf.5 \ - nmcli-examples.5 - -docbook_autogenerated_man_pages = \ - nm-settings.5 \ +autogenerated_man_pages = \ + nm-settings.5 \ nm-settings-keyfile.5 if CONFIG_PLUGIN_IFCFG_RH -docbook_autogenerated_man_pages += nm-settings-ifcfg-rh.5 +autogenerated_man_pages += nm-settings-ifcfg-rh.5 else EXTRA_DIST += nm-settings-ifcfg-rh.5 endif -EXTRA_DIST += \ - nm-settings.xml \ - nm-settings.xsl \ - nm-settings-keyfile.xml \ - nm-settings-keyfile.xsl \ - nm-settings-ifcfg-rh.xml \ - nm-settings-ifcfg-rh.xsl \ - $(addsuffix .xml,$(basename $(docbook_generated_man_pages))) \ - $(docbook_generated_man_pages) \ - $(docbook_autogenerated_man_pages) - -man_MANS += $(configure_generated_man_pages) +EXTRA_DIST += \ + nm-settings.xml \ + nm-settings.xsl \ + nm-settings-keyfile.xml \ + nm-settings-keyfile.xsl \ + nm-settings-ifcfg-rh.xml \ + nm-settings-ifcfg-rh.xsl \ + $(addsuffix .xml,$(basename $(man_pages))) \ + $(man_pages) \ + $(autogenerated_man_pages) -links = nmtui-edit nmtui-connect nmtui-hostname +nmtui_links = nmtui-edit nmtui-connect nmtui-hostname +NetworkManager_conf_links = nm-system-settings.conf install-data-hook: - for link in $(links); do \ + for link in $(nmtui_links); do \ ln -f $(DESTDIR)$(mandir)/man1/nmtui.1 $(DESTDIR)$(mandir)/man1/$$link.1; \ done + for link in $(NetworkManager_conf_links); do \ + ln -f $(DESTDIR)$(mandir)/man5/NetworkManager.conf.5 $(DESTDIR)$(mandir)/man5/$$link.5; \ + done uninstall-hook: - for link in $(links); do \ + for link in $(nmtui_links); do \ rm -f $(DESTDIR)$(mandir)/man1/$$link.1; \ done + for link in $(NetworkManager_conf_links); do \ + rm -f $(DESTDIR)$(mandir)/man5/$$link.5; \ + done if ENABLE_GTK_DOC -man_MANS += $(docbook_generated_man_pages) -CLEANFILES += $(docbook_generated_man_pages) +man_MANS += $(man_pages) +CLEANFILES += $(man_pages) if SETTING_DOCS_AVAILABLE -man_MANS += $(docbook_autogenerated_man_pages) -CLEANFILES += $(docbook_autogenerated_man_pages) +man_MANS += $(autogenerated_man_pages) +CLEANFILES += $(autogenerated_man_pages) endif else if INSTALL_PREGEN_MANPAGES man_MANS += \ - $(docbook_generated_man_pages) \ - $(docbook_autogenerated_man_pages) + $(man_pages) \ + $(autogenerated_man_pages) endif endif diff --git a/man/NetworkManager.conf.xml.in b/man/NetworkManager.conf.xml.in index 7491a7cdbf..2736065e52 100644 --- a/man/NetworkManager.conf.xml.in +++ b/man/NetworkManager.conf.xml.in @@ -1010,7 +1010,7 @@ interface-name:vboxnet*,except:interface-name:vboxnet2 <para> <citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry>, <citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>nm-online</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>nm-applet</refentrytitle><manvolnum>1</manvolnum></citerefentry>, diff --git a/man/NetworkManager.xml b/man/NetworkManager.xml index 39dfe484ba..3c4b733e5c 100644 --- a/man/NetworkManager.xml +++ b/man/NetworkManager.xml @@ -1,7 +1,10 @@ -<?xml version='1.0'?> <!--*-nxml-*--> +<?xml version='1.0'?> <?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?> <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" - "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "common.ent" > +%entities; +]> <!-- Copyright 2005 - 2014 Red Hat, Inc. @@ -19,7 +22,7 @@ <manvolnum>8</manvolnum> <refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="manual">Network management daemons</refmiscinfo> - <refmiscinfo class="version">1.2</refmiscinfo> + <refmiscinfo class="version">&NM_VERSION;</refmiscinfo> </refmeta> <refnamediv> @@ -455,7 +458,7 @@ <para> <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry>, - <citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>7</manvolnum></citerefentry>, <citerefentry><refentrytitle>nm-online</refentrytitle><manvolnum>1</manvolnum></citerefentry>, <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry>, <citerefentry><refentrytitle>nm-applet</refentrytitle><manvolnum>1</manvolnum></citerefentry>, diff --git a/man/common.ent.in b/man/common.ent.in new file mode 100644 index 0000000000..cd43b8d8e9 --- /dev/null +++ b/man/common.ent.in @@ -0,0 +1,2 @@ +<?xml version="1.0" encoding="utf-8" ?> +<!ENTITY NM_VERSION "@NM_VERSION@"> diff --git a/man/nm-online.1.in b/man/nm-online.1.in deleted file mode 100644 index 4ee6fb1dca..0000000000 --- a/man/nm-online.1.in +++ /dev/null @@ -1,76 +0,0 @@ -.\" nm-online (1) manual page -.\" -.\" This is free documentation; you can redistribute it and/or -.\" modify it under the terms of the GNU General Public License as -.\" published by the Free Software Foundation; either version 2 of -.\" the License, or (at your option) any later version. -.\" -.\" The GNU General Public License's references to "object code" -.\" and "executables" are to be interpreted as the output of any -.\" document formatting or typesetting system, including -.\" intermediate and printed output. -.\" -.\" This manual 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 General Public License for more details. -.\" -.\" You should have received a copy of the GNU General Public Licence along -.\" with this manual; if not, write to the Free Software Foundation, Inc., -.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -.\" -.\" Copyright (C) 2010 - 2014 Red Hat, Inc. -.\" -.TH NM-ONLINE "1" "2014-03-25" "NetworkManager 1.2" - -.SH NAME -nm-online \- ask NetworkManager whether the network is connected -.SH SYNOPSIS -.B nm-online -.RI " [ " OPTIONS " ] - -.SH DESCRIPTION -.B nm-online -is a utility to find out whether we are online. It is done by asking -NetworkManager about its status. When run, \fInm\-online\fP waits until -NetworkManager reports an active connection, or specified timeout expires. On -exit, the returned status code should be checked (see the return codes below). -.P -By default NetworkManager waits for IPv4 dynamic addressing to complete but does -not wait for the "auto" IPv6 dynamic addressing. To wait for IPv6 addressing to -complete, either (1) change the network connection's IPv6 "may-fail" setting to "no", -and/or (2) change the IPv6 addressing method to "manual" or "dhcp", to indicate that -IPv6 connectivity is expected. -.SH OPTIONS -.TP -.B \-t, \-\-timeout <timeout_value> -Time to wait for a connection, in seconds. If the option is not provided, -the default timeout is 30 seconds. -.TP -.B \-x, \-\-exit -Exit immediately if NetworkManager is not running or connecting. -.TP -.B \-q, \-\-quiet -Don't print anything. -.TP -.B \-s, \-\-wait-for-startup -Wait for NetworkManager startup to complete, rather than waiting for -network connectivity specifically. Startup is considered complete once -NetworkManager has activated (or attempted to activate) every -auto-activate connection which is available given the current network -state. (This is generally only useful at boot time; after startup has -completed, \fInm-online -s\fP will just return immediately, regardless -of the current network state.) - -.SH EXIT STATUS - -.IP "0" 4 -Success - already online or connection established within given timeout -.IP "1" 4 -Offline or not online within given timeout -.IP "2" 4 -Unspecified error - -.SH SEE ALSO -.BR nmcli (1), -.BR NetworkManager(8). diff --git a/man/nm-online.xml b/man/nm-online.xml new file mode 100644 index 0000000000..f1f7a0d4b8 --- /dev/null +++ b/man/nm-online.xml @@ -0,0 +1,171 @@ +<?xml version='1.0'?> +<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "common.ent" > +%entities; +]> + +<!-- + nm-online(1) manual page + + This is free documentation; you can redistribute it and/or + modify it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 2 of + the License, or (at your option) any later version. + + The GNU General Public License's references to "object code" + and "executables" are to be interpreted as the output of any + document formatting or typesetting system, including + intermediate and printed output. + + This manual 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 General Public License for more details. + + You should have received a copy of the GNU General Public Licence along + with this manual; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + + Copyright 2010 - 2016 Red Hat, Inc. +--> + +<refentry id='nm-online'> + + <refentryinfo> + <title>nm-online</title> + <author>NetworkManager developers</author> + </refentryinfo> + + <refmeta> + <refentrytitle>nm-online</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class="source">NetworkManager</refmiscinfo> + <refmiscinfo class="manual">General Commands Manual</refmiscinfo> + <refmiscinfo class="version">&NM_VERSION;</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>nm-online</refname> + <refpurpose>ask NetworkManager whether the network is connected</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>nm-online</command> + <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'><title>Description</title> + <para><command>nm-online</command> is a utility to find out whether we are + online. It is done by asking NetworkManager about its status. When run, + <command>nm-online</command> waits until NetworkManager reports an active + connection, or specified timeout expires. On exit, the returned status code + should be checked (see the return codes below).</para> + + <para>By default NetworkManager waits for IPv4 dynamic addressing to complete + but does not wait for the <literal>auto</literal> IPv6 dynamic addressing. To + wait for IPv6 addressing to complete, either (1) change the network + connection's IPv6 <literal>may-fail</literal> setting to <literal>no</literal>, + and/or (2) change the IPv6 addressing method to <literal>manual</literal> or + <literal>dhcp</literal>, to indicate that IPv6 connectivity is expected.</para> + </refsect1> + + <refsect1 id='options'><title>Options</title> + <variablelist> + <varlistentry> + <term> + <group choice='plain'> + <arg choice='plain'><option>-t</option></arg> + <arg choice='plain'><option>--timeout</option></arg> + </group> + <arg choice='plain'><replaceable>seconds</replaceable></arg> + </term> + + <listitem> + <para>Time to wait for a connection, in seconds. If the option is not provided, + the default timeout is 30 seconds.</para> + </listitem> + </varlistentry> + + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-x</option></arg> + <arg choice='plain'><option>--exit</option></arg> + </group></term> + + <listitem> + <para>Exit immediately if NetworkManager is not running or connecting.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-q</option></arg> + <arg choice='plain'><option>--quiet</option></arg> + </group></term> + + <listitem> + <para>Don't print anything.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-s</option></arg> + <arg choice='plain'><option>--wait-for-startup</option></arg> + </group></term> + + <listitem> + <para>Wait for NetworkManager startup to complete, rather than waiting for + network connectivity specifically. Startup is considered complete once + NetworkManager has activated (or attempted to activate) every auto-activate + connection which is available given the current network state. (This is + generally only useful at boot time; after startup has completed, + <command>nm-online -s</command> will just return immediately, regardless of the + current network state.)</para> + </listitem> + </varlistentry> + + </variablelist> + </refsect1> + + <refsect1 id='exit_status'><title>Exit Status</title> + + <para><command>nm-online</command> exits with status 0 if it succeeds, a value + greater than 0 is returned if an error occurs.</para> + + <variablelist spacing='compact' termlength='3'> + <varlistentry> + <term><errorcode>0</errorcode></term> + <listitem> + <para>Success – already online or connection established within given timeout.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><errorcode>1</errorcode></term> + <listitem> + <para>Offline or not online within given timeout.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><errorcode>2</errorcode></term> + <listitem> + <para>Unknown or unspecified error.</para> + </listitem> + </varlistentry> + + </variablelist> + </refsect1> + + <refsect1 id='see_also'><title>See Also</title> + <para><citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> + </refsect1> + +</refentry> diff --git a/man/nm-settings-ifcfg-rh.xsl b/man/nm-settings-ifcfg-rh.xsl index 4379eb38fd..5a9f8d6a7a 100644 --- a/man/nm-settings-ifcfg-rh.xsl +++ b/man/nm-settings-ifcfg-rh.xsl @@ -1,4 +1,8 @@ <?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE stylesheet [ +<!ENTITY % entities SYSTEM "common.ent" > +%entities; +]> <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> @@ -12,28 +16,25 @@ doctype-system="http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" /> - <xsl:param name="date"/> - <xsl:param name="version"/> - <xsl:template match="nm-ifcfg-rh-docs"> <xsl:variable name="unsupported" select="'adsl, bluetooth, ppp, pppoe, serial, generic, gsm, cdma, 802-11-olpc-mesh, wimax, vpn'"/> <refentry id="nm-settings-ifcfg-rh"> <refentryinfo> - <date><xsl:value-of select="$date"/></date> + <title>nm-settings-ifcfg-rh</title> + <author>NetworkManager developers</author> </refentryinfo> <refmeta> <refentrytitle>nm-settings-ifcfg-rh</refentrytitle> <manvolnum>5</manvolnum> <refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="manual">Configuration</refmiscinfo> - <refmiscinfo class="version"><xsl:value-of select="$version"/></refmiscinfo> + <refmiscinfo class="version">&NM_VERSION;</refmiscinfo> </refmeta> <refnamediv> <refname>nm-settings-ifcfg-rh</refname> <refpurpose>Description of <emphasis>ifcfg-rh</emphasis> settings plugin</refpurpose> </refnamediv> - <refsect1> - <title>DESCRIPTION</title> + <refsect1 id='description'><title>Description</title> <para> NetworkManager is based on the concept of connection profiles that contain network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle> @@ -58,8 +59,7 @@ (initscripts). </para> </refsect1> - <refsect1> - <title>File Format</title> + <refsect1 id='file_format'><title>File Format</title> <para> The <emphasis>ifcfg-rh</emphasis> config format is a simple text file containing VARIABLE="value" lines. The format is described in <filename>sysconfig.txt</filename> @@ -205,8 +205,7 @@ DEVICETYPE=TeamPort </formalpara> </refsect1> - <refsect1> - <title>Differences against initscripts</title> + <refsect1 id='differences_against_initscripts'><title>Differences against initscripts</title> <para> The main differences of NetworkManager ifcfg-rh plugin and traditional initscripts are: @@ -270,8 +269,7 @@ DEVICETYPE=TeamPort </para> </refsect1> - <refsect1> - <title>DETAILS</title> + <refsect1 id='details'><title>Details</title> <para> <emphasis>ifcfg-rh</emphasis> plugin variables marked with <emphasis>(+)</emphasis> are NetworkManager specific extensions not understood by traditional initscripts. @@ -305,26 +303,20 @@ DEVICETYPE=TeamPort </refsect2> </refsect1> - <refsect1> - <title>AUTHOR</title> - <para> - <author> - <firstname>NetworkManager developers</firstname> - </author> - </para> - </refsect1> - <refsect1> - <title>FILES</title> + <refsect1 id='files'><title>Files</title> <para><filename>/etc/sysconfig/network-scripts/ifcfg-*</filename></para> <para><filename>/etc/sysconfig/network-scripts/keys-*</filename></para> <para><filename>/etc/sysconfig/network-scripts/route-*</filename></para> <para><filename>/etc/sysconfig/network-scripts/route6-*</filename></para> <para><filename>/usr/share/doc/initscripts/sysconfig.txt</filename></para> </refsect1> - <refsect1> - <title>SEE ALSO</title> - <para>https://developer.gnome.org/NetworkManager/unstable/ref-settings.html</para> - <para>nm-settings(5), nm-settings-keyfile(5), NetworkManager(8), NetworkManager.conf(5), nmcli(1), nmcli-examples(5)</para> + <refsect1 id='see_also'><title>See Also</title> + <para><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-settings-keyfile</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> </refsect1> </refentry> </xsl:template> diff --git a/man/nm-settings-keyfile.xsl b/man/nm-settings-keyfile.xsl index 5b479bdc2a..41e7dcdb88 100644 --- a/man/nm-settings-keyfile.xsl +++ b/man/nm-settings-keyfile.xsl @@ -1,4 +1,8 @@ <?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE stylesheet [ +<!ENTITY % entities SYSTEM "common.ent" > +%entities; +]> <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> @@ -8,27 +12,24 @@ doctype-system="http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" /> - <xsl:param name="date"/> - <xsl:param name="version"/> - <xsl:template match="nm-keyfile-docs"> <refentry id="nm-settings-keyfile"> <refentryinfo> - <date><xsl:value-of select="$date"/></date> + <title>nm-settings-keyfile</title> + <author>NetworkManager developers</author> </refentryinfo> <refmeta> <refentrytitle>nm-settings-keyfile</refentrytitle> <manvolnum>5</manvolnum> <refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="manual">Configuration</refmiscinfo> - <refmiscinfo class="version"><xsl:value-of select="$version"/></refmiscinfo> + <refmiscinfo class="version">&NM_VERSION;</refmiscinfo> </refmeta> <refnamediv> <refname>nm-settings-keyfile</refname> <refpurpose>Description of <emphasis>keyfile</emphasis> settings plugin</refpurpose> </refnamediv> - <refsect1> - <title>DESCRIPTION</title> + <refsect1 id='description'><title>Description</title> <para> NetworkManager is based on the concept of connection profiles that contain network configuration (see <citerefentry><refentrytitle>nm-settings</refentrytitle> @@ -48,8 +49,7 @@ in plaintext inside the file. </para> </refsect1> - <refsect1> - <title>File Format</title> + <refsect1 id='file_format'><title>File Format</title> <para> The <emphasis>keyfile</emphasis> config format is a simple .ini-style format. It consists of sections (groups) of key-value pairs. Each section @@ -187,8 +187,7 @@ id=4 </formalpara> </refsect1> - <refsect1> - <title>DETAILS</title> + <refsect1 id='details'><title>Details</title> <para> <emphasis>keyfile</emphasis> plugin variables for the majority of NetworkManager properties have one-to-one mapping. It means a NetworkManager property is stored @@ -242,22 +241,17 @@ id=4 </refsect2> </refsect1> - <refsect1> - <title>AUTHOR</title> - <para> - <author> - <firstname>NetworkManager developers</firstname> - </author> - </para> - </refsect1> - <refsect1> - <title>FILES</title> + <refsect1 id='files'><title>Files</title> <para><filename>/etc/NetworkManager/system-connections/*</filename></para> </refsect1> - <refsect1> - <title>SEE ALSO</title> - <para>https://developer.gnome.org/NetworkManager/unstable/ref-settings.html</para> - <para>nm-settings(5), nm-settings-ifcfg-rh(5), NetworkManager(8), NetworkManager.conf(5), nmcli(1), nmcli-examples(5)</para> + + <refsect1 id='see_also'><title>See Also</title> + <para><citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-settings-ifcfg-rh</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>7</manvolnum></citerefentry></para> </refsect1> </refentry> </xsl:template> diff --git a/man/nm-settings.xsl b/man/nm-settings.xsl index b6f564c7da..0fe4cabea8 100644 --- a/man/nm-settings.xsl +++ b/man/nm-settings.xsl @@ -1,4 +1,8 @@ <?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE stylesheet [ +<!ENTITY % entities SYSTEM "common.ent" > +%entities; +]> <xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform"> @@ -8,27 +12,25 @@ doctype-system="http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" /> - <xsl:param name="date"/> - <xsl:param name="version"/> - <xsl:template match="nm-setting-docs"> <refentry id="nm-settings"> <refentryinfo> - <date><xsl:value-of select="$date"/></date> + <title>nm-settings</title> + <author>NetworkManager developers</author> </refentryinfo> <refmeta> <refentrytitle>nm-settings</refentrytitle> <manvolnum>5</manvolnum> <refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="manual">Configuration</refmiscinfo> - <refmiscinfo class="version"><xsl:value-of select="$version"/></refmiscinfo> + <refmiscinfo class="version">&NM_VERSION;</refmiscinfo> </refmeta> <refnamediv> <refname>nm-settings</refname> <refpurpose>Description of settings and properties of NetworkManager connection profiles</refpurpose> </refnamediv> - <refsect1> - <title>DESCRIPTION</title> + + <refsect1 id='description'><title>Description</title> <para> NetworkManager is based on a concept of connection profiles, sometimes referred to as connections only. These connection profiles contain a network configuration. When @@ -109,23 +111,16 @@ </itemizedlist> </refsect2> </refsect1> - <refsect1> - <title>AUTHOR</title> - <para> - <author> - <firstname>NetworkManager developers</firstname> - </author> - </para> - </refsect1> - <refsect1> - <title>FILES</title> - <para>/etc/NetworkManager/system-connections</para> - <para>or distro plugin-specific location</para> + + <refsect1 id='files'><title>Files</title> + <para><filename>/etc/NetworkManager/system-connections</filename> or distro plugin-specific location</para> </refsect1> - <refsect1> - <title>SEE ALSO</title> - <para>https://wiki.gnome.org/Projects/NetworkManager/ConfigurationSpecification</para> - <para>NetworkManager(8), nmcli(1), nmcli-examples(5), NetworkManager.conf(5)</para> + + <refsect1 id='see_also'><title>See Also</title> + <para><citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>7</manvolnum></citerefentry>, + <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry></para> </refsect1> </refentry> </xsl:template> diff --git a/man/nm-system-settings.conf.5.in b/man/nm-system-settings.conf.5.in deleted file mode 100644 index 172db11256..0000000000 --- a/man/nm-system-settings.conf.5.in +++ /dev/null @@ -1,25 +0,0 @@ -.\" nm-system-settings.conf(5) manual page -.\" -.\" Copyright (C) 2010 Red Hat, Inc. -.\" -.TH "nm-system-settings.conf" "5" "1 February 2010" "" -.SH NAME -nm\-system\-settings.conf \- Deprecated NetworkManager configuration file -.SH SYNOPSIS -/etc/NetworkManager/nm\-system\-settings.conf -.br -or -.br -\fI<SYSCONFDIR>\fP/NetworkManager/nm\-system\-settings.conf -.br -where <SYSCONFDIR> depends on your distribution or build. -.SH DESCRIPTION -.P -.I nm\-system\-settings.conf -is a deprecated configuration file for \fBNetworkManager\fP (5). While this -file can still be used, NetworkManager now defaults to reading the config -file <SYSCONFDIR>\fP/NetworkManager/NetworkManager.conf\fP instead, falling back -to nm\-system\-settings.conf if NetworkManager.conf does not exist. -.SH "SEE ALSO" -.BR NetworkManager (8), -.BR NetworkManager.conf (5). diff --git a/man/nmcli-examples.xml b/man/nmcli-examples.xml index 768434725e..9c28e15fe1 100644 --- a/man/nmcli-examples.xml +++ b/man/nmcli-examples.xml @@ -1,6 +1,10 @@ -<?xml version='1.0'?> <!--*-nxml-*--> -<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" -"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> +<?xml version='1.0'?> +<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "common.ent" > +%entities; +]> <!-- Copyright 2013 - 2014 Red Hat, Inc. @@ -9,16 +13,15 @@ Copyright 2013 - 2014 Red Hat, Inc. <refentry id="nmcli-examples"> <refentryinfo> <title>nmcli-examples</title> - <date>19 November 2014</date> <author>NetworkManager developers</author> </refentryinfo> <refmeta> <refentrytitle>nmcli-examples</refentrytitle> - <manvolnum>5</manvolnum> + <manvolnum>7</manvolnum> <refmiscinfo class="source">NetworkManager</refmiscinfo> <refmiscinfo class="manual">Examples</refmiscinfo> - <refmiscinfo class="version">1.2</refmiscinfo> + <refmiscinfo class="version">&NM_VERSION;</refmiscinfo> </refmeta> <refnamediv> diff --git a/man/nmcli.1.in b/man/nmcli.1.in deleted file mode 100644 index 3c76348f8e..0000000000 --- a/man/nmcli.1.in +++ /dev/null @@ -1,1282 +0,0 @@ -.\" nmcli (1) manual page -.\" -.\" This is free documentation; you can redistribute it and/or -.\" modify it under the terms of the GNU General Public License as -.\" published by the Free Software Foundation; either version 2 of -.\" the License, or (at your option) any later version. -.\" -.\" The GNU General Public License's references to "object code" -.\" and "executables" are to be interpreted as the output of any -.\" document formatting or typesetting system, including -.\" intermediate and printed output. -.\" -.\" This manual 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 General Public License for more details. -.\" -.\" You should have received a copy of the GNU General Public Licence along -.\" with this manual; if not, write to the Free Software Foundation, Inc., -.\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. -.\" -.\" Copyright 2010 - 2015 Red Hat, Inc. -.\" -.TH NMCLI "1" "2016-03-09" "NetworkManager 1.2" - -.SH NAME -nmcli \- command\(hyline tool for controlling NetworkManager -.SH SYNOPSIS -.ad l -.B nmcli -.RI " [ " OPTIONS " ] " OBJECT " { " COMMAND " | " -.BR help " } " -.sp - -.IR OBJECT " := { " -.BR general " | " networking " | " radio " | " connection " | " device " | " agent " | " monitor -.RI " }" -.sp - -.IR OPTIONS " := { " -.br -\fB\-t\fR[\fIerse\fR] -.br -\fB\-p\fR[\fIretty\fR] -.br -\fB\-m\fR[\fImode\fR] tabular | multiline -.br -\fB\-c\fR[\fIcolors\fR] auto | yes | no -.br -\fB\-f\fR[\fIields\fR] <field1,field2,...> | all | common -.br -\fB\-e\fR[\fIscape\fR] yes | no -.br -\fB\-n\fR[\fIocheck\fR] -.br -\fB\-a\fR[\fIsk\fR] -.br -\fB\-s\fR[\fIhow-secrets\fR] -.br -\fB\-w\fR[\fIait\fR] <seconds> -.br -\fB\-v\fR[\fIersion\fR] -.br -\fB\-h\fR[\fIelp\fR] -.br -.RI "}" - -.SH DESCRIPTION -.B nmcli -is a command\(hyline tool for controlling NetworkManager and reporting network -status. It can be utilized as a replacement for \fInm\(hyapplet\fP or other -graphical clients. \fInmcli\fP is used to create, display, edit, delete, activate, -and deactivate network connections, as well as control and display network device -status. -.P -Typical uses include: -.IP \(em 4 -Scripts: utilize NetworkManager via \fInmcli\fP instead of managing network -connections manually. \fInmcli\fP supports a terse output format which is better -suited for script processing. Note that NetworkManager can also execute scripts, -called "dispatcher scripts", in response to network events. See -\fBNetworkManager\fP for details about these dispatcher scripts. -.IP \(em 4 -Servers, headless machines, and terminals: \fInmcli\fP can be used to control -NetworkManager without a GUI, including creating, editing, starting and stopping -network connections and viewing network status. -.SS \fIOPTIONS\fP -.TP -.B \-t, \-\-terse -Output is terse. This mode is designed and suitable for computer (script) -processing. -.TP -.B \-p, \-\-pretty -Output is pretty. This causes \fInmcli\fP to produce easily readable outputs -for humans, i.e. values are aligned, headers are printed, etc. -.TP -.B \-m, \-\-mode tabular | multiline -Switch between \fItabular\fP and \fImultiline\fP output. -If omitted, default is \fItabular\fP for most commands. For the commands -producing more structured information, that cannot be displayed on a single -line, default is \fImultiline\fP. Currently, they are: -.br -.nf - 'nmcli connection show <ID>' - 'nmcli device show' -.fi -\fItabular\fP \(en Output is a table where each line describes a single entry. -Columns define particular properties of the entry. -.br -\fImultiline\fP \(en Each entry comprises multiple lines, each property on its own -line. The values are prefixed with the property name. -.TP -.B \-c, \-\-colors auto|yes|no -This option controls color output (using terminal escape sequences). \fIyes\fP -enables colors, \fIno\fP disables them, \fIauto\fP only produces colors when -standard output is directed to a terminal. The default value is \fIauto\fP. -.TP -.B \-f, \-\-fields <field1,field2,...> | all | common -This option is used to specify what fields (column names) should be printed. -Valid field names differ for specific commands. List available fields by -providing an invalid value to the \fI\-\-fields\fP option. -.br -\fIall\fP is used to print all valid field values of the command. -\fIcommon\fP is used to print common field values of the command. -If omitted, default is \fIcommon\fP. -The option is mandatory when \fI\-\-terse\fP is used. In this case, generic -values \fIall\fP and \fIcommon\fP cannot be used. (This is to maintain -compatibility when new fields are added in the future). -.TP -.B \-e, \-\-escape yes | no -Whether to escape ':' and '\\' characters in terse tabular mode. The escape -character is '\\'. -If omitted, default is \fIyes\fP. -.TP -.B \-n, \-\-nocheck -This option can be used to force \fInmcli\fP to skip checking \fInmcli\fP and -\fINetworkManager\fP version compatibility. Use it with care, because using -incompatible versions may produce incorrect results. -.TP -.B \-a, \-\-ask -When using this option \fInmcli\fP will stop and ask for any missing required -arguments, so do not use this option for non-interactive purposes like scripts. -This option controls, for example, whether you will be prompted for a password -if it is required for connecting to a network. -.TP -.B \-s, \-\-show-secrets -When using this option \fInmcli\fP will display passwords and secrets that might -be present in an output of an operation. This option also influences echoing -passwords typed by user as an input. -.TP -.B \-w, \-\-wait <seconds> -This option sets a timeout period for which \fInmcli\fP will wait for \fINetworkManager\fP -to finish operations. It is especially useful for commands that may take a longer time to -complete, e.g. connection activation. -Specifying a value of \fB0\fP instructs \fInmcli\fP not to wait but to exit immediately -with a status of success. The default value depends on the executed command. -.TP -.B \-v, \-\-version -Show \fInmcli\fP version. -.TP -.B \-h, \-\-help -Print help information. -.SS \fIOBJECT\fP -.TP -.B general \- general \fINetworkManager\fP status and operations -.br -Use this object to show NetworkManager status and permissions. You can also get -and change system hostname, as well as NetworkManager logging level and domains. -.TP -.SS \fICOMMAND\fP := { status | hostname | permissions | logging } -.sp -.RS -.TP -.B status -.br -Show overall status of NetworkManager. This is the default action, when no additional -command is provided for \fIgeneral\fP object. -.TP -.B hostname [<hostname>] -.br -Get and change system hostname. With no arguments, this prints currently configured hostname. -When you pass a hostname, it will be handed over to NetworkManager to be set as a new system -hostname. -.br -Note that the term \fBsystem\fP hostname may also be referred to as \fBpersistent\fP or -\fBstatic\fP by other programs or tools. The hostname is stored in /etc/hostname -file in most distributions. For example, systemd-hostnamed service uses the term -\fBstatic\fP hostname and it only reads the /etc/hostname file when it starts. -.TP -.B permissions -.br -Show the permissions a caller has for various authenticated operations that -NetworkManager provides, like enable and disable networking, changing Wi\(hyFi -and WWAN state, modifying connections, etc. -.TP -.B logging [level <log level>] [domains <log domains>] -.br -Get and change \fINetworkManager\fP logging level and domains. Without any argument -current logging level and domains are shown. In order to change logging state, provide -\fIlevel\fP and, or, \fIdomain\fP parameters. See \fBNetworkManager.conf\fP for available -level and domain values. -.RE - -.TP -.B networking \- get or set general networking state of NetworkManager -.br -Use this object to show NetworkManager networking status, or to enable and disable -networking. Disabling networking removes the configuration from all devices and -changes them to the 'unmanaged' state. -.TP -.SS \fICOMMAND\fP := { [ on | off | connectivity ] } -.sp -.RS -.TP -.B [ on | off ] -.br -Get networking\(hyenabled status or enable and disable networking by NetworkManager. -All interfaces managed by NetworkManager are deactivated when networking has -been disabled. -.TP -.B connectivity [check] -.br -Get network connectivity state. -The optional \fIcheck\fP argument tells NetworkManager to re-check the connectivity, -else the most recent known connectivity state is displayed without re-checking. -.br -Possible states are: -.RS -.PP -.IP \fInone\fP 9 -\(en the host is not connected to any network -.IP \fIportal\fP 9 -\(en the host is behind a captive portal and cannot reach the full Internet -.IP \fIlimited\fP 9 -\(en the host is connected to a network, but it has no access to the Internet -.IP \fIfull\fP 9 -\(en the host is connected to a network and has full access to the Internet -.IP \fIunknown\fP 9 -\(en the connectivity status cannot be found out -.RE -.RE - -.TP -.B radio \- get or set radio switch states -.br -Use this object to show radio switches status, or enable and disable -the switches. -.TP -.SS \fICOMMAND\fP := { all | wifi | wwan } -.sp -.RS -.TP -.B wifi [ on | off ] -.br -Show or set status of Wi\(hyFi in NetworkManager. If no arguments are supplied, -Wi\(hyFi status is printed; \fIon\fP enables Wi\(hyFi; \fIoff\fP disables Wi\(hyFi. -.TP -.B wwan [ on | off ] -.br -Show or set status of WWAN (mobile broadband) in NetworkManager. If no arguments -are supplied, mobile broadband status is printed; \fIon\fP enables mobile broadband, -\fIoff\fP disables it. -.TP -.B all [ on | off ] -.br -Show or set all previously mentioned radio switches at the same time. -.RE - -.TP -.B monitor \- monitor NetworkManager -.br -Use this object to observe NetworkManager activity. Watches for changes -in connectivity state, devices or connection profiles. -.br -See also \fImonitor\fP command of \fIconnection\fP or \fIdevice\fP object -to watch for changes in certain objects or object classes. -.RE - -.TP -.B connection \- start, stop, and manage network connections -.sp -NetworkManager stores all network configuration as \fIconnections\fP, which are -collections of data (Layer2 details, IP addressing, etc.) that describe -how to create or connect to a network. A connection is \fIactive\fP when -a device uses that connection's configuration to create or connect to a network. -There may be multiple connections that apply to a device, but only one of them -can be active on that device at any given time. The additional connections can -be used to allow quick switching between different networks and configurations. -.sp -Consider a machine which is usually connected to a DHCP-enabled network, but -sometimes connected to a testing network which uses static IP addressing. Instead -of manually reconfiguring eth0 each time the network is changed, the settings can -be saved as two connections which both apply to eth0, one for DHCP (called -"default") and one with the static addressing details (called "testing"). When -connected to the DHCP-enabled network the user would run "nmcli con up default" -, and when connected to the static network the user would run "nmcli con up testing". -.TP -.SS \fICOMMAND\fP := { show | up | down | add | edit | modify | delete | monitor | reload | load } -.sp -.RS -.TP -.B show [--active] -.br -List in-memory and on-disk connection profiles, some of which may also be -active if a device is using that connection profile. Without a parameter, all -profiles are listed. When --active option is specified, only the active profiles -are shown. -.TP -.B show [--active] [--order <order spec>] [ id | uuid | path | apath ] <ID> ... -.br -Show details for specified connections. By default, both static configuration -and active connection data are displayed. When --active option is specified, -only the active profiles are taken into account. Use global --show-secrets option -to display secrets associated with the profile. -.sp -Ordering: -.br -The --order option can be used to get custom ordering of connections. The -connections can be ordered by active status, name, type or D-Bus path. If -connections are equal according to a sort order category, an additional -category can be specified. -The default sorting order is equivalent to "--order active:name:path". -.sp -<order spec> := category:category:... -.br -category := [+-]active | [+-]name | [+-]type | [+-]path -.br -\fI+\fP or no prefix means sorting in ascending order (alphabetically or in numbers). -.br -\fI-\fP means reverse (descending) order. -.br -The category names can be abbreviated (e.g. --order -a:na) -.sp -\fIid\fP, \fIuuid\fP, \fIpath\fP and \fIapath\fP keywords can be used if -\fI<ID>\fP is ambiguous. -.RS -.PP -Optional <ID>-specifying keywords are: -.IP \fIid\fP 13 -\(en the <ID> denotes a connection name -.IP \fIuuid\fP 13 -\(en the <ID> denotes a connection UUID -.IP \fIpath\fP 13 -\(en the <ID> denotes a D-Bus static connection path -in the format of /org/freedesktop/NetworkManager/Settings/<num> or just <num> -.IP \fIapath\fP 13 -\(en the <ID> denotes a D-Bus active connection path -in the format of /org/freedesktop/NetworkManager/ActiveConnection/<num> or just <num> -.PP -It is possible to filter the output using the global \fI--fields\fP option. Use the following -values: -.RE -.RS -.PP -.IP \fIprofile\fP 13 -\(en only shows static profile configuration -.IP \fIactive\fP 13 -\(en only shows active connection data (when the profile is active) -.PP -You can also specify particular fields. For static configuration, use setting and property names -as described in \fInm-settings\fP(5) manual page. For active data use GENERAL, IP4, DHCP4, IP6, -DHCP6, VPN. -.PP -When no command is given to the \fIconnection\fP object, the default action -is 'nmcli connection show'. -.RE -.TP -.B up [ id | uuid | path ] <ID> [ifname <ifname>] [ap <BSSID>] [passwd-file <file with passwords>] -.RE -.RS -.B up ifname <ifname> [ap <BSSID>] [passwd-file <file with passwords>] -.RS -.br -Activate a connection. The connection is identified by its name, UUID or D-Bus -path. If <ID> is ambiguous, a keyword \fIid\fP, \fIuuid\fP or \fIpath\fP can be -used. When requiring a particular device to activate the connection on, the -\fIifname\fP option with interface name should be given. If the <ID> is not -given an \fIifname\fP is required, and NetworkManager will activate the best -available connection for the given \fIifname\fP. In case of a VPN connection, -the \fIifname\fP option specifies the device of the base connection. The -\fIap\fP option specify what particular AP should be used in case of a Wi\(hyFi -connection. -.br -If '--wait' option is not specified, the default timeout will be 90 seconds. -.br -See \fBconnection show\fP above for the description of the <ID>-specifying keywords. -.RS -.PP -Available options are: -.IP \fIifname\fP 13 -\(en interface that will be used for activation -.IP \fIap\fP 13 -\(en BSSID of the AP which the command should connect to (for Wi\(hyFi connections) -.IP \fIpasswd-file\fP 13 -\(en some networks may require credentials during activation. You can give these -credentials using this option. -Each line of the file should contain one password in the form of -.br -\fBsetting_name.property_name:the password\fP -.br -For example, for WPA Wi-Fi with PSK, the line would be -.br -\fI802-11-wireless-security.psk:secret12345\fP -.br -For 802.1X password, the line would be -.br -\fI802-1x.password:my 1X password\fP -.br -nmcli also accepts "wifi-sec" and "wifi" strings instead of "802-11-wireless-security". -When NetworkManager requires a password and it is not given, nmcli will ask for it -when run with --ask. If --ask was not passed, NetworkManager can ask another secret -agent that may be running (typically a GUI secret agent, such as nm-applet or -gnome-shell). -.RE -.RE -.TP -.B down [ id | uuid | path | apath ] <ID> ... -.br -Deactivate a connection from a device without preventing the device from -further auto-activation. Multiple connections can be passed to the command. -.sp -Be aware that this command deactivates the specified active connection, but the device -on which the connection was active, is still ready to connect and will perform -auto-activation by looking for a suitable connection that has the 'autoconnect' -flag set. This includes the just deactivated connection. So if the connection is set -to auto-connect, it will be automatically started on the disconnected device again. -.br -In most cases you may want to use \fIdevice disconnect\fP command instead. -.sp -The connection is identified by its name, UUID or D-Bus path. -If <ID> is ambiguous, a keyword \fIid\fP, \fIuuid\fP, \fIpath\fP or -\fIapath\fP can be used. -.br -See \fBconnection show\fP above for the description of the <ID>-specifying keywords. -.br -If '--wait' option is not specified, the default timeout will be 10 seconds. -.TP -.B add COMMON_OPTIONS TYPE_SPECIFIC_OPTIONS IP_OPTIONS [-- [+|-]<setting>.<property> <value> ...] -.br -Add a connection for NetworkManager. Arguments differ according to connection types, see below. -.RS -.TP -.B COMMON_OPTIONS: -.IP "\fItype <type>\fP" 42 -\(en connection type; see below \fBTYPE_SPECIFIC_OPTIONS\fP for allowed values; (mandatory) -Note that types \fIbond-slave\fP, \fIteam-slave\fP and \fIbridge-slave\fP create \fIethernet\fP -connection profiles. Their use is discouraged in favor of using a specific type with \fImaster\fP -option. -.IP "\fIifname <ifname> | \(dq\&*\(dq\&\fP" 42 -\(en interface to bind the connection to. The connection will only be applicable to this -interface name. A special value of "\fB*\fP" can be used for interface-independent connections. -The \fIifname\fP argument is mandatory for all connection types except bond, team, bridge and vlan. -Note: use quotes around \fB*\fP to suppress shell expansion. -.IP "\fI[con-name <connection name>]\fP" 42 -\(en connection name (when not provided a default name is generated: <type>[-<ifname>][-<num>]) -.IP "\fI[autoconnect yes|no]\fP" 42 -\(en whether the connection profile can be automatically activated (default: yes) -.IP "\fI[save yes|no]\fP" 42 -\(en whether the connection should be persistent, i.e. NetworkManager should store it on disk (default: yes) -.IP "\fI[master <master (ifname, or connection UUID or name)>]\fP" 42 -\(en master interface name, or connection UUID or ID of master connection profile. -The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disambiguate it. -.IP "\fI[slave-type <master connection type>]\fP" 42 -\(en type of master connection. Only required when it can not be inferred (i.e. the master connection does -not exist yet). -.RE -.RS -.TP -.B TYPE_SPECIFIC_OPTIONS: -.TP -.B ethernet: -.IP "\fI[mac <MAC address>]\fP" 42 -\(en MAC address of the device this connection is locked to -.IP "\fI[cloned-mac <cloned MAC address>]\fP" 42 -\(en cloned MAC -.IP "\fI[mtu <MTU>]\fP" 42 -\(en MTU -.RE -.RS -.TP -.B wifi: -.IP "\fIssid <SSID>\fP" 42 -\(en SSID -.IP "\fI[mac <MAC address>]\fP" 42 -\(en MAC address of the device this connection is locked to -.IP "\fI[cloned-mac <cloned MAC address>]\fP" 42 -\(en cloned MAC -.IP "\fI[mode infrastructure|ap|adhoc]\fP" 42 -\(en Wi-Fi network mode. If blank, \fIinfrastructure\fP is assumed. -.IP "\fI[mtu <MTU>]\fP" 42 -\(en MTU -.RE -.RS -.TP -.B wimax: -.IP "\fI[mac <MAC address>]\fP" 42 -\(en MAC address of the device this connection is locked to -.IP "\fI[nsp <NSP>]\fP" 42 -\(en Network Service Provider name -.RE -.RS -.TP -.B pppoe: -.IP "\fIusername <PPPoE username>\fP" 42 -\(en PPPoE username -.IP "\fI[password <PPPoE password>]\fP" 42 -\(en Password for the PPPoE username -.IP "\fI[service <PPPoE service name>]\fP" 42 -\(en PPPoE service name (if required by concentrator) -.IP "\fI[mtu <MTU>]\fP" 42 -\(en MTU -.IP "\fI[mac <MAC address>]\fP" 42 -\(en MAC address of the device this connection is locked to -.RE -.RS -.TP -.B gsm: -.IP "\fIapn <APN>\fP" 42 -\(en APN - GSM Access Point Name -.IP "\fI[user <username>]\fP" 42 -\(en user name -.IP "\fI[password <password>]\fP" 42 -\(en password -.RE -.RS -.TP -.B cdma: -.IP "\fI[user <username>]\fP" 42 -\(en user name -.IP "\fI[password <password>]\fP" 42 -\(en password -.RE -.RS -.TP -.B infiniband: -.IP "\fI[mac <MAC address>]\fP" 42 -\(en MAC address of the device this connection is locked to (InfiniBand MAC is 20 bytes) -.IP "\fI[mtu <MTU>]\fP" 42 -\(en MTU -.IP "\fI[transport-mode datagram | connected]\fP" 42 -\(en InfiniBand transport mode -.IP "\fI[parent <interface name>]\fP" 42 -\(en the interface name of the parent device (if any) -.IP "\fI[p-key <IPoIB P_Key>]\fP" 42 -\(en the InfiniBand P_Key (16-bit unsigned integer) -.RE -.RS -.TP -.B bluetooth: -.IP "\fI[addr <bluetooth address>]\fP" 42 -\(en Bluetooth device address (MAC) -.IP "\fI[bt-type panu|dun-gsm|dun-cdma]\fP" 42 -\(en Bluetooth connection type -.RE -.RS -.TP -.B vlan: -.IP "\fIdev <parent device (connection UUID, ifname, or MAC)>\fP" 42 -\(en parent device this VLAN is on -.IP "\fIid <VLAN ID>\fP" 42 -\(en VLAN ID in range <0-4095> -.IP "\fI[flags <VLAN flags>]\fP" 42 -\(en flags -.IP "\fI[ingress <ingress priority mapping>]\fP" 42 -\(en VLAN ingress priority mapping -.IP "\fI[egress <egress priority mapping>]\fP" 42 -\(en VLAN egress priority mapping -.IP "\fI[mtu <MTU>]\fP" 42 -\(en MTU -.RE -.RS -.TP -.B bond: -.IP "\fI[mode balance-rr (0) | active-backup (1) | balance-xor (2) | broadcast (3) |\fP" -.IP "\fI 802.3ad (4) | balance-tlb (5) | balance-alb (6)]\fP" 42 -\(en bonding mode (default: balance-rr) -.IP "\fI[primary <ifname>]\fP" 42 -\(en primary interface name (for "active-backup" mode) -.IP "\fI[miimon <num>]\fP" 42 -\(en miimon (default: 100) -.IP "\fI[downdelay <num>]\fP" 42 -\(en downdelay (default: 0) -.IP "\fI[updelay <num>]\fP" 42 -\(en updelay (default: 0) -.IP "\fI[arp-interval <num>]\fP" 42 -\(en ARP interval (default: 0) -.IP "\fI[arp-ip-target <num>]\fP" 42 -\(en ARP IP target -.RE -.RS -.TP -.B bond-slave: -.IP "\fImaster <master (ifname, or connection UUID or name)>\fP" 42 -\(en master bond interface name, or connection UUID or ID of bond master connection profile. -The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disambiguate it. -.RE -.RS -.TP -.B team: -.IP "\fI[config <file>|<raw JSON data>]\fP" 42 -\(en JSON configuration for team -.RE -.RS -.TP -.B team-slave: -.IP "\fImaster <master (ifname, or connection UUID or name)>\fP" 42 -\(en master team interface name, or connection UUID or ID of team master connection profile. -The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disambiguate it. -.RE -.RS -.TP -.IP "\fI[config <file>|<raw JSON data>]\fP" 42 -\(en JSON configuration for team -.RE -.RS -.TP -.B bridge: -.IP "\fI[stp yes|no]\fP" 42 -\(en controls whether Spanning Tree Protocol (STP) is enabled for this bridge (default: yes) -.IP "\fI[priority <num>]\fP" 42 -\(en sets STP priority (default: 128) -.IP "\fI[forward-delay <2-30>]\fP" 42 -\(en STP forwarding delay, in seconds (default: 15) -.IP "\fI[hello-time <1-10>]\fP" 42 -\(en STP hello time, in seconds (default: 2) -.IP "\fI[max-age <6-42>]\fP" 42 -\(en STP maximum message age, in seconds (default: 20) -.IP "\fI[ageing-time <0-1000000>]\fP" 42 -\(en the Ethernet MAC address aging time, in seconds (default: 300) -.IP "\fI[multicast-snooping yes|no]\fP" 42 -\(en controls whether IGMP snooping is enabled (default: yes) -.IP "\fI[mac <MAC address>]\fP" 42 -\(en MAC address of the bridge (note: this requires a recent kernel feature, -originally introduced in 3.15 upstream kernel) -.RE -.RS -.TP -.B bridge-slave: -.IP "\fImaster <master (ifname, or connection UUID or name)>\fP" 42 -\(en master bridge interface name, or connection UUID or ID of bridge master connection profile. -The value can be prefixed with \fBifname/\fP, \fBuuid/\fP or \fBid/\fP to disambiguate it. -.RE -.RS -.TP -.IP "\fI[priority <0-63>]\fP" 42 -\(en STP priority of this slave (default: 32) -.IP "\fI[path-cost <1-65535>]\fP" 42 -\(en STP port cost for destinations via this slave (default: 100) -.IP "\fI[hairpin yes|no]\fP" 42 -\(en 'hairpin mode' for the slave, which allows frames -to be sent back out through the slave the frame was received on (default: yes) -.RE -.RS -.TP -.B vpn: -.IP "\fIvpn-type vpnc|openvpn|pptp|openconnect|openswan|libreswan|strongswan|ssh|l2tp|iodine|fortisslvpn|...\fP" 42 -\(en VPN type -.IP "\fI[user <username>]\fP" 42 -\(en VPN username -.RE -.RS -.TP -.B olpc-mesh: -.IP "\fIssid <SSID>\fP" 42 -\(en SSID -.IP "\fI[channel <1-13>]\fP" 42 -\(en channel to use for the network -.IP "\fI[dhcp-anycast <MAC address>]\fP" 42 -\(en anycast DHCP MAC address used when requesting an IP address via DHCP -.RE -.RS -.TP -.B adsl: -.IP "\fIusername <username>\fP" 42 -\(en ADSL user name -.IP "\fIprotocol pppoa|pppoe|ipoatm\fP" 42 -\(en ADSL protocol -.IP "\fI[password <password>]\fP" 42 -\(en ADSL password -.IP "\fI[encapsulation vcmux|llc]\fP" 42 -\(en ADSL encapsulation -.RE -.RS -.TP -.B tun: -.IP "\fImode tun|tap\fP" 42 -\(en Mode for the device -.IP "\fI[owner <UID>]\fP" 42 -\(en UID of the owner -.IP "\fI[group <GID>]\fP" 42 -\(en GID of the group -.IP "\fI[pi yes|no>]\fP" 42 -\(en include packet information (~IFF_NO_PI flag) -.IP "\fI[vnet-hdr yes|no>]\fP" 42 -\(en send and receive large (i.e. GSO) packets and packets with partial checksums (IFF_VNET_HDR flag) -.IP "\fI[multi-queue yes|no>]\fP" 42 -\(en multi-queue support for tun/tap device (IFF_MULTI_QUEUE flag) -.RE -.RS -.TP -.B ip-tunnel: -.IP "\fImode ipip|gre|sit|isatap|vti|ip6ip6|ipip6|ip6gre|vti6\fP" 42 -\(en tunnel mode -.IP "\fIremote <remote endpoint IP>\fP" 42 -\(en IPv4 or IPv6 address of the remote tunnel endpoint -.IP "\fI[local <local endpoint IP>]\fP" 42 -\(en IPv4 or IPv6 address of the local tunnel endpoint -.IP "\fI[dev <parent device (ifname or connection UUID)>]\fP" 42 -\(en device to use for tunnel endpoint communication -.RE -.RS -.TP -.B macvlan: -.IP "\fIdev <parent device (connection UUID, ifname, or MAC)>\fP" 42 -\(en parent device this MACVLAN is on -.IP "\fImode vepa|bridge|private|passthru|source\fP" 42 -\(en MACVLAN mode, which specifies the communication mechanism between multiple MACVLANs on the same lower device -.IP "\fI[tap yes|no]\fP" 42 -\(en controls the device type. If set to 'yes' a MACVTAP will be created (default: no) -.RE -.RS -.TP -.B vxlan: -.IP "\fIid <VXLAN ID>\fP" 42 -\(en VXLAN Network Identifer to use -.IP "\fIremote <IP>\fP" 42 -\(en unicast destination IP address or multicast IP address to join -.IP "\fI[dev <parent device (ifname or connection UUID)>]\fP" 42 -\(en device to use for tunnel endpoint communication -.IP "\fI[local <IP>]\fP" 42 -\(en source IP address -.IP "\fI[source-port-min <0-65535>]\fP" 42 -\(en minimum UDP source port to communicate to the remote VXLAN tunnel endpoint -.IP "\fI[source-port-max <0-65535>]\fP" 42 -\(en maximum UDP source port to communicate to the remote VXLAN tunnel endpoint -.IP "\fI[destination-port <0-65535>]\fP" 42 -\(en UDP destination port to communicate to the remote VXLAN tunnel endpoint -.RE -.RS -.TP -.B IP_OPTIONS: -.IP "\fI[ip4 <IPv4 address>] [gw4 <IPv4 gateway>]\fP" 42 -\(en IPv4 addresses -.IP "\fI[ip6 <IPv6 address>] [gw6 <IPv6 gateway>]\fP" 42 -\(en IPv6 addresses -.RE -.RS -If a \fI--\fP argument is encountered, the rest of command line is interpreted -as property list in the same format as \fIconnection modify\fP command accepts. -This makes it possible to adjust the connection properties before it's added. -.RE -.TP -.B edit [id | uuid | path ] <ID> - edit an existing connection -.RE -.RS -.B edit [type <new connection type>] [con-name <new connection name>] - add a new connection -.RS -Edit an existing connection or add a new one, using an interactive editor. -.br -The existing connection is identified by its name, UUID or D-Bus path. -If <ID> is ambiguous, a keyword \fIid\fP, \fIuuid\fP, or \fIpath\fP can be used. -See \fBconnection show\fP above for the description of the <ID>-specifying keywords. -Not providing an <ID> means that a new connection will be added. -.sp -The interactive editor will guide you through the connection editing and -allow you to change connection parameters according to your needs by means of -a simple menu-driven interface. The editor indicates what settings and -properties can be modified and provides in-line help. -.sp -.PP -Available options: -.IP \fItype\fP 13 -\(en type of the new connection; valid types are the same as for \fIconnection add\fP command -.IP \fIcon-name\fP 13 -\(en name for the new connection. It can be changed later in the editor. -.RE -.RS -.sp -See also \fInm-settings\fP(5) for all NetworkManager settings and property names, and their -descriptions; and \fInmcli-examples\fP(5) for sample editor sessions. -.RE -.TP -.B modify [--temporary] [ id | uuid | path ] <ID> [+|-]<setting>.<property> <value> -.B [+|-]<setting>.<property> <value> ... -.br -Modify one or more properties in the connection profile. -.br -The connection is identified by its name, UUID or D-Bus path. If <ID> is -ambiguous, a keyword \fIid\fP, \fIuuid\fP or \fIpath\fP can be used. See -\fInm-settings\fP(5) for setting and property names, their descriptions and -default values. This command supports abbreviations for \fIsetting name\fP and -\fIproperty name\fP provided they are unique. Empty \fIvalue\fP ("") removes -the property value (sets the property to the default value). The provided -value overwrites the existing property value. -.br -If you want to append an item to the existing value, use \fI+\fP prefix for the -property name. If you want to remove just one item from container-type -property, use \fI-\fP prefix for the property name and specify a value or an -zero-based index of the item to remove (or option name for properties with -named options) as \fIvalue\fP. Of course, \fI+|-\fP only have a real effect for -multi-value (container) properties like ipv4.dns, ipv4.addresses, bond.options, -etc. -.br -The changes to the connection profile will be saved persistently by -NetworkManager, unless \fI--temporary\fP option is provided, in which case the -changes won't persist over NetworkManager restart. -.TP -.B clone [--temporary] [ id | uuid | path ] <ID> <new name> -.br -Clone a connection. The connection to be cloned is identified by its -name, UUID or D-Bus path. If <ID> is ambiguous, a keyword \fIid\fP, -\fIuuid\fP or \fIpath\fP can be used. See \fBconnection show\fP above for -the description of the <ID>-specifying keywords. \fI<new name>\fP is the name -of the new cloned connection. The new connection will be the exact copy except -the connection.id (\fI<new name>\fP) and connection.uuid (generated) -properties. -.br -The new connection profile will be saved as persistent unless \fI--temporary\fP -option is specified, in which case the new profile won't exist after NetworkManager -restart. -.TP -.B delete [ id | uuid | path ] <ID> ... -.br -Delete a configured connection. The connection to be deleted is identified by -its name, UUID or D-Bus path. If <ID> is ambiguous, a keyword \fIid\fP, -\fIuuid\fP or \fIpath\fP can be used. -.br -See \fBconnection show\fP above for the description of the <ID>-specifying keywords. -.br -If '--wait' option is not specified, the default timeout will be 10 seconds. -.TP -.B monitor [ id | uuid | path ] <ID> ... -.br -Monitor connection profile activity. This command prints a line whenever the -specified connection changes. The connection to be monitored is identified by -its name, UUID or D-Bus path. If <ID> is ambiguous, a keyword \fIid\fP, -\fIuuid\fP or \fIpath\fP can be used. -.br -See \fBconnection show\fP above for the description of the <ID>-specifying keywords. -.br -Monitors all connection profiles in case none is specified. The command terminates -when all monitored connections disappear. If you want to monitor connection creation -consider using the global monitor with \fInmcli monitor\fP command. -.TP -.B reload -.br -Reload all connection files from disk. \fINetworkManager\fP does not monitor -changes to connection files by default. So you need to use this command in order -to tell \fINetworkManager\fP to re-read the connection profiles from disk when -a change was made to them. However, the auto-loading feature can be enabled and -then \fINetworkManager\fP will reload connection files any time they change -(monitor-connection-files=true in \fINetworkManager.conf\fP(5)). -.TP -.B load <filename> [<filename>...] -.br -Load/reload one or more connection files from disk. Use this after manually -editing a connection file to ensure that \fBNetworkManager\fP is aware -of its latest state. -.TP -.B import [--temporary] type <type> file <file to import> -.br -Import an external/foreign configuration as a NetworkManager connection profile. -The type of the input file is specified by \fItype\fP option. -.br -Only VPN configurations are supported at the moment. The configuration -is imported by NetworkManager VPN plugins. \fItype\fP values are the same as for -\fIvpn-type\fP option in \fBnmcli connection add\fP. VPN configurations are -imported by VPN plugins. Therefore the proper VPN plugin has to be installed -so that nmcli could import the data. -.br -The imported connection profile will be saved as persistent unless \fI--temporary\fP -option is specified, in which case the new profile won't exist after NetworkManager -restart. -.TP -.B export [ id | uuid | path ] <ID> [<output file>] -.br -Export a connection. -.br -Only VPN connections are supported at the moment. A proper VPN plugin has to be -installed so that nmcli could export a connection. If no \fI<output file>\fP is -provided, the VPN configuration data will be printed to standard output. -.RE - -.TP -.B device - show and manage network interfaces -.br -.TP -.SS \fICOMMAND\fP := { status | show | set | connect | reapply | disconnect | delete | monitor | wifi | lldp } -.sp -.RS -.TP -.B status -.br -Print status of devices. -.br -This is the default action if no command is specified to \fIdevice\fP object. -.TP -.B show [<ifname>] -.br -Show detailed information about devices. Without an argument, all devices are -examined. To get information for a specific device, the interface name has -to be provided. -.TP -.TP -.B set [ifname] <ifname> [autoconnect yes|no] [managed yes|no] -.br -Set device properties. -.TP -.B connect <ifname> -.br -Connect the device. NetworkManager will try to find a suitable connection that -will be activated. It will also consider connections that are not set to auto connect. -.br -If '--wait' option is not specified, the default timeout will be 90 seconds. -.TP -.B reapply <ifname> -.br -Attempt to update device with changes to the currently active connection -made since it was last applied. -.TP -.B disconnect <ifname> ... -.br -Disconnect a device and prevent the device from automatically activating further -connections without user/manual intervention. Note that disconnecting software -devices may mean that the devices will disappear. -.br -If '--wait' option is not specified, the default timeout will be 10 seconds. -.TP -.B delete <ifname> ... -.br -Delete a device. The command removes the interface from the system. Note that -this only works for software devices like bonds, bridges, teams, etc. -Hardware devices (like Ethernet) cannot be deleted by the command. -.br -If '--wait' option is not specified, the default timeout will be 10 seconds. -.TP -.B monitor [<ifname>] ... -.br -Monitor device activity. This command prints a line whenever the specified devices -change state. -.br -Monitors all devices in case no interface is specified. The monitor terminates when -all specified devices disappear. If you want to monitor device addition consider -using the global monitor with \fInmcli monitor\fP command. -.TP -.B wifi [list [ifname <ifname>] [bssid <BSSID>]] -.br -List available Wi\(hyFi access points. The \fIifname\fP and \fIbssid\fP options -can be used to list APs for a particular interface or with a specific BSSID, -respectively. -.TP -.B wifi connect <(B)SSID> [password <password>] [wep\-key\-type key|phrase] [ifname <ifname>] [bssid <BSSID>] [name <name>] -.B [private yes|no] [hidden yes|no] -.br -Connect to a Wi\(hyFi network specified by SSID or BSSID. The command creates a new -connection and then activates it on a device. This is a command\(hyline counterpart -of clicking an SSID in a GUI client. The command always creates a new connection -and thus it is mainly useful for connecting to new Wi\(hyFi networks. If a connection -for the network already exists, it is better to bring up (activate) the existing connection -as follows: \fInmcli con up id <name>\fP. Note that only open, WEP and WPA\(hyPSK networks -are supported at the moment. It is also supposed that IP configuration is obtained via -DHCP. -.br -If '--wait' option is not specified, the default timeout will be 90 seconds. -.RS -.PP -Available options are: -.IP \fIpassword\fP 13 -\(en password for secured networks (WEP or WPA) -.IP \fIwep\-key\-type\fP 13 -\(en type of WEP secret, either \fIkey\fP for ASCII/HEX key or \fIphrase\fP for passphrase -.IP \fIifname\fP 13 -\(en interface that will be used for activation -.IP \fIbssid\fP 13 -\(en if specified, the created connection will be restricted just for the BSSID -.IP \fIname\fP 13 -\(en if specified, the connection will use the name (else NM creates a name itself) -.IP \fIprivate\fP 13 -\(en if set to \fByes\fP, the connection will only be visible to the user who created it. -Otherwise the connection is system\(hywide, which is the default. -.IP \fIhidden\fP 13 -\(en set to \fByes\fP when connecting for the first time to an AP not broadcasting its SSID. -Otherwise the SSID would not be found and the connection attempt would fail. -.RE -.TP -.B wifi hotspot [ifname <ifname>] [con-name <name>] [ssid <SSID>] [band a|bg] [channel <channel>] [password <password>] -.br -Create a Wi-Fi hotspot. The command creates a hotspot connection profile according to -Wi-Fi device capabilities and activates it on the device. The hotspot is secured with WPA -if device/driver supports that, otherwise WEP is used. -Use \fIconnection down\fP or \fIdevice disconnect\fP to stop the hotspot. -.br -.RS -.PP -Parameters of the hotspot can be influenced by the optional parameters: -.IP \fIifname\fP 17 -\(en what Wi-Fi device is used -.IP \fIcon-name\fP 17 -\(en name of the created hotspot connection profile -.IP \fIssid\fP 17 -\(en SSID of the hotspot -.IP \fIband\fP 17 -\(en Wi-Fi band to use -.IP \fIchannel\fP 17 -\(en Wi-Fi channel to use -.IP \fIpassword\fP 17 -\(en password to use for the created hotspot. If not provided, -nmcli will generate a password. The password is either WPA -pre-shared key or WEP key. -.PP -Note that \fI--show-secrets\fP global option can be used to print the hotspot -password. It is useful especially when the password was generated. -.RE -.TP -.B wifi rescan [ifname <ifname>] [[ssid <SSID>] ...] -.br -Request that \fINetworkManager\fP immediately re-scan for available access points. -NetworkManager scans Wi\(hyFi networks periodically, but in some cases it can be -useful to start scanning manually (e.g. after resuming the computer). By using -\fIssid\fP, it is possible to scan for a specific SSID, which is useful for APs -with hidden SSIDs. You can provide multiple \fIssid\fP parameters in order to -scan more SSIDs. -.br -This command does not show the APs, use 'nmcli device wifi list' for that. -.TP -.B lldp [list [ifname <ifname>]] -.br -Display information about neighboring devices learned through the Link -Layer Discovery Protocol (LLDP). The \fIifname\fP option can be used to -list neighbors only for a given interface. The protocol must be -enabled in the connection settings. -.RE - -.TP -.B agent \- run nmcli as a NetworkManager secret agent, or polkit agent -.br -.TP -.SS \fICOMMAND\fP := { secret | polkit | all } -.sp -.RS -.TP -.B secret -.br -Register nmcli as a NetworkManager secret agent and listen for secret requests. -You do usually not need this command, because nmcli can handle secrets when -connecting to networks. However, you may find the command useful when you use -another tool for activating connections and you do not have a secret agent -available (like nm-applet). -.TP -.B polkit -.br -Register nmcli as a polkit agent for the user session and listen for -authorization requests. You do not usually need this command, because nmcli can -handle polkit actions related to NetworkManager operations (when run with ---ask). However, you may find the command useful when you want to run a simple -text based polkit agent and you do not have an agent of a desktop environment. -Note that running this command makes nmcli handle all polkit requests, not only -NetworkManager related ones, because only one polkit agent can run for the -session. -.TP -.B all -.br -Runs nmcli as both NetworkManager secret and a polkit agent. -.RE - -.SH ENVIRONMENT VARIABLES -\fInmcli\fP's behavior is affected by the following environment variables. -.IP "LC_ALL" 13 -If set to a non\(hyempty string value, it overrides the values of all the other -internationalization variables. -.IP "LC_MESSAGES" 13 -Determines the locale to be used for internationalized messages. -.IP "LANG" 13 -Provides a default value for the internationalization variables that are unset -or null. - -.RE -Internationalization notes: -.br -Be aware that \fInmcli\fP is localized and that is why the output depends on -your environment. This is important to realize especially when you parse the -output. -.br -Call \fInmcli\fP as \fBLC_ALL=C nmcli\fP to be sure the locale is -set to "C" while executing in a script. - -\fBLC_ALL\fP, \fBLC_MESSAGES\fP, \fBLANG\fP variables specify the LC_MESSAGES -locale category (in that order), which determines the language that \fInmcli\fP -uses for messages. The "C" locale is used if none of these variables are set, -and this locale uses English messages. - -.SH EXIT STATUS -\fInmcli\fP exits with status 0 if it succeeds, a value greater than 0 is -returned if an error occurs. -.IP "0" 4 -Success \(en indicates the operation succeeded -.IP "1" 4 -Unknown or unspecified error -.IP "2" 4 -Invalid user input, wrong \fInmcli\fP invocation -.IP "3" 4 -Timeout expired (see \fI\-\-wait\fP option) -.IP "4" 4 -Connection activation failed -.IP "5" 4 -Connection deactivation failed -.IP "6" 4 -Disconnecting device failed -.IP "7" 4 -Connection deletion failed -.IP "8" 4 -NetworkManager is not running -.IP "9" 4 -\fInmcli\fP and \fINetworkManager\fP versions mismatch -.IP "10" 4 -Connection, device, or access point does not exist. - -.SH EXAMPLES -.PP -This section presents various examples of nmcli usage. If you want even more, -please refer to \fInmcli-examples\fP(5) manual page. -.sp -.IP "\fB\f(CWnmcli \-t \-f RUNNING general\fP\fP" -.IP -tells you whether NetworkManager is running or not. - -.IP "\fB\f(CWnmcli \-t \-f STATE general\fP\fP" -.IP -shows the overall status of NetworkManager. - -.IP "\fB\f(CWnmcli radio wifi off\fP\fP" -.IP -switches Wi\(hyFi off. - -.IP "\fB\f(CWnmcli connection show\fP\fP" -.IP -lists all connections NetworkManager has. - -.IP "\fB\f(CWnmcli \-p \-m multiline \-f all con show\fP\fP" -.IP -shows all configured connections in multi-line mode. - -.IP "\fB\f(CWnmcli connection show --active\fP\fP" -.IP -lists all currently active connections. - -.IP "\fB\f(CWnmcli \-f name,autoconnect c s\fP\fP" -.IP -shows all connection profile names and their auto-connect property. - -.IP "\fB\f(CWnmcli \-p connection show \(dq\&My default em1\(dq\&\fP\fP" -.IP -shows details for "My default em1" connection profile. - -.IP "\fB\f(CWnmcli --show-secrets connection show \(dq\&My Home WiFi\(dq\&\fP\fP" -.IP -shows details for "My Home WiFi" connection profile with all passwords. -Without \fI--show-secrets\fP option, secrets would not be displayed. - -.IP "\fB\f(CWnmcli \-f active connection show \(dq\&My default em1\(dq\&\fP\fP" -.IP -shows details for "My default em1" active connection, like IP, DHCP -information, etc. - -.IP "\fB\f(CWnmcli -f profile con s \(dq\&My wired connection\(dq\&\fP\fP" -.IP -shows static configuration details of the connection profile with "My wired connection" name. - -.IP "\fB\f(CWnmcli \-p con up \(dq\&My wired connection\(dq\& ifname eth0\fP\fP" -.IP -activates the connection profile with name "My wired connection" on interface eth0. -The \-p option makes nmcli show progress of the activation. - -.IP "\fB\f(CWnmcli con up 6b028a27\-6dc9\-4411\-9886\-e9ad1dd43761 ap 00:3A:98:7C:42:D3\fP\fP" -.IP -connects the Wi\(hyFi connection with UUID 6b028a27\-6dc9\-4411\-9886\-e9ad1dd43761 to the AP -with BSSID 00:3A:98:7C:42:D3. - -.IP "\fB\f(CWnmcli device status\fP\fP" -.IP -shows the status for all devices. - -.IP "\fB\f(CWnmcli dev disconnect em2\fP\fP" -.IP -disconnects a connection on interface em2 and marks the device as unavailable for -auto\(hyconnecting. As a result, no connection will automatically be activated on the -device until the device's 'autoconnect' is set to TRUE or the user manually activates -a connection. - -.IP "\fB\f(CWnmcli \-f GENERAL,WIFI\-PROPERTIES dev show wlan0\fP\fP" -.IP -shows details for wlan0 interface; only GENERAL and WIFI\-PROPERTIES sections will be shown. - -.IP "\fB\f(CWnmcli \-f CONNECTIONS device show wlp3s0\fP\fP" -.IP -shows all available connection profiles for your Wi-Fi interface wlp3s0. - -.IP "\fB\f(CWnmcli dev wifi\fP\fP" -.IP -lists available Wi\(hyFi access points known to NetworkManager. - -.IP "\fB\f(CWnmcli dev wifi con \(dq\&Cafe Hotspot 1\(dq\& password caffeine name \(dq\&My cafe\(dq\&\fP\fP" -.IP -creates a new connection named "My cafe" and then connects it to "Cafe Hotspot 1" SSID -using password "caffeine". This is mainly useful when connecting to "Cafe Hotspot 1" for -the first time. Next time, it is better to use 'nmcli con up id "My cafe"' so that the -existing connection profile can be used and no additional is created. - -.IP "\fB\f(CWnmcli -s dev wifi hotspot con-name QuickHotspot\fP\fP" -.IP -creates a hotspot profile and connects it. Prints the hotspot password the user should use -to connect to the hotspot from other devices. - -.IP "\fB\f(CWnmcli connection add type ethernet autoconnect no ifname eth0\fP\fP" -.IP -non-interactively adds an Ethernet connection tied to eth0 interface with automatic IP configuration (DHCP), -and disables the connection's "autoconnect" flag. - -.IP "\fB\f(CWnmcli c a ifname Maxipes\(hyfik type vlan dev eth0 id 55\fP\fP" -.IP -non-interactively adds a VLAN connection with ID 55. The connection will use eth0 and the VLAN interface -will be named Maxipes\(hyfik. - -.IP "\fB\f(CWnmcli c a ifname eth0 type ethernet -- ipv4.method disabled ipv6.method link-local\fP\fP" -.IP -non-interactively adds a connection that will use eth0 Ethernet interface and only have an IPv6 link-local -address configured. - -.IP "\fB\f(CWnmcli connection edit ethernet\-em1\-2\fP\fP" -.IP -edits existing "ethernet\(hyem1\(hy2" connection in the interactive editor. - -.IP "\fB\f(CWnmcli connection edit type ethernet con-name \(dq\&yet another Ethernet connection\(dq\&\fP\fP" -.IP -adds a new Ethernet connection in the interactive editor. - -.IP "\fB\f(CWnmcli con mod ethernet\-2 connection.autoconnect no\fP\fP" -.IP -modifies 'autoconnect' property in the 'connection' setting of 'ethernet\(hy2' connection. - -.IP "\fB\f(CWnmcli con mod \(dq\&Home Wi\-Fi\(dq\& wifi.mtu 1350\fP\fP" -.IP -modifies 'mtu' property in the 'wifi' setting of 'Home Wi\(hyFi' connection. - -.IP "\fB\f(CWnmcli con mod em1-1 ipv4.method manual ipv4.addr \(dq\&192.168.1.23/24 192.168.1.1, 10.10.1.5/8, 10.0.0.11\(dq\&\fP\fP" -.IP -sets manual addressing and the addresses in em1-1 profile. - -.IP "\fB\f(CWnmcli con modify ABC +ipv4.dns 8.8.8.8\fP\fP" -.IP -appends a Google public DNS server to DNS servers in ABC profile. - -.IP "\fB\f(CWnmcli con modify ABC -ipv4.addresses \(dq\&192.168.100.25/24 192.168.1.1\(dq\&\fP\fP" -.IP -removes the specified IP address from (static) profile ABC. - -.IP "\fB\f(CWnmcli con import type openvpn file ~/Downloads/frootvpn.ovpn\fP\fP" -.IP -imports an OpenVPN configuration to NetworkManager. - -.IP "\fB\f(CWnmcli con export corp-vpnc /home/joe/corpvpn.conf\fP\fP" -.IP -exports NetworkManager VPN profile corp-vpnc as standard Cisco (vpnc) configuration. - -.SH NOTES -\fInmcli\fP accepts abbreviations, as long as they are a unique prefix in the set -of possible options. As new options get added, these abbreviations are not guaranteed -to stay unique. For scripting and long term compatibility it is therefore strongly -advised to spell out the full option names. - -.SH BUGS -There are probably some bugs. If you find a bug, please report it to -https://bugzilla.gnome.org/ \(em product \fINetworkManager\fP. - -.SH SEE ALSO -.BR nmcli\-examples (5), -.BR nm\-online (1), -.BR NetworkManager (8), -.BR NetworkManager.conf (5), -.BR nm\-settings (5), -.BR nm\-applet (1), -.BR nm\-connection\-editor (1). diff --git a/man/nmcli.xml b/man/nmcli.xml new file mode 100644 index 0000000000..6195466787 --- /dev/null +++ b/man/nmcli.xml @@ -0,0 +1,3116 @@ +<?xml version='1.0'?> +<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "common.ent" > +%entities; +]> + +<!-- + nmcli(1) manual page + + This is free documentation; you can redistribute it and/or + modify it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 2 of + the License, or (at your option) any later version. + + The GNU General Public License's references to "object code" + and "executables" are to be interpreted as the output of any + document formatting or typesetting system, including + intermediate and printed output. + + This manual 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 General Public License for more details. + + You should have received a copy of the GNU General Public Licence along + with this manual; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + + Copyright 2010 - 2016 Red Hat, Inc. +--> + +<refentry id='nmcli'> + + <refentryinfo> + <title>nmcli</title> + <author>NetworkManager developers</author> + </refentryinfo> + + <refmeta> + <refentrytitle>nmcli</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class="source">NetworkManager</refmiscinfo> + <refmiscinfo class="manual">General Commands Manual</refmiscinfo> + <refmiscinfo class="version">&NM_VERSION;</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>nmcli</refname> + <refpurpose>command-line tool for controlling NetworkManager</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command>nmcli</command> + <arg choice="opt" rep="repeat"><replaceable>OPTIONS</replaceable></arg> + <group choice='req'> + <arg choice='plain'><option>help</option></arg> + <arg choice='plain'><option>general</option></arg> + <arg choice='plain'><option>networking</option></arg> + <arg choice='plain'><option>radio</option></arg> + <arg choice='plain'><option>connection</option></arg> + <arg choice='plain'><option>device</option></arg> + <arg choice='plain'><option>agent</option></arg> + <arg choice='plain'><option>monitor</option></arg> + </group> + <arg><replaceable>COMMAND</replaceable></arg> + <arg rep="repeat"><replaceable>ARGUMENTS</replaceable></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'><title>Description</title> + <para><command>nmcli</command> is a command-line tool for controlling + NetworkManager and reporting network status. It can be utilized as a + replacement for <command>nm-applet</command> or other graphical clients. + <command>nmcli</command> is used to create, display, edit, delete, activate, + and deactivate network connections, as well as control and display network + device status.</para> + + <para>Typical uses include:</para> + <itemizedlist> + <listitem> + <para>Scripts: Utilize NetworkManager via <command>nmcli</command> instead of + managing network connections manually. <command>nmcli</command> supports a + terse output format which is better suited for script processing. Note that + NetworkManager can also execute scripts, called "dispatcher scripts", in + response to network events. See + <citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry> + for details about these dispatcher scripts.</para> + </listitem> + + <listitem> + <para>Servers, headless machines, and terminals: <command>nmcli</command> can + be used to control NetworkManager without a GUI, including creating, editing, + starting and stopping network connections and viewing network status.</para> + </listitem> + </itemizedlist> + </refsect1> + + <refsect1 id='options'><title>Options</title> + <variablelist> + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-t</option></arg> + <arg choice='plain'><option>--terse</option></arg> + </group></term> + + <listitem> + <para>Output is terse. This mode is designed and suitable for computer (script) + processing.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-p</option></arg> + <arg choice='plain'><option>--pretty</option></arg> + </group></term> + + <listitem> + <para>Output is pretty. This causes <command>nmcli</command> to produce easily + readable outputs for humans, i.e. values are aligned, headers are printed, + etc.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-m</option></arg> + <arg choice='plain'><option>--mode</option></arg> + <group choice='req'> + <arg choice='plain'>tabular</arg> + <arg choice='plain'>multiline</arg> + </group> + </group></term> + + <listitem> + <para>Switch between tabular and multiline output:</para> + + <variablelist> + <varlistentry> + <term><arg choice='plain'>tabular</arg></term> + <listitem> + <para>Output is a table where each line describes a single entry. + Columns define particular properties of the entry.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><arg choice='plain'>multiline</arg></term> + <listitem> + <para>Each entry comprises multiple lines, each property on its + own line. The values are prefixed with the property name.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>If omitted, default is <literal>tabular</literal> for most commands. + For the commands producing more structured information, that cannot be + displayed on a single line, default is <literal>multiline</literal>. + Currently, they are:</para> + + <itemizedlist> + <listitem> + <para><literal>nmcli connection show <replaceable>ID</replaceable></literal></para> + </listitem> + + <listitem> + <para><literal>nmcli device show</literal></para> + </listitem> + </itemizedlist> + + </listitem> + </varlistentry> + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-c</option></arg> + <arg choice='plain'><option>--colors</option></arg> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + <arg choice='plain'>auto</arg> + </group> + </group></term> + + <listitem> + <para>This option controls color output (using terminal escape sequences). + <literal>yes</literal> enables colors, <literal>no</literal> disables them, + <literal>auto</literal> only produces colors when standard output is directed + to a terminal. The default value is <literal>auto</literal>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-f</option></arg> + <arg choice='plain'><option>--fields</option></arg> + <group choice='req'> + <arg conice='plain' rep='repeat'><replaceable>field</replaceable></arg> + <arg choice='plain'>all</arg> + <arg choice='plain'>common</arg> + </group> + </group></term> + + <listitem> + <para>This option is used to specify what fields (column names) should be + printed. Valid field names differ for specific commands. List available fields + by providing an invalid value to the <option>--fields</option> option. + <literal>all</literal> is used to print all valid field values of the + command. <literal>common</literal> is used to print common field values of + the command.</para> + + <para>If omitted, default is <literal>common</literal>. The option is + mandatory when <option>--terse</option> is used. In this case, generic values + <literal>all</literal> and <literal>common</literal> cannot be used. This + is to maintain compatibility when new fields are added in the future.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-e</option></arg> + <arg choice='plain'><option>--escape</option></arg> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + </group> + </group></term> + + <listitem> + <para>Whether to escape <literal>:</literal> and <literal>\</literal> characters in terse tabular mode. The + escape character is <literal>\</literal>.</para> + + <para>If omitted, default is <literal>yes</literal>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-n</option></arg> + <arg choice='plain'><option>--nocheck</option></arg> + </group></term> + + <listitem> + <para>This option can be used to force <command>nmcli</command> to skip + checking <command>nmcli</command> and <command>NetworkManager</command> + version compatibility. Use it with care, because using incompatible versions + may produce incorrect results.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-a</option></arg> + <arg choice='plain'><option>--ask</option></arg> + </group></term> + + <listitem> + <para>When using this option <command>nmcli</command> will stop and ask for any + missing required arguments, so do not use this option for non-interactive + purposes like scripts. This option controls, for example, whether you will be + prompted for a password if it is required for connecting to a network.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-s</option></arg> + <arg choice='plain'><option>--show-secrets</option></arg> + </group></term> + + <listitem> + <para>When using this option <command>nmcli</command> will display passwords + and secrets that might be present in an output of an operation. This option + also influences echoing passwords typed by user as an input.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><arg> + <group choice='plain'> + <arg choice='plain'><option>-w</option></arg> + <arg choice='plain'><option>--wait</option></arg> + </group> + <arg choice='plain' rep='repeat'><replaceable>seconds</replaceable></arg> + </arg></term> + + <listitem> + <para>This option sets a timeout period for which <command>nmcli</command> will + wait for NetworkManager to finish operations. It is + especially useful for commands that may take a longer time to complete, e.g. + connection activation.</para> + + <para>Specifying a value of <literal>0</literal> instructs + <command>nmcli</command> not to wait but to exit immediately with a status of + success. The default value depends on the executed command.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-v</option></arg> + <arg choice='plain'><option>--version</option></arg> + </group></term> + + <listitem> + <para>Show <command>nmcli</command> version.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><group choice='plain'> + <arg choice='plain'><option>-h</option></arg> + <arg choice='plain'><option>--help</option></arg> + </group></term> + + <listitem> + <para>Print help information.</para> + </listitem> + </varlistentry> + + </variablelist> + </refsect1> + + <refsect1 id='general'><title>General Commands</title> + + <cmdsynopsis> + <command>nmcli general</command> + <group choice='req'> + <arg choice='plain'><command>status</command></arg> + <arg choice='plain'><command>hostname</command></arg> + <arg choice='plain'><command>permissions</command></arg> + <arg choice='plain'><command>logging</command></arg> + </group> + <arg rep='repeat'><replaceable>ARGUMENTS</replaceable></arg> + </cmdsynopsis> + + <para>Use this command to show NetworkManager status and permissions. You can also get + and change system hostname, as well as NetworkManager logging level and domains.</para> + + <variablelist> + + <varlistentry> + <term><command>status</command></term> + + <listitem> + <para>Show overall status of NetworkManager. This is the default action, when + no additional command is provided for <command>nmcli general</command>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>hostname</command> + <arg><replaceable>hostname</replaceable></arg> + </term> + + <listitem> + <para>Get and change system hostname. With no arguments, this prints currently + configured hostname. When you pass a hostname, it will be handed over to + NetworkManager to be set as a new system hostname.</para> + + <para>Note that the term "system" hostname may also be referred to as + "persistent" or "static" by other programs or tools. The hostname is stored + in <filename>/etc/hostname</filename> file in most distributions. For example, + systemd-hostnamed service uses the term "static" hostname and it only reads + the <filename>/etc/hostname</filename> file when it starts.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><command>permissions</command></term> + + <listitem> + <para>Show the permissions a caller has for various authenticated operations + that NetworkManager provides, like enable and disable networking, changing + Wi-Fi and WWAN state, modifying connections, etc.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>logging</command> + <arg><option>level</option> <replaceable>level</replaceable></arg> + <arg rep='repeat'><option>domain</option> <replaceable>domains</replaceable></arg> + </term> + + <listitem> + <para>Get and change NetworkManager logging level and + domains. Without any argument current logging level and domains are shown. In + order to change logging state, provide <option>level</option> and, or, + <option>domain</option> parameters. See + <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> + for available level and domain values.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id='networking'><title>Networking Control Commands</title> + + <cmdsynopsis> + <command>nmcli networking</command> + <group choice='req'> + <arg choice='plain'><command>on</command></arg> + <arg choice='plain'><command>off</command></arg> + <arg choice='plain'><command>connectivity</command></arg> + </group> + <arg rep='repeat'><replaceable>ARGUMENTS</replaceable></arg> + </cmdsynopsis> + + <para>Query NetworkManager networking status, enable and disable networking. + </para> + + <variablelist> + + <varlistentry> + <term><command>on</command></term> + <term><command>off</command></term> + + <listitem> + <para>Enable enable or disable networking control by NetworkManager. + All interfaces managed by NetworkManager are deactivated when networking + is disabled.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>connectivity</command> + <arg>check</arg> + </term> + + <listitem> + <para>Get network connectivity state. The optional <option>check</option> + argument tells NetworkManager to re-check the connectivity, else the most + recent known connectivity state is displayed without re-checking.</para> + + <para>Possible states are:</para> + + <variablelist> + <varlistentry> + <term><arg choice='plain'>none</arg></term> + <listitem> + <para>the host is not connected to any network.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><arg choice='plain'>portal</arg></term> + <listitem> + <para>the host is behind a captive portal and cannot reach the full Internet.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><arg choice='plain'>limited</arg></term> + <listitem> + <para>the host is connected to a network, but it has no access to the Internet.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><arg choice='plain'>full</arg></term> + <listitem> + <para>the host is connected to a network and has full access to the Internet.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><arg choice='plain'>unknown</arg></term> + <listitem> + <para>the connectivity status cannot be found out.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + </variablelist> + </refsect1> + + <refsect1 id='radio'><title>Radio Transmission Control Commands</title> + + <cmdsynopsis> + <command>nmcli radio</command> + <group choice='req'> + <arg choice='plain'><command>all</command></arg> + <arg choice='plain'><command>wifi</command></arg> + <arg choice='plain'><command>wwan</command></arg> + </group> + <arg rep='repeat'><replaceable>ARGUMENTS</replaceable></arg> + </cmdsynopsis> + + <para>Show radio switches status, or enable and disable the switches.</para> + + <variablelist> + + <varlistentry> + <term> + <command>wifi</command> + <group> + <arg choice='plain'>on</arg> + <arg choice='plain'>off</arg> + </group> + </term> + + <listitem> + <para>Show or set status of Wi-Fi in NetworkManager. If no arguments are + supplied, Wi-Fi status is printed; <option>on</option> enables Wi-Fi; + <option>off</option> disables Wi-Fi.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>wwan</command> + <group> + <arg choice='plain'>on</arg> + <arg choice='plain'>off</arg> + </group> + </term> + + <listitem> + <para>Show or set status of WWAN (mobile broadband) in NetworkManager. If no + arguments are supplied, mobile broadband status is printed; + <option>on</option> enables mobile broadband, <option>off</option> + disables it.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>all</command> + <group> + <arg choice='plain'>on</arg> + <arg choice='plain'>off</arg> + </group> + </term> + + <listitem> + <para>Show or set all previously mentioned radio switches at the same time.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id='monitor'><title>Activity Monitor</title> + + <cmdsynopsis> + <command>nmcli monitor</command> + </cmdsynopsis> + + <para>Observe NetworkManager activity. Watches for changes + in connectivity state, devices or connection profiles.</para> + + <para>See also <command>nmcli connection monitor</command> + and <command>nmcli device monitor</command> to watch + for changes in certain devices or connections.</para> + </refsect1> + + <refsect1 id='connection'><title>Connection Management Commands</title> + + <cmdsynopsis> + <command>nmcli connection</command> + <group choice='req'> + <arg choice='plain'><command>show</command></arg> + <arg choice='plain'><command>up</command></arg> + <arg choice='plain'><command>down</command></arg> + <arg choice='plain'><command>add</command></arg> + <arg choice='plain'><command>edit</command></arg> + <arg choice='plain'><command>modify</command></arg> + <arg choice='plain'><command>delete</command></arg> + <arg choice='plain'><command>monitor</command></arg> + <arg choice='plain'><command>reload</command></arg> + <arg choice='plain'><command>load</command></arg> + </group> + <arg rep='repeat'><replaceable>ARGUMENTS</replaceable></arg> + </cmdsynopsis> + + <para>NetworkManager stores all network configuration as "connections", + which are collections of data (Layer2 details, IP addressing, etc.) that + describe how to create or connect to a network. A connection is "active" + when a device uses that connection's configuration to create or connect to + a network. There may be multiple connections that apply to a device, but only + one of them can be active on that device at any given time. The additional + connections can be used to allow quick switching between different networks + and configurations.</para> + + <para>Consider a machine which is usually connected to a DHCP-enabled network, + but sometimes connected to a testing network which uses static IP addressing. + Instead of manually reconfiguring eth0 each time the network is changed, the + settings can be saved as two connections which both apply to eth0, one for DHCP + (called <literal>default</literal>) and one with the static addressing details (called + <literal>testing</literal>). When connected to the DHCP-enabled network the user would run + <command>nmcli con up default</command> , and when connected to the static network the user + would run <command>nmcli con up testing</command>.</para> + + <variablelist> + + <varlistentry> + <term> + <command>show</command> + <arg><option>--active</option></arg> + <arg> + <option>--order</option> + <arg choice='plain' rep='repeat'>[+-]<replaceable>category</replaceable>:</arg> + </arg> + </term> + + <listitem> + <para>List in-memory and on-disk connection profiles, some of which may also be + active if a device is using that connection profile. Without a parameter, all + profiles are listed. When <option>--active</option> option is specified, only + the active profiles are shown.</para> + + <para>The <option>--order</option> option can be used to get custom + ordering of connections. The connections can be ordered by active status + (<literal>active</literal>), name (<literal>name</literal>), type + (<literal>type</literal>) or D-Bus path (<literal>path</literal>). If + connections are equal according to a sort order category, an additional + category can be specified. The default sorting order is equivalent to + <literal>--order active:name:path</literal>. <literal>+</literal> or no + prefix means sorting in ascending order (alphabetically or in numbers), + <literal>-</literal> means reverse (descending) order. The category names + can be abbreviated (e.g. <literal>--order -a:na</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>show</command> + <arg><option>--active</option></arg> + <group> + <arg choice='plain'><option>id</option></arg> + <arg choice='plain'><option>uuid</option></arg> + <arg choice='plain'><option>path</option></arg> + <arg choice='plain'><option>apath</option></arg> + </group> + <arg rep='repeat' choice='plain'><replaceable>ID</replaceable></arg> + </term> + + <listitem> + <para>Show details for specified connections. By default, both static + configuration and active connection data are displayed. When + <option>--active</option> option is specified, only the active profiles are + taken into account. Use global <option>--show-secrets</option> option to + display secrets associated with the profile.</para> + + <para><option>id</option>, <option>uuid</option>, + <option>path</option> and <option>apath</option> keywords can be used + if <replaceable>ID</replaceable> is ambiguous. Optional + <replaceable>ID</replaceable>-specifying keywords are:</para> + + <variablelist> + <varlistentry> + <term><option>id</option></term> + <listitem> + <para>the <replaceable>ID</replaceable> denotes a connection name.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>uuid</option></term> + <listitem> + <para>the <replaceable>ID</replaceable> denotes a connection UUID.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>path</option></term> + <listitem> + <para>the <replaceable>ID</replaceable> denotes a D-Bus + static connection path in the format of + /org/freedesktop/NetworkManager/Settings/<replaceable>num</replaceable> + or just <replaceable>num</replaceable>.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>apath</option></term> + <listitem> + <para>the <replaceable>ID</replaceable> denotes a D-Bus active connection path in the format of + /org/freedesktop/NetworkManager/ActiveConnection/<replaceable>num</replaceable> or just + <replaceable>num</replaceable>.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>It is possible to filter the output using the global + <option>--fields</option> option. Use the following values:</para> + + <variablelist> + <varlistentry> + <term><option>profile</option></term> + <listitem> + <para>only shows static profile configuration.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>active</option></term> + <listitem> + <para>only shows active connection data (when the profile is active).</para> + </listitem> + </varlistentry> + </variablelist> + + <para>You can also specify particular fields. For static configuration, use + setting and property names as described in + <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> manual page. For active data use GENERAL, IP4, DHCP4, IP6, + DHCP6, VPN.</para> + + <para>When no command is given to the <command>nmcli connection</command>, + the default action is <command>nmcli connection show</command>.</para> + + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>up</command> + <group> + <arg choice='plain'><option>id</option></arg> + <arg choice='plain'><option>uuid</option></arg> + <arg choice='plain'><option>path</option></arg> + </group> + <arg rep='repeat' choice='plain'><replaceable>ID</replaceable></arg> + <arg><option>ifname</option> <replaceable>ifname</replaceable></arg> + <arg><option>ap</option> <replaceable>BSSID</replaceable></arg> + <arg><option>passwd-file</option> <replaceable>file</replaceable></arg> + </term> + + <listitem> + <para>Activate a connection. The connection is identified by its name, UUID or + D-Bus path. If <replaceable>ID</replaceable> is ambiguous, a keyword <option>id</option>, + <option>uuid</option> or <option>path</option> can be used. When + requiring a particular device to activate the connection on, the + <option>ifname</option> option with interface name should be given. If the + <replaceable>ID</replaceable> is not given an <option>ifname</option> is required, and + NetworkManager will activate the best available connection for the given + <option>ifname</option>. In case of a VPN connection, the + <option>ifname</option> option specifies the device of the base connection. + The <option>ap</option> option specify what particular AP should be used in + case of a Wi-Fi connection.</para> + + <para>If <option>--wait</option> option is not specified, the default timeout will be 90 + seconds.</para> + + <para>See <command>connection show</command> above for the description of the + <replaceable>ID</replaceable>-specifying keywords.</para> + + <para>Available options are:</para> + + <variablelist> + <varlistentry> + <term><option>ifname</option></term> + <listitem> + <para>interface that will be used for activation.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>ap</option></term> + <listitem> + <para>BSSID of the AP which the command should connect to (for Wi-Fi connections).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>passwd-file</option></term> + <listitem> + <para>some networks may require credentials during activation. You can give + these credentials using this option. Each line of the file should contain one + password in the form: + + <programlisting>setting_name.property_name:the password</programlisting> + + For example, for WPA Wi-Fi with PSK, the line would be + + <programlisting>802-11-wireless-security.psk:secret12345</programlisting> + + For 802.1X password, the line would be + + <programlisting>802-1x.password:my 1X password</programlisting> + + <command>nmcli</command> also accepts <literal>wifi-sec</literal> and <literal>wifi</literal> strings instead of + <literal>802-11-wireless-security</literal>. When NetworkManager requires a password and it is + not given, <command>nmcli</command> will ask for it when run with <option>--ask</option>. + If <option>--ask</option> was not passed, NetworkManager can ask another secret + agent that may be running (typically a GUI secret agent, such as nm-applet or + gnome-shell).</para> + </listitem> + </varlistentry> + </variablelist> + + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>down</command> + <group> + <arg choice='plain'><option>id</option></arg> + <arg choice='plain'><option>uuid</option></arg> + <arg choice='plain'><option>path</option></arg> + <arg choice='plain'><option>apath</option></arg> + </group> + <arg rep='repeat' choice='plain'><replaceable>ID</replaceable></arg> + </term> + + <listitem> + <para>Deactivate a connection from a device without preventing the device from + further auto-activation. Multiple connections can be passed to the + command.</para> + + <para>Be aware that this command deactivates the specified active connection, + but the device on which the connection was active, is still ready to connect + and will perform auto-activation by looking for a suitable connection that has + the 'autoconnect' flag set. This includes the just deactivated connection. So + if the connection is set to auto-connect, it will be automatically started on + the disconnected device again.</para> + + <para>In most cases you may want to use <command>device disconnect</command> + command instead.</para> + + <para>The connection is identified by its name, UUID or D-Bus path. If + <replaceable>ID</replaceable> is ambiguous, a keyword <option>id</option>, + <option>uuid</option>, <option>path</option> or + <option>apath</option> can be used.</para> + + <para> See <command>connection show</command> above for the description of + the <replaceable>ID</replaceable>-specifying keywords.</para> + + <para>If <option>--wait</option> option is not specified, the default timeout + will be 10 seconds.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>add</command> + <arg choice='plain'><option>ifname</option> <replaceable>ifname</replaceable></arg> + <arg>con-name <replaceable>name</replaceable></arg> + <arg> + <option>autoconnect</option> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + </group> + </arg> + <arg> + <option>save</option> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + </group> + </arg> + <arg>master <replaceable>master</replaceable></arg> + <arg>slave-type <replaceable>type</replaceable></arg> + <arg>type <replaceable>type</replaceable></arg> + <arg rep="repeat"><replaceable>ARGUMENTS</replaceable></arg> + <arg>ip4 <replaceable>addr</replaceable></arg> + <arg>gw4 <replaceable>addr</replaceable></arg> + <arg>ip6 <replaceable>addr</replaceable></arg> + <arg>gw6 <replaceable>addr</replaceable></arg> + <arg> + <option>--</option> + <arg choice='plain' rep='repeat'> + [+|-]<replaceable>setting</replaceable>.<replaceable>property</replaceable> + <replaceable>value</replaceable> + </arg> + </arg> + </term> + + <listitem> + <para>Add a connection for NetworkManager. Arguments differ according to connection types, see below.</para> + + <variablelist> + + <varlistentry> + <term><option>ifname</option></term> + <listitem> + <para>interface to bind the connection to. The connection will only be + applicable to this interface name. A special value of <literal>*</literal> + can be used for interface-independent connections. The + <option>ifname</option> argument is mandatory for all connection types + except bond, team, bridge and vlan. Note: use quotes around + <literal>*</literal> to suppress shell expansion.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>con-name</option></term> + <listitem> + <para>connection name (when not provided a default name is generated: + <type>[-<ifname>][-<num>]).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>autoconnect</option></term> + <listitem> + <para>whether the connection profile can be automatically activated (default: + yes).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>save</option></term> + <listitem> + <para>whether the connection should be persistent, i.e. NetworkManager should + store it on disk (default: <literal>yes</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>master</option></term> + <listitem> + <para>master interface name, or connection UUID or ID of master connection + profile. The value can be prefixed with <literal>ifname/</literal>, + <literal>uuid/</literal> or <literal>id/</literal> to disambiguate it.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>slave-type</option></term> + <listitem> + <para>type of master connection. Only required when it can not be inferred + (i.e. the master connection does + not exist yet).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>type</option></term> + <listitem> + <para>connection type; see below for allowed values. Note that types + <option>bond-slave</option>, <option>team-slave</option> and + <option>bridge-slave</option> create <option>ethernet</option> connection + profiles. Their use is discouraged in favor of using a specific type with + <option>master</option> option.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type ethernet</option> + <arg><option>mac</option> <replaceable>addr</replaceable></arg> + <arg><option>cloned-mac</option> <replaceable>addr</replaceable></arg> + <arg><option>mtu</option> <replaceable>mtu</replaceable></arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>mac</option></term> + <listitem> + <para>MAC address of the device this connection is locked to.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>cloned-mac</option></term> + <listitem> + <para>cloned MAC.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>mtu</option></term> + <listitem> + <para>MTU.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type wifi</option> + <arg choice='plain'><option>ssid</option> <replaceable>SSID</replaceable></arg> + <arg><option>mac</option> <replaceable>addr</replaceable></arg> + <arg><option>cloned-mac</option> <replaceable>addr</replaceable></arg> + <arg> + <option>mode</option> + <group choice='req'> + <arg choice='plain'>infrastructure</arg> + <arg choice='plain'>ap</arg> + <arg choice='plain'>adhoc</arg> + </group> + </arg> + <arg><option>mtu</option> <replaceable>mtu</replaceable></arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>ssid</option></term> + <listitem> + <para>SSID.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>mac</option></term> + <listitem> + <para>MAC address of the device this connection is locked to.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>cloned-mac</option></term> + <listitem> + <para>cloned MAC.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>mode</option></term> + <listitem> + <para>Wi-Fi network mode. If blank, <literal>infrastructure</literal> + is assumed.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>mtu</option></term> + <listitem> + <para>MTU.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type wimax</option> + <arg><option>mac</option> <replaceable>addr</replaceable></arg> + <arg><option>nsp</option> <replaceable>nsp</replaceable></arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>mac</option></term> + <listitem> + <para>MAC address of the device this connection is locked to.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>nsp</option></term> + <listitem> + <para>Network Service Provider name.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type pppoe</option> + <arg choice='plain'><option>username</option> <replaceable>user</replaceable></arg> + <arg><option>password</option> <replaceable>passwd</replaceable></arg> + <arg><option>service</option> <replaceable>name</replaceable></arg> + <arg><option>mtu</option> <replaceable>mtu</replaceable></arg> + <arg><option>mac</option> <replaceable>addr</replaceable></arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>username</option></term> + <listitem> + <para>PPPoE username.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>password</option></term> + <listitem> + <para>Password for the PPPoE username.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>service</option></term> + <listitem> + <para>PPPoE service name (if required by concentrator).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>mtu</option></term> + <listitem> + <para>MTU.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>mac</option></term> + <listitem> + <para>MAC address of the device this connection is locked to.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type gsm</option> + <arg><option>apn</option> <replaceable>APN</replaceable></arg> + <arg><option>username</option> <replaceable>user</replaceable></arg> + <arg><option>password</option> <replaceable>passwd</replaceable></arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>apn</option></term> + <listitem> + <para>APN - GSM Access Point Name.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>user</option></term> + <listitem> + <para>user name.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>password</option></term> + <listitem> + <para>password.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type cdma</option> + <arg><option>username</option> <replaceable>user</replaceable></arg> + <arg><option>password</option> <replaceable>passwd</replaceable></arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>user</option></term> + <listitem> + <para>user name.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>password</option></term> + <listitem> + <para>password.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type infiniband</option> + <arg><option>mac</option> <replaceable>addr</replaceable></arg> + <arg><option>mtu</option> <replaceable>mtu</replaceable></arg> + <arg> + <option>transport-mode</option> + <group choice='req'> + <arg choice='plain'>datagram</arg> + <arg choice='plain'>connected</arg> + </group> + </arg> + <arg><option>parent</option> <replaceable>device</replaceable></arg> + <arg><option>p-key</option> <replaceable>key</replaceable></arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>mac</option></term> + <listitem> + <para>MAC address of the device this connection is locked to + (InfiniBand MAC is 20 bytes).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>mtu</option></term> + <listitem> + <para>MTU.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>transport-mode</option></term> + <listitem> + <para>InfiniBand transport mode.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>parent</option></term> + <listitem> + <para>the interface name of the parent device (if any).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>p-key</option></term> + <listitem> + <para>the InfiniBand P_Key (16-bit unsigned integer).</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type bluetooth</option> + <arg><option>addr</option> <replaceable>addr</replaceable></arg> + <arg> + <option>bt-type</option> + <group choice='req'> + <arg choice='plain'>panu</arg> + <arg choice='plain'>dun-gsm</arg> + <arg choice='plain'>dun-cdma</arg> + </group> + </arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>addr</option></term> + <listitem> + <para>Bluetooth device address (MAC).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>bt-type</option></term> + <listitem> + <para>Bluetooth connection type.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type vlan</option> + <arg choice='plain'><option>dev</option> <replaceable>device</replaceable></arg> + <arg choice='plain'><option>id</option> <replaceable>id</replaceable></arg> + <arg><option>flags</option> <replaceable>flags</replaceable></arg> + <arg><option>ingress</option> <replaceable>mapping</replaceable></arg> + <arg><option>egress</option> <replaceable>mapping</replaceable></arg> + <arg><option>mtu</option> <replaceable>mtu</replaceable></arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>dev</option></term> + <listitem> + <para>parent device this VLAN is on.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>id</option></term> + <listitem> + <para>VLAN ID in range 0-4095.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>flags</option></term> + <listitem> + <para>flags.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>ingress</option></term> + <listitem> + <para>VLAN ingress priority mapping.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>egress</option></term> + <listitem> + <para>VLAN egress priority mapping.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>mtu</option></term> + <listitem> + <para>MTU.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type bond</option> + <arg> + <option>mode</option> + <group choice='req'> + <arg choice='plain'>active-backup</arg> + <arg choice='plain'>balance-xor</arg> + <arg choice='plain'>broadcast</arg> + <arg choice='plain'>802.3ad</arg> + <arg choice='plain'>balance-tlb</arg> + <arg choice='plain'>balance-alb</arg> + <arg choice='plain'><replaceable>num</replaceable></arg> + </group> + </arg> + <arg><option>primary</option> <replaceable>ifname</replaceable></arg> + <arg><option>miimon</option> <replaceable>num</replaceable></arg> + <arg><option>downdelay</option> <replaceable>num</replaceable></arg> + <arg><option>updelay</option> <replaceable>num</replaceable></arg> + <arg><option>arp-interval</option> <replaceable>num</replaceable></arg> + <arg><option>arp-ip-target</option> <replaceable>num</replaceable></arg> + </term> + <listitem> + <variablelist> + + <varlistentry> + <term><option>mode</option></term> + <listitem> + <para>bonding mode (default: <literal>balance-rr</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>primary</option></term> + <listitem> + <para>primary interface name (for <literal>active-backup</literal> mode).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>miimon</option></term> + <listitem> + <para>miimon (default: <literal>100</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>downdelay</option></term> + <listitem> + <para>downdelay (default: <literal>0</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>updelay</option></term> + <listitem> + <para>updelay (default: <literal>0</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>arp-interval</option></term> + <listitem> + <para>ARP interval (default: <literal>0</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>arp-ip-target</option></term> + <listitem> + <para>ARP IP target.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type bond-slave</option> + <arg><option>master</option> <replaceable>master</replaceable></arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>master</option></term> + <listitem> + <para>master bond interface name, or connection UUID or + ID of bond master connection profile. The value can be + prefixed with <literal>ifname/</literal>, + <literal>uuid/</literal> or <literal>id/</literal> to + disambiguate it.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type team</option> + <arg> + <option>config</option> + <group choice='req'> + <arg choice='plain'>file</arg> + <arg choice='plain'><replaceable>JSON</replaceable></arg> + </group> + </arg> + </term> + <listitem> + <variablelist> + + <varlistentry> + <term><option>config</option></term> + <listitem> + <para>JSON configuration for team.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type team-slave</option> + <arg> + <option>config</option> + <option><replaceable>JSON</replaceable></option> + </arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>master</option></term> + <listitem> + <para>master team interface name, or connection UUID or + ID of team master connection profile. The value can be + prefixed with <literal>ifname/</literal>, + <literal>uuid/</literal> or <literal>id/</literal>to + disambiguate it.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>config</option></term> + <listitem> + <para>JSON configuration for team.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type bridge</option> + <arg> + <option>stp</option> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + </group> + </arg> + <arg><option>priority</option> <replaceable>num</replaceable></arg> + <arg><option>forward-delay</option> <replaceable>2-30</replaceable></arg> + <arg><option>hello-time</option> <replaceable>1-10</replaceable></arg> + <arg><option>max-age</option> <replaceable>6-42</replaceable></arg> + <arg><option>ageing-time</option> <replaceable>0-1000000</replaceable></arg> + <arg> + <option>multicast-snooping</option> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + </group> + </arg> + <arg><option>mac</option> <replaceable>addr</replaceable></arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>stp</option></term> + <listitem> + <para>controls whether Spanning Tree Protocol (STP) is enabled for this bridge + (default: <literal>yes</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>priority</option></term> + <listitem> + <para>sets STP priority (default: <literal>128</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>forward-delay</option></term> + <listitem> + <para>STP forwarding delay, in seconds (default: <literal>15</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>hello-time</option></term> + <listitem> + <para>STP hello time, in seconds (default: <literal>2</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>max-age</option></term> + <listitem> + <para>STP maximum message age, in seconds (default: <literal>20</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>ageing-time</option></term> + <listitem> + <para>the Ethernet MAC address aging time, in seconds (default: <literal>300</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>multicast-snooping</option></term> + <listitem> + <para>controls whether IGMP snooping is enabled (default: <literal>yes</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>mac</option></term> + <listitem> + <para>MAC address of the bridge (note: this requires a recent kernel feature, + originally introduced in 3.15 upstream kernel).</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type bridge-slave</option> + <arg><option>master</option> <replaceable>master</replaceable></arg> + <arg><option>priority</option> <replaceable>num</replaceable></arg> + <arg><option>path-cost</option> <replaceable>1-65535</replaceable></arg> + <arg> + <option>hairpin</option> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + </group> + </arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>master</option></term> + <listitem> + <para>master bridge interface name, or connection UUID + or ID of bridge master connection profile. The value + can be prefixed with <literal>ifname/</literal>, + <literal>uuid/</literal> or <literal>id/</literal> + to disambiguate it.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>priority</option></term> + <listitem> + <para>STP priority of this slave (default: <literal>32</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>path-cost</option></term> + <listitem> + <para>STP port cost for destinations via this slave (default: <literal>100</literal>).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>hairpin</option></term> + <listitem> + <para>'hairpin mode' for the slave, which allows frames to be sent back out + through the slave the frame was received on (default: <literal>yes</literal>).</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type vpn</option> + <arg><option>type</option> <replaceable>type</replaceable></arg> + <arg><option>user</option> <replaceable>username</replaceable></arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>vpn-type</option></term> + <listitem> + <para>VPN type.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>user</option></term> + <listitem> + <para>VPN username.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type olpc-mesh</option> + <arg choice='plain'><option>ssid</option> <replaceable>SSID</replaceable></arg> + <arg><option>channel</option> <replaceable>1-13</replaceable></arg> + <arg><option>dhcp-anycast</option> <replaceable>MAC</replaceable></arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>ssid</option></term> + <listitem> + <para>SSID.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>channel</option></term> + <listitem> + <para>channel to use for the network.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>dhcp-anycast</option></term> + <listitem> + <para>anycast DHCP MAC address used when requesting an IP address via DHCP.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type adsl</option> + <arg choice='plain'><option>username</option> <replaceable>username</replaceable></arg> + <arg choice='plain'> + <option>protocol</option> + <group choice='req'> + <arg choice='plain'>pppoa</arg> + <arg choice='plain'>pppoe</arg> + <arg choice='plain'>ipoatm</arg> + </group> + </arg> + <arg><option>password</option> <replaceable>passwd</replaceable></arg> + <arg> + <option>encapsulation</option> + <group choice='req'> + <arg choice='plain'>vcmux</arg> + <arg choice='plain'>llc</arg> + </group> + </arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>username</option></term> + <listitem> + <para>ADSL user name.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>protocol</option></term> + <listitem> + <para>ADSL protocol.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>password</option></term> + <listitem> + <para>ADSL password.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>encapsulation</option></term> + <listitem> + <para>ADSL encapsulation.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type tun</option> + <arg choice='plain'> + <option>mode</option> + <group choice='req'> + <arg choice='plain'>tun</arg> + <arg choice='plain'>tap</arg> + </group> + </arg> + <arg><option>owner</option> <replaceable>UID</replaceable></arg> + <arg><option>group</option> <replaceable>GID</replaceable></arg> + <arg> + <option>pi</option> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + </group> + </arg> + <arg> + <option>vnet-hdr</option> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + </group> + </arg> + <arg> + <option>multi-queue</option> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + </group> + </arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>mode</option></term> + <listitem> + <para>Mode for the device.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>owner</option></term> + <listitem> + <para>UID of the owner.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>group</option></term> + <listitem> + <para>GID of the group.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>pi</option></term> + <listitem> + <para>include packet information (~IFF_NO_PI flag).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>vnet-hdr</option></term> + <listitem> + <para>send and receive large (i.e. GSO) packets and packets with partial + checksums (IFF_VNET_HDR flag).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>multi-queue</option></term> + <listitem> + <para>multi-queue support for tun/tap device (IFF_MULTI_QUEUE flag).</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type ip-tunnel</option> + <arg choice='plain'> + <option>mode</option> + <group choice='req'> + <arg choice='plain'>ipip</arg> + <arg choice='plain'>gre</arg> + <arg choice='plain'>sit</arg> + <arg choice='plain'>isatap</arg> + <arg choice='plain'>vti</arg> + <arg choice='plain'>ip6ip6</arg> + <arg choice='plain'>ipip6</arg> + <arg choice='plain'>ip6gre</arg> + <arg choice='plain'>vti6</arg> + <arg choice='plain'>tun</arg> + </group> + </arg> + <arg choice='plain'><option>remote</option> <replaceable>addr</replaceable></arg> + <arg><option>local</option> <replaceable>addr</replaceable></arg> + <arg><option>dev</option> <replaceable>device</replaceable></arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>mode</option></term> + <listitem> + <para>tunnel mode.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>remote</option></term> + <listitem> + <para>IPv4 or IPv6 address of the remote tunnel endpoint.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>local</option></term> + <listitem> + <para>IPv4 or IPv6 address of the local tunnel endpoint.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>dev</option></term> + <listitem> + <para>device to use for tunnel endpoint communication.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type macvlan</option> + <arg choice='plain'><option>dev</option> <replaceable>device</replaceable></arg> + <arg choice='plain'> + <option>mode</option> + <group choice='req'> + <arg choice='plain'>vepa</arg> + <arg choice='plain'>bridge</arg> + <arg choice='plain'>private</arg> + <arg choice='plain'>passthru</arg> + <arg choice='plain'>source</arg> + </group> + </arg> + <arg> + <option>tap</option> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + </group> + </arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>dev</option></term> + <listitem> + <para>parent device this MACVLAN is on.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>mode</option></term> + <listitem> + <para>MACVLAN mode, which specifies the communication mechanism between + multiple MACVLANs on the same lower device.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>tap</option></term> + <listitem> + <para>controls the device type. If set to 'yes' a MACVTAP will be created + (default: <literal>no</literal>).</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <option>type vxlan</option> + <arg choice='plain'><option>id</option> <replaceable>id</replaceable></arg> + <arg choice='plain'><option>remote</option> <replaceable>addr</replaceable></arg> + <arg><option>dev</option> <replaceable>parent device (ifname or connection UUID)</replaceable></arg> + <arg><option>local</option> <replaceable>addr</replaceable></arg> + <arg><option>source-port-min</option> <replaceable>0-65535</replaceable></arg> + <arg><option>source-port-max</option> <replaceable>0-65535</replaceable></arg> + <arg><option>destination-port</option> <replaceable>0-65535</replaceable></arg> + </term> + <listitem> + <variablelist> + <varlistentry> + <term><option>id</option></term> + <listitem> + <para>VXLAN Network Identifer to use.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>remote</option></term> + <listitem> + <para>unicast destination IP address or multicast IP address to join.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>dev</option></term> + <listitem> + <para>device to use for tunnel endpoint communication.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>local</option></term> + <listitem> + <para>source IP address.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>source-port-min</option></term> + <listitem> + <para>minimum UDP source port to communicate to the remote VXLAN tunnel endpoint.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>source-port-max</option></term> + <listitem> + <para>maximum UDP source port to communicate to the remote VXLAN tunnel endpoint.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>destination-port</option></term> + <listitem> + <para>UDP destination port to communicate to the remote VXLAN tunnel endpoint.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>ip4</option></term> + <term><option>gw4</option></term> + <listitem> + <para>IPv4 addresses.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>ip6</option></term> + <term><option>gw6</option></term> + <listitem> + <para>IPv6 addresses.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>--</option></term> + <listitem> + <para>If a <option>--</option> argument is encountered, the rest of command + line is interpreted as property list in the same format as <command>connection + modify</command> command accepts. This makes it possible to adjust the + connection properties before it's added.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>edit</command> + <group choice='req'> + <arg choice='plain'> + <group> + <arg choice='plain'><option>id</option></arg> + <arg choice='plain'><option>uuid</option></arg> + <arg choice='plain'><option>path</option></arg> + </group> + <arg rep='repeat' choice='plain'><replaceable>ID</replaceable></arg> + </arg> + <arg choice='plain'> + <arg><option>type</option> <replaceable>type</replaceable></arg> + <arg><option>con-name</option> <replaceable>name</replaceable></arg> + </arg> + </group> + </term> + + <listitem> + <para>Edit an existing connection or add a new one, using an interactive editor.</para> + + <para>The existing connection is identified by its name, UUID or D-Bus path. If + <replaceable>ID</replaceable> is ambiguous, a keyword <option>id</option>, + <option>uuid</option>, or <option>path</option> can be used. See + <command>connection show</command> above for the description of the + <replaceable>ID</replaceable>-specifying keywords. Not providing an + <replaceable>ID</replaceable> means that a new connection will be added.</para> + + <para>The interactive editor will guide you through the connection editing and + allow you to change connection parameters according to your needs by means of + a simple menu-driven interface. The editor indicates what settings and + properties can be modified and provides in-line help.</para> + + <para>Available options:</para> + + <variablelist> + <varlistentry> + <term><option>type</option></term> + <listitem> + <para>type of the new connection; valid types are the same as for + <command>connection add</command> command.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>con-name</option></term> + <listitem> + <para>name for the new connection. It can be changed later in the editor.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>See also + <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> for all NetworkManager settings and property names, and their + descriptions; and + <citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>7</manvolnum></citerefentry> + for sample editor sessions.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>modify</command> + <arg><option>--temporary</option></arg> + <group> + <arg choice='plain'><option>id</option></arg> + <arg choice='plain'><option>uuid</option></arg> + <arg choice='plain'><option>path</option></arg> + </group> + <arg choice='plain'><replaceable>ID</replaceable></arg> + <arg choice='plain' rep='repeat'> + [+|-]<replaceable>setting</replaceable>.<replaceable>property</replaceable> + <replaceable>value</replaceable> + </arg> + </term> + + <listitem> + <para>Modify one or more properties in the connection profile.</para> + + <para>The connection is identified by its name, UUID or D-Bus path. If + <replaceable>ID</replaceable> is ambiguous, a keyword <option>id</option>, + <option>uuid</option> or <option>path</option> can be used. See + <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum> + </citerefentry> for setting and property names, their descriptions and default + values. This command supports abbreviations for <replaceable>setting</replaceable> + and <replaceable>property</replaceable> provided they are unique. Empty + <replaceable>value</replaceable> ("") removes the property value (sets + the property to the default value). The provided value overwrites the existing + property value.</para> + + <para>If you want to append an item to the existing value, use + <literal>+</literal> prefix for the property name. If you want to remove just + one item from container-type property, use <literal>-</literal> prefix for + the property name and specify a value or an zero-based index of the item to + remove (or option name for properties with named options) as + <replaceable>value</replaceable>. Of course, <literal>+</literal> and + <literal>-</literal> only have a real effect for multi-value (container) + properties like <literal>ipv4.dns</literal>, <literal>ipv4.addresses</literal>, + <literal>bond.options</literal>, etc.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>clone</command> + <arg><option>--temporary</option></arg> + <group> + <arg choice='plain'><option>id</option></arg> + <arg choice='plain'><option>uuid</option></arg> + <arg choice='plain'><option>path</option></arg> + </group> + <arg choice='plain' rep='repeat'><replaceable>ID</replaceable></arg> + <arg choice='plain'><option>new</option> <replaceable>name</replaceable></arg> + </term> + + <listitem> + <para>Clone a connection. The connection to be cloned is identified by its + name, UUID or D-Bus path. If <replaceable>ID</replaceable> is ambiguous, a keyword + <option>id</option>, <option>uuid</option> or <option>path</option> + can be used. See <command>connection show</command> above for the description + of the <replaceable>ID</replaceable>-specifying keywords. <replaceable>name</replaceable> is + the name of the new cloned connection. The new connection will be the exact + copy except the connection.id (<replaceable>name</replaceable>) and + connection.uuid (generated) properties.</para> + + <para>The new connection profile will be saved as persistent unless + <option>--temporary</option> option is specified, in which case the new profile + won't exist after NetworkManager restart.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>delete</command> + <group> + <arg choice='plain'><option>id</option></arg> + <arg choice='plain'><option>uuid</option></arg> + <arg choice='plain'><option>path</option></arg> + </group> + <arg choice='plain' rep='repeat'><replaceable>ID</replaceable></arg> + </term> + + <listitem> + <para>Delete a configured connection. The connection to be deleted is + identified by its name, UUID or D-Bus path. If <replaceable>ID</replaceable> is ambiguous, a + keyword <option>id</option>, <option>uuid</option> or <option>path</option> can be used. + See <command>connection show</command> above for the description of + the <replaceable>ID</replaceable>-specifying keywords.</para> + + <para>If <option>--wait</option> option is not specified, the default timeout will be 10 + seconds.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>monitor</command> + <group> + <arg choice='plain'><option>id</option></arg> + <arg choice='plain'><option>uuid</option></arg> + <arg choice='plain'><option>path</option></arg> + </group> + <arg choice='plain' rep='repeat'><replaceable>ID</replaceable></arg> + </term> + + <listitem> + <para>Monitor connection profile activity. This command prints a line whenever + the specified connection changes. The connection to be monitored is identified + by its name, UUID or D-Bus path. If <replaceable>ID</replaceable> is ambiguous, a keyword + <option>id</option>, <option>uuid</option> or <option>path</option> + can be used. See <command>connection show</command> above for the description of the + <replaceable>ID</replaceable>-specifying keywords.</para> + + <para>Monitors all connection profiles in case none is specified. The command + terminates when all monitored connections disappear. If you want to monitor + connection creation consider using the global monitor with <command>nmcli + monitor</command> command.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>reload</command> + </term> + + <listitem> + <para>Reload all connection files from disk. + NetworkManager does not monitor changes to connection + files by default. So you need to use this command in order to tell + NetworkManager to re-read the connection profiles from + disk when a change was made to them. However, the auto-loading feature can be + enabled and then NetworkManager will reload connection + files any time they change (monitor-connection-files=true in + <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>). + </para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>load</command> + <arg choice='plain' rep='repeat'><replaceable>filename</replaceable></arg> + </term> + + <listitem> + <para>Load/reload one or more connection files from disk. Use this after + manually editing a connection file to ensure that + NetworkManager is aware of its latest state.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>import</command> + <arg><option>--temporary</option></arg> + <arg><option>type</option> <replaceable>type</replaceable></arg> + <arg><option>file</option> <replaceable>file</replaceable></arg> + </term> + + <listitem> + <para>Import an external/foreign configuration as a NetworkManager connection + profile. The type of the input file is specified by <option>type</option> + option.</para> + + <para>Only VPN configurations are supported at the moment. The configuration is + imported by NetworkManager VPN plugins. <option>type</option> values are + the same as for <option>vpn-type</option> option in <command>nmcli + connection add</command>. VPN configurations are imported by VPN plugins. + Therefore the proper VPN plugin has to be installed so that <command>nmcli</command> could import + the data.</para> + + <para>The imported connection profile will be saved as persistent unless + <option>--temporary</option> option is specified, in which case the new profile + won't exist after NetworkManager restart.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>export</command> + <group> + <arg choice='plain'><option>id</option></arg> + <arg choice='plain'><option>uuid</option></arg> + <arg choice='plain'><option>path</option></arg> + </group> + <arg choice='plain'><replaceable>ID</replaceable></arg> + <arg><replaceable>file</replaceable></arg> + </term> + + <listitem> + <para>Export a connection.</para> + + <para>Only VPN connections are supported at the moment. A proper VPN plugin has + to be installed so that <command>nmcli</command> could export a connection. If no + <replaceable>file</replaceable> is provided, the VPN configuration + data will be printed to standard output.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id='device'><title>Device Management Commands</title> + + <cmdsynopsis> + <command>nmcli device</command> + <group choice='req'> + <arg choice='plain'><command>status</command></arg> + <arg choice='plain'><command>show</command></arg> + <arg choice='plain'><command>set</command></arg> + <arg choice='plain'><command>connect</command></arg> + <arg choice='plain'><command>reapply</command></arg> + <arg choice='plain'><command>disconnect</command></arg> + <arg choice='plain'><command>delete</command></arg> + <arg choice='plain'><command>monitor</command></arg> + <arg choice='plain'><command>wifi</command></arg> + <arg choice='plain'><command>lldp</command></arg> + </group> + <arg rep='repeat'><replaceable>ARGUMENTS</replaceable></arg> + </cmdsynopsis> + + <para>Show and manage network interfaces.</para> + + <variablelist> + + <varlistentry> + <term><command>status</command></term> + + <listitem> + <para>Print status of devices.</para> + + <para>This is the default action if no command is specified to + <command>nmcli device</command>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>show</command> + <arg><replaceable>ifname</replaceable></arg> + </term> + + <listitem> + <para>Show detailed information about devices. Without an argument, all + devices are examined. To get information for a specific device, the interface + name has to be provided.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>set</command> + <arg>ifname</arg> + <arg choice='plain'><replaceable>ifname</replaceable></arg> + <arg> + <option>autoconnect</option> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + </group> + </arg> + <arg> + <option>managed</option> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + </group> + </arg> + </term> + + <listitem> + <para>Set device properties.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>connect</command> + <arg><replaceable>ifname</replaceable></arg> + </term> + + <listitem> + <para>Connect the device. NetworkManager will try to find a suitable connection + that will be activated. It will also consider connections that are not set to + auto connect.</para> + + <para>If <option>--wait</option> option is not specified, the default timeout will be 90 + seconds.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>reapply</command> + <arg><replaceable>ifname</replaceable></arg> + </term> + + <listitem> + <para>Attempt to update device with changes to the currently active connection + made since it was last applied.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>disconnect</command> + <arg rep='repeat'><replaceable>ifname</replaceable></arg> + </term> + + <listitem> + <para>Disconnect a device and prevent the device from automatically activating + further connections without user/manual intervention. Note that disconnecting + software devices may mean that the devices will disappear.</para> + + <para>If <option>--wait</option> option is not specified, the default timeout + will be 10 seconds.</para> + </listitem> + </varlistentry> + + + <varlistentry> + <term> + <command>delete</command> + <arg rep='repeat'><replaceable>ifname</replaceable></arg> + </term> + + <listitem> + <para>Delete a device. The command removes the interface from the system. Note + that this only works for software devices like bonds, bridges, teams, etc. + Hardware devices (like Ethernet) cannot be deleted by the command.</para> + + <para>If <option>--wait</option> option is not specified, the default timeout will be 10 + seconds.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>monitor</command> + <arg rep='repeat'><replaceable>ifname</replaceable></arg> + </term> + + <listitem> + <para>Monitor device activity. This command prints a line whenever the + specified devices change state.</para> + + <para>Monitors all devices in case no interface is specified. The monitor + terminates when all specified devices disappear. If you want to monitor device + addition consider using the global monitor with <command>nmcli + monitor</command> command.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>wifi</command> + <arg> + <command>list</command> + <arg><option>ifname</option> <replaceable>ifname</replaceable></arg> + <arg><option>bssid</option> <replaceable>BSSID</replaceable></arg> + </arg> + </term> + + <listitem> + <para>List available Wi-Fi access points. The <option>ifname</option> and + <option>bssid</option> options can be used to list APs for a particular + interface or with a specific BSSID, respectively.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>wifi</command> + <command>connect</command> + <arg choice='plain'><replaceable>(B)SSID</replaceable></arg> + <arg><option>password</option> <replaceable>password</replaceable></arg> + <arg> + <option>wep-key-type</option> + <group choice='req'> + <arg choice='plain'>key</arg> + <arg choice='plain'>phrase</arg> + </group> + </arg> + <arg><option>ifname</option> <replaceable>ifname</replaceable></arg> + <arg><option>bssid</option> <replaceable>BSSID</replaceable></arg> + <arg><option>name</option> <replaceable>name</replaceable></arg> + <arg> + <option>private</option> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + </group> + </arg> + <arg> + <option>hidden</option> + <group choice='req'> + <arg choice='plain'>yes</arg> + <arg choice='plain'>no</arg> + </group> + </arg> + </term> + + <listitem> + <para>Connect to a Wi-Fi network specified by SSID or BSSID. The command + creates a new connection and then activates it on a device. This is a + command-line counterpart of clicking an SSID in a GUI client. The command + always creates a new connection and thus it is mainly useful for connecting to + new Wi-Fi networks. If a connection for the network already exists, it is + better to bring up (activate) the existing connection as follows: + <command>nmcli con up id <replaceable>name</replaceable></command>. Note that + only open, WEP and WPA-PSK networks are supported at the moment. It is also + supposed that IP configuration is obtained via DHCP.</para> + + <para>If <option>--wait</option> option is not specified, the default timeout will be 90 + seconds.</para> + + <para>Available options are:</para> + + <variablelist> + <varlistentry> + <term><option>password</option></term> + <listitem> + <para>password for secured networks (WEP or WPA).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>wep-key-type</option></term> + <listitem> + <para>type of WEP secret, either <option>key</option> for ASCII/HEX key or + <option>phrase</option> for passphrase.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>ifname</option></term> + <listitem> + <para>interface that will be used for activation.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>bssid</option></term> + <listitem> + <para>if specified, the created connection will be restricted just for the + BSSID.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>name</option></term> + <listitem> + <para>if specified, the connection will use the name (else NM creates a name + itself).</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>private</option></term> + <listitem> + <para>if set to <literal>yes</literal>, the connection will only be visible + to the user who created it. Otherwise the connection is system-wide, which is + the default.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>hidden</option></term> + <listitem> + <para>set to <literal>yes</literal> when connecting for the first time to an + AP not broadcasting its SSID. Otherwise the SSID would not be found and the + connection attempt would fail.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>wifi</command> + <command>hotspot</command> + <arg><option>ifname</option> <replaceable>ifname</replaceable></arg> + <arg><option>con-name</option> <replaceable>name</replaceable></arg> + <arg><option>ssid</option> <replaceable>SSID</replaceable></arg> + <arg> + <option>band</option> + <group choice='req'> + <arg choice='plain'>a</arg> + <arg choice='plain'>bg</arg> + </group> + </arg> + <arg><option>channel</option> <replaceable>channel</replaceable></arg> + <arg><option>password</option> <replaceable>password</replaceable></arg> + </term> + + <listitem> + <para>Create a Wi-Fi hotspot. The command creates a hotspot connection profile + according to Wi-Fi device capabilities and activates it on the device. The + hotspot is secured with WPA if device/driver supports that, otherwise WEP is + used. Use <command>connection down</command> or <command>device + disconnect</command> to stop the hotspot.</para> + + <para>Parameters of the hotspot can be influenced by the optional + parameters:</para> + + <variablelist> + <varlistentry> + <term><option>ifname</option></term> + <listitem> + <para>what Wi-Fi device is used.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>con-name</option></term> + <listitem> + <para>name of the created hotspot connection profile.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>ssid</option></term> + <listitem> + <para>SSID of the hotspot.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>band</option></term> + <listitem> + <para>Wi-Fi band to use.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>channel</option></term> + <listitem> + <para>Wi-Fi channel to use.</para> + </listitem> + </varlistentry> + <varlistentry> + <term><option>password</option></term> + <listitem> + <para>password to use for the created hotspot. If not provided, <command>nmcli</command> will + generate a password. The password is either WPA pre-shared key or WEP + key.</para> + + <para>Note that <option>--show-secrets</option> global option can be used to + print the hotspot password. It is useful especially when the password was + generated.</para> + </listitem> + </varlistentry> + </variablelist> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>wifi</command> + <command>rescan</command> + <arg><option>ifname</option> <replaceable>ifname</replaceable></arg> + <arg rep='repeat'><option>ssid</option> <replaceable>SSID</replaceable></arg> + </term> + + <listitem> + <para>Request that NetworkManager immediately re-scan for + available access points. NetworkManager scans Wi-Fi networks periodically, but + in some cases it can be useful to start scanning manually (e.g. after resuming + the computer). By using <option>ssid</option>, it is possible to scan for a + specific SSID, which is useful for APs with hidden SSIDs. You can provide + multiple <option>ssid</option> parameters in order to scan more + SSIDs.</para> + + <para>This command does not show the APs, use <command>nmcli device wifi list</command> + for that.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>lldp</command> + <arg> + <command>list</command> + <arg><option>ifname</option> <replaceable>ifname</replaceable></arg> + </arg> + </term> + + <listitem> + <para>Display information about neighboring devices learned through the Link + Layer Discovery Protocol (LLDP). The <option>ifname</option> option can be + used to list neighbors only for a given interface. The protocol must be enabled + in the connection settings.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id='agent'><title>Secret Agent</title> + + <cmdsynopsis> + <command>nmcli agent</command> + <group choice='req'> + <arg choice='plain'><command>secret</command></arg> + <arg choice='plain'><command>polkit</command></arg> + <arg choice='plain'><command>all</command></arg> + </group> + </cmdsynopsis> + + <para>Run <command>nmcli</command> as a NetworkManager secret agent, or polkit agent.</para> + + <variablelist> + + <varlistentry> + <term><command>secret</command></term> + + <listitem> + <para>Register <command>nmcli</command> as a NetworkManager secret agent and listen for secret + requests. You do usually not need this command, because <command>nmcli</command> can handle + secrets when connecting to networks. However, you may find the command useful + when you use another tool for activating connections and you do not have a + secret agent available (like nm-applet).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>polkit</command> + </term> + + <listitem> + <para>Register <command>nmcli</command> as a polkit agent for the user session and listen for + authorization requests. You do not usually need this command, because <command>nmcli</command> can + handle polkit actions related to NetworkManager operations (when run with + <option>--ask</option>). However, you may find the command useful when you want + to run a simple text based polkit agent and you do not have an agent of a desktop + environment. Note that running this command makes <command>nmcli</command> handle all polkit requests, + not only NetworkManager related ones, because only one polkit agent can run for the + session.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term> + <command>all</command> + </term> + + <listitem> + <para>Runs <command>nmcli</command> as both NetworkManager secret and a polkit agent.</para> + </listitem> + </varlistentry> + + </variablelist> + + </refsect1> + + <refsect1 id='environment_variables'><title>Environment Variables</title> + + <para><command>nmcli</command>'s behavior is affected by the following + environment variables.</para> + + <variablelist> + <varlistentry> + <term><envar>LC_ALL</envar></term> + <listitem> + <para>If set to a non-empty string value, it overrides the values of all the + other internationalization variables.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><envar>LC_MESSAGES</envar></term> + <listitem> + <para>Determines the locale to be used for internationalized messages.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><envar>LANG</envar></term> + <listitem> + <para>Provides a default value for the internationalization variables that are + unset or null.</para> + </listitem> + </varlistentry> + </variablelist> + + </refsect1> + + <refsect1 id='internationalization_notes'><title>Internationalization notes</title> + + <para>Be aware that <command>nmcli</command> is localized and that is why the + output depends on your environment. This is important to realize especially + when you parse the output.</para> + + <para>Call <command>nmcli</command> as <command>LC_ALL=C nmcli</command> to + be sure the locale is set to <literal>C</literal> while executing in a script.</para> + + <para><envar>LC_ALL</envar>, <envar>LC_MESSAGES</envar>, <envar>LANG</envar> + variables specify the <envar>LC_MESSAGES</envar> locale category (in that + order), which determines the language that <command>nmcli</command> uses for + messages. The <literal>C</literal> locale is used if none of these variables are set, and this + locale uses English messages.</para> + + </refsect1> + + <refsect1 id='exit_status'><title>Exit Status</title> + + <para><command>nmcli</command> exits with status 0 if it succeeds, a value + greater than 0 is returned if an error occurs.</para> + + <variablelist spacing='compact' termlength='3'> + <varlistentry> + <term><errorcode>0</errorcode></term> + <listitem> + <para>Success – indicates the operation succeeded.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><errorcode>1</errorcode></term> + <listitem> + <para>Unknown or unspecified error.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><errorcode>2</errorcode></term> + <listitem> + <para>Invalid user input, wrong <command>nmcli</command> + invocation.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><errorcode>3</errorcode></term> + <listitem> + <para>Timeout expired (see <option>--wait</option> option).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><errorcode>4</errorcode></term> + <listitem> + <para>Connection activation failed.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><errorcode>5</errorcode></term> + <listitem> + <para>Connection deactivation failed.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><errorcode>6</errorcode></term> + <listitem> + <para>Disconnecting device failed.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><errorcode>7</errorcode></term> + <listitem> + <para>Connection deletion failed.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><errorcode>8</errorcode></term> + <listitem> + <para>NetworkManager is not running.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><errorcode>9</errorcode></term> + <listitem> + <para><command>nmcli</command> and <command>NetworkManager</command> + versions mismatch.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><errorcode>10</errorcode></term> + <listitem> + <para>Connection, device, or access point does not exist.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id='examples'><title>Examples</title> + + <para>This section presents various examples of <command>nmcli</command> usage. If you want even + more, please refer to + <citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>7</manvolnum></citerefentry> + manual page.</para> + + <variablelist> + <varlistentry> + <term><userinput>nmcli -t -f RUNNING general</userinput></term> + <listitem> + <para>tells you whether NetworkManager is running or not.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli -t -f STATE general</userinput></term> + <listitem> + <para>shows the overall status of NetworkManager.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli radio wifi off</userinput></term> + <listitem> + <para>switches Wi-Fi off.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli connection show</userinput></term> + <listitem> + <para>lists all connections NetworkManager has.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli -p -m multiline -f all con show</userinput></term> + <listitem> + <para>shows all configured connections in multi-line mode.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli connection show --active</userinput></term> + <listitem> + <para>lists all currently active connections.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli -f name,autoconnect c s</userinput></term> + <listitem> + <para>shows all connection profile names and their auto-connect property.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli -p connection show "My default em1"</userinput></term> + <listitem> + <para>shows details for "My default em1" connection profile.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli --show-secrets connection show "My Home WiFi"</userinput></term> + <listitem> + <para>shows details for "My Home WiFi" connection profile with all passwords. + Without <option>--show-secrets</option> option, secrets would not be + displayed.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli -f active connection show "My default em1"</userinput></term> + <listitem> + <para>shows details for "My default em1" active connection, like IP, DHCP + information, etc.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli -f profile con s "My wired connection"</userinput></term> + <listitem> + <para>shows static configuration details of the connection profile with "My + wired connection" name.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli -p con up "My wired connection" ifname eth0</userinput></term> + <listitem> + <para>activates the connection profile with name "My wired connection" on + interface eth0. The -p option makes <command>nmcli</command> show progress of the + activation.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli con up 6b028a27-6dc9-4411-9886-e9ad1dd43761 ap 00:3A:98:7C:42:D3</userinput></term> + <listitem> + <para>connects the Wi-Fi connection with UUID + 6b028a27-6dc9-4411-9886-e9ad1dd43761 to the AP with BSSID + 00:3A:98:7C:42:D3.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli device status</userinput></term> + <listitem> + <para>shows the status for all devices.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli dev disconnect em2</userinput></term> + <listitem> + <para>disconnects a connection on interface em2 and marks the device as + unavailable for auto-connecting. As a result, no connection will automatically + be activated on the device until the device's 'autoconnect' is set to TRUE or + the user manually activates a connection.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli -f GENERAL,WIFI-PROPERTIES dev show wlan0</userinput></term> + <listitem> + <para>shows details for wlan0 interface; only GENERAL and WIFI-PROPERTIES + sections will be shown.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli -f CONNECTIONS device show wlp3s0</userinput></term> + <listitem> + <para>shows all available connection profiles for your Wi-Fi interface + wlp3s0.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli dev wifi</userinput></term> + <listitem> + <para>lists available Wi-Fi access points known to NetworkManager.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli dev wifi con "Cafe Hotspot 1" password caffeine name "My cafe"</userinput></term> + <listitem> + <para>creates a new connection named "My cafe" and then connects it to "Cafe + Hotspot 1" SSID using password "caffeine". This is mainly useful when + connecting to "Cafe Hotspot 1" for the first time. Next time, it is better to + use <command>nmcli con up id "My cafe"</command> so that the + existing connection profile can be used and no additional is created.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli -s dev wifi hotspot con-name QuickHotspot</userinput></term> + <listitem> + <para>creates a hotspot profile and connects it. Prints the hotspot password + the user should use to connect to the hotspot from other devices.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli connection add type ethernet autoconnect no ifname eth0</userinput></term> + <listitem> + <para>non-interactively adds an Ethernet connection tied to eth0 interface with + automatic IP configuration (DHCP), and disables the connection's <literal>autoconnect</literal> + flag.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli c a ifname Maxipes-fik type vlan dev eth0 id 55</userinput></term> + <listitem> + <para>non-interactively adds a VLAN connection with ID 55. The connection will + use eth0 and the VLAN interface will be named Maxipes-fik.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli c a ifname eth0 type ethernet -- ipv4.method disabled ipv6.method link-local</userinput></term> + <listitem> + <para>non-interactively adds a connection that will use eth0 Ethernet interface + and only have an IPv6 link-local address configured.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli connection edit ethernet-em1-2</userinput></term> + <listitem> + <para>edits existing "ethernet-em1-2" connection in the interactive + editor.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli connection edit type ethernet con-name "yet another Ethernet connection"</userinput></term> + <listitem> + <para>adds a new Ethernet connection in the interactive editor.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli con mod ethernet-2 connection.autoconnect no</userinput></term> + <listitem> + <para>modifies 'autoconnect' property in the 'connection' setting of + 'ethernet-2' connection.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli con mod "Home Wi-Fi" wifi.mtu 1350</userinput></term> + <listitem> + <para>modifies 'mtu' property in the 'wifi' setting of 'Home Wi-Fi' + connection.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli con mod em1-1 ipv4.method manual ipv4.addr "192.168.1.23/24 192.168.1.1, 10.10.1.5/8, 10.0.0.11"</userinput></term> + <listitem> + <para>sets manual addressing and the addresses in em1-1 profile.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli con modify ABC +ipv4.dns 8.8.8.8</userinput></term> + <listitem> + <para>appends a Google public DNS server to DNS servers in ABC profile.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli con modify ABC -ipv4.addresses "192.168.100.25/24 192.168.1.1"</userinput></term> + <listitem> + <para>removes the specified IP address from (static) profile ABC.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli con import type openvpn file ~/Downloads/frootvpn.ovpn</userinput></term> + <listitem> + <para>imports an OpenVPN configuration to NetworkManager.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><userinput>nmcli con export corp-vpnc /home/joe/corpvpn.conf</userinput></term> + <listitem> + <para>exports NetworkManager VPN profile corp-vpnc as standard Cisco (vpnc) + configuration.</para> + </listitem> + </varlistentry> + </variablelist> + </refsect1> + + <refsect1 id='notes'><title>Notes</title> + <para><command>nmcli</command> accepts abbreviations, as long as they are a unique prefix in the set + of possible options. As new options get added, these abbreviations are not guaranteed + to stay unique. For scripting and long term compatibility it is therefore strongly + advised to spell out the full option names.</para> + </refsect1> + + <refsect1 id='bugs'><title>Bugs</title> + <para>There are probably some bugs. If you find a bug, please report it to + https://bugzilla.gnome.org/ — product <literal>NetworkManager</literal>.</para> + </refsect1> + + <refsect1 id='see_also'><title>See Also</title> + <para><citerefentry><refentrytitle>nmcli-examples</refentrytitle><manvolnum>7</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-online</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry>, + <citerefentry><refentrytitle>NetworkManager.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-settings</refentrytitle><manvolnum>5</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-applet</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-connection-editor</refentrytitle><manvolnum>1</manvolnum></citerefentry>.</para> + </refsect1> + +</refentry> diff --git a/man/nmtui.xml b/man/nmtui.xml new file mode 100644 index 0000000000..d92f525bca --- /dev/null +++ b/man/nmtui.xml @@ -0,0 +1,137 @@ +<?xml version='1.0'?> +<?xml-stylesheet type="text/xsl" href="http://docbook.sourceforge.net/release/xsl/current/xhtml/docbook.xsl"?> +<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN" +"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [ +<!ENTITY % entities SYSTEM "common.ent" > +%entities; +]> + +<!-- + nmtui(1) manual page + + This is free documentation; you can redistribute it and/or + modify it under the terms of the GNU General Public License as + published by the Free Software Foundation; either version 2 of + the License, or (at your option) any later version. + + The GNU General Public License's references to "object code" + and "executables" are to be interpreted as the output of any + document formatting or typesetting system, including + intermediate and printed output. + + This manual 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 General Public License for more details. + + You should have received a copy of the GNU General Public Licence along + with this manual; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + + Copyright 2010 - 2016 Red Hat, Inc. +--> + +<refentry id='nmtui'> + + <refentryinfo> + <title>nmtui</title> + <author>NetworkManager developers</author> + </refentryinfo> + + <refmeta> + <refentrytitle>nmtui</refentrytitle> + <manvolnum>1</manvolnum> + <refmiscinfo class="source">NetworkManager</refmiscinfo> + <refmiscinfo class="manual">General Commands Manual</refmiscinfo> + <refmiscinfo class="version">&NM_VERSION;</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>nmtui</refname> + <refpurpose>Text User Interface for controlling NetworkManager</refpurpose> + </refnamediv> + + <refsynopsisdiv id='synopsis'> + <cmdsynopsis> + <command><group choice='plain'> + <arg choice='plain'>nmtui-edit</arg> + <arg choice='plain'>nmtui edit</arg> + </group></command> + <arg choice='plain'> + <group choice='req'> + <arg choice='plain'><replaceable>name</replaceable></arg> + <arg choice='plain'><replaceable>id</replaceable></arg> + </group> + </arg> + </cmdsynopsis> + <cmdsynopsis> + <command><group choice='plain'> + <arg choice='plain'>nmtui-connect</arg> + <arg choice='plain'>nmtui connect</arg> + </group></command> + <arg choice='plain'> + <group choice='req'> + <arg choice='plain'><replaceable>name</replaceable></arg> + <arg choice='plain'><replaceable>uuid</replaceable></arg> + <arg choice='plain'><replaceable>device</replaceable></arg> + <arg choice='plain'><replaceable>SSID</replaceable></arg> + </group> + </arg> + </cmdsynopsis> + <cmdsynopsis> + <command><group choice='plain'> + <arg choice='plain'>nmtui-hostname</arg> + <arg choice='plain'>nmtui hostname</arg> + </group></command> + </cmdsynopsis> + </refsynopsisdiv> + + <refsect1 id='description'><title>Description</title> + <para><command>nmtui</command> is a curses‐based TUI application for + interacting with NetworkManager. When starting <command>nmtui</command>, the + user is prompted to choose the activity to perform unless it was specified as + the first argument.</para> + + <para>The supported activities are:</para> + + <variablelist> + <varlistentry> + <term><option>edit</option></term> + <listitem> + <para>Show a connection editor that supports adding, modifying, viewing and + deleting connections. It provides similar functionality as + <command>nm-connection-editor</command>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>connect</option></term> + <listitem> + <para>Show a list of available connections, with the option to activate or + deactivate them. It provides similar functionality as + <command>nm-applet</command>.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><option>hostname</option></term> + <listitem> + <para>Set the system hostname.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>Corresponding to above activities, <command>nmtui</command> also comes + with binaries named <command>nmtui-edit</command>, + <command>nmtui-connect</command>, and <command>nmtui-hostname</command> to skip + the selection of the activities.</para> + </refsect1> + + <refsect1 id='see_also'><title>See Also</title> + <para><citerefentry><refentrytitle>nmcli</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-applet</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>nm-connection-editor</refentrytitle><manvolnum>1</manvolnum></citerefentry>, + <citerefentry><refentrytitle>NetworkManager</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para> + </refsect1> + +</refentry> diff --git a/src/settings/plugins/ifcfg-rh/nm-ifcfg-rh.xml b/src/settings/plugins/ifcfg-rh/nm-ifcfg-rh.xml index c2a6cb34ea..033fbfaa30 100644 --- a/src/settings/plugins/ifcfg-rh/nm-ifcfg-rh.xml +++ b/src/settings/plugins/ifcfg-rh/nm-ifcfg-rh.xml @@ -1,30 +1,26 @@ -<?xml version="1.0" encoding="UTF-8" ?> +<?xml version="1.0" encoding="UTF-8"?> +<node name="/"> -<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0"> - <interface name="com.redhat.ifcfgrh1"> - <annotation name="org.gtk.GDBus.DocString" value=" - Utility methods for handling NM integration with standard Red Hat ifcfg files. - " /> + <!-- + com.redhat.ifcfgrh1: - <method name="GetIfcfgDetails"> - <annotation name="org.gtk.GDBus.DocString" value=" - Given an ifcfg file, return various internal information about it. - " /> - <arg name="ifcfg" type="s" direction="in"> - <annotation name="org.gtk.GDBus.DocString" value=" - The full path to an ifcfg file. - " /> - </arg> - <arg name="uuid" type="s" direction="out"> - <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. - " /> - </arg> - <arg name="path" type="o" direction="out"> - <annotation name="org.gtk.GDBus.DocString" value=" - The object path of the NM connected backed by this ifcfg file. - " /> - </arg> - </method> - </interface> + Utility methods for handling NM integration with standard Red Hat ifcfg + files. + --> + <interface name="com.redhat.ifcfgrh1"> + + <!-- + GetIfcfgDetails: + @ifcfg: The full path to an ifcfg file. + @uuid: 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. + @path: The object path of the NM connected backed by this ifcfg file. + + Given an ifcfg file, return various internal information about it. + --> + <method name="GetIfcfgDetails"> + <arg name="ifcfg" type="s" direction="in"/> + <arg name="uuid" type="s" direction="out"/> + <arg name="path" type="o" direction="out"/> + </method> + </interface> </node> |