5 Interface net.connman.Service
6 Object path [variable prefix]/{service0,service1,...}
8 Methods dict GetProperties() [deprecated]
10 Returns properties for the service object. See
11 the properties section for available properties.
13 Usage of this method is highly discouraged. Use
14 the Manager.GetServices() method instead.
16 Possible Errors: [service].Error.InvalidArguments
18 void SetProperty(string name, variant value)
20 Changes the value of the specified property. Only
21 properties that are listed as read-write are
22 changeable. On success a PropertyChanged signal
25 Properties cannot be set for hidden WiFi service
26 entries or provisioned services.
28 Possible Errors: [service].Error.InvalidArguments
29 [service].Error.InvalidProperty
31 void ClearProperty(string name)
33 Clears the value of the specified property.
35 Properties cannot be cleared for hidden WiFi service
36 entries or provisioned services.
38 Possible Errors: [service].Error.InvalidArguments
39 [service].Error.InvalidProperty
43 Connect this service. It will attempt to connect
44 WiFi or Bluetooth services.
46 For Ethernet devices this method can only be used
47 if it has previously been disconnected. Otherwise
48 the plugging of a cable will trigger connecting
49 automatically. If no cable is plugged in this method
52 This method call will only return in case of an
53 error or when the service is fully connected. So
54 setting a longer D-Bus timeout might be a really
57 Calling Connect() on a hidden WiFi service entry will
58 query the missing SSID via the Agent API causing a
59 WiFi service with the given SSID to be scanned,
60 created and connected.
62 Possible Errors: [service].Error.InvalidArguments
66 Disconnect this service. If the service is not
67 connected an error message will be generated.
69 On Ethernet devices this will disconnect the IP
70 details from the service. It will not magically
71 unplug the cable. When no cable is plugged in this
74 This method can also be used to abort a previous
75 connection attempt via the Connect method.
77 Hidden WiFi service entries cannot be disconnected
78 as they always stay in idle state.
80 Possible Errors: [service].Error.InvalidArguments
84 A successfully connected service with Favorite=true
85 can be removed this way. If it is connected, it will
86 be automatically disconnected first.
88 If the service requires a passphrase it will be
89 cleared and forgotten when removing.
91 This is similar to setting the Favorite property
92 to false, but that is currently not supported.
94 In the case a connection attempt failed and the
95 service is in the State=failure, this method can
96 also be used to reset the service.
98 Calling this method on Ethernet devices, hidden WiFi
99 services or provisioned services will cause an error
100 message. It is not possible to remove these kind of
103 Possible Errors: [service].Error.InvalidArguments
105 void MoveBefore(object service)
107 If a service has been used before, this allows a
108 reorder of the favorite services.
110 Possible Errors: [service].Error.InvalidArguments
112 void MoveAfter(object service)
114 If a service has been used before, this allows a
115 reorder of the favorite services.
117 Possible Errors: [service].Error.InvalidArguments
119 void ResetCounters() [experimental]
121 Reset the counter statistics.
123 Possible Errors: None
125 boolean GetUserFavorite() [experimental]
127 This function is used to check whether this service
128 is favorite to the current user.
130 Possible Errors: None
132 Signals PropertyChanged(string name, variant value)
134 This signal indicates a changed value of the given
137 Properties string State [readonly]
139 The service state information.
141 Valid states are "idle", "failure", "association",
142 "configuration", "ready", "disconnect" and "online".
144 The "ready" state signals a successfully
145 connected device. "online" signals that an
146 Internet connection is available and has been
149 See doc/overview-api.txt for more information about
152 string Error [readonly]
154 The service error status details.
156 When error occur during connection or disconnection
157 the detailed information is represented in this
158 property to help the user interface to present the
159 user with alternate options.
161 This property is only valid when the service is in
162 the "failure" state. Otherwise it might be empty or
165 Currently defined error codes are: "out-of-range",
166 "pin-missing", "dhcp-failed", "connect-failed",
167 "login-failed", "auth-failed" and "invalid-key".
169 string Name [readonly]
171 The service name (for example "Wireless" etc.)
173 This name can be used for directly displaying it in
174 the application. It has pure informational purpose
175 and no attempt should be made to translate it.
177 For Ethernet devices and hidden WiFi networks this
178 property is not present.
180 string Type [readonly]
182 The service type (for example "ethernet", "wifi" etc.)
184 This information should only be used to determine
185 advanced properties or showing the correct icon
188 Together with a missing Name property, this can
189 be used to identify hidden WiFi networks.
191 array{string} Security [readonly]
193 If the service type is WiFi, then this property is
194 present and contains the list of security methods
195 or key management settings.
197 Possible values are "none", "wep", "psk", "ieee8021x"
200 This property might be only present for WiFi
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 cellular networks don't provide
293 correct name servers and this allows for an
296 This array is sorted by priority and the first
297 entry in the list represents the nameserver with
298 the highest priority.
300 When using manual configuration and no global
301 nameservers are configured, then it is useful
302 to configure this setting.
304 Changes to the domain name servers can be done
305 at any time. It will not cause a disconnect of
306 the service. However there might be small window
307 where name resolution might fail.
309 array{string} Timeservers [readonly]
311 The list of currently active timeservers for this
312 service. If the server is not in READY or ONLINE
313 state than this list will be empty.
315 array{string} Timeservers.Configuration [readwrite]
317 The list of manually configured time servers.
319 The first entry in the list represents the
320 timeserver with the highest priority.
322 When using manual configuration this setting
323 is useful to override all the other timeserver
324 settings. This is service specific, hence only
325 the values for the default service are used.
327 Changes to this property will result in restart
330 array{string} Domains [readonly]
332 The list of currently used search domains taken
333 from Domains.Configurations if set, otherwise a
334 domain name if provided by DHCP or VPNs.
336 array{string} Domains.Configuration [readwrite]
338 The list of manually configured search domains.
342 string Method [readonly]
344 Possible values are "dhcp", "manual"
347 The value "fixed" indicates an IP address
348 that can not be modified. For example
349 cellular networks return fixed information.
351 string Address [readonly]
353 The current configured IPv4 address.
355 string Netmask [readonly]
357 The current configured IPv4 netmask.
359 string Gateway [readonly]
361 The current configured IPv4 gateway.
363 dict IPv4.Configuration [readwrite]
365 Same values as IPv4 property. The IPv4 represents
366 the actual system configuration while this allows
369 Changing these settings will cause a state change
370 of the service. The service will become unavailable
371 until the new configuration has been successfully
376 string Method [readonly]
378 Possible values are "auto", "manual", "6to4"
381 The value "fixed" indicates an IP address
382 that can not be modified. For example
383 cellular networks return fixed information.
384 The value "6to4" is returned if 6to4 tunnel
385 is created by connman. The tunnel can only be
386 created if method was set to "auto" by the
387 user. User cannot set the method to "6to4".
389 string Address [readonly]
391 The current configured IPv6 address.
393 uint8 PrefixLength [readonly]
395 The prefix length of the IPv6 address.
397 string Gateway [readonly]
399 The current configured IPv6 gateway.
401 string Privacy [readonly]
403 Enable or disable IPv6 privacy extension
404 that is described in RFC 4941. The value
405 has only meaning if Method is set to "auto".
407 Value "disabled" means that privacy extension
408 is disabled and normal autoconf addresses are
411 Value "enabled" means that privacy extension is
412 enabled and system prefers to use public
413 addresses over temporary addresses.
415 Value "prefered" means that privacy extension is
416 enabled and system prefers temporary addresses
417 over public addresses.
419 Default value is "disabled".
421 dict IPv6.Configuration [readwrite]
423 Same values as IPv6 property. The IPv6 represents
424 the actual system configuration while this allows
427 Changing these settings will cause a state change
428 of the service. The service will become unavailable
429 until the new configuration has been successfully
432 dict Proxy [readonly]
434 string Method [readonly]
436 Possible values are "direct", "auto" and
439 In case of "auto" method, the URL file can be
440 provided unless you want to let DHCP/WPAD
441 auto-discover to be tried. In such case if DHCP
442 and WPAD auto-discover methods fails then
443 method will be "direct".
445 In case of "direct" no additional information
446 are provided. For the "manual" method the
447 Servers have to be set, Excludes is optional.
449 string URL [readonly]
451 Automatic proxy configuration URL. Used by
454 array{string} Servers [readonly]
456 Used when "manual" method is set.
458 List of proxy URIs. The URI without a protocol
459 will be interpreted as the generic proxy URI.
460 All others will target a specific protocol and
463 Example for generic proxy server entry would
464 be like this: "server.example.com:911".
466 array{string} Excludes [readonly]
468 Used when "manual" method is set.
470 List of hosts which can be accessed directly.
472 dict Proxy.Configuration [readwrite]
474 Same values as Proxy property. The Proxy represents
475 the actual system configuration while this allows
478 If "auto" method is set with an empty URL, then
479 DHCP/WPAD auto-discover will be tried. Otherwise the
480 specified URL will be used.
482 dict Provider [readonly]
484 string Host [readonly]
488 string Domain [readonly]
492 string Name [readonly]
496 string Type [readonly]
500 dict Ethernet [readonly]
502 string Method [readonly]
504 Possible values are "auto" and "manual".
506 string Interface [readonly]
508 Interface name (for example eth0).
510 string Address [readonly]
512 Ethernet device address (MAC address).
514 uint16 MTU [readonly]
516 The Ethernet MTU (default is 1500).
518 uint16 Speed [readonly] [deprecated]
520 Selected speed of the line.
522 This information is not available.
524 string Duplex [readonly] [deprecated]
526 Selected duplex settings of the line.
527 Possible values are "half" and "full".
529 This information is not available.