workspace/solid/networkmanager-0.7/dbus/introspection/nm-device.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.Device">
   5     <property name="Udi" type="s" access="read">
   6       <tp:docstring>
   7         HAL UDI for the device.
   8       </tp:docstring>
   9     </property>
  10     <property name="Interface" type="s" access="read">
  11       <tp:docstring>
  12         The network interface offered by the device.
  13       </tp:docstring>
  14     </property>
  15     <property name="Driver" type="s" access="read">
  16       <tp:docstring>
  17         The driver handling the device.
  18       </tp:docstring>
  19     </property>
  20     <property name="Capabilities" type="u" access="read" tp:type="NM_DEVICE_CAP">
  21       <tp:docstring>
  22         Flags describing the capabilities of the device.
  23       </tp:docstring>
  24     </property>
  25     <property name="Ip4Address" type="i" access="read">
  26       <tp:docstring>
  27         The IPv4 address bound to the device. FIXME: what about devices with >1 IP address?
  28       </tp:docstring>
  29     </property>
  30     <property name="State" type="u" access="read" tp:type="NM_DEVICE_STATE">
  31       <tp:docstring>
  32         The current state of the device.
  33       </tp:docstring>
  34     </property>
  35     <property name="Ip4Config" type="o" access="read">
  36       <tp:docstring>
  37         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.
  38       </tp:docstring>
  39     </property>
  40     <property name="Dhcp4Config" type="o" access="read">
  41       <tp:docstring>
  42         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.
  43       </tp:docstring>
  44     </property>
  45     <property name="Managed" type="b" access="read">
  46       <tp:docstring>
  47         Whether or not this device is managed by NetworkManager.
  48       </tp:docstring>
  49     </property>
  50
  51     <!-- Ugh, but I see no other way of getting the type on the caller
  52     based on dbus object path only -->
  53     <property name="DeviceType" type="u" access="read">
  54       <tp:docstring>
  55       </tp:docstring>
  56     </property>
  57
  58
  59     <signal name="StateChanged">
  60       <arg name="new_state" type="u" tp:type="NM_DEVICE_STATE">
  61         <tp:docstring>
  62           The new state of the device.
  63         </tp:docstring>
  64       </arg>
  65       <arg name="old_state" type="u" tp:type="NM_DEVICE_STATE">
  66         <tp:docstring>
  67           The previous state of the device.
  68         </tp:docstring>
  69       </arg>
  70       <arg name="reason" type="u" tp:type="NM_DEVICE_STATE_REASON">
  71         <tp:docstring>
  72           A reason for the state transition.
  73         </tp:docstring>
  74       </arg>
  75     </signal>
  76
  77     <tp:enum name="NM_DEVICE_STATE" type="u">
  78       <tp:enumvalue suffix="UNKNOWN" value="0">
  79         <tp:docstring>
  80           The device is in an unknown state.
  81         </tp:docstring>
  82       </tp:enumvalue>
  83       <tp:enumvalue suffix="UNMANAGED" value="1">
  84         <tp:docstring>
  85           The device is not managed by NetworkManager.
  86         </tp:docstring>
  87       </tp:enumvalue>
  88       <tp:enumvalue suffix="UNAVAILABLE" value="2">
  89         <tp:docstring>
  90           The device cannot be used (carrier off, rfkill, etc).
  91         </tp:docstring>
  92       </tp:enumvalue>
  93       <tp:enumvalue suffix="DISCONNECTED" value="3">
  94         <tp:docstring>
  95           The device is not connected.
  96         </tp:docstring>
  97       </tp:enumvalue>
  98       <tp:enumvalue suffix="PREPARE" value="4">
  99         <tp:docstring>
 100           The device is preparing to connect.
 101         </tp:docstring>
 102       </tp:enumvalue>
 103       <tp:enumvalue suffix="CONFIG" value="5">
 104         <tp:docstring>
 105           The device is being configured.
 106         </tp:docstring>
 107       </tp:enumvalue>
 108       <tp:enumvalue suffix="NEED_AUTH" value="6">
 109         <tp:docstring>
 110           The device is awaiting secrets necessary to continue connection.
 111         </tp:docstring>
 112       </tp:enumvalue>
 113       <tp:enumvalue suffix="IP_CONFIG" value="7">
 114         <tp:docstring>
 115           The IP settings of the device are being requested and configured.
 116         </tp:docstring>
 117       </tp:enumvalue>
 118       <tp:enumvalue suffix="ACTIVATED" value="8">
 119         <tp:docstring>
 120           The device is active.
 121         </tp:docstring>
 122       </tp:enumvalue>
 123       <tp:enumvalue suffix="FAILED" value="9">
 124         <tp:docstring>
 125           The device is in a failure state following an attempt to activate it.
 126         </tp:docstring>
 127       </tp:enumvalue>
 128     </tp:enum>
 129
 130     <tp:flags name="NM_DEVICE_CAP" value-prefix="NM_DEVICE_CAP" type="u">
 131       <tp:flag suffix="NONE" value="0x0">
 132         <tp:docstring>Null capability.</tp:docstring>
 133       </tp:flag>
 134       <tp:flag suffix="NM_SUPPORTED" value="0x1">
 135         <tp:docstring>The device is supported by NetworkManager.</tp:docstring>
 136       </tp:flag>
 137       <tp:flag suffix="CARRIER_DETECT" value="0x2">
 138         <tp:docstring>The device supports carrier detection.</tp:docstring>
 139       </tp:flag>
 140     </tp:flags>
 141
 142     <tp:enum name="NM_DEVICE_STATE_REASON" type="u">
 143       <tp:enumvalue suffix="UNKNOWN" value="0">
 144         <tp:docstring>
 145           The reason for the device state change is unknown.
 146         </tp:docstring>
 147       </tp:enumvalue>
 148       <tp:enumvalue suffix="NONE" value="1">
 149         <tp:docstring>
 150           The state change is normal.
 151         </tp:docstring>
 152       </tp:enumvalue>
 153       <tp:enumvalue suffix="NOW_MANAGED" value="2">
 154         <tp:docstring>
 155           The device is now managed.
 156         </tp:docstring>
 157       </tp:enumvalue>
 158       <tp:enumvalue suffix="NOW_UNMANAGED" value="3">
 159         <tp:docstring>
 160           The device is no longer managed.
 161         </tp:docstring>
 162       </tp:enumvalue>
 163       <tp:enumvalue suffix="CONFIG_FAILED" value="4">
 164         <tp:docstring>
 165           The device could not be readied for configuration.
 166         </tp:docstring>
 167       </tp:enumvalue>
 168       <tp:enumvalue suffix="CONFIG_UNAVAILABLE" value="5">
 169         <tp:docstring>
 170           IP configuration could not be reserved (no available address, timeout, etc).
 171         </tp:docstring>
 172       </tp:enumvalue>
 173       <tp:enumvalue suffix="CONFIG_EXPIRED" value="6">
 174         <tp:docstring>
 175           The IP configuration is no longer valid.
 176         </tp:docstring>
 177       </tp:enumvalue>
 178       <tp:enumvalue suffix="NO_SECRETS" value="7">
 179         <tp:docstring>
 180           Secrets were required, but not provided.
 181         </tp:docstring>
 182       </tp:enumvalue>
 183       <tp:enumvalue suffix="SUPPLICANT_DISCONNECT" value="8">
 184         <tp:docstring>
 185           The 802.1X supplicant disconnected from the access point or authentication server.
 186         </tp:docstring>
 187       </tp:enumvalue>
 188       <tp:enumvalue suffix="SUPPLICANT_CONFIG_FAILED" value="9">
 189         <tp:docstring>
 190           Configuration of the 802.1X supplicant failed.
 191         </tp:docstring>
 192       </tp:enumvalue>
 193       <tp:enumvalue suffix="SUPPLICANT_FAILED" value="10">
 194         <tp:docstring>
 195           The 802.1X supplicant quit or failed unexpectedly.
 196         </tp:docstring>
 197       </tp:enumvalue>
 198       <tp:enumvalue suffix="SUPPLICANT_TIMEOUT" value="11">
 199         <tp:docstring>
 200           The 802.1X supplicant took too long to authenticate.
 201         </tp:docstring>
 202       </tp:enumvalue>
 203       <tp:enumvalue suffix="PPP_START_FAILED" value="12">
 204         <tp:docstring>
 205           The PPP service failed to start within the allowed time.
 206         </tp:docstring>
 207       </tp:enumvalue>
 208       <tp:enumvalue suffix="PPP_DISCONNECT" value="13">
 209         <tp:docstring>
 210           The PPP service disconnected unexpectedly.
 211         </tp:docstring>
 212       </tp:enumvalue>
 213       <tp:enumvalue suffix="PPP_FAILED" value="14">
 214         <tp:docstring>
 215           The PPP service quit or failed unexpectedly.
 216         </tp:docstring>
 217       </tp:enumvalue>
 218       <tp:enumvalue suffix="DHCP_START_FAILED" value="15">
 219         <tp:docstring>
 220           The DHCP service failed to start within the allowed time.
 221         </tp:docstring>
 222       </tp:enumvalue>
 223       <tp:enumvalue suffix="DHCP_ERROR" value="16">
 224         <tp:docstring>
 225           The DHCP service reported an unexpected error.
 226         </tp:docstring>
 227       </tp:enumvalue>
 228       <tp:enumvalue suffix="DHCP_FAILED" value="17">
 229         <tp:docstring>
 230           The DHCP service quit or failed unexpectedly.
 231         </tp:docstring>
 232       </tp:enumvalue>
 233       <tp:enumvalue suffix="SHARED_START_FAILED" value="18">
 234         <tp:docstring>
 235           The shared connection service failed to start.
 236         </tp:docstring>
 237       </tp:enumvalue>
 238       <tp:enumvalue suffix="SHARED_FAILED" value="19">
 239         <tp:docstring>
 240           The shared connection service quit or failed unexpectedly.
 241         </tp:docstring>
 242       </tp:enumvalue>
 243       <tp:enumvalue suffix="AUTOIP_START_FAILED" value="20">
 244         <tp:docstring>
 245           The AutoIP service failed to start.
 246         </tp:docstring>
 247       </tp:enumvalue>
 248       <tp:enumvalue suffix="AUTOIP_ERROR" value="21">
 249         <tp:docstring>
 250           The AutoIP service reported an unexpected error.
 251         </tp:docstring>
 252       </tp:enumvalue>
 253       <tp:enumvalue suffix="AUTOIP_FAILED" value="22">
 254         <tp:docstring>
 255           The AutoIP service quit or failed unexpectedly.
 256         </tp:docstring>
 257       </tp:enumvalue>
 258       <tp:enumvalue suffix="MODEM_BUSY" value="23">
 259         <tp:docstring>
 260           Dialing failed because the line was busy.
 261         </tp:docstring>
 262       </tp:enumvalue>
 263       <tp:enumvalue suffix="MODEM_NO_DIAL_TONE" value="24">
 264         <tp:docstring>
 265           Dialing failed because there was no dial tone.
 266         </tp:docstring>
 267       </tp:enumvalue>
 268       <tp:enumvalue suffix="MODEM_NO_CARRIER" value="25">
 269         <tp:docstring>
 270           Dialing failed because there was carrier.
 271         </tp:docstring>
 272       </tp:enumvalue>
 273       <tp:enumvalue suffix="MODEM_DIAL_TIMEOUT" value="26">
 274         <tp:docstring>
 275           Dialing timed out.
 276         </tp:docstring>
 277       </tp:enumvalue>
 278       <tp:enumvalue suffix="MODEM_DIAL_FAILED" value="27">
 279         <tp:docstring>
 280           Dialing failed.
 281         </tp:docstring>
 282       </tp:enumvalue>
 283       <tp:enumvalue suffix="MODEM_INIT_FAILED" value="28">
 284         <tp:docstring>
 285           Modem initialization failed.
 286         </tp:docstring>
 287       </tp:enumvalue>
 288       <tp:enumvalue suffix="GSM_APN_FAILED" value="29">
 289         <tp:docstring>
 290           Failed to select the specified GSM APN.
 291         </tp:docstring>
 292       </tp:enumvalue>
 293       <tp:enumvalue suffix="GSM_REGISTRATION_NOT_SEARCHING" value="30">
 294         <tp:docstring>
 295           Not searching for networks.
 296         </tp:docstring>
 297       </tp:enumvalue>
 298       <tp:enumvalue suffix="GSM_REGISTRATION_DENIED" value="31">
 299         <tp:docstring>
 300           Network registration was denied.
 301         </tp:docstring>
 302       </tp:enumvalue>
 303       <tp:enumvalue suffix="GSM_REGISTRATION_TIMEOUT" value="32">
 304         <tp:docstring>
 305           Network registration timed out.
 306         </tp:docstring>
 307       </tp:enumvalue>
 308       <tp:enumvalue suffix="GSM_REGISTRATION_FAILED" value="33">
 309         <tp:docstring>
 310           Failed to register with the requested GSM network.
 311         </tp:docstring>
 312       </tp:enumvalue>
 313       <tp:enumvalue suffix="GSM_PIN_CHECK_FAILED" value="34">
 314         <tp:docstring>
 315           PIN check failed.
 316         </tp:docstring>
 317       </tp:enumvalue>
 318       <tp:enumvalue suffix="FIRMWARE_MISSING" value="35">
 319         <tp:docstring>
 320           Necessary firmware for the device may be missing.
 321         </tp:docstring>
 322       </tp:enumvalue>
 323         </tp:enum>
 324
 325   </interface>
 326 </node>