workspace/solid/networkmanager-0.7/dbus/introspection/nm-vpn-connection.xml

   1 <?xml version="1.0" encoding="UTF-8" ?>
   2
   3 <node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
   4   <interface name="org.freedesktop.NetworkManager.Connection.Active">
   5     <property name="ServiceName" type="s" access="read">
   6       <tp:docstring>The D-Bus service name providing this connection.</tp:docstring>
   7     </property>
   8     <property name="Connection" type="o" access="read">
   9       <tp:docstring>The path of the connection.</tp:docstring>
  10     </property>
  11     <property name="SpecificObject" type="o" access="read">
  12       <tp:docstring>A specific object associated with the active connection.</tp:docstring>
  13     </property>
  14     <property name="Devices" type="ao" access="read">
  15       <tp:docstring>Array of object paths representing devices which are part of this active connection.</tp:docstring>
  16     </property>
  17     <property name="State" type="u" access="read" tp:type="NM_ACTIVE_CONNECTION_STATE">
  18       <tp:docstring>The state of this active connection.</tp:docstring>
  19     </property>
  20     <property name="Default" type="b" access="read">
  21       <tp:docstring>Whether this active connection is the default connection, i.e. whether it currently owns the default route.</tp:docstring>
  22     </property>
  23   </interface>
  24
  25   <interface name="org.freedesktop.NetworkManager.VPN.Connection">
  26     <tp:docstring>
  27       Represents an active connection to a Virtual Private Network.
  28     </tp:docstring>
  29
  30     <signal name="PropertiesChanged">
  31         <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
  32             <tp:docstring>
  33                 A dictionary mapping property names to variant boxed values
  34             </tp:docstring>
  35         </arg>
  36     </signal>
  37
  38     <property name="VpnState" type="u" access="read" tp:type="NM_VPN_CONNECTION_STATE">
  39       <tp:docstring>The VPN-specific state of the connection.</tp:docstring>
  40     </property>
  41     <property name="Banner" type="s" access="read">
  42       <tp:docstring>The banner string of the VPN connection.</tp:docstring>
  43     </property>
  44
  45     <signal name="VpnStateChanged">
  46       <tp:docstring>
  47         Emitted when the state of the VPN connection has changed.
  48       </tp:docstring>
  49       <arg name="state" type="u" tp:type="NM_VPN_CONNECTION_STATE">
  50         <tp:docstring>
  51           The new state of the VPN connection.
  52         </tp:docstring>
  53       </arg>
  54       <arg name="reason" type="u" tp:type="NM_VPN_CONNECTION_STATE_REASON">
  55         <tp:docstring>
  56           Reason code describing the change to the new state.
  57         </tp:docstring>
  58       </arg>
  59     </signal>
  60
  61     <tp:enum name="NM_VPN_CONNECTION_STATE" type="u">
  62       <tp:enumvalue suffix="UNKNOWN" value="0">
  63         <tp:docstring>
  64           The state of the VPN connection is unknown.
  65         </tp:docstring>
  66       </tp:enumvalue>
  67       <tp:enumvalue suffix="PREPARE" value="1">
  68         <tp:docstring>
  69           The VPN connection is preparing to connect.
  70         </tp:docstring>
  71       </tp:enumvalue>
  72       <tp:enumvalue suffix="NEED_AUTH" value="2">
  73         <tp:docstring>
  74           The VPN connection needs authorization credentials.
  75         </tp:docstring>
  76       </tp:enumvalue>
  77       <tp:enumvalue suffix="CONNECT" value="3">
  78         <tp:docstring>
  79           The VPN connection is being established.  FIXME: Should be CONNECTING or CONNECTED.
  80         </tp:docstring>
  81       </tp:enumvalue>
  82       <tp:enumvalue suffix="IP_CONFIG_GET" value="4">
  83         <tp:docstring>
  84           The VPN connection is getting an IP address.  FIXME: Should be an -ING
  85         </tp:docstring>
  86       </tp:enumvalue>
  87       <tp:enumvalue suffix="ACTIVATED" value="5">
  88         <tp:docstring>
  89           The VPN connection is active.
  90         </tp:docstring>
  91       </tp:enumvalue>
  92       <tp:enumvalue suffix="FAILED" value="6">
  93         <tp:docstring>
  94           The VPN connection failed.
  95         </tp:docstring>
  96       </tp:enumvalue>
  97       <tp:enumvalue suffix="DISCONNECTED" value="7">
  98         <tp:docstring>
  99           The VPN connection is disconnected.
 100         </tp:docstring>
 101       </tp:enumvalue>
 102     </tp:enum>
 103     <tp:enum name="NM_VPN_CONNECTION_STATE_REASON" type="u">
 104       <tp:enumvalue suffix="UNKNOWN" value="0">
 105         <tp:docstring>
 106           The reason for the VPN connection state change is unknown.
 107         </tp:docstring>
 108       </tp:enumvalue>
 109       <tp:enumvalue suffix="NONE" value="1">
 110         <tp:docstring>
 111           No reason was given for the VPN connection state change.
 112         </tp:docstring>
 113       </tp:enumvalue>
 114       <tp:enumvalue suffix="USER_DISCONNECTED" value="2">
 115         <tp:docstring>
 116           The VPN connection changed state because the user disconnected it.
 117         </tp:docstring>
 118       </tp:enumvalue>
 119       <tp:enumvalue suffix="DEVICE_DISCONNECTED" value="3">
 120         <tp:docstring>
 121           The VPN connection changed state because the device it was using was disconnected.
 122         </tp:docstring>
 123       </tp:enumvalue>
 124       <tp:enumvalue suffix="SERVICE_STOPPED" value="4">
 125         <tp:docstring>
 126           The service providing the VPN connection was stopped.
 127         </tp:docstring>
 128       </tp:enumvalue>
 129       <tp:enumvalue suffix="IP_CONFIG_INVALID" value="5">
 130         <tp:docstring>
 131           The IP config of the VPN connection was invalid.
 132         </tp:docstring>
 133       </tp:enumvalue>
 134       <tp:enumvalue suffix="CONNECT_TIMEOUT" value="6">
 135         <tp:docstring>
 136           The connection attempt to the VPN service timed out.
 137         </tp:docstring>
 138       </tp:enumvalue>
 139       <tp:enumvalue suffix="SERVICE_START_TIMEOUT" value="7">
 140         <tp:docstring>
 141           A timeout occurred while starting the service providing the VPN connection.
 142         </tp:docstring>
 143       </tp:enumvalue>
 144       <tp:enumvalue suffix="SERVICE_START_FAILED" value="8">
 145         <tp:docstring>
 146           Starting the service starting the service providing the VPN connection failed.
 147         </tp:docstring>
 148       </tp:enumvalue>
 149       <tp:enumvalue suffix="NO_SECRETS" value="9">
 150         <tp:docstring>
 151           Necessary secrets for the VPN connection were not provided.
 152         </tp:docstring>
 153       </tp:enumvalue>
 154     </tp:enum>
 155   </interface>
 156 </node>
 157