summaryrefslogtreecommitdiffstats
path: root/knetworkmanager-0.8/introspection/nm-vpn-connection.xml
blob: e5f74e142343b073125abb07be7177563ff69472 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
<?xml version="1.0" encoding="UTF-8" ?>

<node name="/" xmlns:tp="http://telepathy.freedesktop.org/wiki/DbusSpec#extensions-v0">
  <interface name="org.freedesktop.NetworkManager.Connection.Active">
    <property name="ServiceName" type="s" access="read">
      <tp:docstring>The D-Bus service name providing this connection.</tp:docstring>
    </property>
    <property name="Connection" type="o" access="read">
      <tp:docstring>The path of the connection.</tp:docstring>
    </property>
    <property name="SpecificObject" type="o" access="read">
      <tp:docstring>A specific object associated with the active connection.</tp:docstring>
    </property>
    <property name="SharedServiceName" type="s" access="read">
      <tp:docstring>The D-Bus service name that provides a connection with which this active connection is shared.</tp:docstring>
    </property>
    <property name="SharedConnection" type="o" access="read">
      <tp:docstring>The path of a connection provided by the D-Bus service SharedServiceName which which this connection is shared.</tp:docstring>
    </property>
    <property name="Devices" type="ao" access="read">
      <tp:docstring>Array of object paths representing devices which are part of this active connection.</tp:docstring>
    </property>
    <property name="State" type="u" access="read" tp:type="NM_ACTIVE_DEVICE_STATE">
      <tp:docstring>The state of this active connection.</tp:docstring>
    </property>
    <property name="Default" type="b" access="read">
      <tp:docstring>Whether this active connection is the default connection, i.e. whether it currently owns the default route.</tp:docstring>
    </property>
  </interface>

  <interface name="org.freedesktop.NetworkManager.VPN.Connection">
    <tp:docstring>
      Represents an active connection to a Virtual Private Network.
    </tp:docstring>

    <signal name="PropertiesChanged">
        <arg name="properties" type="a{sv}" tp:type="String_Variant_Map">
            <tp:docstring>
                A dictionary mapping property names to variant boxed values
            </tp:docstring>
        </arg>
    </signal>

    <property name="VpnState" type="u" access="read" tp:type="NM_VPN_CONNECTION_STATE">
      <tp:docstring>The VPN-specific state of the connection.</tp:docstring>
    </property>
    <property name="Banner" type="s" access="read">
      <tp:docstring>The banner string of the VPN connection.</tp:docstring>
    </property>

    <signal name="VpnStateChanged">
      <tp:docstring>
        Emitted when the state of the VPN connection has changed.
      </tp:docstring>
      <arg name="state" type="u" tp:type="NM_VPN_CONNECTION_STATE">
        <tp:docstring>
          The new state of the VPN connection.
        </tp:docstring>
      </arg>
      <arg name="reason" type="u" tp:type="NM_VPN_CONNECTION_STATE_REASON">
        <tp:docstring>
          Reason code describing the change to the new state.
        </tp:docstring>
      </arg>
    </signal>

    <tp:enum name="NM_VPN_CONNECTION_STATE" type="u">
      <tp:enumvalue suffix="UNKNOWN" value="0">
        <tp:docstring>
          The state of the VPN connection is unknown.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="PREPARE" value="1">
        <tp:docstring>
          The VPN connection is preparing to connect.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="NEED_AUTH" value="2">
        <tp:docstring>
          The VPN connection needs authorization credentials.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="CONNECT" value="3">
        <tp:docstring>
          The VPN connection is being established.  FIXME: Should be CONNECTING or CONNECTED.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="IP_CONFIG_GET" value="4">
        <tp:docstring>
          The VPN connection is getting an IP address.  FIXME: Should be an -ING 
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="ACTIVATED" value="5">
        <tp:docstring>
          The VPN connection is active.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="FAILED" value="6">
        <tp:docstring>
          The VPN connection failed.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="DISCONNECTED" value="7">
        <tp:docstring>
          The VPN connection is disconnected.
        </tp:docstring>
      </tp:enumvalue>
    </tp:enum>
    <tp:enum name="NM_VPN_CONNECTION_STATE_REASON" type="u">
      <tp:enumvalue suffix="UNKNOWN" value="0">
        <tp:docstring>
          The reason for the VPN connection state change is unknown.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="NONE" value="1">
        <tp:docstring>
          No reason was given for the VPN connection state change.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="USER_DISCONNECTED" value="2">
        <tp:docstring>
          The VPN connection changed state because the user disconnected it.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="DEVICE_DISCONNECTED" value="3">
        <tp:docstring>
          The VPN connection changed state because the device it was using was disconnected.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="SERVICE_STOPPED" value="4">
        <tp:docstring>
          The service providing the VPN connection was stopped.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="IP_CONFIG_INVALID" value="5">
        <tp:docstring>
          The IP config of the VPN connection was invalid.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="CONNECT_TIMEOUT" value="6">
        <tp:docstring>
          The connection attempt to the VPN service timed out.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="SERVICE_START_TIMEOUT" value="7">
        <tp:docstring>
          A timeout occurred while starting the service providing the VPN connection.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="SERVICE_START_FAILED" value="8">
        <tp:docstring>
          Starting the service starting the service providing the VPN connection failed.
        </tp:docstring>
      </tp:enumvalue>
      <tp:enumvalue suffix="NO_SECRETS" value="9">
        <tp:docstring>
          Necessary secrets for the VPN connection were not provided.
        </tp:docstring>
      </tp:enumvalue>
    </tp:enum>
  </interface>
</node>