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
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"
170 and also "wps". Alternate values for "psk" can also
173 This property might be only present for WiFi
176 boolean LoginRequired [readonly]
178 This property indicates that an additional login
179 step, like web based authentication, is needed
180 before the connection establishment can proceed.
182 string Passphrase [readwrite]
184 If the service type is WiFi, then this property
185 can be used to store a passphrase.
187 No PropertyChanged signals will be sent for this
188 property. The PassphraseRequired property should
189 be monitored instead.
191 This property might also not always be included
192 since it is protected by a different security policy.
194 boolean PassphraseRequired [readonly]
196 If the service type is WiFi, then this property
197 indicates if a passphrase is required.
199 If a passphrase has been set already or if no
200 passphrase is needed, then this property will
203 uint8 Strength [readonly]
205 Indicates the signal strength of the service. This
206 is a normalized value between 0 and 100.
208 This property will not be present for Ethernet
211 boolean Favorite [readonly]
213 Will be true if a cable is plugged in or the user
214 selected and successfully connected to this service.
216 This value is automatically changed and to revert
217 it back to false the Remove() method needs to be
220 boolean Immutable [readonly]
222 This value will be set to true if the service is
223 configured externally via a configuration file.
225 The only valid operation are Connect() and of
226 course Disconnect(). The Remove() method will
229 boolean AutoConnect [readwrite]
231 If set to true, this service will auto-connect
232 when no other connection is available.
234 The service won't auto-connect while roaming.
236 For favorite services it is possible to change
237 this value to prevent or permit automatic
240 boolean SetupRequired [readonly]
242 If the service is Cellular, then this property
243 indicates that some extra setup steps are required.
245 In most cases it is required to fill in the APN
248 boolean Roaming [readonly]
250 This property indicates if this service is roaming.
252 In the case of Cellular services this normally
253 indicates connections to a foreign provider when
256 array{string} Nameservers [readonly]
258 The list of currently active nameservers for this
259 service. If the server is not in READY or ONLINE
260 state than this list will be empty.
262 Global nameservers are automatically added to this
263 list. The array represents a sorted list of the
264 current nameservers. The first one has the highest
265 priority and is used by default.
267 When using DHCP this array represents the nameservers
268 provided by the network. In case of manual settings,
269 the ones from Nameservers.Configuration are used.
271 array{string} Nameservers.Configuration [readwrite]
273 The list of manually configured domain name
274 servers. Some 3G networks don't provide correct
275 name servers and this allows for an override.
277 This array is sorted by priority and the first
278 entry in the list represents the nameserver with
279 the highest priority.
281 When using manual configuration and no global
282 nameservers are configured, then it is useful
283 to configure this setting.
285 Changes to the domain name servers can be done
286 at any time. It will not cause a disconnect of
287 the service. However there might be small window
288 where name resolution might fail.
290 array{string} Domains [readonly]
292 The list of currently used search domains.
294 array{string} Domains.Configuration [readwrite]
296 The list of manually configured search domains.
300 string Method [readonly]
302 Possible values are "dhcp", "manual"
305 The value "fixed" indicates an IP address
306 that can not be modified. For example
307 cellular networks return fixed information.
309 string Address [readonly]
311 The current configured IPv4 address.
313 string Netmask [readonly]
315 The current configured IPv4 netmask.
317 string Gateway [readonly]
319 The current configured IPv4 gateway.
321 dict IPv4.Configuration [readwrite]
323 Same values as IPv4 property. The IPv4 represents
324 the actual system configuration while this allows
327 Changing these settings will cause a state change
328 of the service. The service will become unavailable
329 until the new configuration has been successfully
334 string Method [readonly]
336 Possible values are "auto", "manual", "6to4"
339 The value "fixed" indicates an IP address
340 that can not be modified. For example
341 cellular networks return fixed information.
342 The value "6to4" is returned if 6to4 tunnel
343 is created by connman. The tunnel can only be
344 created if method was set to "auto" by the
345 user. User cannot set the method to "6to4".
347 string Address [readonly]
349 The current configured IPv6 address.
351 uint8 PrefixLength [readonly]
353 The prefix length of the IPv6 address.
355 string Gateway [readonly]
357 The current configured IPv6 gateway.
359 string Privacy [readonly]
361 Enable or disable IPv6 privacy extension
362 that is described in RFC 4941. The value
363 has only meaning if Method is set to "auto".
365 Value "disabled" means that privacy extension
366 is disabled and normal autoconf addresses are
369 Value "enabled" means that privacy extension is
370 enabled and system prefers to use public
371 addresses over temporary addresses.
373 Value "prefered" means that privacy extension is
374 enabled and system prefers temporary addresses
375 over public addresses.
377 Default value is "disabled".
379 dict IPv6.Configuration [readwrite]
381 Same values as IPv6 property. The IPv6 represents
382 the actual system configuration while this allows
385 Changing these settings will cause a state change
386 of the service. The service will become unavailable
387 until the new configuration has been successfully
390 dict Proxy [readonly]
392 string Method [readonly]
394 Possible values are "direct", "auto" and
397 In case of "auto" method, the URL file can be
398 provided unless you want to let DHCP/WPAD
399 auto-discover to be tried. In such case if DHCP
400 and WPAD auto-discover methods fails then
401 method will be "direct".
403 In case of "direct" no additional information
404 are provided. For the "manual" method the
405 Servers have to be set, Excludes is optional.
407 string URL [readonly]
409 Automatic proxy configuration URL. Used by
412 array{string} Servers [readonly]
414 Used when "manual" method is set.
416 List of proxy URIs. The URI without a protocol
417 will be interpreted as the generic proxy URI.
418 All others will target a specific protocol and
421 Example for generic proxy server entry would
422 be like this: "server.example.com:911".
424 array{string} Excludes [readonly]
426 Used when "manual" method is set.
428 List of hosts which can be accessed directly.
430 dict Proxy.Configuration [readwrite]
432 Same values as Proxy property. The Proxy represents
433 the actual system configuration while this allows
436 If "auto" method is set with an empty URL, then
437 DHCP/WPAD auto-discover will be tried. Otherwise the
438 specified URL will be used.
440 dict Provider [readonly]
442 string Host [readonly]
446 string Domain [readonly]
450 string Name [readonly]
454 string Type [readonly]
458 dict Ethernet [readonly]
460 string Method [readonly]
462 Possible values are "auto" and "manual".
464 string Interface [readonly]
466 Interface name (for example eth0).
468 string Address [readonly]
470 Ethernet device address (MAC address).
472 uint16 MTU [readonly]
474 The Ethernet MTU (default is 1500).
476 uint16 Speed [readonly]
478 Selected speed of the line.
480 This information might not always be
483 string Duplex [readonly]
485 Selected duplex settings of the line.
487 Possible values are "half" and "full".
489 This information might not always be