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 string BSSID [readonly]
205 If the service type is WiFi, then this property
206 indicates the BSSID of the service.
208 uint32 MaxRate [readonly]
210 If the service type is WiFi, then this property
211 indicates the Maximum speed(bps) of the service.
213 uint16 Frequency [readonly]
215 If the service type is WiFi, then this property
216 indicates the frequency band(MHz) of the service.
218 string EncryptionMode [readonly]
220 If the service type is WiFi, then this property
221 indicates the key encryption mode.
223 Possible values are "none", "wep", "tkip", "aes"
226 This property might be only present for WiFi
229 uint8 Strength [readonly]
231 Indicates the signal strength of the service. This
232 is a normalized value between 0 and 100.
234 This property will not be present for Ethernet
237 boolean Favorite [readonly]
239 Will be true if a cable is plugged in or the user
240 selected and successfully connected to this service.
242 This value is automatically changed and to revert
243 it back to false the Remove() method needs to be
246 boolean Immutable [readonly]
248 This value will be set to true if the service is
249 configured externally via a configuration file.
251 The only valid operation are Connect() and of
252 course Disconnect(). The Remove() method will
255 boolean AutoConnect [readwrite]
257 If set to true, this service will auto-connect
258 when no other connection is available.
260 The service won't auto-connect while roaming.
262 For favorite services it is possible to change
263 this value to prevent or permit automatic
266 boolean Roaming [readonly]
268 This property indicates if this service is roaming.
270 In the case of Cellular services this normally
271 indicates connections to a foreign provider when
274 array{string} Nameservers [readonly]
276 The list of currently active nameservers for this
277 service. If the server is not in READY or ONLINE
278 state than this list will be empty.
280 Global nameservers are automatically added to this
281 list. The array represents a sorted list of the
282 current nameservers. The first one has the highest
283 priority and is used by default.
285 When using DHCP this array represents the nameservers
286 provided by the network. In case of manual settings,
287 the ones from Nameservers.Configuration are used.
289 array{string} Nameservers.Configuration [readwrite]
291 The list of manually configured domain name
292 servers. Some 3G networks don't provide correct
293 name servers and this allows for an override.
295 This array is sorted by priority and the first
296 entry in the list represents the nameserver with
297 the highest priority.
299 When using manual configuration and no global
300 nameservers are configured, then it is useful
301 to configure this setting.
303 Changes to the domain name servers can be done
304 at any time. It will not cause a disconnect of
305 the service. However there might be small window
306 where name resolution might fail.
308 array{string} Domains [readonly]
310 The list of currently used search domains.
312 array{string} Domains.Configuration [readwrite]
314 The list of manually configured search domains.
318 string Method [readonly]
320 Possible values are "dhcp", "manual"
323 The value "fixed" indicates an IP address
324 that can not be modified. For example
325 cellular networks return fixed information.
327 string Address [readonly]
329 The current configured IPv4 address.
331 string Netmask [readonly]
333 The current configured IPv4 netmask.
335 string Gateway [readonly]
337 The current configured IPv4 gateway.
339 dict IPv4.Configuration [readwrite]
341 Same values as IPv4 property. The IPv4 represents
342 the actual system configuration while this allows
345 Changing these settings will cause a state change
346 of the service. The service will become unavailable
347 until the new configuration has been successfully
352 string Method [readonly]
354 Possible values are "auto", "manual", "6to4"
357 The value "fixed" indicates an IP address
358 that can not be modified. For example
359 cellular networks return fixed information.
360 The value "6to4" is returned if 6to4 tunnel
361 is created by connman. The tunnel can only be
362 created if method was set to "auto" by the
363 user. User cannot set the method to "6to4".
365 string Address [readonly]
367 The current configured IPv6 address.
369 uint8 PrefixLength [readonly]
371 The prefix length of the IPv6 address.
373 string Gateway [readonly]
375 The current configured IPv6 gateway.
377 string Privacy [readonly]
379 Enable or disable IPv6 privacy extension
380 that is described in RFC 4941. The value
381 has only meaning if Method is set to "auto".
383 Value "disabled" means that privacy extension
384 is disabled and normal autoconf addresses are
387 Value "enabled" means that privacy extension is
388 enabled and system prefers to use public
389 addresses over temporary addresses.
391 Value "prefered" means that privacy extension is
392 enabled and system prefers temporary addresses
393 over public addresses.
395 Default value is "disabled".
397 dict IPv6.Configuration [readwrite]
399 Same values as IPv6 property. The IPv6 represents
400 the actual system configuration while this allows
403 Changing these settings will cause a state change
404 of the service. The service will become unavailable
405 until the new configuration has been successfully
408 dict Proxy [readonly]
410 string Method [readonly]
412 Possible values are "direct", "auto" and
415 In case of "auto" method, the URL file can be
416 provided unless you want to let DHCP/WPAD
417 auto-discover to be tried. In such case if DHCP
418 and WPAD auto-discover methods fails then
419 method will be "direct".
421 In case of "direct" no additional information
422 are provided. For the "manual" method the
423 Servers have to be set, Excludes is optional.
425 string URL [readonly]
427 Automatic proxy configuration URL. Used by
430 array{string} Servers [readonly]
432 Used when "manual" method is set.
434 List of proxy URIs. The URI without a protocol
435 will be interpreted as the generic proxy URI.
436 All others will target a specific protocol and
439 Example for generic proxy server entry would
440 be like this: "server.example.com:911".
442 array{string} Excludes [readonly]
444 Used when "manual" method is set.
446 List of hosts which can be accessed directly.
448 dict Proxy.Configuration [readwrite]
450 Same values as Proxy property. The Proxy represents
451 the actual system configuration while this allows
454 If "auto" method is set with an empty URL, then
455 DHCP/WPAD auto-discover will be tried. Otherwise the
456 specified URL will be used.
458 dict Provider [readonly]
460 string Host [readonly]
464 string Domain [readonly]
468 string Name [readonly]
472 string Type [readonly]
476 dict Ethernet [readonly]
478 string Method [readonly]
480 Possible values are "auto" and "manual".
482 string Interface [readonly]
484 Interface name (for example eth0).
486 string Address [readonly]
488 Ethernet device address (MAC address).
490 uint16 MTU [readonly]
492 The Ethernet MTU (default is 1500).
494 uint16 Speed [readonly]
496 Selected speed of the line.
498 This information might not always be
501 string Duplex [readonly]
503 Selected duplex settings of the line.
505 Possible values are "half" and "full".
507 This information might not always be