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 Possible Errors: [service].Error.InvalidArguments
26 [service].Error.InvalidProperty
28 void ClearProperty(string name)
30 Clears the value of the specified property.
32 Possible Errors: [service].Error.InvalidArguments
33 [service].Error.InvalidProperty
37 Connect this service. It will attempt to connect
38 WiFi, WiMAX or Bluetooth services.
40 For Ethernet devices this method can only be used
41 if it has previously been disconnected. Otherwise
42 the plugging of a cable will trigger connecting
43 automatically. If no cable is plugged in this method
46 This method call will only return in case of an
47 error or when the service is fully connected. So
48 setting a longer D-Bus timeout might be a really
51 Possible Errors: [service].Error.InvalidArguments
55 Disconnect this service. If the service is not
56 connected an error message will be generated.
58 On Ethernet devices this will disconnect the IP
59 details from the service. It will not magically
60 unplug the cable. When no cable is plugged in this
63 This method can also be used to abort a previous
64 connectiong attempt via the Connect method.
66 Possible Errors: [service].Error.InvalidArguments
70 A successfully connected service with Favorite=true
71 can be removed this way. If it is connected, it will
72 be automatically disconnected first.
74 If the service requires a passphrase it will be
75 cleared and forgotten when removing.
77 This is similar to setting the Favorite property
78 to false, but that is currently not supported.
80 In the case a connection attempt failed and the
81 service is in the State=failure, this method can
82 also be used to reset the service.
84 Calling this method on Ethernet devices will cause
85 an error message. It is not possible to remove these
88 Possible Errors: [service].Error.InvalidArguments
90 void MoveBefore(object service)
92 If a service has been used before, this allows a
93 reorder of the favorite services.
95 The target service object must be part of this
96 profile. Moving between profiles is not supported.
98 Possible Errors: [service].Error.InvalidArguments
100 void MoveAfter(object service)
102 If a service has been used before, this allows a
103 reorder of the favorite services.
105 The target service object must be part of this
106 profile. Moving between profiles is not supported.
108 Possible Errors: [service].Error.InvalidArguments
110 void ResetCounters() [experimental]
112 Reset the counter statistics.
114 Possible Errors: None
116 Signals PropertyChanged(string name, variant value)
118 This signal indicates a changed value of the given
121 Properties string State [readonly]
123 The service state information.
125 Valid states are "idle", "failure", "association",
126 "configuration", "ready" and "online".
128 The "ready" state signals a successfully
129 connected device. "online" signals that an
130 Internet connection is available and has been
133 string Error [readonly]
135 The service error status details.
137 When error occur during connection or disconnection
138 the detailed information is represented in this
139 property to help the user interface to present the
140 user with alternate options.
142 This property is only valid when the service is in
143 the "failure" state. Otherwise it might be empty or
146 Current defined error code is "dhcp-failed".
148 string Name [readonly]
150 The service name (for example "Wireless" etc.)
152 This name can be used for directly displaying it in
153 the application. It has pure informational purpose
154 and no attempt should be made to translate it.
156 For Ethernet devices and hidden WiFi networks this
157 property is not present.
159 string Type [readonly]
161 The service type (for example "ethernet", "wifi" etc.)
163 This information should only be used to determine
164 advanced properties or showing the correct icon
167 Together with a missing Name property, this can
168 be used to identify hidden WiFi networks.
170 array{string} Security [readonly]
172 If the service type is WiFi, then this property is
173 present and contains the list of security methods
174 or key management settings.
176 Possible values are "none", "wep", "psk", "ieee8021x"
179 This property might be only present for WiFi
182 uint8 Strength [readonly]
184 Indicates the signal strength of the service. This
185 is a normalized value between 0 and 100.
187 This property will not be present for Ethernet
190 boolean Favorite [readonly]
192 Will be true if a cable is plugged in or the user
193 selected and successfully connected to this service.
195 This value is automatically changed and to revert
196 it back to false the Remove() method needs to be
199 boolean Immutable [readonly]
201 This value will be set to true if the service is
202 configured externally via a configuration file.
204 The only valid operation are Connect() and of
205 course Disconnect(). The Remove() method will
208 boolean AutoConnect [readwrite]
210 If set to true, this service will auto-connect
211 when no other connection is available.
213 The service won't auto-connect while roaming.
215 For favorite services it is possible to change
216 this value to prevent or permit automatic
219 boolean Roaming [readonly]
221 This property indicates if this service is roaming.
223 In the case of Cellular services this normally
224 indicates connections to a foreign provider when
227 array{string} Nameservers [readonly]
229 The list of currently active nameservers for this
230 service. If the server is not in READY or ONLINE
231 state than this list will be empty.
233 Global nameservers are automatically added to this
234 list. The array represents a sorted list of the
235 current nameservers. The first one has the highest
236 priority and is used by default.
238 When using DHCP this array represents the nameservers
239 provided by the network. In case of manual settings,
240 the ones from Nameservers.Configuration are used.
242 array{string} Nameservers.Configuration [readwrite]
244 The list of manually configured domain name
245 servers. Some cellular networks don't provide
246 correct name servers and this allows for an
249 This array is sorted by priority and the first
250 entry in the list represents the nameserver with
251 the highest priority.
253 When using manual configuration and no global
254 nameservers are configured, then it is useful
255 to configure this setting.
257 Changes to the domain name servers can be done
258 at any time. It will not cause a disconnect of
259 the service. However there might be small window
260 where name resolution might fail.
262 array{string} Timeservers [readonly]
264 The list of currently active timeservers for this
265 service. If the server is not in READY or ONLINE
266 state than this list will be empty.
268 array{string} Timeservers.Configuration [readwrite]
270 The list of manually configured time servers.
272 The first entry in the list represents the
273 timeserver with the highest priority.
275 When using manual configuration this setting
276 is useful to override all the other timeserver
277 settings. This is service specific, hence only
278 the values for the default service are used.
280 Changes to this property will result in restart
283 array{string} Domains [readonly]
285 The list of currently used search domains.
287 array{string} Domains.Configuration [readwrite]
289 The list of manually configured search domains.
293 string Method [readonly]
295 Possible values are "dhcp", "manual"
298 The value "fixed" indicates an IP address
299 that can not be modified. For example
300 cellular networks return fixed information.
302 string Address [readonly]
304 The current configured IPv4 address.
306 string Netmask [readonly]
308 The current configured IPv4 netmask.
310 string Gateway [readonly]
312 The current configured IPv4 gateway.
314 dict IPv4.Configuration [readwrite]
316 Same values as IPv4 property. The IPv4 represents
317 the actual system configuration while this allows
320 Changing these settings will cause a state change
321 of the service. The service will become unavailable
322 until the new configuration has been successfully
327 string Method [readonly]
329 Possible values are "auto", "manual", "6to4"
332 The value "fixed" indicates an IP address
333 that can not be modified. For example
334 cellular networks return fixed information.
335 The value "6to4" is returned if 6to4 tunnel
336 is created by connman. The tunnel can only be
337 created if method was set to "auto" by the
338 user. User cannot set the method to "6to4".
340 string Address [readonly]
342 The current configured IPv6 address.
344 uint8 PrefixLength [readonly]
346 The prefix length of the IPv6 address.
348 string Gateway [readonly]
350 The current configured IPv6 gateway.
352 string Privacy [readonly]
354 Enable or disable IPv6 privacy extension
355 that is described in RFC 4941. The value
356 has only meaning if Method is set to "auto".
358 Value "disabled" means that privacy extension
359 is disabled and normal autoconf addresses are
362 Value "enabled" means that privacy extension is
363 enabled and system prefers to use public
364 addresses over temporary addresses.
366 Value "prefered" means that privacy extension is
367 enabled and system prefers temporary addresses
368 over public addresses.
370 Default value is "disabled".
372 dict IPv6.Configuration [readwrite]
374 Same values as IPv6 property. The IPv6 represents
375 the actual system configuration while this allows
378 Changing these settings will cause a state change
379 of the service. The service will become unavailable
380 until the new configuration has been successfully
383 dict Proxy [readonly]
385 string Method [readonly]
387 Possible values are "direct", "auto" and
390 In case of "auto" method, the URL file can be
391 provided unless you want to let DHCP/WPAD
392 auto-discover to be tried. In such case if DHCP
393 and WPAD auto-discover methods fails then
394 method will be "direct".
396 In case of "direct" no additional information
397 are provided. For the "manual" method the
398 Servers have to be set, Excludes is optional.
400 string URL [readonly]
402 Automatic proxy configuration URL. Used by
405 array{string} Servers [readonly]
407 Used when "manual" method is set.
409 List of proxy URIs. The URI without a protocol
410 will be interpreted as the generic proxy URI.
411 All others will target a specific protocol and
414 Example for generic proxy server entry would
415 be like this: "server.example.com:911".
417 array{string} Excludes [readonly]
419 Used when "manual" method is set.
421 List of hosts which can be accessed directly.
423 dict Proxy.Configuration [readwrite]
425 Same values as Proxy property. The Proxy represents
426 the actual system configuration while this allows
429 If "auto" method is set with an empty URL, then
430 DHCP/WPAD auto-discover will be tried. Otherwise the
431 specified URL will be used.
433 dict Provider [readonly]
435 string Host [readonly]
439 string Domain [readonly]
443 string Name [readonly]
447 string Type [readonly]
451 dict Ethernet [readonly]
453 string Method [readonly]
455 Possible values are "auto" and "manual".
457 string Interface [readonly]
459 Interface name (for example eth0).
461 string Address [readonly]
463 Ethernet device address (MAC address).
465 uint16 MTU [readonly]
467 The Ethernet MTU (default is 1500).
469 uint16 Speed [readonly]
471 Selected speed of the line.
473 This information might not always be
476 string Duplex [readonly]
478 Selected duplex settings of the line.
480 Possible values are "half" and "full".
482 This information might not always be