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 Disconnect() [experimental]
44 Disconnect this VPN connection. If the connection is
45 not connected an error message will be generated.
47 Possible Errors: [connection].Error.InvalidArguments
49 Signals PropertyChanged(string name, variant value) [experimental]
51 This signal indicates a changed value of the given
54 Properties string State [readonly]
56 The connection state information.
58 Valid states are "idle", "failure", "configuration",
59 "ready", "disconnect".
61 string Type [readonly]
63 The VPN type (for example "openvpn", "vpnc" etc.)
65 string Name [readonly]
69 string Domain [readonly]
71 The domain name used behind the VPN connection.
72 This is optional for most VPN technologies.
74 string Host [readonly]
76 The VPN host (server) address.
78 boolean Immutable [readonly]
80 This value will be set to true if the connection is
81 configured externally via a configuration file.
83 The only valid operation are Connect(), Disconnect()
88 The index of the VPN network tunneling interface.
89 If there is no tunneling device, then this value
96 The current configured IPv4 address.
100 The current configured IPv4 netmask.
104 The current configured IPv4 gateway.
108 The current configured VPN tunnel endpoint
115 The current configured IPv6 address.
119 The prefix length of the IPv6 address.
123 The current configured IPv6 gateway.
127 The current configured VPN tunnel endpoint
130 array{string} Nameservers [readonly]
132 The list of nameservers set by VPN.
134 array{dict} UserRoutes [readwrite]
138 Protocol family of the route. Set to 4
139 if IPv4 and 6 if IPv6 route.
143 The network part of the route.
147 The netmask of the route. For IPv6 routes,
148 this is the prefix length.
152 Gateway address of the route.
154 The list of currently active user activated
157 array{dict} ServerRoutes [readonly]
161 Protocol family of the route. Set to 4
162 if IPv4 and 6 if IPv6 route.
166 The network part of the route.
170 The netmask of the route. For IPv6 routes,
171 this is the prefix length.
175 Gateway address of the route.
177 The VPN server activated route. These routes
178 are pushed to connman by VPN server.
180 There can be other properties also but as the VPN
181 technologies are so different, they have different
182 kind of options that they need, so not all options
183 are mentioned in this document.