blob: dff46fed1d684c18a2b39573eab821fe2727918b [file] [log] [blame]
Paul Stewarta4e618b2012-04-25 16:21:22 -07001Service hierarchy
2=================
3
4Service org.chromium.flimflam
5Interface org.chromium.flimflam.Service
6Object path [variable prefix]/{service0,service1,...}
7
8Methods dict GetProperties()
9
10 Return the properties for the service object. See
11 the Properties section for available properties.
12
13 void SetProperty(string name, variant value)
14
15 Change the value of the specified property. Only
16 properties that are listed as read-write are
17 changeable. On success a PropertyChanged signal
18 will be emitted.
19
20 Possible Errors: [service].Error.InvalidArguments
21 [service].Error.InvalidProperty
22 [service].Error.InvalidService
23 [service].Error.InvalidPassphrase
24
25 void ClearProperty(string name)
26
27 Clear the value of the specified property. Only
28 properties that are listed as read-write are
29 changeable. On success a PropertyChanged signal
30 will be emitted.
31
32 Possible Errors: [service].Error.InvalidArguments
33 [service].Error.InvalidProperty
34
35 void Connect()
36
37 Initiate a connection for the specified service.
38
39 For Ethernet devices this method can only be used
40 if it has previously been disconnected. Otherwise
41 the plugging of a cable automatically triggers
42 a connection. If no cable is plugged in this
43 method will fail.
44
45 If the requested service is already connected
46 then this request is ignored and AlreadyConnected
47 is returned.
48
49 If the requested service is in the process of
50 connecting then this request is ignored and
51 InProgress is returned.
52
53 If another service of the same type is connected or
54 connecting then it is terminated before this request
55 is handled.
56
Wade Guthrie005bd342012-05-02 09:37:07 -070057 If the requested service cannot, for reasons not
58 described above, be connected, OperationFailed is
59 returned.
60
Paul Stewarta4e618b2012-04-25 16:21:22 -070061 Possible Errors: [service].Error.AlreadyConnected
62 [service].Error.InProgress
63 [service].Error.OperationAborted
64 [service].Error.InvalidService
Wade Guthrie005bd342012-05-02 09:37:07 -070065 [service].Error.OperationFailed
Paul Stewarta4e618b2012-04-25 16:21:22 -070066
67 void Disconnect()
68
69 Disconnect a service. If the service is not
70 connected or in the process of connecting an
71 error message will be generated.
72
73 For Ethernet devices this will remove all
74 Layer 3 state and mark the associated network
75 interface down. If no cable is plugged in this
76 request will fail.
77
78 This method can also be used to abort a previous
79 connection attempt via the Connect method.
80
81 Possible Errors: [service].Error.InvalidArguments
82
83 void Remove()
84
85 Disconnect and remove all recorded state of a
86 service. The service must have previously had
87 a success connection so that the Favorite property
88 is marked "true".
89
90 This method is not permitted for Ethernet devices;
91 it will generate a NotSupported error response.
92
93 Possible Errors: [service].Error.InvalidArguments
94 [service].Error.NotSupported
95
96 [Silently ignored in shill so far]
97
98 void MoveBefore(object service)
99
100 Silently ignored in shill. Do not use.
101
102 void MoveAfter(object service)
103
104 Silently ignored in shill. Do not use.
105
106 void ActivateCellularModem(string carrier)
107
108 Activate a cellular modem on the provided carrier.
109
110 This method returns immediately. The caller
111 can either poll the Cellular.ActivationState
112 property, or monitor the PropertyChanged
113 signal to know when and if the
114 ActivateCellularModem call succeeded.
115
116 The correct carrier specific modem firmware
117 must already be loaded before this method is
118 called.
119
120 If this method is called for a non-cellular
121 service or on a service associated with a
122 non-CDMA device, it will return a NotSupported
123 error.
124
125 If the device is already activated nothing is returned.
126 but if the device needs to be activated an InProgress
127 error is returned.
128
129 Expected Result: [service].Error.InProgress
130 Possible Errors: [service].Error.NotSupported
131
132Signals PropertyChanged(string name, variant value)
133
134 This signal indicates a changed value of the given
135 property.
136
137
138Properties boolean AutoConnect [readwrite]
139
140 If set to true, this service will auto-connect
141 when no other connection is available. If multiple
142 services are marked for auto-connect then the highest
143 priority available service will be selected.
144
145 For favorite services it is possible to change
146 this value to prevent or permit automatic
147 connection attempts. For non-favorite services, setting
148 AutoConnect to TRUE causes favorite to be set to TRUE.
149
150 string Cellular.ActivationState [readonly]
151
152 (Cellular only) The activate state of the device
153 on the cellular network. Possible values for
154 activate_state are:
155 "not-activated"
156 "activating"
157 "partially-activated"
158 "activated"
159
160 A CDMA device can be activated by calling the
161 Activate method.
162
163 This property is relevant only for services
164 associated with a CDMA cellular device.
165
166 dict Cellular.ServingOperator [readonly] [GSM only]
167 (Cellular only) Description of the operator on whose
168 network the modem is currently registered, if any.
169 The dictionary may contain the following string-valued
170 properties:
171
172 "name" The operator name
173 "country" The two-letter country code.
174 "network_id" The MCC (Mobile Country Code)
175 and MNC (Mobile Network Code) of the
176 operator on whose network the device is
177 registered. The value of the property is
178 the simple concatenation of the MCC and
179 the MNC, with no separator. The first
180 three digits are always the MCC, and
181 the following two or three digits are the
182 MNC.
183
184 string Cellular.NetworkTechnology [readonly]
185
186 (Cellular only) If the modem is registered on a
187 network, then this property gives the data bearer
188 technology currently in use. The following
189 table lists the values this property may have,
190 along with a rough indication of the "generation"
191 to which the technology is considered to belong.
192
193 Value Generation
194 -----------------------------
195 "1xRTT" (CDMA) 2.5G
196 "EVDO" (CDMA) 3G to 3.5G
197 "GPRS" 2.5G
198 "EDGE" 2.75G
199 "UMTS" 3G
200 "HSPA" 3.5G
201 "HSPA+" 3.75G
202 "LTE" 3.9G
203 "LTE Advanced" 4G
204
205 string Cellular.RoamingState [readonly]
206
207 (Cellular only) The roaming status of the modem on
208 the current network. Possible values are "home",
209 "roaming", and "unknown".
210
211 string Cellular.Olp [readonly]
212
213 (Cellular only) A dictionary describing the
214 online payment portal (OLP) at which a user
215 can sign up for, or modify, a mobile data
216 plan. The value of this property is a
217 string -> string dictionary, which includes
218 the following keys:
219
220 "url" The URL for the portal
221 "method" The HTTP method to use, "GET" or "POST"
222 "postdata" If the method is POST then this key is
223 present and contains the postdata
224 to send.
225
226 dict Cellular.APN [readwrite] [GSM only]
227
228 (Cellular only) The APN to be used with a GSM
229 carrier for making data connections. The value of
230 this property is a string -> string dictionary,
231 which must include at least the following key:
232
233 "apn" The APN to use for making connections
234
235 There are three optional properties. The first is
236
237 "network_id" The network ID (MCC/MNC pair) of the
238 network for which the APN should be used.
239 If not specified, then the network ID of
240 the currently registered network is used.
241
242 The other two optional properties are "username"
243 and "password", which, if specified, will be supplied
244 to the connect operation on the modem along with the
245 APN.
246
247 When the APN is set using this method, it overrides
248 any APN that may be associated with the specified
249 network ID in the APN database. The APN setting is
250 persistent across reboots.
251
252 A user-specified APN may be cleared by clearing this
253 property.
254
255 The algorithm for connecting to GSM networks is as
256 follows, stopping when a connection is succesfully
257 established:
258 1. Try the last APN that resulted in a successful
259 connection.
260 2. Try the APN that was set from the Cellular.APN
261 property (if any).
262 3. Try the list of APNs for the current provider one
263 at a time. The list comes from the mobile broadband
264 provider information database.
265 4. As a last resort, try connecting without specifying
266 an APN.
267
268 If all these steps fail, then the connect attempt fails.
269 Whenever this property is set to establish a new APN to
270 use, the remembered last-good-APN is cleared. The
271 remembered last-good-APN is persistent across reboots.
272
273 dict Cellular.LastGoodAPN [readonly] [GSM only]
274
275 (Cellular only) The APN information used in the
276 last successful connection attempt. If the last
277 attempt was unsuccesful, this property is unset.
278 The format of this property is the same as for
279 the Cellular.APN property.
280
281 string CheckPortal [readwrite]
282
283 Control captive portal checking. Possible values
284 are "true", "false", and "auto" (default).
285 When set to "auto" captive portal checking is
286 controlled by Manager.CheckPortalList (which
287 is a per-technology mask/list of which services
288 should do captive portal checking).
289
290 boolean Connectable [readonly]
291
292 Indicates whether a service is prepared for use
293 as an argument to the Connect method. A service
294 will not be marked Connectable if, for example,
295 it is missing necessary security credentials.
296 Clients may use this property to not disable
297 services or to mark them in some way to indicate
298 they are present but not usable.
299
300 object Device [readonly]
301
302 The object path of the associated device.
303 This value may be used to retrieve and manipulate
304 Layer 3 configuration state.
305
306 string EAP.Identity [readwrite]
307
308 The client identity string used in setting up
309 services of type "802_1x".
310
311 This property is included in get requests only
312 when the requester has sufficient privileges.
313
314 string EAP.EAP [readwrite]
315
316 The EAP methods that will be accepted when setting
317 up services of type "802_1x".
318
319 This property is included in get requests only
320 when the requester has sufficient privileges.
321
322 string EAP.InnerEAP [readwrite]
323
324 The authentication methods that will be on the
325 inside of a PEAP or EAP-TTLS tunnel.
326
327 This property is included in get requests only
328 when the requester has sufficient privileges.
329
330 string EAP.AnonymousIdentity [readwrite]
331
332 The client identity string that will be used
333 for the outer EAP authentication for tunneled
334 methods such as PEAP and EAP-TTLS.
335
336 This property is included in get requests only
337 when the requester has sufficient privileges.
338
339 string EAP.ClientCert [readwrite]
340
341 The pathname to a file containing the client
342 certificate for setting up services of type
343 "802_1x". The certificate file must be in
344 PEM format.
345
346 This property is included in get requests only
347 when the requester has sufficient privileges.
348
349 string EAP.CertID [readwrite]
350
351 The PKCS#11 identifier of the client certificate
352 to use when setting up services of type "802_1x".
353
354 This property is included in get requests only
355 when the requester has sufficient privileges.
356
357 string EAP.PrivateKey [readwrite]
358
359 The pathname of a file containing the private
360 key for setting up services of type "802_1x".
361 The private key file must be in PEM format.
362
363 This property is included in get requests only
364 when the requester has sufficient privileges.
365
366 string EAP.PrivateKeyPassword [readwrite]
367
368 The password to decrypt a private key given
369 in EAP.PrivateKey.
370
371 This property is included in get requests only
372 when the requester has sufficient privileges.
373
374 string EAP.KeyID [readwrite]
375
376 The PKCS#11 identifier of the private key to
377 use when setting up services of type "802_1x".
378
379 This property is included in get requests only
380 when the requester has sufficient privileges.
381
382 string EAP.CACert [readwrite]
383
384 The pathname of a file containing the Certificate
385 Authority's certificate for validating server
386 certificates during the 802.1x authentication
387 process.
388
389 This property is included in get requests only
390 when the requester has sufficient privileges.
391
392 string EAP.CACertID [readwrite]
393
394 The PKCS#11 ID of the EAP.CACert file for
395 validating server certificate recieved during
396 the 802.1x authentication process.
397
398 This property is included in get requests only
399 when the requester has sufficient privileges.
400
401 boolean EAP.UseSystemCAs [readwrite]
402
403 Control whether EAP operations are
404 configured to use the system's installed set
405 of certificate authorities when validating
406 server certificates. Note that if UseSystemCAs
407 is false and no CA is specified with EAP.CACert
408 or EAP.CaCertID - that is, no CAs are configured
409 at all - server certificates will not have their
410 signatures checked. Defaults to true.
411
412 This property is included in get requests only
413 when the requester has sufficient privileges.
414
415 string EAP.PIN [readwrite]
416
417 The PIN used to authenticate to the PKCS#11 device
418 to retrieve a client certificate, private key,
419 or certificate authority certificate.
420
421 This property is included in get requests only
422 when the requester has sufficient privileges.
423
424 string EAP.Password [readwrite]
425
426 The password to use in 802.1x authentication.
427
428 This property is included in get requests only
429 when the requester has sufficient privileges.
430
431 string EAP.KeyMgmt [readwrite]
432
433 (WiFi only) The key management algorithm to be
434 used in 802.1x authentication. If this property
435 is not set then "WPA-EAP" is used for the key
436 management algorithm.
437
438 This property is included in get requests only
439 when the requester has sufficient privileges.
440
Paul Stewartbc6e7392012-05-24 07:07:48 -0700441 array{string} EAP.RemoteCertification [readonly]
442
443 (WiFi only) The list of certificate subject names
444 reported by the remote RADIUS server. This
445 property is set during 802.1x negotiation and
446 persists after disconnection for later inspection,
447 but is not persisted between connection manager
448 restarts. It is also cleared at the beginning of
449 the next connection.
450
451 string EAP.SubjectMatch [readwrite]
452
453 (WiFi only) A substring which the remote
454 RADIUS server certificate subject name must
455 contain. If the subject does not contain this
456 substring, abort 802.1x negotiation.
457
Paul Stewarta4e618b2012-04-25 16:21:22 -0700458 string Error [readonly]
459
460 The service error status details.
461
462 When error occur during connection or disconnection
463 the detailed information are represented in this
464 property to help the user interface to present the
465 user with alternate options.
466
467 This property is only valid when the service is in
468 the "failure" or "activation-failure" states. Otherwise
469 it might be empty or not present at all.
470
471 Current defined error code is "dhcp-failed".
472
473 boolean Favorite [readonly]
474
475 Will be true if a cable is plugged in or the user
476 selected and successfully connected to this service.
477
478 This value is automatically changed and to revert
479 it back to false the Remove() method needs to be
480 used.
481
482 string GUID [readwrite]
483
484 The Globally Unique IDentifier for the service.
485 This value may be set by a client and is
486 intended for cross-referencing Service objects
487 to externally-maintained data.
488
489 object IPConfig [readonly]
490
491 The object path of the associated IP configuration.
492 This value only exists when the service is connected,
493 and is used used to retrieve Layer 3 configuration
494 state.
495
496 boolean IsActive [readonly]
497
498 Will be true if this service has a default route;
499 i.e. network traffic is being sent through it.
500
501 string Mode [readonly]
502
503 If the service type is "wifi", then this property is
504 present and contains the mode of the network. The
505 possible values are "managed" or "adhoc".
506
507 This property is present only for WiFi services.
508
509 string Name [readonly]
510
511 The service name (for example "Wireless" etc.)
512
513 This name can be used for directly displaying it in
514 the application. It has pure informational purpose.
515
516 For Ethernet devices and hidden WiFi networks it is
517 not guaranteed that this property is present. For
518 visible WiFi networks, this may contain the SSID.
519
520 See also the WiFi.HexSSID property.
521
522 string Passphrase [readwrite]
523
524 If the service type is "wifi", then this property
525 holds a passphrase used in setting up services of
526 type "wep", "wpa", "rsn", "psk", or a private
527 key password used in setting up services of
528 type "802_1x".
529
530 For "wep" services, this must contain the WEP
531 key and, optionally, a key index. Only 40-bit
532 and 104-bit WEP keys are supported. The WEP
533 key can be formatted either as an ASCII string
534 (5 or 13 characters), or as ASCII hex digits
535 (10 or 26). When using ASCII hex digits, the
536 key may optionally be preceded by "0x" or "0X".
537 To specify an optional WEP key index, prepend
538 the key with "0:", "1:", "2:" or "3:". If no
539 index is specified, 0 is used.
540
541 By default this property is not included in get
542 requests. It may be present if a non-default
543 security policy is configured and the client has
544 "read secret" privileges.
545
546 Note that no PropertyChanged signals are sent for
547 this property. The PassphraseRequired property
548 should be monitored instead.
549
550 boolean PassphraseRequired [readonly]
551
552 If the service type is "wifi", then this property
553 indicates if a passphrase or key (for WEP) is required.
554
555 If a passphrase has been set already or if no
556 passphrase is needed, then this property will
557 be set to false.
558
559 UI clients may monitor this property for a
560 PropertyChanged signals to prompt for a required
561 passphrase or key.
562
563 [We will be supporting this soon for VPN]
564
565 int32 Priority [readwrite]
566
567 An optional value used to calculate the priority order
568 of this service. Priorities are between 1 to 100.
569 Services with priorities are sorted ahead of services
570 without. Services with the same priority are ordered
571 by other means such as service type and signal
572 strength.
573
574 By default services are not assigned a priority;
575 clients must set one if they desire. To remove an
576 existing priority use the ClearProperty method.
577
578 object Profile [readwrite]
579
580 The object path of the associated Profile object.
581 This may not be present if the Service object
582 has not been written to a profile yet.
583
584 string ProxyConfig [readwrite]
585
586 An externalized json dictionary describing the proxy
587 configuration that can be stored on the service, and
588 modified by a user.
589 Flimflam does not use this information for anything,
590 but it is left available to the caller, and stored
591 persistently.
592 This property may be set by any client and will be
593 adopted by chrome during run-time. If syntax of the
594 value is wrong, chrome will ignore this property during
595 runtime.
596 The value of this property is a string -> string
597 dictionary that includes the following keys. The final
598 string is a comma separated list of key-value pairs
599 enclosed by "{" and "}"; syntax of a key-value pair is:
600 <key>":"<value>. Example:
601 {"mode":"fixed-servers","server":"http=foopy:80"}
602
603 "mode"
604 type of proxy that can be one of:
605 "direct" --
606 direct connection to network, other preferences
607 are ignored
608 "auto_detect" --
609 try to retrieve a PAC script from
610 http://wpad/wpad.dat or fall back to direct
611 connection
612 "pac_script" --
613 try to retrieve PAC script specified for "pac_url"
614 (see below) or fall back to direct connection
615 "fixed_servers" --
616 manual configuration of one or more servers
617 to be used as proxy
618
619 "pac_url"
620 URL for proxy .pac file (meaningful only if mode=
621 pac_script); scheme of URL must be specified
622
623 "pac_mandatory"
624 indciate if a valid PAC script is mandatory
625 (meaningful only if mode=pac_script);
626 value is either true or false (without quotes), e.g.
627 "pac_mandatory":true;
628 if true, network traffic does not fall back to
629 direct connections in case the PAC script is not
630 available
631
632 "server"
633 proxy server for manual configuration (meaningful
634 only if mode=fixed-servers); syntax is
635 [<proxy-scheme>"://"]<proxy-host>[":"<proxy-port>];
636 if the proxy to use depends on the scheme of the
637 URL, specify a semicolon separated list of :
638 <url-scheme>"="<proxy-uri>
639 for example:
640 - "http=foopy:80;ftp=foopy2" --
641 use HTTP proxy "foopy:80" for http:// URLs, and
642 HTTP proxy "foopy2:80" for ftp:// URLS
643 - "foopy:80" -- use HTTP proxy "foopy:80" for all
644 URLs
645 - "socks4://foopy" --
646 use SOCKS v4 proxy "foopy:80" for all URLs
647
648 "bypass_list"
649 proxy bypass rules for manual configuration
650 (meaningful only if mode=fixed-servers); format
651 can be any one of the following:
652 1) [<url_scheme>"://"]<hostname_pattern>[":"<port>]
653 Match all hostnames that match the pattern
654 hostname_pattern which can be a substring of the
655 hostname with asterisks.
656 Examples: "foobar.com", "*foobar.com",
657 "*.foobar.com", "*foobar.com:99",
658 "https://x.*.y.com:99"
659 2) "."<hostname_suffix_pattern>[":"<port>]
660 Match a particular domain suffix.
661 Examples: ".google.com", ".com",
662 "http://.google.com"
663 3) [<scheme>"://"]<ip_literal>[":"<port>]
664 Match URLs that are IP address literals.
665 Conceptually this is the similar to (1), but with
666 special cases to handle IP literal
667 canonicalization. For example matching on
668 "[0:0:0::1]" would be the same as matching on
669 "[::1]" since the IPv6 canonicalization is done
670 internally.
671 Examples: "127.0.1", "[0:0::1]", "[::1]",
672 "http://[::1]:99"
673 4) <ip_literal>"/"<prefix_length_in_bits>
674 Match any URL that is to an IP literal that falls
675 in the given range. IP range is specified using
676 CIDR notation.
677 Examples: "192.168.1.1/16", "fefe:13::abc/33".
678 5) "<local>"
679 Match local addresses; this is a literal string.
680 "<local>" matches one of: "127.0.0.1", "::1",
681 "localhost".
682
683 dict Provider [readonly]
684
685 (VPN only) Provider data. A provider is a service
686 that piggy-backs on top of a transport service.
687 This is presently used by VPN services.
688
689 string Domain [readonly]
690 VPN domain name.
691 string Host [readonly]
692 VPN host IP address.
693 string Name [readonly]
694 VPN provider name.
695 string Type [readonly]
696 VPN provider type (e.g. openvpn).
697
698 boolean SaveCredentials [readwrite]
699
700 This property indicates if security credentials
701 should be reused and/or written to stable storage.
702 Setting this property to FALSE ensures nothing is
703 recorded and the client must supply credentials
704 for each Connect request.
705
706 The following credentials are not recorded when
707 this property is set to FALSE:
708
709 Passphrase
710 EAP.Identity
711 EAP.AnonymousIdentity
712 EAP.ClientCert
713 EAP.CertID
714 EAP.PrivateKey
715 EAP.PrivateKeyPassword
716 EAP.KeyID
717 EAP.PIN
718 EAP.Password
719
720 Note that no PropertyChanged signals are sent for
721 this property.
722
723 string Security [readonly]
724
725 If the service type is "wifi", then this property is
726 present and contains the security method or key
727 management setting.
728
729 Possible values are: "none" (no privacy),
730 "wep" (fixed key WEP), "wpa" (WPA-PSK), "rsn"
731 (IEEE 802.11i-PSK), "psk" (either "wpa" or "rsn"),
732 and "802_1x" (IEEE 802.11i with 802.1x authentication).
733
734 This property is only present for WiFi services.
735
736 string State [readonly]
737
738 The state of the service; one of:
739
740 "idle" The service is not enabled or otherwise
741 operational.
742
743 "carrier" The associated device is powered on and
744 ready for Layer 2 operation; e.g. a
745 wired Ethernet device that is powered
746 up and connected to a switch.
747
748 "association" Intermediate states associated with
749 "disconnect" connection-based devices such as WiFi
750 and Cellular. These are exposed for
751 UI applications to provide more
752 fine-grained status.
753
754 "configuration" Layer 2 is setup but Layer 3 setup
755 has yet to completed.
756
757 "ready" Layer 3 setup is complete; ready to
758 transit and receive data.
759
760 "portal" Layer 3 setup is complete but
761 connectivity to the Internet may be
762 limited or unavailable.
763
764 "online" Layer 3 setup is complete and an
765 Internet connection has been checked
766 to support HTTP access to the
767 Manager.PortalURL site.
768
769 "failure" An error occurred while trying to
770 reach the "ready" state. Consult the
771 Error propery for details.
772
773 "activation-failure"
774 An error occurred while trying to
775 activate a cellular modem. Consult the
776 Error property for details.
777
Paul Stewart1291e082012-04-30 20:08:05 -0700778 string StaticIP.Address [readwrite]
779 string StaticIP.Gateway [readwrite]
780 int32 StaticIP.Mtu [readwrite]
781 string StaticIP.NameServers [readwrite]
782 string StaticIP.PeerAddress [readwrite]
783 int32 StaticIP.Prefixlen [readwrite]
784
785 The properties above can be set on a service to
786 selectively override individual parameters received
787 over DHCP or whatever default IP aquisition technique
788 is used by the service. The "StaticIP.NameServers"
789 property should be a comma-separated list of IP
790 addresses.
791
792 Additionally, in services that use DHCP, if the
793 "StaticIP.Address" and "StaticIP.Prefixlen"
794 parameters are both set on a service, the service
795 will be configured as soon as a link is established,
796 in order to allow full static IP configuration. A
797 DHCP client will be launched in parallel, which, if
798 successful, will provide values for any parameters
799 that were not set statically.
800
801 The IPConfig associated with the service (object
802 path supplied in the "IPConfig" property above)
803 will display the result of the merged network
804 parameters.
805
Paul Stewartdef189e2012-08-02 20:12:09 -0700806 string SavedIP.Address [readonly]
807 string SavedIP.Gateway [readonly]
808 int32 SavedIP.Mtu [readonly]
809 string SavedIP.NameServers [readonly]
810 string SavedIP.PeerAddress [readonly]
811 int32 SavedIP.Prefixlen [readonly]
812
813 The properties above are set on a service to present
814 the configuration that was recieved from the DHCP
815 server prior to applying any "StaticIP.*" parameters
816 during the most recent connection attempt. All
817 parameters are saved regardless of whether they were
818 overridden.
819
820 Note that if a "StaticIP.*" parameter is set on
821 a service, but the service has not been re-connected,
822 the IPConfig object will still contain the true
823 value that the interface is set to.
824
Paul Stewarta4e618b2012-04-25 16:21:22 -0700825 uint8 Strength [readonly]
826
827 Indicates the signal strength of the service. This
828 is a normalized value between 0 and 100.
829
830 This property will not be present for Ethernet
831 devices.
832
833 string Type [readonly]
834
835 The service type; one of:
836 "ethernet" (802.3 wired Ethernet),
837 "wifi" (IEEE 802.11),
838 "wimax" (IEEE 802.16),
839 "bluetooth" (Bluetooth PAN),
840 "cellular" (3G Cellular), or
841 "vpn" (Virtual Private Network).
842
843 This information should only be used to determine
844 advanced properties or showing the correct icon
845 to the user.
846
847 string UIData [readwrite]
848
849 This is additional data available about this service
850 for use by the user interface. This value is opaque
851 and not used by shill.
852
853 string WiFi.AuthMode [readonly]
854
855 (WiFi only) If the service state is
856 "configuration" or "ready", then this property
857 will be present and contains the negotiated
858 authentication method.
859
860 There are too many possible values to enumerate here.
861 The complete set depends on the capabilities of the
862 associated WiFi supplicant.
863
864 string WiFi.BSSID [readonly]
865
866 (WiFi only) The BSSID of the associated AP.
867 One can monitor this property for PropertyChanged
868 signals to identify when roaming changes the
869 current AP.
870
871 boolean WiFi.HiddenSSID [readonly]
872
873 (WiFi only) If true, the associated WiFi network
874 does not broadcast it's SSID in beacon frames.
875
876 uint16 WiFi.Frequency [readonly]
877
878 (WiFi only) The operating frequency in MHz of
879 the network.
880
881 string WiFi.PhyMode [readonly]
882
883 (WiFi only) If the service state is
884 "configuration" or "ready", then this property
885 will be present and contains the negotiated
886 operating mode for the channel. Possible values
887 include "802.11a", "802.11b", "802.11g",
888 "802.11n". This value is for informational
889 purposes only.
890
891 string WiFi.HexSSID [readonly]
892
893 (WiFi only) If the service's SSID contains
894 unprintable characters then this property is
895 present and holds a hex-encoded copy of the SSID.
896
897 See also the Name property. (Note that there is
898 no SSID property.)
899
900 string WiFi.SSID [readonly]
901 (WiFi only) The service's SSID. Must have a non-zero
902 length less than or equal to 32.
Paul Stewart72b2fdc2012-06-02 08:58:51 -0700903
904 dict WiFi.VendorInformation [readonly]
905 (WiFi only) Information about the vendor of the
906 AP, gleaned from WPS and vendor-specific information
907 elements in the beacon and probe respondss.
908
909 string Manufacturer [readonly]
910 Device manufacturer name as supplied by WPS IE.
911 string ModelName [readonly]
912 Device model name as supplied by WPS IE.
913 string ModelNumber [readonly]
914 Device model number as supplied by WPS IE.
915 string DeviceName [readonly]
916 Device name as supplied by WPS IE.
917 string OUIList [readonly]
918 Space separated list of OUI identifiers for
919 vendor-specific IEs that were neither the
920 Microsoft nor Epigram identifiers (the former
921 two are used for platform-neutral information).