5 Interface net.connman.Service
6 Object path [variable prefix]/{service0,service1,...}
8 Methods dict GetProperties()
10 Returns properties for the service object. See
11 the properties section for available properties.
13 Possible Errors: [service].Error.InvalidArguments
15 void SetProperty(string name, variant value)
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: [service].Error.InvalidArguments
23 [service].Error.InvalidProperty
25 void ClearProperty(string name)
27 Clears the value of the specified property.
29 Possible Errors: [service].Error.InvalidArguments
30 [service].Error.InvalidProperty
34 Connect this service. It will attempt to connect
35 WiFi, WiMAX or Bluetooth services.
37 For Ethernet devices this method can only be used
38 if it has previously been disconnected. Otherwise
39 the plugging of a cable will trigger connecting
40 automatically. If no cable is plugged in this method
43 This method call will only return in case of an
44 error or when the service is fully connected. So
45 setting a longer D-Bus timeout might be a really
48 Possible Errors: [service].Error.InvalidArguments
52 Disconnect this service. If the service is not
53 connected an error message will be generated.
55 On Ethernet devices this will disconnect the IP
56 details from the service. It will not magically
57 unplug the cable. When no cable is plugged in this
60 This method can also be used to abort a previous
61 connectiong attempt via the Connect method.
63 Possible Errors: [service].Error.InvalidArguments
67 A successfully connected service with Favorite=true
68 can be removed this way. If it is connected, it will
69 be automatically disconnected first.
71 If the service requires a passphrase it will be
72 cleared and forgotten when removing.
74 This is similar to setting the Favorite property
75 to false, but that is currently not supported.
77 In the case a connection attempt failed and the
78 service is in the State=failure, this method can
79 also be used to reset the service.
81 Calling this method on Ethernet devices will cause
82 an error message. It is not possible to remove these
85 Possible Errors: [service].Error.InvalidArguments
87 void MoveBefore(object service)
89 If a service has been used before, this allows a
90 reorder of the favorite services.
92 The target service object must be part of this
93 profile. Moving between profiles is not supported.
95 Possible Errors: [service].Error.InvalidArguments
97 void MoveAfter(object service)
99 If a service has been used before, this allows a
100 reorder of the favorite services.
102 The target service object must be part of this
103 profile. Moving between profiles is not supported.
105 Possible Errors: [service].Error.InvalidArguments
107 void ResetCounters() [experimental]
109 Reset the counter statistics.
111 Possible Errors: None
113 Signals PropertyChanged(string name, variant value)
115 This signal indicates a changed value of the given
118 Properties string State [readonly]
120 The service state information.
122 Valid states are "idle", "failure", "association",
123 "configuration", "ready" and "online".
125 The "ready" state signals a successfully
126 connected device. "online" signals that an
127 Internet connection is available and has been
130 string Error [readonly]
132 The service error status details.
134 When error occur during connection or disconnection
135 the detailed information is represented in this
136 property to help the user interface to present the
137 user with alternate options.
139 This property is only valid when the service is in
140 the "failure" state. Otherwise it might be empty or
143 Current defined error code is "dhcp-failed".
145 string Name [readonly]
147 The service name (for example "Wireless" etc.)
149 This name can be used for directly displaying it in
150 the application. It has pure informational purpose.
152 For Ethernet devices and hidden WiFi networks it is
153 not guaranteed that this property is present.
155 string Type [readonly]
157 The service type (for example "ethernet", "wifi" etc.)
159 This information should only be used to determine
160 advanced properties or showing the correct icon
163 array{string} Security [readonly]
165 If the service type is WiFi, then this property is
166 present and contains the list of security methods
167 or key management settings.
169 Possible values are "none", "wep", "psk", "ieee8021x"
172 This property might be only present for WiFi
175 uint8 Strength [readonly]
177 Indicates the signal strength of the service. This
178 is a normalized value between 0 and 100.
180 This property will not be present for Ethernet
183 boolean Favorite [readonly]
185 Will be true if a cable is plugged in or the user
186 selected and successfully connected to this service.
188 This value is automatically changed and to revert
189 it back to false the Remove() method needs to be
192 boolean Immutable [readonly]
194 This value will be set to true if the service is
195 configured externally via a configuration file.
197 The only valid operation are Connect() and of
198 course Disconnect(). The Remove() method will
201 boolean AutoConnect [readwrite]
203 If set to true, this service will auto-connect
204 when no other connection is available.
206 The service won't auto-connect while roaming.
208 For favorite services it is possible to change
209 this value to prevent or permit automatic
212 boolean Roaming [readonly]
214 This property indicates if this service is roaming.
216 In the case of Cellular services this normally
217 indicates connections to a foreign provider when
220 array{string} Nameservers [readonly]
222 The list of currently active nameservers for this
223 service. If the server is not in READY or ONLINE
224 state than this list will be empty.
226 Global nameservers are automatically added to this
227 list. The array represents a sorted list of the
228 current nameservers. The first one has the highest
229 priority and is used by default.
231 When using DHCP this array represents the nameservers
232 provided by the network. In case of manual settings,
233 the ones from Nameservers.Configuration are used.
235 array{string} Nameservers.Configuration [readwrite]
237 The list of manually configured domain name
238 servers. Some cellular networks don't provide
239 correct name servers and this allows for an
242 This array is sorted by priority and the first
243 entry in the list represents the nameserver with
244 the highest priority.
246 When using manual configuration and no global
247 nameservers are configured, then it is useful
248 to configure this setting.
250 Changes to the domain name servers can be done
251 at any time. It will not cause a disconnect of
252 the service. However there might be small window
253 where name resolution might fail.
255 array{string} Domains [readonly]
257 The list of currently used search domains.
259 array{string} Domains.Configuration [readwrite]
261 The list of manually configured search domains.
265 string Method [readonly]
267 Possible values are "dhcp", "manual"
270 The value "fixed" indicates an IP address
271 that can not be modified. For example
272 cellular networks return fixed information.
274 string Address [readonly]
276 The current configured IPv4 address.
278 string Netmask [readonly]
280 The current configured IPv4 netmask.
282 string Gateway [readonly]
284 The current configured IPv4 gateway.
286 dict IPv4.Configuration [readwrite]
288 Same values as IPv4 property. The IPv4 represents
289 the actual system configuration while this allows
292 Changing these settings will cause a state change
293 of the service. The service will become unavailable
294 until the new configuration has been successfully
299 string Method [readonly]
301 Possible values are "auto", "manual", "6to4"
304 The value "fixed" indicates an IP address
305 that can not be modified. For example
306 cellular networks return fixed information.
307 The value "6to4" is returned if 6to4 tunnel
308 is created by connman. The tunnel can only be
309 created if method was set to "auto" by the
310 user. User cannot set the method to "6to4".
312 string Address [readonly]
314 The current configured IPv6 address.
316 uint8 PrefixLength [readonly]
318 The prefix length of the IPv6 address.
320 string Gateway [readonly]
322 The current configured IPv6 gateway.
324 string Privacy [readonly]
326 Enable or disable IPv6 privacy extension
327 that is described in RFC 4941. The value
328 has only meaning if Method is set to "auto".
330 Value "disabled" means that privacy extension
331 is disabled and normal autoconf addresses are
334 Value "enabled" means that privacy extension is
335 enabled and system prefers to use public
336 addresses over temporary addresses.
338 Value "prefered" means that privacy extension is
339 enabled and system prefers temporary addresses
340 over public addresses.
342 Default value is "disabled".
344 dict IPv6.Configuration [readwrite]
346 Same values as IPv6 property. The IPv6 represents
347 the actual system configuration while this allows
350 Changing these settings will cause a state change
351 of the service. The service will become unavailable
352 until the new configuration has been successfully
355 dict Proxy [readonly]
357 string Method [readonly]
359 Possible values are "direct", "auto" and
362 In case of "auto" method, the URL file can be
363 provided unless you want to let DHCP/WPAD
364 auto-discover to be tried. In such case if DHCP
365 and WPAD auto-discover methods fails then
366 method will be "direct".
368 In case of "direct" no additional information
369 are provided. For the "manual" method the
370 Servers have to be set, Excludes is optional.
372 string URL [readonly]
374 Automatic proxy configuration URL. Used by
377 array{string} Servers [readonly]
379 Used when "manual" method is set.
381 List of proxy URIs. The URI without a protocol
382 will be interpreted as the generic proxy URI.
383 All others will target a specific protocol and
386 Example for generic proxy server entry would
387 be like this: "server.example.com:911".
389 array{string} Excludes [readonly]
391 Used when "manual" method is set.
393 List of hosts which can be accessed directly.
395 dict Proxy.Configuration [readwrite]
397 Same values as Proxy property. The Proxy represents
398 the actual system configuration while this allows
401 If "auto" method is set with an empty URL, then
402 DHCP/WPAD auto-discover will be tried. Otherwise the
403 specified URL will be used.
405 dict Provider [readonly]
407 string Host [readonly]
411 string Domain [readonly]
415 string Name [readonly]
419 string Type [readonly]
423 dict Ethernet [readonly]
425 string Method [readonly]
427 Possible values are "auto" and "manual".
429 string Interface [readonly]
431 Interface name (for example eth0).
433 string Address [readonly]
435 Ethernet device address (MAC address).
437 uint16 MTU [readonly]
439 The Ethernet MTU (default is 1500).
441 uint16 Speed [readonly]
443 Selected speed of the line.
445 This information might not always be
448 string Duplex [readonly]
450 Selected duplex settings of the line.
452 Possible values are "half" and "full".
454 This information might not always be