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 Signals PropertyChanged(string name, variant value)
127 This signal indicates a changed value of the given
130 Properties string State [readonly]
132 The service state information.
134 Valid states are "idle", "failure", "association",
135 "configuration", "ready", "disconnect" and "online".
137 The "ready" state signals a successfully
138 connected device. "online" signals that an
139 Internet connection is available and has been
142 See doc/overview-api.txt for more information about
145 string Error [readonly]
147 The service error status details.
149 When error occur during connection or disconnection
150 the detailed information is represented in this
151 property to help the user interface to present the
152 user with alternate options.
154 This property is only valid when the service is in
155 the "failure" state. Otherwise it might be empty or
158 Currently defined error codes are: "out-of-range",
159 "pin-missing", "dhcp-failed", "connect-failed",
160 "login-failed", "auth-failed" and "invalid-key".
162 string Name [readonly]
164 The service name (for example "Wireless" etc.)
166 This name can be used for directly displaying it in
167 the application. It has pure informational purpose
168 and no attempt should be made to translate it.
170 For Ethernet devices and hidden WiFi networks this
171 property is not present.
173 string Type [readonly]
175 The service type (for example "ethernet", "wifi" etc.)
177 This information should only be used to determine
178 advanced properties or showing the correct icon
181 Together with a missing Name property, this can
182 be used to identify hidden WiFi networks.
184 array{string} Security [readonly]
186 If the service type is WiFi, then this property is
187 present and contains the list of security methods
188 or key management settings.
190 Possible values are "none", "wep", "psk", "ieee8021x"
193 This property might be only present for WiFi
196 uint8 Strength [readonly]
198 Indicates the signal strength of the service. This
199 is a normalized value between 0 and 100.
201 This property will not be present for Ethernet
204 boolean Favorite [readonly]
206 Will be true if a cable is plugged in or the user
207 selected and successfully connected to this service.
209 This value is automatically changed and to revert
210 it back to false the Remove() method needs to be
213 boolean Immutable [readonly]
215 This value will be set to true if the service is
216 configured externally via a configuration file.
218 The only valid operation are Connect() and of
219 course Disconnect(). The Remove() method will
222 boolean AutoConnect [readwrite]
224 If set to true, this service will auto-connect
225 when no other connection is available.
227 The service won't auto-connect while roaming.
229 For favorite services it is possible to change
230 this value to prevent or permit automatic
233 boolean Roaming [readonly]
235 This property indicates if this service is roaming.
237 In the case of Cellular services this normally
238 indicates connections to a foreign provider when
241 array{string} Nameservers [readonly]
243 The list of currently active nameservers for this
244 service. If the server is not in READY or ONLINE
245 state than this list will be empty.
247 Global nameservers are automatically added to this
248 list. The array represents a sorted list of the
249 current nameservers. The first one has the highest
250 priority and is used by default.
252 When using DHCP this array represents the nameservers
253 provided by the network. In case of manual settings,
254 the ones from Nameservers.Configuration are used.
256 array{string} Nameservers.Configuration [readwrite]
258 The list of manually configured domain name
259 servers. Some cellular networks don't provide
260 correct name servers and this allows for an
263 This array is sorted by priority and the first
264 entry in the list represents the nameserver with
265 the highest priority.
267 When using manual configuration and no global
268 nameservers are configured, then it is useful
269 to configure this setting.
271 Changes to the domain name servers can be done
272 at any time. It will not cause a disconnect of
273 the service. However there might be small window
274 where name resolution might fail.
276 array{string} Timeservers [readonly]
278 The list of currently active timeservers for this
279 service. If the server is not in READY or ONLINE
280 state than this list will be empty.
282 array{string} Timeservers.Configuration [readwrite]
284 The list of manually configured time servers.
286 The first entry in the list represents the
287 timeserver with the highest priority.
289 When using manual configuration this setting
290 is useful to override all the other timeserver
291 settings. This is service specific, hence only
292 the values for the default service are used.
294 Changes to this property will result in restart
297 array{string} Domains [readonly]
299 The list of currently used search domains taken
300 from Domains.Configurations if set, otherwise a
301 domain name if provided by DHCP or VPNs.
303 array{string} Domains.Configuration [readwrite]
305 The list of manually configured search domains.
309 string Method [readonly]
311 Possible values are "dhcp", "manual"
314 The value "fixed" indicates an IP address
315 that can not be modified. For example
316 cellular networks return fixed information.
318 string Address [readonly]
320 The current configured IPv4 address.
322 string Netmask [readonly]
324 The current configured IPv4 netmask.
326 string Gateway [readonly]
328 The current configured IPv4 gateway.
330 dict IPv4.Configuration [readwrite]
332 Same values as IPv4 property. The IPv4 represents
333 the actual system configuration while this allows
336 Changing these settings will cause a state change
337 of the service. The service will become unavailable
338 until the new configuration has been successfully
343 string Method [readonly]
345 Possible values are "auto", "manual", "6to4"
348 The value "fixed" indicates an IP address
349 that can not be modified. For example
350 cellular networks return fixed information.
351 The value "6to4" is returned if 6to4 tunnel
352 is created by connman. The tunnel can only be
353 created if method was set to "auto" by the
354 user. User cannot set the method to "6to4".
356 string Address [readonly]
358 The current configured IPv6 address.
360 uint8 PrefixLength [readonly]
362 The prefix length of the IPv6 address.
364 string Gateway [readonly]
366 The current configured IPv6 gateway.
368 string Privacy [readonly]
370 Enable or disable IPv6 privacy extension
371 that is described in RFC 4941. The value
372 has only meaning if Method is set to "auto".
374 Value "disabled" means that privacy extension
375 is disabled and normal autoconf addresses are
378 Value "enabled" means that privacy extension is
379 enabled and system prefers to use public
380 addresses over temporary addresses.
382 Value "prefered" means that privacy extension is
383 enabled and system prefers temporary addresses
384 over public addresses.
386 Default value is "disabled".
388 dict IPv6.Configuration [readwrite]
390 Same values as IPv6 property. The IPv6 represents
391 the actual system configuration while this allows
394 Changing these settings will cause a state change
395 of the service. The service will become unavailable
396 until the new configuration has been successfully
399 dict Proxy [readonly]
401 string Method [readonly]
403 Possible values are "direct", "auto" and
406 In case of "auto" method, the URL file can be
407 provided unless you want to let DHCP/WPAD
408 auto-discover to be tried. In such case if DHCP
409 and WPAD auto-discover methods fails then
410 method will be "direct".
412 In case of "direct" no additional information
413 are provided. For the "manual" method the
414 Servers have to be set, Excludes is optional.
416 string URL [readonly]
418 Automatic proxy configuration URL. Used by
421 array{string} Servers [readonly]
423 Used when "manual" method is set.
425 List of proxy URIs. The URI without a protocol
426 will be interpreted as the generic proxy URI.
427 All others will target a specific protocol and
430 Example for generic proxy server entry would
431 be like this: "server.example.com:911".
433 array{string} Excludes [readonly]
435 Used when "manual" method is set.
437 List of hosts which can be accessed directly.
439 dict Proxy.Configuration [readwrite]
441 Same values as Proxy property. The Proxy represents
442 the actual system configuration while this allows
445 If "auto" method is set with an empty URL, then
446 DHCP/WPAD auto-discover will be tried. Otherwise the
447 specified URL will be used.
449 dict Provider [readonly]
451 string Host [readonly]
455 string Domain [readonly]
459 string Name [readonly]
463 string Type [readonly]
467 dict Ethernet [readonly]
469 string Method [readonly]
471 Possible values are "auto" and "manual".
473 string Interface [readonly]
475 Interface name (for example eth0).
477 string Address [readonly]
479 Ethernet device address (MAC address).
481 uint16 MTU [readonly]
483 The Ethernet MTU (default is 1500).
485 uint16 Speed [readonly] [deprecated]
487 Selected speed of the line.
489 This information is not available.
491 string Duplex [readonly] [deprecated]
493 Selected duplex settings of the line.
494 Possible values are "half" and "full".
496 This information is not available.