4 Service net.connman.vpn
5 Interface net.connman.vpn.Connection
6 Object path [variable prefix]/{connection0,connection1,...}
8 Methods dict GetProperties() [experimental]
10 Returns properties for the connection object. See
11 the properties section for available properties.
13 Possible Errors: [connection].Error.InvalidArguments
15 void SetProperty(string name, variant value) [experimental]
17 Changes the value of the specified property. Only
18 properties that are listed as read-write are
19 changeable. On success a PropertyChanged signal
22 Possible Errors: [connection].Error.InvalidArguments
23 [connection].Error.InvalidProperty
25 void ClearProperty(string name) [experimental]
27 Clears the value of the specified property.
29 Possible Errors: [connection].Error.InvalidArguments
30 [connection].Error.InvalidProperty
32 void Connect() [experimental]
34 Connect this VPN connection. It will attempt to connect
35 to the VPN connection. The Connect() will wait until
36 the connection is created or there is an error. The
37 error description is returned in dbus error.
39 Possible Errors: [connection].Error.InvalidArguments
40 [connection].Error.InProgress
42 void Connect2(string dbus_sender) [experimental]
44 Connect this VPN connection. The Connect2() is a
45 wrapper for Connect() allowing to pass original D-Bus
46 sender when proxying the connection request. The
47 Connect2() will wait until the connection is created or
48 there is an error. The error description is returned in
51 Possible Errors: [connection].Error.InvalidArguments
52 [connection].Error.InProgress
55 void Disconnect() [experimental]
57 Disconnect this VPN connection. If the connection is
58 not connected an error message will be generated.
60 Possible Errors: [connection].Error.InvalidArguments
62 Signals PropertyChanged(string name, variant value) [experimental]
64 This signal indicates a changed value of the given
67 Properties string State [readonly]
69 The connection state information.
71 Valid states are "idle", "failure", "configuration",
72 "ready", "disconnect".
74 string Type [readonly]
76 The VPN type (for example "openvpn", "vpnc" etc.)
78 string Name [readonly]
82 string Domain [readonly]
84 The domain name used behind the VPN connection.
85 This is optional for most VPN technologies.
87 string Host [readonly]
89 The VPN host (server) address.
91 boolean Immutable [readonly]
93 This value will be set to true if the connection is
94 configured externally via a configuration file.
96 The only valid operation are Connect(), Disconnect()
101 The index of the VPN network tunneling interface.
102 If there is no tunneling device, then this value
109 The current configured IPv4 address.
113 The current configured IPv4 netmask.
117 The current configured IPv4 gateway.
121 The current configured VPN tunnel endpoint
128 The current configured IPv6 address.
132 The prefix length of the IPv6 address.
136 The current configured IPv6 gateway.
140 The current configured VPN tunnel endpoint
143 array{string} Nameservers [readonly]
145 The list of nameservers set by VPN.
147 array{dict} UserRoutes [readwrite]
151 Protocol family of the route. Set to 4
152 if IPv4 and 6 if IPv6 route.
156 The network part of the route.
160 The netmask of the route. For IPv6 routes,
161 this is the prefix length.
165 Gateway address of the route.
167 The list of currently active user activated
170 array{dict} ServerRoutes [readonly]
174 Protocol family of the route. Set to 4
175 if IPv4 and 6 if IPv6 route.
179 The network part of the route.
183 The netmask of the route. For IPv6 routes,
184 this is the prefix length.
188 Gateway address of the route.
190 The VPN server activated route. These routes
191 are pushed to connman by VPN server.
193 There can be other properties also but as the VPN
194 technologies are so different, they have different
195 kind of options that they need, so not all options
196 are mentioned in this document.