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
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">]><refentry id="nm-settings">
<refentryinfo>
<date>08 February 2013</date>
</refentryinfo>
<refmeta>
<refentrytitle>nm-settings</refentrytitle>
<manvolnum>5</manvolnum>
<refmiscinfo class="source">NetworkManager</refmiscinfo>
<refmiscinfo class="manual">Configuration</refmiscinfo>
<refmiscinfo class="version">0.9.7.997</refmiscinfo>
</refmeta>
<refnamediv>
<refname>nm-settings</refname>
<refpurpose>Description of settings and parameters of NetworkManager connections.</refpurpose>
</refnamediv>
<refsect1>
<title>DESCRIPTION</title>
<para>
NetworkManager is based on a concept of connections. These connections are
then applied to a device to make an active network connection. Users can create
as many connections as they see fit. The connections are handled by NetworkManager
via <emphasis>settings service</emphasis> and are exported on D-Bus
(<emphasis>/org/freedesktop/NetworkManager/Settings/<num></emphasis> objects).
The conceptual objects can be described as follows:
<variablelist>
<varlistentry>
<term>Connection</term>
<listitem>
<para>
A specific, encapsulated, independent group of settings describing
all the configuration required to connect to a specific network.
It is referred to by a unique identifier called the UUID. A connection
is tied to a one specific device type, but not necessarily a specific
hardware device. It is composed of one or more <emphasis>Settings</emphasis>
objects.
</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>Setting</term>
<listitem>
<para>
A group of related key/value pairs describing a specific piece of a
<emphasis>Connection</emphasis>. Settings keys and allowed values are
described in the tables below. Developers can find the settings
objects in the libnm-util sources. Look for the <function>class_init</function>
functions near the bottoms of each setting source file.
</para>
</listitem>
</varlistentry>
</variablelist>
<table>
<title>802-1x setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">802-1x</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">eap</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">identity</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Identity string for EAP authentication methods. Often the user's user or login name.</entry>
</row>
<row>
<entry align="left">anonymous-identity</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Anonymous identity string for EAP authentication methods. Used as the unencrypted identity with EAP types that support different tunneled identity like EAP-TTLS.</entry>
</row>
<row>
<entry align="left">pac-file</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>UTF-8 encoded file path containing PAC for EAP-FAST.</entry>
</row>
<row>
<entry align="left">ca-cert</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">ca-path</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">subject-match</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Substring to be matched against the subject of the certificate presented by the authentication server. When unset, no verification of the authentication server certificate's subject is performed.</entry>
</row>
<row>
<entry align="left">altsubject-matches</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>List of strings to be matched against the altSubjectName of the certificate presented by the authentication server. If the list is empty, no verification of the server certificate's altSubjectName is performed.</entry>
</row>
<row>
<entry align="left">client-cert</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">phase1-peapver</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">phase1-peaplabel</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">phase1-fast-provisioning</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">phase2-auth</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">phase2-autheap</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">phase2-ca-cert</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">phase2-ca-path</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">phase2-subject-match</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Substring to be matched against the subject of the certificate presented by the authentication server during the inner 'phase2' authentication. When unset, no verification of the authentication server certificate's subject is performed.</entry>
</row>
<row>
<entry align="left">phase2-altsubject-matches</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>List of strings to be matched against List of strings to be matched against the altSubjectName of the certificate presented by the authentication server during the inner 'phase 2' authentication. If the list is empty, no verification of the server certificate's altSubjectName is performed.</entry>
</row>
<row>
<entry align="left">phase2-client-cert</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>Contains the 'phase 2' client 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 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.</entry>
</row>
<row>
<entry align="left">password</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Password used for EAP authentication methods.</entry>
</row>
<row>
<entry align="left">password-flags</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>Flags indicating how to handle the 802.1x password. (see <xref linkend="secrets-flags"/> for flag values)</entry>
</row>
<row>
<entry align="left">password-raw</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>Password used for EAP authentication methods as a byte array</entry>
</row>
<row>
<entry align="left">password-raw-flags</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>Flags indicating how to handle the 802.1x password byte array. (see <xref linkend="secrets-flags"/> for flag values)</entry>
</row>
<row>
<entry align="left">private-key</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>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 private keys, this property should be set to the key's encrypted PEM encoded data. When using 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 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 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.</entry>
</row>
<row>
<entry align="left">private-key-password</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">private-key-password-flags</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>Flags indicating how to handle the 802.1x private key password. (see <xref linkend="secrets-flags"/> for flag values)</entry>
</row>
<row>
<entry align="left">phase2-private-key</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>Contains the 'phase 2' inner private key when the 'phase2-auth' 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 private keys, this property should be set to the key's encrypted PEM encoded data. When using 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 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 and the 'phase2-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 'phase2-private-key-password' property must be set to the password used to decode the PKCS#12 private key and certificate.</entry>
</row>
<row>
<entry align="left">phase2-private-key-password</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">phase2-private-key-password-flags</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>Flags indicating how to handle the 802.1x phase2 private key password. (see <xref linkend="secrets-flags"/> for flag values)</entry>
</row>
<row>
<entry align="left">system-ca-certs</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>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.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>adsl setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">adsl</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">username</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Username used to authenticate with the pppoa service.</entry>
</row>
<row>
<entry align="left">password</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Password used to authenticate with the pppoa service.</entry>
</row>
<row>
<entry align="left">password-flags</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>Flags indicating how to handle the ADSL password. (see <xref linkend="secrets-flags"/> for flag values)</entry>
</row>
<row>
<entry align="left">protocol</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>ADSL connection protocol.</entry>
</row>
<row>
<entry align="left">encapsulation</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Encapsulation of ADSL connection</entry>
</row>
<row>
<entry align="left">vpi</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>VPI of ADSL connection</entry>
</row>
<row>
<entry align="left">vci</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>VCI of ADSL connection</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>bluetooth setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">bluetooth</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">bdaddr</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>The Bluetooth address of the device</entry>
</row>
<row>
<entry align="left">type</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Either 'dun' for Dial-Up Networking connections or 'panu' for Personal Area Networking connections.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>bond setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">bond</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">interface-name</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>The name of the virtual in-kernel bonding network interface</entry>
</row>
<row>
<entry align="left">options</entry>
<entry align="left">dict of (string::string)</entry>
<entry align="left">[ ]</entry>
<entry>Dictionary of key/value pairs of bonding options. Both keys and values must be strings. Option names must contain only alphanumeric characters (ie, [a-zA-Z0-9]).</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>bridge setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">bridge</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">interface-name</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>The name of the virtual in-kernel bridging network interface</entry>
</row>
<row>
<entry align="left">stp</entry>
<entry align="left">boolean</entry>
<entry align="left">TRUE</entry>
<entry>Controls whether Spanning Tree Protocol (STP) is enabled for this bridge.</entry>
</row>
<row>
<entry align="left">priority</entry>
<entry align="left">uint32</entry>
<entry align="left">128</entry>
<entry>Sets the Spanning Tree Protocol (STP) priority for this bridge. Lower values are 'better'; the lowest priority bridge will be elected the root bridge.</entry>
</row>
<row>
<entry align="left">forward-delay</entry>
<entry align="left">uint32</entry>
<entry align="left">15</entry>
<entry>The Spanning Tree Protocol (STP) forwarding delay, in seconds.</entry>
</row>
<row>
<entry align="left">hello-time</entry>
<entry align="left">uint32</entry>
<entry align="left">2</entry>
<entry>The Spanning Tree Protocol (STP) hello time, in seconds.</entry>
</row>
<row>
<entry align="left">max-age</entry>
<entry align="left">uint32</entry>
<entry align="left">20</entry>
<entry>The Spanning Tree Protocol (STP) maximum message age, in seconds.</entry>
</row>
<row>
<entry align="left">ageing-time</entry>
<entry align="left">uint32</entry>
<entry align="left">300</entry>
<entry>The ethernet MAC address aging time, in seconds.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>bridge-port setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">bridge-port</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">priority</entry>
<entry align="left">uint32</entry>
<entry align="left">32</entry>
<entry>The Spanning Tree Protocol (STP) priority of this bridge port</entry>
</row>
<row>
<entry align="left">path-cost</entry>
<entry align="left">uint32</entry>
<entry align="left">100</entry>
<entry>The Spanning Tree Protocol (STP) port cost for destinations via this port.</entry>
</row>
<row>
<entry align="left">hairpin-mode</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>Enables or disabled 'hairpin mode' for the port, which allows frames to be sent back out through the port the frame was received on.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>cdma setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">cdma</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">number</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">username</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</entry>
</row>
<row>
<entry align="left">password</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</entry>
</row>
<row>
<entry align="left">password-flags</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>Flags indicating how to handle the CDMA password. (see <xref linkend="secrets-flags"/> for flag values)</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>connection setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">connection</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">id</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">uuid</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">type</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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).</entry>
</row>
<row>
<entry align="left">permissions</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>An array of strings defining what access a given user has to this connection. If this is NULL or empty, all users are allowed to access this connection. Otherwise a user is allowed to access this connection if and only if they are in this array. Each entry is of the form "[type]:[id]:[reserved]", for example: "user:dcbw:blah" At this time only the 'user' [type] is allowed. Any other values are ignored and reserved for future use. [id] is the username that this permission refers to, which may not contain the ':' character. Any [reserved] information (if present) must be ignored and is reserved for future use. All of [type], [id], and [reserved] must be valid UTF-8.</entry>
</row>
<row>
<entry align="left">autoconnect</entry>
<entry align="left">boolean</entry>
<entry align="left">TRUE</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">timestamp</entry>
<entry align="left">uint64</entry>
<entry align="left">0</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">read-only</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">zone</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>The trust level of a the connection.Free form case-insensitive string (for example "Home", "Work", "Public"). NULL or unspecified zone means the connection will be placed in the default zone as defined by the firewall.</entry>
</row>
<row>
<entry align="left">master</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Interface name of the master device or UUID of the master connection</entry>
</row>
<row>
<entry align="left">slave-type</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Setting name describing the type of slave this connection is (ie, 'bond') or NULL if this connection is not a slave.</entry>
</row>
<row>
<entry align="left">secondaries</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>List of connection UUIDs that should be activated when the base connection itself is activated.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>gsm setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">gsm</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">number</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Number to dial when establishing a PPP data session with the GSM-based mobile broadband network. Many modems do not require PPP for connections to the mobile network and thus this property should be left blank, which allows NetworkManager to select the appropriate settings automatically.</entry>
</row>
<row>
<entry align="left">username</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Username used to authenticate with the network, if required. Note that many providers do not require a username or accept any username.</entry>
</row>
<row>
<entry align="left">password</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Password used to authenticate with the network, if required. Note that many providers do not require a password or accept any password.</entry>
</row>
<row>
<entry align="left">password-flags</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>Flags indicating how to handle the GSM password. (see <xref linkend="secrets-flags"/> for flag values)</entry>
</row>
<row>
<entry align="left">apn</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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. The APN may only be composed of the characters a-z, 0-9, ., and - per GSM 03.60 Section 14.9.</entry>
</row>
<row>
<entry align="left">network-id</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">network-type</entry>
<entry align="left">int32</entry>
<entry align="left">-1</entry>
<entry>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, 3: prefer 2G, 4: prefer 4G/LTE, 5: 4G/LTE only. Note that not all devices allow network preference control.</entry>
</row>
<row>
<entry align="left">pin</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">pin-flags</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>Flags indicating how to handle the GSM SIM PIN. (see <xref linkend="secrets-flags"/> for flag values)</entry>
</row>
<row>
<entry align="left">allowed-bands</entry>
<entry align="left">uint32</entry>
<entry align="left">1</entry>
<entry>Bitfield of allowed frequency bands. Note that not all devices allow frequency band control.</entry>
</row>
<row>
<entry align="left">home-only</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>When TRUE, only connections to the home network will be allowed. Connections to roaming networks will not be made.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>infiniband setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">infiniband</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">mac-address</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>If specified, this connection will only apply to the IPoIB device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry>
</row>
<row>
<entry align="left">mtu</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple frames.</entry>
</row>
<row>
<entry align="left">transport-mode</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>The IPoIB transport mode. Either 'datagram' or 'connected'.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>ipv4 setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">ipv4</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">method</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">dns</entry>
<entry align="left">array of uint32</entry>
<entry align="left">[]</entry>
<entry>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 upstream network. In all other methods, these DNS servers are used as the only DNS servers for this connection.</entry>
</row>
<row>
<entry align="left">dns-search</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">addresses</entry>
<entry align="left">array of array of uint32</entry>
<entry align="left">[]</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">routes</entry>
<entry align="left">array of array of uint32</entry>
<entry align="left">[]</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">ignore-auto-routes</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">ignore-auto-dns</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">dhcp-client-id</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>A string sent to the DHCP server to identify the local machine which the DHCP server may use to customize the DHCP lease and options.</entry>
</row>
<row>
<entry align="left">dhcp-send-hostname</entry>
<entry align="left">boolean</entry>
<entry align="left">TRUE</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">dhcp-hostname</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>If the 'dhcp-send-hostname' property is TRUE, then the specified name will be sent to the DHCP server when acquiring a lease.</entry>
</row>
<row>
<entry align="left">never-default</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>If TRUE, this connection will never be the default IPv4 connection, meaning it will never be assigned the default route by NetworkManager.</entry>
</row>
<row>
<entry align="left">may-fail</entry>
<entry align="left">boolean</entry>
<entry align="left">TRUE</entry>
<entry>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.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>ipv6 setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">ipv6</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">method</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>IPv6 configuration method. If 'auto' is specified then the appropriate automatic method (PPP, router advertisement, etc) is used for the device and most other properties can be left unset. To force the use of DHCP only, specify 'dhcp'; this method is only valid for ethernet-based hardware. 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' methodis not yet supported.</entry>
</row>
<row>
<entry align="left">dhcp-hostname</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>The specified name will be sent to the DHCP server when acquiring a lease.</entry>
</row>
<row>
<entry align="left">dns</entry>
<entry align="left">array of byte array</entry>
<entry align="left">[]</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">dns-search</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">addresses</entry>
<entry align="left">array of (byte array, uint32, byte array)</entry>
<entry align="left">[]</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">routes</entry>
<entry align="left">array of (byte array, uint32, byte array, uint32)</entry>
<entry align="left">[]</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">ignore-auto-routes</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>When the method is set to 'auto' or 'dhcp' and this property is set to TRUE, automatically configured routes are ignored and only routes specified in the 'routes' property, if any, are used.</entry>
</row>
<row>
<entry align="left">ignore-auto-dns</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>When the method is set to 'auto' or 'dhcp' and this property is set 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.</entry>
</row>
<row>
<entry align="left">never-default</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>If TRUE, this connection will never be the default IPv6 connection, meaning it will never be assigned the default IPv6 route by NetworkManager.</entry>
</row>
<row>
<entry align="left">may-fail</entry>
<entry align="left">boolean</entry>
<entry align="left">TRUE</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">ip6-privacy</entry>
<entry align="left">int32</entry>
<entry align="left">-1</entry>
<entry>Configure IPv6 Privacy Extensions for SLAAC, described in RFC4941. If enabled, it makes the kernel generate a temporary IPv6 address in addition to the public one generated from MAC address via modified EUI-64. This enhances privacy, but could cause problems in some applications, on the other hand. The permitted values are: 0: disabled, 1: enabled (prefer public address), 2: enabled (prefer temporary addresses).</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>802-11-olpc-mesh setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">802-11-olpc-mesh</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">ssid</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>SSID of the mesh network to join.</entry>
</row>
<row>
<entry align="left">channel</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>Channel on which the mesh network to join is located.</entry>
</row>
<row>
<entry align="left">dhcp-anycast-address</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>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.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>ppp setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">ppp</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">noauth</entry>
<entry align="left">boolean</entry>
<entry align="left">TRUE</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">refuse-eap</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>If TRUE, the EAP authentication method will not be used.</entry>
</row>
<row>
<entry align="left">refuse-pap</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>If TRUE, the PAP authentication method will not be used.</entry>
</row>
<row>
<entry align="left">refuse-chap</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>If TRUE, the CHAP authentication method will not be used.</entry>
</row>
<row>
<entry align="left">refuse-mschap</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>If TRUE, the MSCHAP authentication method will not be used.</entry>
</row>
<row>
<entry align="left">refuse-mschapv2</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>If TRUE, the MSCHAPv2 authentication method will not be used.</entry>
</row>
<row>
<entry align="left">nobsdcomp</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>If TRUE, BSD compression will not be requested.</entry>
</row>
<row>
<entry align="left">nodeflate</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>If TRUE, 'deflate' compression will not be requested.</entry>
</row>
<row>
<entry align="left">no-vj-comp</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>If TRUE, Van Jacobsen TCP header compression will not be requested.</entry>
</row>
<row>
<entry align="left">require-mppe</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">require-mppe-128</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">mppe-stateful</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>If TRUE, stateful MPPE is used. See pppd documentation for more information on stateful MPPE.</entry>
</row>
<row>
<entry align="left">crtscts</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">baud</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">mru</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">mtu</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>If non-zero, instruct pppd to send packets no larger than the specified size.</entry>
</row>
<row>
<entry align="left">lcp-echo-failure</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">lcp-echo-interval</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>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.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>pppoe setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">pppoe</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">service</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">username</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Username used to authenticate with the PPPoE service.</entry>
</row>
<row>
<entry align="left">password</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Password used to authenticate with the PPPoE service.</entry>
</row>
<row>
<entry align="left">password-flags</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>Flags indicating how to handle the PPPoE password. (see <xref linkend="secrets-flags"/> for flag values)</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>serial setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">serial</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">baud</entry>
<entry align="left">uint32</entry>
<entry align="left">57600</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">bits</entry>
<entry align="left">uint32</entry>
<entry align="left">8</entry>
<entry>Byte-width of the serial communication. The 8 in '8n1' for example.</entry>
</row>
<row>
<entry align="left">parity</entry>
<entry align="left">gchar</entry>
<entry align="left">110</entry>
<entry>Parity setting of the serial port. Either 'E' for even parity, 'o' for odd parity, or 'n' for no parity.</entry>
</row>
<row>
<entry align="left">stopbits</entry>
<entry align="left">uint32</entry>
<entry align="left">1</entry>
<entry>Number of stop bits for communication on the serial port. Either 1 or 2. The 1 in '8n1' for example.</entry>
</row>
<row>
<entry align="left">send-delay</entry>
<entry align="left">uint64</entry>
<entry align="left">0</entry>
<entry>Time to delay between each byte sent to the modem, in microseconds.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>vlan setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">vlan</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">interface-name</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>If given, specifies the kernel name of the VLAN interface. If not given, a default name will be constructed from the interface described by the parent interface and the 'id' property, ex 'eth2.1'. The parent interface may be given by the 'parent' property or by a hardware address property, eg the 'wired' settings' 'mac-address' property.</entry>
</row>
<row>
<entry align="left">parent</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>If given, specifies the parent interface name or parent connection UUID from which this VLAN interface should be created. If this property is not specified, the connection must contain a hardware address in a hardware-specific setting, like the 'wired' settings' 'mac-address' property.</entry>
</row>
<row>
<entry align="left">id</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>The VLAN indentifier the interface created by this connection should be assigned.</entry>
</row>
<row>
<entry align="left">flags</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>One or more flags which control the behavior and features of the VLAN interface. Flags include reordering of output packet headers (0x01), use of the GVRP protocol (0x02), and loose binding of the interface to its master device's operating state (0x04).</entry>
</row>
<row>
<entry align="left">ingress-priority-map</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>For incoming packets, a list of mappings from 802.1p priorities to Linux SKB priorities. The mapping is given in the format 'from:to' where both 'from' and 'to' are unsigned integers, ie '7:3'.</entry>
</row>
<row>
<entry align="left">egress-priority-map</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>For outgoing packets, a list of mappings from Linux SKB priorities to 802.1p priorities. The mapping is given in the format 'from:to' where both 'from' and 'to' are unsigned integers, ie '7:3'.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>vpn setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">vpn</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">service-type</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">user-name</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>If the VPN connection requires a user name for authentication, that name should be provided here. If the connection is available to more than one user, and the VPN requires each user to supply a different name, then leave this property empty. If this property is empty, NetworkManager will automatically supply the username of the user which requested the VPN connection.</entry>
</row>
<row>
<entry align="left">data</entry>
<entry align="left">dict of (string::string)</entry>
<entry align="left">[ ]</entry>
<entry>Dictionary of key/value pairs of VPN plugin specific data. Both keys and values must be strings.</entry>
</row>
<row>
<entry align="left">secrets</entry>
<entry align="left">dict of (string::string)</entry>
<entry align="left">[ ]</entry>
<entry>Dictionary of key/value pairs of VPN plugin specific secrets like passwords or private keys. Both keys and values must be strings.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>wimax setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">wimax</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">network-name</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>Network Service Provider (NSP) name of the WiMAX network this connection should use.</entry>
</row>
<row>
<entry align="left">mac-address</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>If specified, this connection will only apply to the WiMAX device whose MAC address matches. This property does not change the MAC address of the device (known as MAC spoofing).</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>802-3-ethernet setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">802-3-ethernet</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">port</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">speed</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>If non-zero, request that the device use only the specified speed. In Mbit/s, ie 100 == 100Mbit/s.</entry>
</row>
<row>
<entry align="left">duplex</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>If specified, request that the device only use the specified duplex mode. Either 'half' or 'full'.</entry>
</row>
<row>
<entry align="left">auto-negotiate</entry>
<entry align="left">boolean</entry>
<entry align="left">TRUE</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">mac-address</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>If specified, this connection will only apply to the ethernet device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry>
</row>
<row>
<entry align="left">cloned-mac-address</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>If specified, request that the device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</entry>
</row>
<row>
<entry align="left">mac-address-blacklist</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>If specified, this connection will never apply to the ethernet device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</entry>
</row>
<row>
<entry align="left">mtu</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry>
</row>
<row>
<entry align="left">s390-subchannels</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>Identifies specific subchannels that this network device uses for communcation with z/VM or s390 host. Like the 'mac-address' property for non-z/VM devices, this property can be used to ensure this connection only applies to the network device that uses these subchannels. The list should contain exactly 3 strings, and each string may only be composed of hexadecimal characters and the period (.) character.</entry>
</row>
<row>
<entry align="left">s390-nettype</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>s390 network device type; one of 'qeth', 'lcs', or 'ctc', representing the different types of virtual network devices available on s390 systems.</entry>
</row>
<row>
<entry align="left">s390-options</entry>
<entry align="left">dict of (string::string)</entry>
<entry align="left">[ ]</entry>
<entry>Dictionary of key/value pairs of s390-specific device options. Both keys and values must be strings. Allowed keys include 'portno', 'layer2', 'portname', 'protocol', among others.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>802-11-wireless setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">802-11-wireless</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">ssid</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>SSID of the WiFi network. Must be specified.</entry>
</row>
<row>
<entry align="left">mode</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>WiFi network mode; one of 'infrastructure', 'adhoc' or 'ap'. If blank, infrastructure is assumed.</entry>
</row>
<row>
<entry align="left">band</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">channel</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">bssid</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">rate</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">tx-power</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">mac-address</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>If specified, this connection will only apply to the WiFi device whose permanent MAC address matches. This property does not change the MAC address of the device (i.e. MAC spoofing).</entry>
</row>
<row>
<entry align="left">cloned-mac-address</entry>
<entry align="left">byte array</entry>
<entry align="left">[]</entry>
<entry>If specified, request that the WiFi device use this MAC address instead of its permanent MAC address. This is known as MAC cloning or spoofing.</entry>
</row>
<row>
<entry align="left">mac-address-blacklist</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>If specified, this connection will never apply to the WiFi device whose permanent MAC address matches an address in the list. Each MAC address is in the standard hex-digits-and-colons notation (00:11:22:33:44:55).</entry>
</row>
<row>
<entry align="left">mtu</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>If non-zero, only transmit packets of the specified size or smaller, breaking larger packets up into multiple Ethernet frames.</entry>
</row>
<row>
<entry align="left">seen-bssids</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>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. NetworkManager internally tracks previously seen BSSIDs. The property is only meant for reading and reflects the BBSID list of NetworkManager. The changes you make to this property will not be preserved.</entry>
</row>
<row>
<entry align="left">security</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">hidden</entry>
<entry align="left">boolean</entry>
<entry align="left">FALSE</entry>
<entry>If TRUE, indicates this network is a non-broadcasting network that hides its SSID. In this case various workarounds may take place, such as probe-scanning the SSID for more reliable network discovery. However, these workarounds expose inherent insecurities with hidden SSID networks, and thus hidden SSID networks should be used with caution.</entry>
</row>
</tbody>
</tgroup>
</table>
<table>
<title>802-11-wireless-security setting</title>
<tgroup cols="4">
<thead>
<row>
<entry>Key Name</entry>
<entry>Value Type</entry>
<entry>Default Value</entry>
<entry>Value Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="left">name</entry>
<entry align="left">string</entry>
<entry align="left">802-11-wireless-security</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">key-mgmt</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">wep-tx-keyidx</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">auth-alg</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">proto</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">pairwise</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>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'.</entry>
</row>
<row>
<entry align="left">group</entry>
<entry align="left">array of string</entry>
<entry align="left">[]</entry>
<entry>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'.</entry>
</row>
<row>
<entry align="left">leap-username</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>The login username for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</entry>
</row>
<row>
<entry align="left">wep-key0</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">wep-key1</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">wep-key2</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">wep-key3</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">wep-key-flags</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>Flags indicating how to handle the WEP keys. (see <xref linkend="secrets-flags"/> for flag values)</entry>
</row>
<row>
<entry align="left">wep-key-type</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">psk</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>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.</entry>
</row>
<row>
<entry align="left">psk-flags</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>Flags indicating how to handle the WPA PSK key. (see <xref linkend="secrets-flags"/> for flag values)</entry>
</row>
<row>
<entry align="left">leap-password</entry>
<entry align="left">string</entry>
<entry align="left"></entry>
<entry>The login password for legacy LEAP connections (ie, key-mgmt = 'ieee8021x' and auth-alg = 'leap').</entry>
</row>
<row>
<entry align="left">leap-password-flags</entry>
<entry align="left">uint32</entry>
<entry align="left">0</entry>
<entry>Flags indicating how to handle the LEAP password. (see <xref linkend="secrets-flags"/> for flag values)</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
<refsect2 id="secrets-flags">
<title>Secret flag types:</title>
<para>
Each secret property in a setting has an associated <emphasis>flags</emphasis> property
that describes how to handle that secret. The <emphasis>flags</emphasis> property is a bitfield
that contains zero or more of the following values logically OR-ed together.
</para>
<itemizedlist>
<listitem>
<para>0x0 (none) - the system is responsible for providing and storing this secret.</para>
</listitem>
<listitem>
<para>0x1 (agent-owned) - a user-session secret agent is responsible for providing and storing
this secret; when it is required, agents will be asked to provide it.</para>
</listitem>
<listitem>
<para>0x2 (not-saved) - this secret should not be saved but should be requested from the user
each time it is required. This flag should be used for One-Time-Pad secrets, PIN codes from hardware tokens,
or if the user simply does not want to save the secret.</para>
</listitem>
<listitem>
<para>0x4 (not-required) - in some situations it cannot be automatically determined that a secret
is required or not. This flag hints that the secret is not required and should not be requested from the user.</para>
</listitem>
</itemizedlist>
</refsect2>
</refsect1>
<refsect1>
<title>AUTHOR</title>
<para>
<author>
<firstname>NetworkManager developers</firstname>
</author>
</para>
</refsect1>
<refsect1>
<title>FILES</title>
<para>/etc/NetworkManager/system-connections</para>
<para>or distro plugin-specific location</para>
</refsect1>
<refsect1>
<title>SEE ALSO</title>
<para>https://live.gnome.org/NetworkManagerConfiguration</para>
<para>NetworkManager(8), nmcli(1), NetworkManager.conf(5)</para>
</refsect1>
</refentry>
|
