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 or the
18 properties defined as a dict passed as variant, where
19 the format is equal to the dict returned by
20 GetProperties(). Only properties that are listed as
21 read-write are changeable. Property name "Properties"
22 indicates a dict of properties. On success a
23 PropertyChanged signal will be emitted for the
24 specified property or for all changed properties
25 individually. If there is no change in property value
26 no PropertyChanged signal is sent. Configuration is
27 written to disk when one or more values are changed.
28 In case a dict of properties are given, configuration
29 write is done after all properties are processed.
30 Specifics in dict use in contrast to setting a single
32 - Dict can contain values set as empty strings
33 or arrays. This causes the values to be
34 cleared as if using ClearProperty().
35 - If there are errors with the properties,
36 InvalidProperty or PermissionDenied error is
37 returned. InvalidProperty is sent when there
38 is at least one invalid property, in this
39 case there can be also properties that
40 cannot be changed (immutable properties).
41 If there are only immutable properties
42 PermissionDenied error is returned.
43 - The properties that are invalid or immutable
44 are reported back at the end of the error
45 message as a comma separated property name
47 - One invalid/immutable property does not
48 cause the rest of the properties to be
49 ignored. If there are valid and invalid
50 properties, the valid properties emit
51 PropertyChanged signal and invalid are
52 reported back with an InvalidProperty
55 Possible Errors: [connection].Error.InvalidArguments
56 [connection].Error.InvalidProperty
57 [connection].Error.PermissionDenied
58 [connection].Error.NotSupported
60 void ClearProperty(string name) [experimental]
62 Clears the value of the specified property.
64 Possible Errors: [connection].Error.InvalidArguments
65 [connection].Error.InvalidProperty
66 [connection].Error.PermissionDenied
68 void Connect() [experimental]
70 Connect this VPN connection. It will attempt to connect
71 to the VPN connection. The Connect() will wait until
72 the connection is created or there is an error. The
73 error description is returned in dbus error.
75 Possible Errors: [connection].Error.InvalidArguments
76 [connection].Error.InProgress
78 void Connect2(string dbus_sender) [experimental]
80 Connect this VPN connection. The Connect2() is a
81 wrapper for Connect() allowing to pass original D-Bus
82 sender when proxying the connection request. The
83 Connect2() will wait until the connection is created or
84 there is an error. The error description is returned in
87 Possible Errors: [connection].Error.InvalidArguments
88 [connection].Error.InProgress
91 void Disconnect() [experimental]
93 Disconnect this VPN connection. If the connection is
94 not connected an error message will be generated.
96 Possible Errors: [connection].Error.InvalidArguments
98 Signals PropertyChanged(string name, variant value) [experimental]
100 This signal indicates a changed value of the given
103 Properties string State [readonly]
105 The connection state information.
107 Valid states are "idle", "failure", "configuration",
108 "ready", "disconnect".
110 string Type [readonly]
112 The VPN type (for example "openvpn", "vpnc" etc.)
114 string Name [readonly]
118 string Domain [readonly]
120 The domain name used behind the VPN connection.
121 This is optional for most VPN technologies.
123 string Host [readonly]
125 The VPN host (server) address.
127 boolean Immutable [readonly]
129 This value will be set to true if the connection is
130 configured externally via a configuration file.
132 The only valid operation are Connect(), Disconnect()
137 This value reflects the split routing setting on
138 connmand side. By default, this value is omitted and
139 defaults to false. The value needs to be explicitly
140 set to true for VPN to be split routed.
144 The index of the VPN network tunneling interface.
145 If there is no tunneling device, then this value
152 The current configured IPv4 address.
156 The current configured IPv4 netmask.
160 The current configured IPv4 gateway.
164 The current configured VPN tunnel endpoint
171 The current configured IPv6 address.
175 The prefix length of the IPv6 address.
179 The current configured IPv6 gateway.
183 The current configured VPN tunnel endpoint
186 array{string} Nameservers [readonly]
188 The list of nameservers set by VPN.
190 array{dict} UserRoutes [readwrite]
194 Protocol family of the route. Set to 4
195 if IPv4 and 6 if IPv6 route. Set to 0
196 (PF_UNSPEC) or omit, to have it assigned
201 The network part of the route.
205 The netmask of the route. For IPv6 routes,
206 this is the prefix length.
210 Gateway address of the route.
212 The list of currently active user activated
215 array{dict} ServerRoutes [readonly]
219 Protocol family of the route. Set to 4
220 if IPv4 and 6 if IPv6 route.
224 The network part of the route.
228 The netmask of the route. For IPv6 routes,
229 this is the prefix length.
233 Gateway address of the route.
235 The VPN server activated route. These routes
236 are pushed to connman by VPN server.
238 There can be other properties also but as the VPN
239 technologies are so different, they have different
240 kind of options that they need, so not all options
241 are mentioned in this document.