docs/api/network-manager-docs.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
   3                "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
   4 <!ENTITY version SYSTEM "version.xml">
   5 ]>
   6 <book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">
   7   <bookinfo>
   8     <title>NetworkManager D-Bus API Reference Manual</title>
   9     <releaseinfo>Version &version;</releaseinfo>
  10
  11     <copyright>
  12       <year>2012</year>
  13       <year>2016</year>
  14       <holder>The NetworkManager Authors</holder>
  15     </copyright>
  16
  17     <legalnotice>
  18       <para>
  19         Permission is granted to copy, distribute and/or modify this
  20         document under the terms of the <citetitle>GNU Free
  21         Documentation License</citetitle>, Version 1.1 or any later
  22         version published by the Free Software Foundation with no
  23         Invariant Sections, no Front-Cover Texts, and no Back-Cover
  24         Texts. You may obtain a copy of the <citetitle>GNU Free
  25         Documentation License</citetitle> from the Free Software
  26         Foundation by visiting <ulink type="http"
  27         url="http://www.fsf.org">their Web site</ulink> or by writing
  28         to:
  29
  30         <address>
  31           The Free Software Foundation, Inc.,
  32           <street>51 Franklin Street</street> - Fifth Floor,
  33           <city>Boston</city>, <state>MA</state> <postcode>02110-1301</postcode>,
  34           <country>USA</country>
  35         </address>
  36       </para>
  37     </legalnotice>
  38   </bookinfo>
  39
  40   <chapter id="spec">
  41     <title>D-Bus API Reference</title>
  42
  43     <para>
  44       This part documents the D-Bus interface used to access the
  45       NetworkManager daemon.
  46     </para>
  47
  48     <section id="dbus-interfaces">
  49       <title>Interfaces</title>
  50       <!-- TODO: Split me into chapters about daemon, vpn plugins, dispatcher and the secret agent.
  51                     Then describe the daemon's singletons and object hierarchy. -->
  52       <xi:include href="xml/nmdbus-manager-org.freedesktop.NetworkManager.xml"/>
  53       <xi:include href="xml/nmdbus-settings-org.freedesktop.NetworkManager.Settings.xml"/>
  54       <xi:include href="xml/nmdbus-agent-manager-org.freedesktop.NetworkManager.AgentManager.xml"/>
  55       <xi:include href="xml/nmdbus-access-point-org.freedesktop.NetworkManager.AccessPoint.xml"/>
  56       <xi:include href="xml/nmdbus-ppp-manager-org.freedesktop.NetworkManager.PPP.xml"/>
  57       <xi:include href="xml/nmdbus-settings-connection-org.freedesktop.NetworkManager.Settings.Connection.xml"/>
  58       <xi:include href="xml/nmdbus-vpn-connection-org.freedesktop.NetworkManager.VPN.Connection.xml"/>
  59       <xi:include href="xml/nmdbus-active-connection-org.freedesktop.NetworkManager.Connection.Active.xml"/>
  60       <xi:include href="xml/nmdbus-device-org.freedesktop.NetworkManager.Device.xml"/>
  61       <xi:include href="xml/nmdbus-device-adsl-org.freedesktop.NetworkManager.Device.Adsl.xml"/>
  62       <xi:include href="xml/nmdbus-device-bond-org.freedesktop.NetworkManager.Device.Bond.xml"/>
  63       <xi:include href="xml/nmdbus-device-bridge-org.freedesktop.NetworkManager.Device.Bridge.xml"/>
  64       <xi:include href="xml/nmdbus-device-bt-org.freedesktop.NetworkManager.Device.Bluetooth.xml"/>
  65       <xi:include href="xml/nmdbus-device-ethernet-org.freedesktop.NetworkManager.Device.Wired.xml"/>
  66       <xi:include href="xml/nmdbus-device-generic-org.freedesktop.NetworkManager.Device.Generic.xml"/>
  67       <xi:include href="xml/nmdbus-device-infiniband-org.freedesktop.NetworkManager.Device.Infiniband.xml"/>
  68       <xi:include href="xml/nmdbus-device-ip-tunnel-org.freedesktop.NetworkManager.Device.IPTunnel.xml"/>
  69       <xi:include href="xml/nmdbus-device-macvlan-org.freedesktop.NetworkManager.Device.Macvlan.xml"/>
  70       <xi:include href="xml/nmdbus-device-modem-org.freedesktop.NetworkManager.Device.Modem.xml"/>
  71       <xi:include href="xml/nmdbus-device-olpc-mesh-org.freedesktop.NetworkManager.Device.OlpcMesh.xml"/>
  72       <xi:include href="xml/nmdbus-device-team-org.freedesktop.NetworkManager.Device.Team.xml"/>
  73       <xi:include href="xml/nmdbus-device-tun-org.freedesktop.NetworkManager.Device.Tun.xml"/>
  74       <xi:include href="xml/nmdbus-device-veth-org.freedesktop.NetworkManager.Device.Veth.xml"/>
  75       <xi:include href="xml/nmdbus-device-vlan-org.freedesktop.NetworkManager.Device.Vlan.xml"/>
  76       <xi:include href="xml/nmdbus-device-vxlan-org.freedesktop.NetworkManager.Device.Vxlan.xml"/>
  77       <xi:include href="xml/nmdbus-device-wifi-org.freedesktop.NetworkManager.Device.Wireless.xml"/>
  78       <xi:include href="xml/nmdbus-device-wimax-org.freedesktop.NetworkManager.Device.WiMax.xml"/>
  79       <xi:include href="xml/nmdbus-dhcp4-config-org.freedesktop.NetworkManager.DHCP4Config.xml"/>
  80       <xi:include href="xml/nmdbus-dhcp6-config-org.freedesktop.NetworkManager.DHCP6Config.xml"/>
  81       <xi:include href="xml/nmdbus-ip4-config-org.freedesktop.NetworkManager.IP4Config.xml"/>
  82       <xi:include href="xml/nmdbus-ip6-config-org.freedesktop.NetworkManager.IP6Config.xml"/>
  83       <xi:include href="xml/nmdbus-vpn-plugin-org.freedesktop.NetworkManager.VPN.Plugin.xml"/>
  84       <xi:include href="xml/nmdbus-secret-agent-org.freedesktop.NetworkManager.SecretAgent.xml"/>
  85     </section>
  86   </chapter>
  87
  88   <chapter id="ref-settings">
  89     <title>Network Configuration Setting Specification</title>
  90     <para>
  91       This part documents the properties and value types of each "Setting"
  92       object that composes the basic unit of NetworkManager configuration,
  93       the "Connection".  Each Connection object is simply a dictionary mapping
  94       setting names (like "802-3-ethernet" or "bluetooth") to a dictionary of
  95       key/value pairs that represents each itself.
  96     </para>
  97     <xi:include href="settings-spec.xml">
  98       <xi:fallback>
  99         <section>
 100           <title>Configuration Settings</title>
 101           <note><para>
 102             (NetworkManager was built without full introspection support. Setting
 103             documentation is not available.)
 104           </para></note>
 105         </section>
 106       </xi:fallback>
 107     </xi:include>
 108     <section id="secrets-flags">
 109       <title>Secret flag types</title>
 110       <para>
 111         Each secret property in a setting has an associated "flags" property
 112         that describes how to handle that secret.  The "flags" property is a
 113         bitfield that contains zero or more of the following values logically
 114         OR-ed together.
 115       </para>
 116       <para>
 117         <itemizedlist>
 118           <listitem>
 119             <literal>0x0 (none)</literal> - the system is responsible for providing
 120             and storing this secret.
 121           </listitem>
 122           <listitem>
 123             <literal>0x1 (agent-owned)</literal> - a user-session secret agent
 124             is responsible for providing and storing this secret; when it is
 125             required, agents will be asked to provide it.
 126           </listitem>
 127           <listitem>
 128             <literal>0x2 (not-saved)</literal> - this secret should not be saved
 129             but should be requested from the user each time it is required. This
 130             flag should be used for One-Time-Pad secrets, PIN codes from
 131             hardware tokens, or if the user simply does not want to save the
 132             secret.
 133           </listitem>
 134           <listitem>
 135             <literal>0x4 (not-required)</literal> - in some situations it cannot
 136             be automatically determined that a secret is required or not.  This
 137             flag hints that the secret is not required and should not be
 138             requested from the user.
 139           </listitem>
 140         </itemizedlist>
 141       </para>
 142     </section>
 143   </chapter>
 144
 145   <index>
 146     <title>Index</title>
 147   </index>
 148
 149   <!-- License -->
 150
 151   <appendix id="license">
 152     <title>License</title>
 153     <para>
 154 <programlisting><xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="../../COPYING" parse="text"><xi:fallback>FIXME: MISSING XINCLUDE CONTENT</xi:fallback></xi:include></programlisting>
 155     </para>
 156   </appendix>
 157 </book>
 158