1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
|
<html>
<head>
<title>NetworkManager 0.8.1 Settings Specification</title></head>
<body>
<p><h2>Setting name: '802-1x'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>802-1x</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>eap</strong></td>
<td>array of string</td>
<td>[]</td>
<td>The allowed EAP method to be used when authenticating to the network with 802.1x. Valid methods are: 'leap', 'md5', 'tls', 'peap', 'ttls', and 'fast'. Each method requires different configuration using the properties of this setting; refer to wpa_supplicant documentation for the allowed combinations.</td>
</tr>
<tr align=left valign=top>
<td><strong>identity</strong></td>
<td>string</td>
<td></td>
<td>Identity string for EAP authentication methods. Often the user's user or login name.</td>
</tr>
<tr align=left valign=top>
<td><strong>anonymous-identity</strong></td>
<td>string</td>
<td></td>
<td>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</td>
</tr>
<tr align=left valign=top>
<td><strong>ca-cert</strong></td>
<td>byte array</td>
<td>[]</td>
<td>Contains the CA certificate if used by the EAP method specified in the 'eap' property. Certificate data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</td>
</tr>
<tr align=left valign=top>
<td><strong>ca-path</strong></td>
<td>string</td>
<td></td>
<td>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the 'ca-cert' property.</td>
</tr>
<tr align=left valign=top>
<td><strong>client-cert</strong></td>
<td>byte array</td>
<td>[]</td>
<td>Contains the client certificate if used by the EAP method specified in the 'eap' property. Certificate data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte.</td>
</tr>
<tr align=left valign=top>
<td><strong>phase1-peapver</strong></td>
<td>string</td>
<td></td>
<td>Forces which PEAP version is used when PEAP is set as the EAP method in 'eap' property. When unset, the version reported by the server will be used. Sometimes when using older RADIUS servers, it is necessary to force the client to use a particular PEAP version. To do so, this property may be set to '0' or '1; to force that specific PEAP version.</td>
</tr>
<tr align=left valign=top>
<td><strong>phase1-peaplabel</strong></td>
<td>string</td>
<td></td>
<td>Forces use of the new PEAP label during key derivation. Some RADIUS servers may require forcing the new PEAP label to interoperate with PEAPv1. Set to '1' to force use of the new PEAP label. See the wpa_supplicant documentation for more details.</td>
</tr>
<tr align=left valign=top>
<td><strong>phase1-fast-provisioning</strong></td>
<td>string</td>
<td></td>
<td>Enables or disables in-line provisioning of EAP-FAST credentials when FAST is specified as the EAP method in the #NMSetting8021x:eap property. Allowed values are '0' (disabled), '1' (allow unauthenticated provisioning), '2' (allow authenticated provisioning), and '3' (allow both authenticated and unauthenticated provisioning). See the wpa_supplicant documentation for more details.</td>
</tr>
<tr align=left valign=top>
<td><strong>phase2-auth</strong></td>
<td>string</td>
<td></td>
<td>Specifies the allowed 'phase 2' inner non-EAP authentication methods when an EAP method that uses an inner TLS tunnel is specified in the 'eap' property. Recognized non-EAP phase2 methods are 'pap', 'chap', 'mschap', 'mschapv2', 'gtc', 'otp', 'md5', and 'tls'. Each 'phase 2' inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</td>
</tr>
<tr align=left valign=top>
<td><strong>phase2-autheap</strong></td>
<td>string</td>
<td></td>
<td>Specifies the allowed 'phase 2' inner EAP-based authentication methods when an EAP method that uses an inner TLS tunnel is specified in the 'eap' property. Recognized EAP-based 'phase 2' methods are 'md5', 'mschapv2', 'otp', 'gtc', and 'tls'. Each 'phase 2' inner method requires specific parameters for successful authentication; see the wpa_supplicant documentation for more details.</td>
</tr>
<tr align=left valign=top>
<td><strong>phase2-ca-cert</strong></td>
<td>byte array</td>
<td>[]</td>
<td>Contains the 'phase 2' CA certificate if used by the EAP method specified in the 'phase2-auth' or 'phase2-autheap' properties. Certificate data is specified using a 'scheme'; two are currentlysupported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte. This property can be unset even if the EAP method supports CA certificates, but this allows man-in-the-middle attacks and is NOT recommended.</td>
</tr>
<tr align=left valign=top>
<td><strong>phase2-ca-path</strong></td>
<td>string</td>
<td></td>
<td>UTF-8 encoded path to a directory containing PEM or DER formatted certificates to be added to the verification chain in addition to the certificate specified in the 'phase2-ca-cert' property.</td>
</tr>
<tr align=left valign=top>
<td><strong>phase2-client-cert</strong></td>
<td>byte array</td>
<td>[]</td>
<td>Contains the 'phase 2' client certificate if used by the EAP method specified in the 'phase2-eap' or 'phase2-autheap' properties. Certificate data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme (which is backwards compatible with NM 0.7.x) this property should be set to the certificate's DER encoded data. When using the path scheme, this property should be set to the full UTF-8 encoded path of the certificate, prefixed with the string 'file://' and ending with a terminating NULL byte.</td>
</tr>
<tr align=left valign=top>
<td><strong>password</strong></td>
<td>string</td>
<td></td>
<td>Password used for EAP authentication methods.</td>
</tr>
<tr align=left valign=top>
<td><strong>private-key</strong></td>
<td>byte array</td>
<td>[]</td>
<td>Contains the private key when the 'eap' property is set to 'tls'. Key data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme and X.509 private keys, this property should be set to the keys's decrypted DER encoded data. When using X.509 private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and and ending with a terminating NULL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data (which is encrypted) and the 'private-key-password' property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and and ending with a terminating NULL byte, and as with the blob scheme the 'private-key-password' property must be set to the password used to decode the PKCS#12 private key and certificate.</td>
</tr>
<tr align=left valign=top>
<td><strong>private-key-password</strong></td>
<td>string</td>
<td></td>
<td>The password used to decrypt the private key specified in the 'private-key' property when the private key either uses the path scheme, or if the private key is a PKCS#12 format key.</td>
</tr>
<tr align=left valign=top>
<td><strong>phase2-private-key</strong></td>
<td>byte array</td>
<td>[]</td>
<td>Contains the 'phase 2' inner private key when the 'phase2-eap' or 'phase2-autheap' property is set to 'tls'. Key data is specified using a 'scheme'; two are currently supported: blob and path. When using the blob scheme and X.509 private keys, this property should be set to the keys's decrypted DER encoded data. When using X.509 private keys with the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and and ending with a terminating NULL byte. When using PKCS#12 format private keys and the blob scheme, this property should be set to the PKCS#12 data (which is encrypted) and the 'private-key-password' property must be set to password used to decrypt the PKCS#12 certificate and key. When using PKCS#12 files and the path scheme, this property should be set to the full UTF-8 encoded path of the key, prefixed with the string 'file://' and and ending with a terminating NULL byte, and as with the blob scheme the 'private-key-password' property must be set to the password used to decode the PKCS#12 private key and certificate.</td>
</tr>
<tr align=left valign=top>
<td><strong>phase2-private-key-password</strong></td>
<td>string</td>
<td></td>
<td>The password used to decrypt the 'phase 2' private key specified in the 'private-key' property when the phase2 private key either uses the path scheme, or if the phase2 private key is a PKCS#12 format key.</td>
</tr>
<tr align=left valign=top>
<td><strong>system-ca-certs</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>When TRUE, overrides 'ca-path' and 'phase2-ca-path' properties using the system CA directory specified at configure time with the --system-ca-path switch. The certificates in this directory are added to the verification chain in addition to any certificates specified by the 'ca-cert' and 'phase2-ca-cert' properties.</td>
</tr>
</table><br/>
<p><h2>Setting name: 'bluetooth'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>bluetooth</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>bdaddr</strong></td>
<td>byte array</td>
<td>[]</td>
<td>The Bluetooth address of the device</td>
</tr>
<tr align=left valign=top>
<td><strong>type</strong></td>
<td>string</td>
<td></td>
<td>Either 'dun' for Dial-Up Networking connections (not yet supported) or 'panu' for Personal Area Networking connections.</td>
</tr>
</table><br/>
<p><h2>Setting name: 'cdma'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>cdma</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>number</strong></td>
<td>string</td>
<td></td>
<td>Number to dial when establishing a PPP data session with the CDMA-based mobile broadband network. If not specified, the default number (#777) is used when required.</td>
</tr>
<tr align=left valign=top>
<td><strong>username</strong></td>
<td>string</td>
<td></td>
<td>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</td>
</tr>
<tr align=left valign=top>
<td><strong>password</strong></td>
<td>string</td>
<td></td>
<td>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</td>
</tr>
</table><br/>
<p><h2>Setting name: 'connection'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>connection</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>id</strong></td>
<td>string</td>
<td></td>
<td>User-readable connection identifier/name. Must be one or more characters and may change over the lifetime of the connection if the user decides to rename it.</td>
</tr>
<tr align=left valign=top>
<td><strong>uuid</strong></td>
<td>string</td>
<td></td>
<td>Universally unique connection identifier. Must be in the format '2815492f-7e56-435e-b2e9-246bd7cdc664' (ie, contains only hexadecimal characters and '-'). The UUID should be assigned when the connection is created and never changed as long as the connection still applies to the same network. For example, it should not be changed when the user changes the connection's 'id', but should be recreated when the WiFi SSID, mobile broadband network provider, or the connection type changes.</td>
</tr>
<tr align=left valign=top>
<td><strong>type</strong></td>
<td>string</td>
<td></td>
<td>Base type of the connection. For hardware-dependent connections, should contain the setting name of the hardware-type specific setting (ie, '802-3-ethernet' or '802-11-wireless' or 'bluetooth', etc), and for non-hardware dependent connections like VPN or otherwise, should contain the setting name of that setting type (ie, 'vpn' or 'bridge', etc).</td>
</tr>
<tr align=left valign=top>
<td><strong>autoconnect</strong></td>
<td>boolean</td>
<td>TRUE</td>
<td>If TRUE, NetworkManager will activate this connection when its network resources are available. If FALSE, the connection must be manually activated by the user or some other mechanism.</td>
</tr>
<tr align=left valign=top>
<td><strong>timestamp</strong></td>
<td>uint64</td>
<td>0</td>
<td>Timestamp (in seconds since the Unix Epoch) that the connection was last successfully activated. Settings services should update the connection timestamp periodically when the connection is active to ensure that an active connection has the latest timestamp.</td>
</tr>
<tr align=left valign=top>
<td><strong>read-only</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, the connection is read-only and cannot be changed by the user or any other mechanism. This is normally set for system connections whose plugin cannot yet write updated connections back out.</td>
</tr>
</table><br/>
<p><h2>Setting name: 'gsm'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>gsm</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>number</strong></td>
<td>string</td>
<td></td>
<td>Number to dial when establishing a PPP data session with the GSM-based mobile broadband network. In most cases, leave the number blank and a number selecting the APN specified in the 'apn' property will be used automatically when required.</td>
</tr>
<tr align=left valign=top>
<td><strong>username</strong></td>
<td>string</td>
<td></td>
<td>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</td>
</tr>
<tr align=left valign=top>
<td><strong>password</strong></td>
<td>string</td>
<td></td>
<td>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</td>
</tr>
<tr align=left valign=top>
<td><strong>apn</strong></td>
<td>string</td>
<td></td>
<td>The GPRS Access Point Name specifying the APN used when establishing a data session with the GSM-based network. The APN often determines how the user will be billed for their network usage and whether the user has access to the Internet or just a provider-specific walled-garden, so it is important to use the correct APN for the user's mobile broadband plan.</td>
</tr>
<tr align=left valign=top>
<td><strong>network-id</strong></td>
<td>string</td>
<td></td>
<td>The Network ID (GSM LAI format, ie MCC-MNC) to force specific network registration. If the Network ID is specified, NetworkManager will attempt to force the device to register only on the specified network. This can be used to ensure that the device does not roam when direct roaming control of the device is not otherwise possible.</td>
</tr>
<tr align=left valign=top>
<td><strong>network-type</strong></td>
<td>int32</td>
<td>-1</td>
<td>Network preference to force the device to only use specific network technologies. The permitted values are: -1: any, 0: 3G only, 1: GPRS/EDGE only, 2: prefer 3G, and 3: prefer 2G. Note that not all devices allow network preference control.</td>
</tr>
<tr align=left valign=top>
<td><strong>band</strong></td>
<td>int32</td>
<td>-1</td>
<td>Band (DEPRECATED and UNUSED)</td>
</tr>
<tr align=left valign=top>
<td><strong>pin</strong></td>
<td>string</td>
<td></td>
<td>If the SIM is locked with a PIN it must be unlocked before any other operations are requested. Specify the PIN here to allow operation of the device.</td>
</tr>
<tr align=left valign=top>
<td><strong>puk</strong></td>
<td>string</td>
<td></td>
<td>PUK (DEPRECATED and UNUSED)</td>
</tr>
<tr align=left valign=top>
<td><strong>allowed-bands</strong></td>
<td>uint32</td>
<td>1</td>
<td>Bitfield of allowed frequency bands. Note that not all devices allow frequency band control.</td>
</tr>
<tr align=left valign=top>
<td><strong>home-only</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</td>
</tr>
</table><br/>
<p><h2>Setting name: 'ipv4'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>ipv4</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>method</strong></td>
<td>string</td>
<td></td>
<td>IPv4 configuration method. If 'auto' is specified then the appropriate automatic method (DHCP, PPP, etc) is used for the interface and most other properties can be left unset. If 'link-local' is specified, then a link-local address in the 169.254/16 range will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'shared' is specified (indicating that this connection will provide network access to other computers) then the interface is assigned an address in the 10.42.x.1/24 range and a DHCP and forwarding DNS server are started, and the interface is NAT-ed to the current default network connection. 'disabled' means IPv4 will not be used on this connection. This property must be set.</td>
</tr>
<tr align=left valign=top>
<td><strong>dns</strong></td>
<td>array of uint32</td>
<td>[]</td>
<td>List of DNS servers (network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no usptream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</td>
</tr>
<tr align=left valign=top>
<td><strong>dns-search</strong></td>
<td>array of string</td>
<td>[]</td>
<td>List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared', 'link-local', or 'disabled' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.</td>
</tr>
<tr align=left valign=top>
<td><strong>addresses</strong></td>
<td>array of array of uint32</td>
<td>[]</td>
<td>Array of IPv4 address structures. Each IPv4 address structure is composed of 3 32-bit values; the first being the IPv4 address (network byte order), the second the prefix (1 - 32), and last the IPv4 gateway (network byte order). The gateway may be left as 0 if no gateway exists for that subnet. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared', 'link-local', or 'disabled' methods as addressing is either automatic or disabled with these methods.</td>
</tr>
<tr align=left valign=top>
<td><strong>routes</strong></td>
<td>array of array of uint32</td>
<td>[]</td>
<td>Array of IPv4 route structures. Each IPv4 route structure is composed of 4 32-bit values; the first being the destination IPv4 network or address (network byte order), the second the destination network or address prefix (1 - 32), the third being the next-hop (network byte order) if any, and the fourth being the route metric. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared', 'link-local', or 'disabled', methods as there is no upstream network.</td>
</tr>
<tr align=left valign=top>
<td><strong>ignore-auto-routes</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>When the method is set to 'auto' and this property to TRUE, automatically configured routes are ignored and only routes specified in the 'routes' property, if any, are used.</td>
</tr>
<tr align=left valign=top>
<td><strong>ignore-auto-dns</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>When the method is set to 'auto' and this property to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in the 'dns' and 'dns-search' properties, if any, are used.</td>
</tr>
<tr align=left valign=top>
<td><strong>dhcp-client-id</strong></td>
<td>string</td>
<td></td>
<td>A string sent to the DHCP server to identify the local machine which the DHCP server may use to cusomize the DHCP lease and options.</td>
</tr>
<tr align=left valign=top>
<td><strong>dhcp-send-hostname</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, a hostname is sent to the DHCP server when acquiring a lease. Some DHCP servers use this hostname to update DNS databases, essentially providing a static hostname for the computer. If the 'dhcp-hostname' property is empty and this property is TRUE, the current persistent hostname of the computer is sent.</td>
</tr>
<tr align=left valign=top>
<td><strong>dhcp-hostname</strong></td>
<td>string</td>
<td></td>
<td>If the 'dhcp-send-hostname' property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.</td>
</tr>
<tr align=left valign=top>
<td><strong>never-default</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, this connection will never be the default IPv4 connection, meaning it will never be assigned the default route by NetworkManager.</td>
</tr>
<tr align=left valign=top>
<td><strong>may-fail</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, allow overall network configuration to proceed even if IPv4 configuration times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv6-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv4 configuration fails but IPv6 configuration completes successfully.</td>
</tr>
</table><br/>
<p><h2>Setting name: 'ipv6'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>ipv6</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>method</strong></td>
<td>string</td>
<td></td>
<td>IPv6 configuration method. If 'auto' is specified then the appropriate automatic method (DHCP, PPP, router advertisement, etc) is used for the interface and most other properties can be left unset. If 'link-local' is specified, then an IPv6 link-local address will be assigned to the interface. If 'manual' is specified, static IP addressing is used and at least one IP address must be given in the 'addresses' property. If 'ignored' is specified, IPv6 configuration is not done. This property must be set. NOTE: the 'shared' method are not yet supported.</td>
</tr>
<tr align=left valign=top>
<td><strong>dns</strong></td>
<td>array of byte array</td>
<td>[]</td>
<td>Array of DNS servers, where each member of the array is a byte array containing the IPv6 address of the DNS server (in network byte order). For the 'auto' method, these DNS servers are appended to those (if any) returned by automatic configuration. DNS servers cannot be used with the 'shared' or 'link-local' methods as there is no usptream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</td>
</tr>
<tr align=left valign=top>
<td><strong>dns-search</strong></td>
<td>array of string</td>
<td>[]</td>
<td>List of DNS search domains. For the 'auto' method, these search domains are appended to those returned by automatic configuration. Search domains cannot be used with the 'shared' or 'link-local' methods as there is no upstream network. In all other methods, these search domains are used as the only search domains for this connection.</td>
</tr>
<tr align=left valign=top>
<td><strong>addresses</strong></td>
<td>array of (byte array, uint32, byte array)</td>
<td>[]</td>
<td>Array of IPv6 address structures. Each IPv6 address structure is composed of 3 members, the first being a byte array containing the IPv6 address (network byte order), the second a 32-bit integer containing the IPv6 address prefix, and the third a byte array containing the IPv6 address (network byte order) of the gateway associated with this address, if any. If no gateway is given, the third element should be given as all zeros. For the 'auto' method, given IP addresses are appended to those returned by automatic configuration. Addresses cannot be used with the 'shared' or 'link-local' methods as the interface is automatically assigned an address with these methods.</td>
</tr>
<tr align=left valign=top>
<td><strong>routes</strong></td>
<td>array of (byte array, uint32, byte array, uint32)</td>
<td>[]</td>
<td>Array of IPv6 route structures. Each IPv6 route structure is composed of 4 members; the first being the destination IPv6 network or address (network byte order) as a byte array, the second the destination network or address IPv6 prefix, the third being the next-hop IPv6 address (network byte order) if any, and the fourth being the route metric. For the 'auto' method, given IP routes are appended to those returned by automatic configuration. Routes cannot be used with the 'shared' or 'link-local' methods because there is no upstream network.</td>
</tr>
<tr align=left valign=top>
<td><strong>ignore-auto-routes</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>When the method is set to 'auto' and this property is set to TRUE, automatically configured routes are ignored and only routes specified in the 'routes' property, if any, are used.</td>
</tr>
<tr align=left valign=top>
<td><strong>ignore-auto-dns</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>When the method is set to 'auto' and this property is set to TRUE, automatically configured nameservers and search domains are ignored and only nameservers and search domains specified in 'dns' and 'dns-search' properties, if any, are used.</td>
</tr>
<tr align=left valign=top>
<td><strong>never-default</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, this connection will never be the default IPv6 connection, meaning it will never be assigned the default IPv6 route by NetworkManager.</td>
</tr>
<tr align=left valign=top>
<td><strong>may-fail</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, allow overall network configuration to proceed even if IPv6 configuration times out. Note that at least one IP configuration must succeed or overall network configuration will still fail. For example, in IPv4-only networks, setting this property to TRUE allows the overall network configuration to succeed if IPv6 configuration fails but IPv4 configuration completes successfully.</td>
</tr>
</table><br/>
<p><h2>Setting name: '802-11-olpc-mesh'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>802-11-olpc-mesh</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>ssid</strong></td>
<td>byte array</td>
<td>[]</td>
<td>SSID of the mesh network to join.</td>
</tr>
<tr align=left valign=top>
<td><strong>channel</strong></td>
<td>uint32</td>
<td>0</td>
<td>Channel on which the mesh network to join is located.</td>
</tr>
<tr align=left valign=top>
<td><strong>dhcp-anycast-address</strong></td>
<td>byte array</td>
<td>[]</td>
<td>Anycast DHCP MAC address used when requesting an IP address via DHCP. The specific anycast address used determines which DHCP server class answers the the request.</td>
</tr>
</table><br/>
<p><h2>Setting name: 'ppp'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>ppp</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>noauth</strong></td>
<td>boolean</td>
<td>TRUE</td>
<td>If TRUE, do not require the other side (usually the PPP server) to authenticate itself to the client. If FALSE, require authentication from the remote side. In almost all cases, this should be TRUE.</td>
</tr>
<tr align=left valign=top>
<td><strong>refuse-eap</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, the EAP authentication method will not be used.</td>
</tr>
<tr align=left valign=top>
<td><strong>refuse-pap</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, the PAP authentication method will not be used.</td>
</tr>
<tr align=left valign=top>
<td><strong>refuse-chap</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, the CHAP authentication method will not be used.</td>
</tr>
<tr align=left valign=top>
<td><strong>refuse-mschap</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, the MSCHAP authentication method will not be used.</td>
</tr>
<tr align=left valign=top>
<td><strong>refuse-mschapv2</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, the MSCHAPv2 authentication method will not be used.</td>
</tr>
<tr align=left valign=top>
<td><strong>nobsdcomp</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, BSD compression will not be requested.</td>
</tr>
<tr align=left valign=top>
<td><strong>nodeflate</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, 'deflate' compression will not be requested.</td>
</tr>
<tr align=left valign=top>
<td><strong>no-vj-comp</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, Van Jacobsen TCP header compression will not be requested.</td>
</tr>
<tr align=left valign=top>
<td><strong>require-mppe</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, MPPE (Microsoft Point-to-Point Encrpytion) will be required for the PPP session. If either 64-bit or 128-bit MPPE is not available the session will fail. Note that MPPE is not used on mobile broadband connections.</td>
</tr>
<tr align=left valign=top>
<td><strong>require-mppe-128</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, 128-bit MPPE (Microsoft Point-to-Point Encrpytion) will be required for the PPP session, and the 'require-mppe' property must also be set to TRUE. If 128-bit MPPE is not available the session will fail.</td>
</tr>
<tr align=left valign=top>
<td><strong>mppe-stateful</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</td>
</tr>
<tr align=left valign=top>
<td><strong>crtscts</strong></td>
<td>boolean</td>
<td>FALSE</td>
<td>If TRUE, specify that pppd should set the serial port to use hardware flow control with RTS and CTS signals. This value should normally be set to FALSE.</td>
</tr>
<tr align=left valign=top>
<td><strong>baud</strong></td>
<td>uint32</td>
<td>0</td>
<td>If non-zero, instruct pppd to set the serial port to the specified baudrate. This value should normally be left as 0 to automatically choose the speed.</td>
</tr>
<tr align=left valign=top>
<td><strong>mru</strong></td>
<td>uint32</td>
<td>0</td>
<td>If non-zero, instruct pppd to request that the peer send packets no larger than the specified size. If non-zero, the MRU should be between 128 and 16384.</td>
</tr>
<tr align=left valign=top>
<td><strong>mtu</strong></td>
<td>uint32</td>
<td>0</td>
<td>If non-zero, instruct pppd to send packets no larger than the specified size.</td>
</tr>
<tr align=left valign=top>
<td><strong>lcp-echo-failure</strong></td>
<td>uint32</td>
<td>0</td>
<td>If non-zero, instruct pppd to presume the connection to the peer has failed if the specified number of LCP echo-requests go unanswered by the peer. The 'lcp-echo-interval' property must also be set to a non-zero value if this property is used.</td>
</tr>
<tr align=left valign=top>
<td><strong>lcp-echo-interval</strong></td>
<td>uint32</td>
<td>0</td>
<td>If non-zero, instruct pppd to send an LCP echo-request frame to the peer every n seconds (where n is the specified value). Note that some PPP peers will respond to echo requests and some will not, and it is not possible to autodetect this.</td>
</tr>
</table><br/>
<p><h2>Setting name: 'pppoe'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>pppoe</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>service</strong></td>
<td>string</td>
<td></td>
<td>If specified, instruct PPPoE to only initiate sessions with access concentrators that provide the specified serivce. For most providers, this should be left blank. It is only required if there are multiple access concentrators or a specific service is known to be required.</td>
</tr>
<tr align=left valign=top>
<td><strong>username</strong></td>
<td>string</td>
<td></td>
<td>Username used to authenticate with the PPPoE service.</td>
</tr>
<tr align=left valign=top>
<td><strong>password</strong></td>
<td>string</td>
<td></td>
<td>Password used to authenticate with the PPPoE service.</td>
</tr>
</table><br/>
<p><h2>Setting name: 'serial'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>serial</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>baud</strong></td>
<td>uint32</td>
<td>57600</td>
<td>Speed to use for communication over the serial port. Note that this value usually has no effect for mobile broadband modems as they generally ignore speed settings and use the highest available speed.</td>
</tr>
<tr align=left valign=top>
<td><strong>bits</strong></td>
<td>uint32</td>
<td>8</td>
<td>Byte-width of the serial communication. The 8 in '8n1' for example.</td>
</tr>
<tr align=left valign=top>
<td><strong>parity</strong></td>
<td>gchar</td>
<td>110</td>
<td>Parity setting of the serial port. Either 'E' for even parity, 'o' for odd parity, or 'n' for no parity.</td>
</tr>
<tr align=left valign=top>
<td><strong>stopbits</strong></td>
<td>uint32</td>
<td>1</td>
<td>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in '8n1' for example.</td>
</tr>
<tr align=left valign=top>
<td><strong>send-delay</strong></td>
<td>uint64</td>
<td>0</td>
<td>Time to delay between each byte sent to the modem, in microseconds.</td>
</tr>
</table><br/>
<p><h2>Setting name: 'vpn'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>vpn</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>service-type</strong></td>
<td>string</td>
<td></td>
<td>D-Bus service name of the VPN plugin that this setting uses to connect to its network. i.e. org.freedesktop.NetworkManager.vpnc for the vpnc plugin.</td>
</tr>
<tr align=left valign=top>
<td><strong>user-name</strong></td>
<td>string</td>
<td></td>
<td>User name of the currently logged in user for connections provided by the user settings service. This name is provided to the VPN plugin to use in lieu of a custom username provided by that VPN plugins specific configuration. The VPN plugin itself decides which user name to use.</td>
</tr>
<tr align=left valign=top>
<td><strong>data</strong></td>
<td>dict of (string::string)</td>
<td>[ ]</td>
<td>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</td>
</tr>
<tr align=left valign=top>
<td><strong>secrets</strong></td>
<td>dict of (string::string)</td>
<td>[ ]</td>
<td>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</td>
</tr>
</table><br/>
<p><h2>Setting name: '802-3-ethernet'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>802-3-ethernet</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>port</strong></td>
<td>string</td>
<td></td>
<td>Specific port type to use if multiple the device supports multiple attachment methods. One of 'tp' (Twisted Pair), 'aui' (Attachment Unit Interface), 'bnc' (Thin Ethernet) or 'mii' (Media Independent Interface. If the device supports only one port type, this setting is ignored.</td>
</tr>
<tr align=left valign=top>
<td><strong>speed</strong></td>
<td>uint32</td>
<td>0</td>
<td>If non-zero, request that the device use only the specified speed. In Mbit/s, ie 100 == 100Mbit/s.</td>
</tr>
<tr align=left valign=top>
<td><strong>duplex</strong></td>
<td>string</td>
<td></td>
<td>If specified, request that the device only use the specified duplex mode. Either 'half' or 'full'.</td>
</tr>
<tr align=left valign=top>
<td><strong>auto-negotiate</strong></td>
<td>boolean</td>
<td>TRUE</td>
<td>If TRUE, allow auto-negotiation of port speed and duplex mode. If FALSE, do not allow auto-negotiation,in which case the 'speed' and 'duplex' properties should be set.</td>
</tr>
<tr align=left valign=top>
<td><strong>mac-address</strong></td>
<td>byte array</td>
<td>[]</td>
<td>If specified, this connection will only apply to the ethernet device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing).</td>
</tr>
<tr align=left valign=top>
<td><strong>mtu</strong></td>
<td>uint32</td>
<td>0</td>
<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</td>
</tr>
</table><br/>
<p><h2>Setting name: '802-11-wireless'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>802-11-wireless</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>ssid</strong></td>
<td>byte array</td>
<td>[]</td>
<td>SSID of the WiFi network. Must be specified.</td>
</tr>
<tr align=left valign=top>
<td><strong>mode</strong></td>
<td>string</td>
<td></td>
<td>WiFi network mode; one of 'infrastructure' or 'adhoc'. If blank, infrastructure is assumed.</td>
</tr>
<tr align=left valign=top>
<td><strong>band</strong></td>
<td>string</td>
<td></td>
<td>802.11 frequency band of the network. One of 'a' for 5GHz 802.11a or 'bg' for 2.4GHz 802.11. This will lock associations to the WiFi network to the specific band, i.e. if 'a' is specified, the device will not associate with the same network in the 2.4GHz band even if the network's settings are compatible. This setting depends on specific driver capability and may not work with all drivers.</td>
</tr>
<tr align=left valign=top>
<td><strong>channel</strong></td>
<td>uint32</td>
<td>0</td>
<td>Wireless channel to use for the WiFi connection. The device will only join (or create for Ad-Hoc networks) a WiFi network on the specified channel. Because channel numbers overlap between bands, this property also requires the 'band' property to be set.</td>
</tr>
<tr align=left valign=top>
<td><strong>bssid</strong></td>
<td>byte array</td>
<td>[]</td>
<td>If specified, directs the device to only associate with the given access point. This capability is highly driver dependent and not supported by all devices. Note: this property does not control the BSSID used when creating an Ad-Hoc network and is unlikely to in the future.</td>
</tr>
<tr align=left valign=top>
<td><strong>rate</strong></td>
<td>uint32</td>
<td>0</td>
<td>If non-zero, directs the device to only use the specified bitrate for communication with the access point. Units are in Kb/s, ie 5500 = 5.5 Mbit/s. This property is highly driver dependent and not all devices support setting a static bitrate.</td>
</tr>
<tr align=left valign=top>
<td><strong>tx-power</strong></td>
<td>uint32</td>
<td>0</td>
<td>If non-zero, directs the device to use the specified transmit power. Units are dBm. This property is highly driver dependent and not all devices support setting a static transmit power.</td>
</tr>
<tr align=left valign=top>
<td><strong>mac-address</strong></td>
<td>byte array</td>
<td>[]</td>
<td>If specified, this connection will only apply to the WiFi device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing).</td>
</tr>
<tr align=left valign=top>
<td><strong>mtu</strong></td>
<td>uint32</td>
<td>0</td>
<td>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</td>
</tr>
<tr align=left valign=top>
<td><strong>seen-bssids</strong></td>
<td>array of string</td>
<td>[]</td>
<td>A list of BSSIDs (each BSSID formatted as a MAC address like '00:11:22:33:44:55') that have been detected as part of the WiFI network. The settings service will usually populate this property by periodically asking NetworkManager what the device's current AP is while connected to the network (or monitoring the device's 'active-ap' property) and adding the current AP's BSSID to this list. This list helps NetworkManager find hidden APs by matching up scan results with the BSSIDs in this list.</td>
</tr>
<tr align=left valign=top>
<td><strong>security</strong></td>
<td>string</td>
<td></td>
<td>If the wireless connection has any security restrictions, like 802.1x, WEP, or WPA, set this property to '802-11-wireless-security' and ensure the connection contains a valid 802-11-wireless-security setting.</td>
</tr>
</table><br/>
<p><h2>Setting name: '802-11-wireless-security'</h2></p>
<table cellspacing=10 border=0 cellpadding=2>
<th align=left>Key Name</th>
<th align=left>Value Type</th>
<th align=left>Default Value</th>
<th align=left>Value Description</th>
<tr align=left valign=top>
<td><strong>name</strong></td>
<td>string</td>
<td>802-11-wireless-security</td>
<td>The setting's name; these names are defined by the specification and cannot be changed after the object has been created. Each setting class has a name, and all objects of that class share the same name.</td>
</tr>
<tr align=left valign=top>
<td><strong>key-mgmt</strong></td>
<td>string</td>
<td></td>
<td>Key management used for the connection. One of 'none' (WEP), 'ieee8021x' (Dynamic WEP), 'wpa-none' (WPA-PSK Ad-Hoc), 'wpa-psk' (infrastructure WPA-PSK), or 'wpa-eap' (WPA-Enterprise). This property must be set for any WiFi connection that uses security.</td>
</tr>
<tr align=left valign=top>
<td><strong>wep-tx-keyidx</strong></td>
<td>uint32</td>
<td>0</td>
<td>When static WEP is used (ie, key-mgmt = 'none') and a non-default WEP key index is used by the AP, put that WEP key index here. Valid values are 0 (default key) through 3. Note that some consumer access points (like the Linksys WRT54G) number the keys 1 - 4.</td>
</tr>
<tr align=left valign=top>
<td><strong>auth-alg</strong></td>
<td>string</td>
<td></td>
<td>When WEP is used (ie, key-mgmt = 'none' or 'ieee8021x') indicate the 802.11 authentication algorithm required by the AP here. One of 'open' for Open System, 'shared' for Shared Key, or 'leap' for Cisco LEAP. When using Cisco LEAP (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap') the 'leap-username' and 'leap-password' properties must be specified.</td>
</tr>
<tr align=left valign=top>
<td><strong>proto</strong></td>
<td>array of string</td>
<td>[]</td>
<td>List of strings specifying the allowed WPA protocol versions to use. Each element may be one 'wpa' (allow WPA) or 'rsn' (allow WPA2/RSN). If not specified, both WPA and RSN connections are allowed.</td>
</tr>
<tr align=left valign=top>
<td><strong>pairwise</strong></td>
<td>array of string</td>
<td>[]</td>
<td>If specified, will only connect to WPA networks that provide the specified pairwise encryption capabilities. Each element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.</td>
</tr>
<tr align=left valign=top>
<td><strong>group</strong></td>
<td>array of string</td>
<td>[]</td>
<td>If specified, will only connect to WPA networks that provide the specified group/multicast encryption capabilities. Each element may be one of 'wep40', 'wep104', 'tkip', or 'ccmp'.</td>
</tr>
<tr align=left valign=top>
<td><strong>leap-username</strong></td>
<td>string</td>
<td></td>
<td>The login username for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</td>
</tr>
<tr align=left valign=top>
<td><strong>wep-key0</strong></td>
<td>string</td>
<td></td>
<td>Index 0 WEP key. This is the WEP key used in most networks. See the 'wep-key-type' property for a description of how this key is interpreted.</td>
</tr>
<tr align=left valign=top>
<td><strong>wep-key1</strong></td>
<td>string</td>
<td></td>
<td>Index 1 WEP key. This WEP index is not used by most networks. See the 'wep-key-type' property for a description of how this key is interpreted.</td>
</tr>
<tr align=left valign=top>
<td><strong>wep-key2</strong></td>
<td>string</td>
<td></td>
<td>Index 2 WEP key. This WEP index is not used by most networks. See the 'wep-key-type' property for a description of how this key is interpreted.</td>
</tr>
<tr align=left valign=top>
<td><strong>wep-key3</strong></td>
<td>string</td>
<td></td>
<td>Index 3 WEP key. This WEP index is not used by most networks. See the 'wep-key-type' property for a description of how this key is interpreted.</td>
</tr>
<tr align=left valign=top>
<td><strong>psk</strong></td>
<td>string</td>
<td></td>
<td>Pre-Shared-Key for WPA networks. If the key is 64-characters long, it must contain only hexadecimal characters and is interpreted as a hexadecimal WPA key. Otherwise, the key must be between 8 and 63 ASCII characters (as specified in the 802.11i standard) and is interpreted as a WPA passphrase, and is hashed to derive the actual WPA-PSK used when connecting to the WiFi network.</td>
</tr>
<tr align=left valign=top>
<td><strong>leap-password</strong></td>
<td>string</td>
<td></td>
<td>The login password for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</td>
</tr>
<tr align=left valign=top>
<td><strong>wep-key-type</strong></td>
<td>uint32</td>
<td>0</td>
<td>Controls the interpretation of WEP keys. Allowed values are 1 (interpret WEP keys as hexadecimal or ASCII keys) or 2 (interpret WEP keys as WEP Passphrases). If set to 1 and the keys are hexadecimal, they must be either 10 or 26 characters in length. If set to 1 and the keys are ASCII keys, they must be either 5 or 13 characters in length. If set to 2, the passphrase is hashed using the de-facto MD5 method to derive the actual WEP key.</td>
</tr>
</table><br/>
</body>
</html>
|
