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 are 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 string Mode [readonly]
165 If the service type is WiFi or Cellular, then this
166 property is present and contains the mode of the
169 For WiFi services the possible values are "managed"
170 and "adhoc". For Cellular services it describes the
171 network technology. Possible values are "gprs", "edge"
174 This property might be only present for WiFi and
177 string Security [readonly]
179 If the service type is WiFi, then this property is
180 present and contains the security method or key
183 Possible values are "none", "wep", "psk" and
184 also "ieee8021x". Alternate values for "psk"
185 can also be "wpa" and "rsn".
187 This property might be only present for WiFi
190 boolean LoginRequired [readonly]
192 This property indicates that an additional login
193 step, like web based authentication, is needed
194 before the connection establishment can proceed.
196 string Passphrase [readwrite]
198 If the service type is WiFi, then this property
199 can be used to store a passphrase.
201 No PropertyChanged signals will be send for this
202 property. The PassphraseRequired property should
203 be monitored instead.
205 This property might also not always be included
206 since it is protected by a different security policy.
208 boolean PassphraseRequired [readonly]
210 If the service type is WiFi, then this property
211 indicates if a passphrase is required.
213 If a passphrase has been set already or if no
214 passphrase is needed, then this property will
217 uint8 Strength [readonly]
219 Indicates the signal strength of the service. This
220 is a normalized value between 0 and 100.
222 This property will not be present for Ethernet
225 boolean Favorite [readonly]
227 Will be true if a cable is plugged in or the user
228 selected and successfully connected to this service.
230 This value is automatically changed and to revert
231 it back to false the Remove() method needs to be
234 boolean Immutable [readonly]
236 This value will be set to true if the service is
237 configured externally via a configuration file.
239 The only valid operation are Connect() and of
240 course Disconnect(). The Remove() method will
243 boolean AutoConnect [readwrite]
245 If set to true, this service will auto-connect
246 when not other connection is available.
248 For favorite services it is possible to change
249 this value to prevent or permit automatic
252 boolean SetupRequired [readonly]
254 If the service is Cellular, then this property
255 indicates that some extra setup steps are required.
257 In most cases it is required to fill in the APN
260 string APN [readwrite]
262 If the service is Cellular, then this property
263 contains the APN details.
265 The APN is network provider specific and even
266 sometimes data plan specific. Possible examples
267 are "isp.cingular" or "internet.t-mobile".
269 string MCC [readonly]
271 If the service is Cellular, then this property
272 contains the Mobile Country Code.
274 string MNC [readonly]
276 If the service is Cellular, then this property
277 contains the Mobile Network Code.
279 boolean Roaming [readonly]
281 This property indicates if this service is roaming.
283 In the case of Cellular services this normally
284 indicates connections to a foreign provider when
287 array{string} Nameservers [readonly]
289 The list of currently active nameservers for this
290 service. If the server is not in READY or ONLINE
291 state than this list will be empty.
293 Global nameservers are automatically added to this
294 list. The array represents a sorted list of the
295 current nameservers. The first one has the highest
296 priority and is used by default.
298 When using DHCP this array represents the nameservers
299 provided by the network. In case of manual settings,
300 the ones from Nameservers.Configuration are used.
302 array{string} Nameservers.Configuration [readwrite]
304 The list of manually configured domain name
305 servers. Some 3G networks don't provide correct
306 name servers and this allows for an override.
308 This array is sorted by priority and the first
309 entry in the list represents the nameserver with
310 the highest priority.
312 When using manual configuration and no global
313 nameservers are configured, then it is useful
314 to configure this setting.
316 Changes to the domain name servers can be done
317 at any time. It will not cause a disconnect of
318 the service. However there might be small window
319 where name resolution might fail.
321 array{string} Domains [readonly]
323 The list of currently used search domains.
325 array{string} Domains.Configuration [readwrite]
327 The list of manually configured search domains.
331 string Method [readonly]
333 Possible values are "dhcp", "manual"
336 The value "fixed" indicates an IP address
337 that can not be modified. For example
338 cellular networks return fixed information.
340 string Address [readonly]
342 The current configured IPv4 address.
344 string Netmask [readonly]
346 The current configured IPv4 netmask.
348 string Gateway [readonly]
350 The current configured IPv4 gateway.
352 dict IPv4.Configuration [readwrite]
354 Same values as IPv4 property. The IPv4 represents
355 the actual system configuration while this allows
358 Changing these settings will cause a state change
359 of the service. The service will become unavailable
360 until the new configuration has been successfully
365 string Method [readonly]
367 Possible values are "dhcp", "manual"
370 The value "fixed" indicates an IP address
371 that can not be modified. For example
372 cellular networks return fixed information.
374 "dhcp" is not supported currently.
376 string Address [readonly]
378 The current configured IPv6 address.
380 uint8 PrefixLength [readonly]
382 The prefix length of the IPv6 address.
384 string Gateway [readonly]
386 The current configured IPv6 gateway.
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]
487 Selected speed of the line.
489 This information might not always be
492 string Duplex [readonly]
494 Selected duplex settings of the line.
496 Possible values are "half" and "full".
498 This information might not always be