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 Current defined error code is "dhcp-failed".
160 string Name [readonly]
162 The service name (for example "Wireless" etc.)
164 This name can be used for directly displaying it in
165 the application. It has pure informational purpose
166 and no attempt should be made to translate it.
168 For Ethernet devices and hidden WiFi networks this
169 property is not present.
171 string Type [readonly]
173 The service type (for example "ethernet", "wifi" etc.)
175 This information should only be used to determine
176 advanced properties or showing the correct icon
179 Together with a missing Name property, this can
180 be used to identify hidden WiFi networks.
182 array{string} Security [readonly]
184 If the service type is WiFi, then this property is
185 present and contains the list of security methods
186 or key management settings.
188 Possible values are "none", "wep", "psk", "ieee8021x"
191 This property might be only present for WiFi
194 uint8 Strength [readonly]
196 Indicates the signal strength of the service. This
197 is a normalized value between 0 and 100.
199 This property will not be present for Ethernet
202 boolean Favorite [readonly]
204 Will be true if a cable is plugged in or the user
205 selected and successfully connected to this service.
207 This value is automatically changed and to revert
208 it back to false the Remove() method needs to be
211 boolean Immutable [readonly]
213 This value will be set to true if the service is
214 configured externally via a configuration file.
216 The only valid operation are Connect() and of
217 course Disconnect(). The Remove() method will
220 boolean AutoConnect [readwrite]
222 If set to true, this service will auto-connect
223 when no other connection is available.
225 The service won't auto-connect while roaming.
227 For favorite services it is possible to change
228 this value to prevent or permit automatic
231 boolean Roaming [readonly]
233 This property indicates if this service is roaming.
235 In the case of Cellular services this normally
236 indicates connections to a foreign provider when
239 array{string} Nameservers [readonly]
241 The list of currently active nameservers for this
242 service. If the server is not in READY or ONLINE
243 state than this list will be empty.
245 Global nameservers are automatically added to this
246 list. The array represents a sorted list of the
247 current nameservers. The first one has the highest
248 priority and is used by default.
250 When using DHCP this array represents the nameservers
251 provided by the network. In case of manual settings,
252 the ones from Nameservers.Configuration are used.
254 array{string} Nameservers.Configuration [readwrite]
256 The list of manually configured domain name
257 servers. Some cellular networks don't provide
258 correct name servers and this allows for an
261 This array is sorted by priority and the first
262 entry in the list represents the nameserver with
263 the highest priority.
265 When using manual configuration and no global
266 nameservers are configured, then it is useful
267 to configure this setting.
269 Changes to the domain name servers can be done
270 at any time. It will not cause a disconnect of
271 the service. However there might be small window
272 where name resolution might fail.
274 array{string} Timeservers [readonly]
276 The list of currently active timeservers for this
277 service. If the server is not in READY or ONLINE
278 state than this list will be empty.
280 array{string} Timeservers.Configuration [readwrite]
282 The list of manually configured time servers.
284 The first entry in the list represents the
285 timeserver with the highest priority.
287 When using manual configuration this setting
288 is useful to override all the other timeserver
289 settings. This is service specific, hence only
290 the values for the default service are used.
292 Changes to this property will result in restart
295 array{string} Domains [readonly]
297 The list of currently used search domains taken
298 from Domains.Configurations if set, otherwise a
299 domain name if provided by DHCP or VPNs.
301 array{string} Domains.Configuration [readwrite]
303 The list of manually configured search domains.
307 string Method [readonly]
309 Possible values are "dhcp", "manual"
312 The value "fixed" indicates an IP address
313 that can not be modified. For example
314 cellular networks return fixed information.
316 string Address [readonly]
318 The current configured IPv4 address.
320 string Netmask [readonly]
322 The current configured IPv4 netmask.
324 string Gateway [readonly]
326 The current configured IPv4 gateway.
328 dict IPv4.Configuration [readwrite]
330 Same values as IPv4 property. The IPv4 represents
331 the actual system configuration while this allows
334 Changing these settings will cause a state change
335 of the service. The service will become unavailable
336 until the new configuration has been successfully
341 string Method [readonly]
343 Possible values are "auto", "manual", "6to4"
346 The value "fixed" indicates an IP address
347 that can not be modified. For example
348 cellular networks return fixed information.
349 The value "6to4" is returned if 6to4 tunnel
350 is created by connman. The tunnel can only be
351 created if method was set to "auto" by the
352 user. User cannot set the method to "6to4".
354 string Address [readonly]
356 The current configured IPv6 address.
358 uint8 PrefixLength [readonly]
360 The prefix length of the IPv6 address.
362 string Gateway [readonly]
364 The current configured IPv6 gateway.
366 string Privacy [readonly]
368 Enable or disable IPv6 privacy extension
369 that is described in RFC 4941. The value
370 has only meaning if Method is set to "auto".
372 Value "disabled" means that privacy extension
373 is disabled and normal autoconf addresses are
376 Value "enabled" means that privacy extension is
377 enabled and system prefers to use public
378 addresses over temporary addresses.
380 Value "prefered" means that privacy extension is
381 enabled and system prefers temporary addresses
382 over public addresses.
384 Default value is "disabled".
386 dict IPv6.Configuration [readwrite]
388 Same values as IPv6 property. The IPv6 represents
389 the actual system configuration while this allows
392 Changing these settings will cause a state change
393 of the service. The service will become unavailable
394 until the new configuration has been successfully
397 dict Proxy [readonly]
399 string Method [readonly]
401 Possible values are "direct", "auto" and
404 In case of "auto" method, the URL file can be
405 provided unless you want to let DHCP/WPAD
406 auto-discover to be tried. In such case if DHCP
407 and WPAD auto-discover methods fails then
408 method will be "direct".
410 In case of "direct" no additional information
411 are provided. For the "manual" method the
412 Servers have to be set, Excludes is optional.
414 string URL [readonly]
416 Automatic proxy configuration URL. Used by
419 array{string} Servers [readonly]
421 Used when "manual" method is set.
423 List of proxy URIs. The URI without a protocol
424 will be interpreted as the generic proxy URI.
425 All others will target a specific protocol and
428 Example for generic proxy server entry would
429 be like this: "server.example.com:911".
431 array{string} Excludes [readonly]
433 Used when "manual" method is set.
435 List of hosts which can be accessed directly.
437 dict Proxy.Configuration [readwrite]
439 Same values as Proxy property. The Proxy represents
440 the actual system configuration while this allows
443 If "auto" method is set with an empty URL, then
444 DHCP/WPAD auto-discover will be tried. Otherwise the
445 specified URL will be used.
447 dict Provider [readonly]
449 string Host [readonly]
453 string Domain [readonly]
457 string Name [readonly]
461 string Type [readonly]
465 dict Ethernet [readonly]
467 string Method [readonly]
469 Possible values are "auto" and "manual".
471 string Interface [readonly]
473 Interface name (for example eth0).
475 string Address [readonly]
477 Ethernet device address (MAC address).
479 uint16 MTU [readonly]
481 The Ethernet MTU (default is 1500).
483 uint16 Speed [readonly] [deprecated]
485 Selected speed of the line.
487 This information is not available.
489 string Duplex [readonly] [deprecated]
491 Selected duplex settings of the line.
492 Possible values are "half" and "full".
494 This information is not available.